$_config
$_config : array
Runtime config
Base Authentication class with common methods and properties.
$_tableLocator : \Cake\ORM\Locator\LocatorInterface
Table locator instance
$_defaultConfig : array
Default config for this object.
fields The fields to use to identify a user by.userModel The alias for users table, defaults to Users.finder The finder method to use to fetch user record. Defaults to 'all'.
You can set finder name as string or an array where key is finder name and value
is an array passed to Table::find() options.
E.g. ['finderName' => ['some_finder_option' => 'some_value']]passwordHasher Password hasher class. Can be a string specifying class name
or an array containing className key, any other keys will be passed as
config to the class. Defaults to 'Default'.scope and contain have been deprecated since 3.1. Use custom
finder instead to modify the query to fetch user record.$_registry : \Cake\Controller\ComponentRegistry
A Component registry, used to get more components.
$_passwordHasher : \Cake\Auth\AbstractPasswordHasher
Password hasher instance.
setConfig(string|array $key, mixed|null $value = null, boolean $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(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 | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
tableLocator(\Cake\ORM\Locator\LocatorInterface|null $tableLocator = null) : \Cake\ORM\Locator\LocatorInterface
Sets the table locator.
If no parameters are passed, it will return the currently used locator.
| \Cake\ORM\Locator\LocatorInterface|null | $tableLocator | LocatorInterface instance. |
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator) : $this
Sets the table locator.
| \Cake\ORM\Locator\LocatorInterface | $tableLocator | LocatorInterface instance. |
getTableLocator() : \Cake\ORM\Locator\LocatorInterface
Gets the table locator.
__construct(\Cake\Controller\ComponentRegistry $registry, array $config = array())
Constructor
| \Cake\Controller\ComponentRegistry | $registry | The Component registry used on this request. |
| array | $config | Array of config to use. |
passwordHasher() : \Cake\Auth\AbstractPasswordHasher
Return password hasher object
If password hasher class not found or it does not extend AbstractPasswordHasher
Password hasher instance
authenticate(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response) : mixed
Authenticate a user based on the request information.
| \Cake\Http\ServerRequest | $request | Request to get authentication information from. |
| \Cake\Http\Response | $response | A response object that can have headers added. |
Either false on failure, or an array of user data on success.
getUser(\Cake\Http\ServerRequest $request) : mixed
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
| \Cake\Http\ServerRequest | $request | Request object. |
Either false or an array of user information
unauthenticated(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response) : void
Handle unauthenticated access attempt. In implementation valid return values can be:
| \Cake\Http\ServerRequest | $request | A request object. |
| \Cake\Http\Response | $response | A response object. |
implementedEvents() : array
Returns a list of all events that this authenticate class will listen to.
An authenticate class can listen to following events fired by AuthComponent:
Auth.afterIdentify - Fired after a user has been identified using one of
configured authenticate class. The callback function should have signature
like afterIdentify(Event $event, array $user) when $user is the
identified user record.
Auth.logout - Fired when AuthComponent::logout() is called. The callback
function should have signature like logout(Event $event, array $user)
where $user is the user about to be logged out.List of events this class listens to. Defaults to [].
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
_findUser(string $username, string|null $password = null) : boolean|array
Find a user record using the username and password provided.
Input passwords will be hashed even when a user doesn't exist. This helps mitigate timing attacks that are attempting to find valid usernames.
| string | $username | The username/identifier. |
| string|null | $password | The password, if not provided password checking is skipped and result of find is returned. |
Either false on failure, or an array of user data.
_query(string $username) : \Cake\ORM\Query
Get query object for fetching user from database.
| string | $username | The username/identifier. |