W3cubDocs

/Laravel 8

UserProvider

interface UserProvider (View source)

Methods

Authenticatable|null retrieveById(mixed $identifier)

Retrieve a user by their unique identifier.
Authenticatable|null retrieveByToken(mixed $identifier, string $token)

Retrieve a user by their unique identifier and "remember me" token.
void updateRememberToken(Authenticatable $user, string $token)

Update the "remember me" token for the given user in storage.
Authenticatable|null retrieveByCredentials(array $credentials)

Retrieve a user by the given credentials.
bool validateCredentials(Authenticatable $user, array $credentials)

Validate a user against the given credentials.

Details

Authenticatable|null retrieveById(mixed $identifier)

Retrieve a user by their unique identifier.

Parameters

mixed $identifier

Return Value

Authenticatable|null

Authenticatable|null retrieveByToken(mixed $identifier, string $token)

Retrieve a user by their unique identifier and "remember me" token.

Parameters

mixed $identifier
string $token

Return Value

Authenticatable|null

void updateRememberToken(Authenticatable $user, string $token)

Update the "remember me" token for the given user in storage.

Parameters

Authenticatable $user
string $token

Return Value

void

Authenticatable|null retrieveByCredentials(array $credentials)

Retrieve a user by the given credentials.

Parameters

array $credentials

Return Value

Authenticatable|null

bool validateCredentials(Authenticatable $user, array $credentials)

Validate a user against the given credentials.

Parameters

Authenticatable $user
array $credentials

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Contracts/Auth/UserProvider.html