class PasswordBroker implements PasswordBroker (View source)

Properties

protected TokenRepositoryInterface $tokens The password token repository.
protected UserProvider $users The user provider implementation.
protected Closure $passwordValidator The custom password validator callback.

Methods

void
__construct(TokenRepositoryInterface $tokens, UserProvider $users)

Create a new password broker instance.

string
sendResetLink(array $credentials)

Send a password reset link to a user.

mixed
reset(array $credentials, Closure $callback)

Reset the password for the given token.

validateReset(array $credentials)

Validate a password reset for the given credentials.

void
validator(Closure $callback)

Set a custom password validator.

bool
validateNewPassword(array $credentials)

Determine if the passwords match for the request.

bool
validatePasswordWithDefaults(array $credentials)

Determine if the passwords are valid for the request.

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.

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

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

void validator(Closure $callback)

Set a custom password validator.

Parameters

Closure $callback

Return Value

void

bool validateNewPassword(array $credentials)

Determine if the passwords match for the request.

Parameters

array $credentials

Return Value

bool

protected bool validatePasswordWithDefaults(array $credentials)

Determine if the passwords are valid for the request.

Parameters

array $credentials

Return Value

bool

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.