Base Authentication class with common methods and properties.
$_defaultConfig protected array$_needsPasswordRehash protected booleanWhether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
$_passwordHasher protected $_registry protected Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
Handle unauthenticated access attempt. In implementation valid return values can be:
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )
Constructor
Cake\Controller\ComponentRegistry $registry $config optional [] _findUser( string $username , string|null $password null )
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.
$username $password optional null The password, if not provided password checking is skipped and result of find is returned.
_query( string $username )
Get query object for fetching user from database.
$username Cake\ORM\Queryauthenticate( Cake\Http\ServerRequest $request , Cake\Network\Response $response )
Authenticate a user based on the request information.
Cake\Http\ServerRequest $request $response getUser( Cake\Http\ServerRequest $request )
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Cake\Http\ServerRequest $request implementedEvents( )
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.
[].Cake\Event\EventListenerInterface::implementedEvents() needsPasswordRehash( )
Returns whether or not the password stored in the repository for the logged in user requires to be rehashed with another algorithm
passwordHasher( )
Return password hasher object
Cake\Auth\AbstractPasswordHasherIf password hasher class not found or it does not extend AbstractPasswordHasher
unauthenticated( Cake\Http\ServerRequest $request , Cake\Network\Response $response )
Handle unauthenticated access attempt. In implementation valid return values can be:
Cake\Http\ServerRequest $request $response _configDelete( string $key )
Deletes a single config key.
$key Cake\Core\Exception\Exception_configRead( string|null $key )
Reads a config key.
$key _configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
$key $value $merge optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exceptionconfig( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
$key optional null $value optional null $merge optional true Cake\Core\Exception\ExceptionconfigShallow( 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']);
$key $value optional null getConfig( string|null $key null )
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'); $key optional null setConfig( string|array $key , mixed|null $value null , boolean $merge true )
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']);
$key $value optional null $merge optional true Cake\Core\Exception\Exceptionprotected 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.[
'fields' => [
'username' => 'username',
'password' => 'password'
],
'userModel' => 'Users',
'scope' => [],
'finder' => 'all',
'contain' => null,
'passwordHasher' => 'Default'
] protected boolean
Whether or not the user authenticated by this class requires their password to be rehashed with another algorithm.
false
protected Cake\Controller\ComponentRegistry
A Component registry, used to get more components.
© 2005–2017 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/3.4/class-Cake.Auth.BaseAuthenticate.html