60 lines
1.8 KiB
PHP
60 lines
1.8 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Illuminate\Contracts\Auth;
|
||
|
|
|
||
|
|
interface UserProvider
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Retrieve a user by their unique identifier.
|
||
|
|
*
|
||
|
|
* @param mixed $identifier
|
||
|
|
* @return \Illuminate\Contracts\Auth\Authenticatable|null
|
||
|
|
*/
|
||
|
|
public function retrieveById($identifier);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve a user by their unique identifier and "remember me" token.
|
||
|
|
*
|
||
|
|
* @param mixed $identifier
|
||
|
|
* @param string $token
|
||
|
|
* @return \Illuminate\Contracts\Auth\Authenticatable|null
|
||
|
|
*/
|
||
|
|
public function retrieveByToken($identifier, #[\SensitiveParameter] $token);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the "remember me" token for the given user in storage.
|
||
|
|
*
|
||
|
|
* @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||
|
|
* @param string $token
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function updateRememberToken(Authenticatable $user, #[\SensitiveParameter] $token);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieve a user by the given credentials.
|
||
|
|
*
|
||
|
|
* @param array $credentials
|
||
|
|
* @return \Illuminate\Contracts\Auth\Authenticatable|null
|
||
|
|
*/
|
||
|
|
public function retrieveByCredentials(#[\SensitiveParameter] array $credentials);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate a user against the given credentials.
|
||
|
|
*
|
||
|
|
* @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||
|
|
* @param array $credentials
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function validateCredentials(Authenticatable $user, #[\SensitiveParameter] array $credentials);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Rehash the user's password if required and supported.
|
||
|
|
*
|
||
|
|
* @param \Illuminate\Contracts\Auth\Authenticatable $user
|
||
|
|
* @param array $credentials
|
||
|
|
* @param bool $force
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function rehashPasswordIfRequired(Authenticatable $user, #[\SensitiveParameter] array $credentials, bool $force = false);
|
||
|
|
}
|