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

PasswordBroker

class PasswordBroker implements PasswordBroker

Constants

SENDING_BROKER_CONTEXT_KEY

The coroutine context key holding the broker name currently sending a reset link.

Properties

protected Timebox $timebox

The timebox instance.

Methods

__construct(TokenRepositoryInterface $tokens, UserProvider $users, string $name, Dispatcher|null $events = null, Timebox|null $timebox = null, int $timeboxDuration = 200000)

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.

Timebox
getTimebox()

Get the timebox instance used by the broker.

void
setDispatcher(Dispatcher $events)

Set the event dispatcher instance.

Details

at line 36
__construct(TokenRepositoryInterface $tokens, UserProvider $users, string $name, Dispatcher|null $events = null, Timebox|null $timebox = null, int $timeboxDuration = 200000)

Create a new password broker instance.

Parameters

TokenRepositoryInterface $tokens
UserProvider $users
string $name
Dispatcher|null $events
Timebox|null $timebox
int $timeboxDuration

the number of microseconds that the timebox should wait for

Send a password reset link to a user.

Parameters

array $credentials
Closure|null $callback

Return Value

string

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

Reset the password for the given token.

Parameters

array $credentials
Closure $callback

Return Value

mixed

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

Validate a password reset for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|string

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

Get the user for the given credentials.

Parameters

array $credentials

Return Value

CanResetPassword|null

Exceptions

UnexpectedValueException

at line 163
string createToken(CanResetPassword $user)

Create a new password reset token for the given user.

Parameters

CanResetPassword $user

Return Value

string

at line 171
void deleteToken(CanResetPassword $user)

Delete password reset tokens of the given user.

Parameters

CanResetPassword $user

Return Value

void

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

Validate the given password reset token.

Parameters

CanResetPassword $user
string $token

Return Value

bool

at line 187
TokenRepositoryInterface getRepository()

Get the password reset token repository implementation.

Return Value

TokenRepositoryInterface

at line 195
Timebox getTimebox()

Get the timebox instance used by the broker.

Return Value

Timebox

at line 206
void setDispatcher(Dispatcher $events)

Set the event dispatcher instance.

Boot or tests only. The dispatcher is stored on the worker-lifetime broker and affects every subsequent password reset-link event.

Parameters

Dispatcher $events

Return Value

void