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 the user is authorized.
public function isAuthorized($user)
{
if ($this->request->getParam('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\Controller\ControllerController for the request.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default config for authorize objects.
Cake\Controller\ComponentRegistryComponentRegistry instance for getting more components.
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Checks user authorization using a controller callback.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
Returns the config.
Returns the config for this specific key.
Sets the config.
__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])
Constructor
Cake\Controller\ComponentRegistry $registry array<string, mixed> $config optional _configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string $key Key to write to.
mixed $value Value to write.
string|bool $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
voidCake\Core\Exception\CakeExceptionauthorize(ArrayAccess|array $user, Cake\Http\ServerRequest $request): bool
Checks user authorization using a controller callback.
ArrayAccess|array $user Active user data
Cake\Http\ServerRequest $request Request instance.
boolCake\Core\Exception\CakeExceptionconfigShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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->configShallow('key', $value); Setting a nested value:
$this->configShallow('some.nested.key', $value); Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thiscontroller(Cake\Controller\Controller|null $controller = null): Cake\Controller\Controller
Get/set the controller this authorize object will be working with. Also checks that isAuthorized is implemented.
Cake\Controller\Controller|null $controller optional null to get, a controller to set.
Cake\Controller\ControllergetConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key'); Reading a nested value:
$this->getConfig('some.nested.key'); Reading with default value:
$this->getConfig('some-key', 'default-value'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedgetConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedInvalidArgumentExceptionsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
Setting a specific value:
$this->setConfig('key', $value); Setting a nested value:
$this->setConfig('some.nested.key', $value); Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$thisCake\Core\Exception\CakeExceptionController for the request.
Cake\Controller\ControllerRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault config for authorize objects.
array<string, mixed>ComponentRegistry instance for getting more components.
Cake\Controller\ComponentRegistry
© 2005–present 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.
https://api.cakephp.org/4.4/class-Cake.Auth.ControllerAuthorize.html