1. class
  2. Illuminate
  3. \
  4. Auth
  5. \
  6. Notifications
  7. \
  8. ResetPassword

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, bool $withRelations = true)

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
TModel>
getQueryForModelRestoration(TModel $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
__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

in SerializesAndRestoresModelIdentifiers at line 22
protected mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

Get the property value prepared for serialization.

Parameters

mixed $value
bool $withRelations

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 55
protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

in SerializesAndRestoresModelIdentifiers at line 72
protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

in SerializesAndRestoresModelIdentifiers at line 106
Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

in SerializesAndRestoresModelIdentifiers at line 122
protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

Get the query for model restoration.

Parameters

TModel $model
array|int $ids

Return Value

TModel>

in SerializesModels at line 18
array __serialize()

Prepare the instance values for serialization.

Return Value

array

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

Restore the model after serialization.

Parameters

array $values

Return Value

void

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

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

in Notification at line 30
array broadcastOn()

Get the channels the event should broadcast on.

Return Value

array

in Notification at line 41
$this locale(string $locale)

Set the locale to send this notification in.

Parameters

string $locale

Return Value

$this

at line 37
__construct(string $token)

Create a notification instance.

Parameters

string $token

at line 48
array|string via(mixed $notifiable)

Get the notification's channels.

Parameters

mixed $notifiable

Return Value

array|string

at line 59
MailMessage toMail(mixed $notifiable)

Build the mail representation of the notification.

Parameters

mixed $notifiable

Return Value

MailMessage

at line 74
protected MailMessage buildMailMessage(string $url)

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

Parameters

string $url

Return Value

MailMessage

at line 90
protected string resetUrl(mixed $notifiable)

Get the reset URL for the given notifiable.

Parameters

mixed $notifiable

Return Value

string

at line 108
static void createUrlUsing($callback)

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

Parameters

$callback

Return Value

void

at line 119
static void toMailUsing($callback)

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

Parameters

$callback

Return Value

void