api/laravel/Auth/Notifications/ResetPassword.yaml

121 lines
3.2 KiB
YAML
Raw Permalink Normal View History

2024-09-26 09:03:21 +00:00
name: ResetPassword
class_comment: null
dependencies:
- name: MailMessage
type: class
source: Illuminate\Notifications\Messages\MailMessage
- name: Notification
type: class
source: Illuminate\Notifications\Notification
- name: Lang
type: class
source: Illuminate\Support\Facades\Lang
properties:
- name: token
visibility: public
comment: '# * The password reset token.
# *
# * @var string'
- name: createUrlCallback
visibility: public
comment: '# * The callback that should be used to create the reset password URL.
# *
# * @var (\Closure(mixed, string): string)|null'
- name: toMailCallback
visibility: public
comment: '# * The callback that should be used to build the mail message.
# *
# * @var (\Closure(mixed, string): \Illuminate\Notifications\Messages\MailMessage|\Illuminate\Contracts\Mail\Mailable)|null'
methods:
- name: __construct
visibility: public
parameters:
- name: token
comment: "# * The password reset token.\n# *\n# * @var string\n# */\n# public $token;\n\
# \n# /**\n# * The callback that should be used to create the reset password URL.\n\
# *\n# * @var (\\Closure(mixed, string): string)|null\n# */\n# public static $createUrlCallback;\n\
# \n# /**\n# * The callback that should be used to build the mail message.\n#\
\ *\n# * @var (\\Closure(mixed, string): \\Illuminate\\Notifications\\Messages\\\
MailMessage|\\Illuminate\\Contracts\\Mail\\Mailable)|null\n# */\n# public static\
\ $toMailCallback;\n# \n# /**\n# * Create a notification instance.\n# *\n# * @param\
\ string $token\n# * @return void"
- name: via
visibility: public
parameters:
- name: notifiable
comment: '# * Get the notification''s channels.
# *
# * @param mixed $notifiable
# * @return array|string'
- name: toMail
visibility: public
parameters:
- name: notifiable
comment: '# * Build the mail representation of the notification.
# *
# * @param mixed $notifiable
# * @return \Illuminate\Notifications\Messages\MailMessage'
- name: buildMailMessage
visibility: protected
parameters:
- name: url
comment: '# * Get the reset password notification mail message for the given URL.
# *
# * @param string $url
# * @return \Illuminate\Notifications\Messages\MailMessage'
- name: resetUrl
visibility: protected
parameters:
- name: notifiable
comment: '# * Get the reset URL for the given notifiable.
# *
# * @param mixed $notifiable
# * @return string'
- name: createUrlUsing
visibility: public
parameters:
- name: callback
comment: '# * Set a callback that should be used when creating the reset password
button URL.
# *
# * @param \Closure(mixed, string): string $callback
# * @return void'
- name: toMailUsing
visibility: public
parameters:
- name: callback
comment: '# * Set a callback that should be used when building the notification
mail message.
# *
# * @param \Closure(mixed, string): (\Illuminate\Notifications\Messages\MailMessage|\Illuminate\Contracts\Mail\Mailable) $callback
# * @return void'
traits:
- Illuminate\Notifications\Messages\MailMessage
- Illuminate\Notifications\Notification
- Illuminate\Support\Facades\Lang
interfaces: []