Docs4dev
Docs
laravel / 10 / api / 10.x / illuminate / auth / notifications / resetpassword.html

ResetPassword

class ResetPassword extends Notification (View source)

Traits

SerializesModels
SerializesAndRestoresModelIdentifiers

Properties

string $id

The unique identifier for the notification.

 from Notification
string|null $locale

The locale to be used when sending the notification.

 from Notification
string $token

The password reset token.
static $createUrlCallback

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

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

Methods

mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

 from SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

 from SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

 from SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

 from SerializesAndRestoresModelIdentifiers
Builder getQueryForModelRestoration(Model $model, array|int $ids)

Get the query for model restoration.

 from SerializesAndRestoresModelIdentifiers
array __serialize()

Prepare the instance values for serialization.

 from SerializesModels
void __unserialize(array $values)

Restore the model after serialization.

 from SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

 from SerializesModels
array broadcastOn()

Get the channels the event should broadcast on.

 from Notification
$this locale(string $locale)

Set the locale to send this notification in.

 from Notification
void __construct(string $token)

Create a notification instance.
array|string via(mixed $notifiable)

Get the notification's channels.
MailMessage toMail(mixed $notifiable)

Build the mail representation of the notification.
MailMessage buildMailMessage(string $url)

Get the reset password notification mail message for the given URL.
string resetUrl(mixed $notifiable)

Get the reset URL for the given notifiable.
static void createUrlUsing($callback)

Set a callback that should be used when creating the reset password button URL.
static void toMailUsing($callback)

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

Details

protected mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

Parameters

mixed $value

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 $ids)

Get the query for model restoration.

Parameters

Model $model
array|int $ids

Return Value

Builder

array __serialize()

Prepare the instance values for serialization.

Return Value

array

void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

array broadcastOn()

Get the channels the event should broadcast on.

Return Value

array

$this locale(string $locale)

Set the locale to send this notification in.

Parameters

string $locale

Return Value

$this

void __construct(string $token)

Create a notification instance.

Parameters

string $token

Return Value

void

array|string via(mixed $notifiable)

Get the notification's channels.

Parameters

mixed $notifiable

Return Value

array|string

MailMessage toMail(mixed $notifiable)

Build the mail representation of the notification.

Parameters

mixed $notifiable

Return Value

MailMessage

protected MailMessage buildMailMessage(string $url)

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

Parameters

string $url

Return Value

MailMessage

protected string resetUrl(mixed $notifiable)

Get the reset URL for the given notifiable.

Parameters

mixed $notifiable

Return Value

string

static void createUrlUsing($callback)

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

Parameters

$callback

Return Value

void

static void toMailUsing($callback)

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

Parameters

$callback

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Auth/Notifications/ResetPassword.html