1. class
  2. Illuminate
  3. Auth
  4. Reminders
  5. PasswordBroker

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.

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.

void
validator( Closure $callback)

Set a custom password validator.

RemindableInterface
getUser( array $credentials)

Get the user for the given credentials.

Details

at line line 88
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

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

Send a password reminder to a user.

Parameters

array $credentials
Closure $callback

Return Value

string

at line line 136
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

at line line 158
mixed reset( array $credentials, Closure $callback)

Reset the password for the given token.

Parameters

array $credentials
Closure $callback

Return Value

mixed

at line line 214
void validator( Closure $callback)

Set a custom password validator.

Parameters

Closure $callback

Return Value

void

at line line 258
RemindableInterface getUser( array $credentials)

Get the user for the given credentials.

Parameters

array $credentials

Return Value

RemindableInterface

Exceptions

UnexpectedValueException