class ResetPassword extends Notification

Traits

Properties

string|null $id

The unique identifier for the notification.

from  Notification
string|null $locale

The locale to be used when sending the notification.

from  Notification
static null|Closure(mixed, string): string $createUrlCallback

The callback that should be used to create the reset password URL.

static null|MailMessage $toMailCallback

The callback that should be used to build the mail message.

int $expireMinutes

The number of minutes until the reset token expires.

Methods

mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

mixed
getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

getQueryForModelRestoration(Model $model, array|int|string $ids)

Get the query for model restoration.

array
__serialize()

Prepare the instance values for serialization.

void
__unserialize(array $values)

Restore the model after serialization.

mixed
getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

array
broadcastOn()

Get the channels the event should broadcast on.

locale(string $locale)

Set the locale to send this notification in.

__construct(string $token)

Create a notification instance.

array
via(mixed $notifiable)

Get the notification's channels.

toMail(mixed $notifiable)

Build the mail representation of the notification.

buildMailMessage(string $url)

Get the reset password notification mail message for the given URL.

int
resolveExpireMinutes()

Resolve the expiry minutes from the broker sending this notification.

string
resetUrl(mixed $notifiable)

Get the reset URL for the given notifiable.

static void
createUrlUsing(Closure $callback)

Set a callback that should be used when creating the reset password button URL.

static void
toMailUsing(Closure $callback)

Set a callback that should be used when building the notification mail message.

static void
flushState()

Flush all static state.

Details

protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

Parameters

mixed $value
bool $withRelations

Return Value

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

protected Builder getQueryForModelRestoration(Model $model, array|int|string $ids)

Get the query for model restoration.

Parameters

Model $model
array|int|string $ids

Return Value

Builder

in SerializesModels at line 18
array __serialize()

Prepare the instance values for serialization.

Return Value

array

in SerializesModels at line 68
void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

in SerializesModels at line 101
protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

in Notification at line 26
array broadcastOn()

Get the channels the event should broadcast on.

Return Value

array

in Notification at line 34
Notification locale(string $locale)

Set the locale to send this notification in.

Parameters

string $locale

Return Value

Notification

at line 43
__construct(string $token)

Create a notification instance.

Parameters

string $token

at line 53
array via(mixed $notifiable)

Get the notification's channels.

Parameters

mixed $notifiable

Return Value

array

at line 61
MailMessage toMail(mixed $notifiable)

Build the mail representation of the notification.

Parameters

mixed $notifiable

Return Value

MailMessage

at line 73
protected MailMessage buildMailMessage(string $url)

Get the reset password notification mail message for the given URL.

Parameters

string $url

Return Value

MailMessage

at line 91
protected int resolveExpireMinutes()

Resolve the expiry minutes from the broker sending this notification.

Reads the sending broker stamped by PasswordBroker::sendResetLink(); outside a send flow (tests, previews), resolves the current default broker.

Return Value

int

Exceptions

InvalidArgumentException

at line 103
protected string resetUrl(mixed $notifiable)

Get the reset URL for the given notifiable.

Parameters

mixed $notifiable

Return Value

string

at line 123
static void createUrlUsing(Closure $callback)

Set a callback that should be used when creating the reset password button URL.

Boot-only. The callback persists in a static property for the worker lifetime and runs on every reset-password notification.

Parameters

Closure $callback

Return Value

void

at line 136
static void toMailUsing(Closure $callback)

Set a callback that should be used when building the notification mail message.

Boot-only. The callback persists in a static property for the worker lifetime and runs on every reset-password notification.

Parameters

Closure $callback

Return Value

void

at line 144
static void flushState()

Flush all static state.

Return Value

void