On this page
Class ControllerAuthorize
An authorization adapter for AuthComponent. Provides the ability to authorize using a controller callback. Your controller's isAuthorized() method should return a boolean to indicate whether or not the user is authorized.
public function isAuthorized($user)
{
    if ($this->request->param('admin')) {
        return $user['role'] === 'admin';
    }
    return !empty($user);
}
The above is simple implementation that would only authorize users of the 'admin' role to access admin routing.
- Cake\Auth\BaseAuthorize uses Cake\Core\InstanceConfigTrait
 Cake\Auth\ControllerAuthorize Cake\Auth\ControllerAuthorize
Method Detail
__constructsource public
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )Constructor
Parameters
- Cake\Controller\ComponentRegistry- $registry
- The controller for this request.
- 
     array $configoptional []
- An array of config. This class does not use any config.
Overrides
Cake\Auth\BaseAuthorize::__construct()
  authorizesource public
authorize( array $user , Cake\Network\Request $request )Checks user authorization using a controller callback.
Parameters
- 
     array $user
- Active user data
- Cake\Network\Request- $request
- Request instance.
Returns
booleanbool
controllersource public
controller( Cake\Controller\Controller $controller null )Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
Parameters
- Cake\Controller\Controller- $controlleroptional null
- null to get, a controller to set.
Returns
Cake\Controller\Controller\Cake\Controller\Controller
Throws
Cake\Core\Exception\ExceptionIf controller does not have method
isAuthorized().Methods used from Cake\Core\InstanceConfigTrait
_configDeletesource protected
_configDelete( string $key )Delete a single config key
Parameters
- 
     string $key
- Key to delete.
Throws
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configReadsource protected
_configRead( string|null $key )Read a config variable
Parameters
- 
     string|null $key
- Key to read.
Returns
mixedmixed
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )Write a config variable
Parameters
- 
     string|array $key
- Key to write to.
- 
     mixed $value
- Value to write.
- 
     boolean|string $mergeoptional false
- True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
Cake\Core\Exception\Exceptionif attempting to clobber existing config
configsource public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Parameters
- 
     string|array|null $keyoptional null
- The key to get/set, or a complete array of configs.
- 
     mixed|null $valueoptional null
- The value to set.
- 
     boolean $mergeoptional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallowsource public
configShallow( string|array $key , mixed|null $value null )Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Parameters
- 
     string|array $key
- The key to set, or a complete array of configs.
- 
     mixed|null $valueoptional null
- The value to set.
Returns
mixed$this The object itself.
Properties summary
Properties inherited from Cake\Auth\BaseAuthorize
$_registrysource
protected Cake\Controller\ComponentRegistry
ComponentRegistry instance for getting more components.
Properties used from Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected boolean
Whether the config property has already been configured with defaults
false© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
 http://api.cakephp.org/3.1/class-Cake.Auth.ControllerAuthorize.html