1. interface
  2. Illuminate
  3. \
  4. Auth
  5. \
  6. UserProviderInterface

UserProviderInterface

interface UserProviderInterface (View source)

Methods

UserInterface|null
retrieveById(mixed $identifier)

Retrieve a user by their unique identifier.

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

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

void
updateRememberToken(UserInterface $user, string $token)

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

UserInterface|null
retrieveByCredentials(array $credentials)

Retrieve a user by the given credentials.

bool
validateCredentials(UserInterface $user, array $credentials)

Validate a user against the given credentials.

Details

at line 11
UserInterface|null retrieveById(mixed $identifier)

Retrieve a user by their unique identifier.

Parameters

mixed $identifier

Return Value

UserInterface|null

at line 20
UserInterface|null retrieveByToken(mixed $identifier, string $token)

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

Parameters

mixed $identifier
string $token

Return Value

UserInterface|null

at line 29
void updateRememberToken(UserInterface $user, string $token)

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

Parameters

UserInterface $user
string $token

Return Value

void

at line 37
UserInterface|null retrieveByCredentials(array $credentials)

Retrieve a user by the given credentials.

Parameters

array $credentials

Return Value

UserInterface|null

at line 46
bool validateCredentials(UserInterface $user, array $credentials)

Validate a user against the given credentials.

Parameters

UserInterface $user
array $credentials

Return Value

bool