1. class
  2. Illuminate
  3. \
  4. Auth
  5. \
  6. Passwords
  7. \
  8. PasswordBroker

PasswordBroker

class PasswordBroker implements PasswordBroker (View source)

Properties

protected TokenRepositoryInterface $tokens

The password token repository.
protected UserProvider $users

The user provider implementation.
protected Dispatcher $events

The event dispatcher instance.

Methods

__construct(TokenRepositoryInterface $tokens, UserProvider $users, Dispatcher|null $dispatcher = null)

Create a new password broker instance.

string
sendResetLink(array $credentials, Closure|null $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

at line 44
__construct(TokenRepositoryInterface $tokens, UserProvider $users, Dispatcher|null $dispatcher = null)

Create a new password broker instance.

Parameters

TokenRepositoryInterface $tokens
UserProvider $users
Dispatcher|null $dispatcher

Send a password reset link to a user.

Parameters

array $credentials
Closure|null $callback

Return Value

string

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

Reset the password for the given token.

Parameters

array $credentials
Closure $callback

Return Value

mixed

at line 125
protected CanResetPassword|string validateReset(array $credentials)

Validate a password reset for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|string

at line 146
CanResetPassword|null getUser(array $credentials)

Get the user for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|null

Exceptions

UnexpectedValueException

at line 165
string createToken(CanResetPassword $user)

Create a new password reset token for the given user.

Parameters

CanResetPassword $user

Return Value

string

at line 176
void deleteToken(CanResetPassword $user)

Delete password reset tokens of the given user.

Parameters

CanResetPassword $user

Return Value

void

at line 188
bool tokenExists(CanResetPassword $user, string $token)

Validate the given password reset token.

Parameters

CanResetPassword $user
string $token

Return Value

bool

at line 198
TokenRepositoryInterface getRepository()

Get the password reset token repository implementation.

Return Value

TokenRepositoryInterface