PasswordBroker

class PasswordBroker (View source)

Constants

REMINDER_SENT

Constant representing a successfully sent reminder.
PASSWORD_RESET

Constant representing a successfully reset password.
INVALID_USER

Constant representing the user not found response.
INVALID_PASSWORD

Constant representing an invalid password.
INVALID_TOKEN

Constant representing an invalid token.

Properties

protected ReminderRepositoryInterface $reminders The password reminder repository.
protected UserProviderInterface $users The user provider implementation.
protected Mailer $mailer The mailer instance.
protected string $reminderView The view of the password reminder e-mail.
protected Closure $passwordValidator The custom password validator callback.

Methods

void __construct(ReminderRepositoryInterface $reminders, UserProviderInterface $users, Mailer $mailer, string $reminderView)

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

Send a password reminder to a user.
int sendReminder(RemindableInterface $user, string $token, Closure $callback = null)

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

Reset the password for the given token.
RemindableInterface validateReset(array $credentials)

Validate a password reset for the given credentials.
void validator(Closure $callback)

Set a custom password validator.
bool validNewPasswords(array $credentials)

Determine if the passwords match for the request.
bool validatePasswordWithDefaults(array $credentials)

Determine if the passwords are valid for the request.
RemindableInterface getUser(array $credentials)

Get the user for the given credentials.
ReminderRepositoryInterface getRepository()

Get the password reminder repository implementation.

Details

void __construct(ReminderRepositoryInterface $reminders, UserProviderInterface $users, Mailer $mailer, string $reminderView)

Create a new password broker instance.

Parameters

ReminderRepositoryInterface $reminders
UserProviderInterface $users
Mailer $mailer
string $reminderView

Return Value

void

string remind(array $credentials, Closure $callback = null)

Send a password reminder to a user.

Parameters

array $credentials
Closure $callback

Return Value

string

int sendReminder(RemindableInterface $user, string $token, Closure $callback = null)

Send the password reminder e-mail.

Parameters

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

Validate a password reset for the given credentials.

Parameters

array $credentials

Return Value

RemindableInterface

void validator(Closure $callback)

Set a custom password validator.

Parameters

Closure $callback

Return Value

void

protected bool validNewPasswords(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

RemindableInterface getUser(array $credentials)

Get the user for the given credentials.

Parameters

array $credentials

Return Value

RemindableInterface

Exceptions

UnexpectedValueException

protected ReminderRepositoryInterface getRepository()

Get the password reminder repository implementation.

Return Value

ReminderRepositoryInterface

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