PHP Class MongolidLaravel\MongolidUserProvider

Inheritance: implements Illuminate\Contracts\Auth\UserProvider
Show file Open project: leroy-merlin-br/mongolid-laravel Class Usage Examples

Protected Properties

Property Type Description
$hasher Illuminate\Contracts\Hashing\Hasher The hasher implementation.
$model MongolidLaravel\MongoLidModel The MongoLid user model.

Public Methods

Method Description
__construct ( Illuminate\Contracts\Hashing\Hasher $hasher, MongolidLaravel\MongoLidModel $model ) Create a new database user provider.
retrieveByCredentials ( array $credentials ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by the given credentials.
retrieveByID ( mixed $identifier ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by their unique identifier.
retrieveByToken ( mixed $identifier, string $token ) : Illuminate\Contracts\Auth\Authenticatable | null Retrieve a user by by their unique identifier and "remember me" token.
updateRememberToken ( Illuminate\Contracts\Auth\Authenticatable $user, string $token ) Update the "remember me" token for the given user in storage.
validateCredentials ( Illuminate\Contracts\Auth\Authenticatable $user, array $credentials ) : boolean Validate a user against the given credentials.

Protected Methods

Method Description
createModel ( ) : MongolidLaravel\MongoLidModel Create a new instance of the model.

Method Details

__construct() public method

Create a new database user provider.
public __construct ( Illuminate\Contracts\Hashing\Hasher $hasher, MongolidLaravel\MongoLidModel $model )
$hasher Illuminate\Contracts\Hashing\Hasher
$model MongolidLaravel\MongoLidModel

createModel() protected method

Create a new instance of the model.
protected createModel ( ) : MongolidLaravel\MongoLidModel
return MongolidLaravel\MongoLidModel

retrieveByCredentials() public method

Retrieve a user by the given credentials.
public retrieveByCredentials ( array $credentials ) : Illuminate\Contracts\Auth\Authenticatable | null
$credentials array
return Illuminate\Contracts\Auth\Authenticatable | null

retrieveByID() public method

Retrieve a user by their unique identifier.
public retrieveByID ( mixed $identifier ) : Illuminate\Contracts\Auth\Authenticatable | null
$identifier mixed
return Illuminate\Contracts\Auth\Authenticatable | null

retrieveByToken() public method

Retrieve a user by by their unique identifier and "remember me" token.
public retrieveByToken ( mixed $identifier, string $token ) : Illuminate\Contracts\Auth\Authenticatable | null
$identifier mixed
$token string
return Illuminate\Contracts\Auth\Authenticatable | null

updateRememberToken() public method

Update the "remember me" token for the given user in storage.
public updateRememberToken ( Illuminate\Contracts\Auth\Authenticatable $user, string $token )
$user Illuminate\Contracts\Auth\Authenticatable
$token string

validateCredentials() public method

Validate a user against the given credentials.
public validateCredentials ( Illuminate\Contracts\Auth\Authenticatable $user, array $credentials ) : boolean
$user Illuminate\Contracts\Auth\Authenticatable
$credentials array
return boolean

Property Details

$hasher protected property

The hasher implementation.
protected Hasher,Illuminate\Contracts\Hashing $hasher
return Illuminate\Contracts\Hashing\Hasher

$model protected property

The MongoLid user model.
protected MongoLidModel,MongolidLaravel $model
return MongolidLaravel\MongoLidModel