W3cubDocs

/Laravel 8

PasswordBroker

class PasswordBroker implements PasswordBroker (View source)

Properties

protected TokenRepositoryInterface $tokens The password token repository.
protected UserProvider $users The user provider implementation.

Methods

void __construct(TokenRepositoryInterface $tokens, UserProvider $users)

Create a new password broker instance.
string sendResetLink(array $credentials, Closure $callback = null)

Send a password reset link to a user.
mixed reset(array $credentials, Closure $callback)

Reset the password for the given token.
CanResetPassword|string validateReset(array $credentials)

Validate a password reset for the given credentials.
CanResetPassword|null getUser(array $credentials)

Get the user for the given credentials.
string createToken(CanResetPassword $user)

Create a new password reset token for the given user.
void deleteToken(CanResetPassword $user)

Delete password reset tokens of the given user.
bool tokenExists(CanResetPassword $user, string $token)

Validate the given password reset token.
TokenRepositoryInterface getRepository()

Get the password reset token repository implementation.

Details

void __construct(TokenRepositoryInterface $tokens, UserProvider $users)

Create a new password broker instance.

Parameters

TokenRepositoryInterface $tokens
UserProvider $users

Return Value

void

Send a password reset link to a user.

Parameters

array $credentials
Closure $callback

Return Value

string

mixed reset(array $credentials, Closure $callback)

Reset the password for the given token.

Parameters

array $credentials
Closure $callback

Return Value

mixed

protected CanResetPassword|string validateReset(array $credentials)

Validate a password reset for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|string

CanResetPassword|null getUser(array $credentials)

Get the user for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|null

Exceptions

UnexpectedValueException

string createToken(CanResetPassword $user)

Create a new password reset token for the given user.

Parameters

CanResetPassword $user

Return Value

string

void deleteToken(CanResetPassword $user)

Delete password reset tokens of the given user.

Parameters

CanResetPassword $user

Return Value

void

bool tokenExists(CanResetPassword $user, string $token)

Validate the given password reset token.

Parameters

CanResetPassword $user
string $token

Return Value

bool

TokenRepositoryInterface getRepository()

Get the password reset token repository implementation.

Return Value

TokenRepositoryInterface

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