PasswordBroker

class PasswordBroker implements PasswordBroker (View source)

Properties

protected TokenRepositoryInterface $tokens The password token repository.
protected UserProvider $users The user provider implementation.
protected Mailer $mailer The mailer instance.
protected string $emailView The view of the password reset link e-mail.
protected Closure $passwordValidator The custom password validator callback.

Methods

void __construct(TokenRepositoryInterface $tokens, UserProvider $users, Mailer $mailer, string $emailView)

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

Send a password reset link to a user.
int emailResetLink(CanResetPassword $user, string $token, Closure $callback = null)

Send the password reset link via e-mail.
mixed reset(array $credentials, Closure $callback)

Reset the password for the given token.
CanResetPassword 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.
CanResetPassword 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(string $token)

Delete the given password reset token.
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, Mailer $mailer, string $emailView)

Create a new password broker instance.

Parameters

TokenRepositoryInterface $tokens
UserProvider $users
Mailer $mailer
string $emailView

Return Value

void

Send a password reset link to a user.

Parameters

array $credentials
Closure $callback

Return Value

string

Send the password reset link via e-mail.

Parameters

CanResetPassword $user
string $token
Closure $callback

Return Value

int

mixed reset(array $credentials, Closure $callback)

Reset the password for the given token.

Parameters

array $credentials
Closure $callback

Return Value

mixed

protected CanResetPassword validateReset(array $credentials)

Validate a password reset for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword

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 getUser(array $credentials)

Get the user for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword

Exceptions

UnexpectedValueException

string createToken(CanResetPassword $user)

Create a new password reset token for the given user.

Parameters

CanResetPassword $user

Return Value

string

void deleteToken(string $token)

Delete the given password reset token.

Parameters

string $token

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/5.2/Illuminate/Auth/Passwords/PasswordBroker.html