Documentation

PasswordBroker

Table of Contents

INVALID_PASSWORD  = 'passwords.password'
Constant representing an invalid password.
INVALID_TOKEN  = 'passwords.token'
Constant representing an invalid token.
INVALID_USER  = 'passwords.user'
Constant representing the user not found response.
PASSWORD_RESET  = 'passwords.reset'
Constant representing a successfully reset password.
RESET_LINK_SENT  = 'passwords.sent'
Constant representing a successfully sent reminder.
reset()  : mixed
Reset the password for the given token.
sendResetLink()  : string
Send a password reset link to a user.
validateNewPassword()  : bool
Determine if the passwords match for the request.
validator()  : void
Set a custom password validator.

Constants

INVALID_PASSWORD

Constant representing an invalid password.

public string INVALID_PASSWORD = 'passwords.password'

INVALID_TOKEN

Constant representing an invalid token.

public string INVALID_TOKEN = 'passwords.token'

INVALID_USER

Constant representing the user not found response.

public string INVALID_USER = 'passwords.user'

PASSWORD_RESET

Constant representing a successfully reset password.

public string PASSWORD_RESET = 'passwords.reset'

Constant representing a successfully sent reminder.

public string RESET_LINK_SENT = 'passwords.sent'

Methods

reset()

Reset the password for the given token.

public reset(array<string|int, mixed> $credentials, Closure $callback) : mixed
Parameters
$credentials : array<string|int, mixed>
$callback : Closure
Return values
mixed

Send a password reset link to a user.

public sendResetLink(array<string|int, mixed> $credentials) : string
Parameters
$credentials : array<string|int, mixed>
Return values
string

validateNewPassword()

Determine if the passwords match for the request.

public validateNewPassword(array<string|int, mixed> $credentials) : bool
Parameters
$credentials : array<string|int, mixed>
Return values
bool

validator()

Set a custom password validator.

public validator(Closure $callback) : void
Parameters
$callback : Closure
Return values
void

Search results