api/laravel/Auth/Notifications/VerifyEmail.yaml
2024-09-26 02:03:21 -07:00

112 lines
2.8 KiB
YAML

name: VerifyEmail
class_comment: null
dependencies:
- name: MailMessage
type: class
source: Illuminate\Notifications\Messages\MailMessage
- name: Notification
type: class
source: Illuminate\Notifications\Notification
- name: Carbon
type: class
source: Illuminate\Support\Carbon
- name: Config
type: class
source: Illuminate\Support\Facades\Config
- name: Lang
type: class
source: Illuminate\Support\Facades\Lang
- name: URL
type: class
source: Illuminate\Support\Facades\URL
properties:
- name: createUrlCallback
visibility: public
comment: '# * The callback that should be used to create the verify email URL.
# *
# * @var \Closure|null'
- name: toMailCallback
visibility: public
comment: '# * The callback that should be used to build the mail message.
# *
# * @var \Closure|null'
methods:
- name: via
visibility: public
parameters:
- name: notifiable
comment: "# * The callback that should be used to create the verify email URL.\n\
# *\n# * @var \\Closure|null\n# */\n# public static $createUrlCallback;\n# \n\
# /**\n# * The callback that should be used to build the mail message.\n# *\n\
# * @var \\Closure|null\n# */\n# public static $toMailCallback;\n# \n# /**\n#\
\ * Get the notification's channels.\n# *\n# * @param mixed $notifiable\n# *\
\ @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 verify email notification mail message for the given URL.
# *
# * @param string $url
# * @return \Illuminate\Notifications\Messages\MailMessage'
- name: verificationUrl
visibility: protected
parameters:
- name: notifiable
comment: '# * Get the verification 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 email verification
URL.
# *
# * @param \Closure $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 $callback
# * @return void'
traits:
- Illuminate\Notifications\Messages\MailMessage
- Illuminate\Notifications\Notification
- Illuminate\Support\Carbon
- Illuminate\Support\Facades\Config
- Illuminate\Support\Facades\Lang
- Illuminate\Support\Facades\URL
interfaces: []