Base Authentication class with common methods and properties.
$_Collection
protected $_passwordHasher
protected $settings
public array
Hash the plain text password so that it matches the hashed/encrypted password in the datasource.
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
Allows you to hook into AuthComponent::logout(), and implement specialized logout behavior.
__construct( ComponentCollection $collection , array $settings )
Constructor
ComponentCollection
$collection
$settings
_findUser( string|array $username , string $password null )
Find a user record using the standard options.
The $username parameter can be a (string)username or an array containing conditions for Model::find('first'). If the $password param is not provided the password field will be present in returned array.
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 _password( string $password )
Hash the plain text password so that it matches the hashed/encrypted password in the datasource.
$password
authenticate( CakeRequest $request , CakeResponse $response )
Authenticate a user based on the request information.
CakeRequest
$request
CakeResponse
$response
getUser( CakeRequest $request )
Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.
CakeRequest
$request
implementedEvents( )
Implemented events
CakeEventListener::implementedEvents()
logout( array $user )
Allows you to hook into AuthComponent::logout(), and implement specialized logout behavior.
All attached authentication objects will have this method called when a user logs out.
$user
passwordHasher( )
Return password hasher object
AbstractPasswordHasher
CakeException
If password hasher class not found or it does not extend AbstractPasswordHasher
unauthenticated( CakeRequest $request , CakeResponse $response )
Handle unauthenticated access attempt.
CakeRequest
$request
CakeResponse
$response
Either true to indicate the unauthenticated request has been dealt with and no more action is required by AuthComponent or void (default).
protected ComponentCollection
A Component collection, used to get more components.
public array
Settings for this object.
fields
The fields to use to identify a user by.userModel
The model name of the User, defaults to User.userFields
Array of fields to retrieve from User model, null to retrieve all. Defaults to null.scope
Additional conditions to use when looking up and authenticating users, i.e. array('User.is_active' => 1).
recursive
The value of the recursive key passed to find(). Defaults to 0.contain
Extra models to contain and store in session.passwordHasher
Password hasher class. Can be a string specifying class name or an array containing className
key, any other keys will be passed as settings to the class. Defaults to 'Simple'.array( 'fields' => array( 'username' => 'username', 'password' => 'password' ), 'userModel' => 'User', 'userFields' => null, 'scope' => array(), 'recursive' => 0, 'contain' => null, 'passwordHasher' => 'Simple' )
© 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/2.8/class-BaseAuthenticate.html