253 lines
5.4 KiB
YAML
253 lines
5.4 KiB
YAML
|
name: SimpleMessage
|
||
|
|
class_comment: null
|
||
|
|
dependencies:
|
||
|
|
- name: Htmlable
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Contracts\Support\Htmlable
|
||
|
|
- name: Action
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Notifications\Action
|
||
|
|
properties:
|
||
|
|
- name: level
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The "level" of the notification (info, success, error).
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: subject
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The subject of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: greeting
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The notification''s greeting.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: salutation
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The notification''s salutation.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: introLines
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The "intro" lines of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
- name: outroLines
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The "outro" lines of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
- name: actionText
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The text / label for the action.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: actionUrl
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The action URL.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
- name: mailer
|
||
|
|
visibility: public
|
||
|
|
comment: '# * The name of the mailer that should send the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var string'
|
||
|
|
methods:
|
||
|
|
- name: success
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: "# * The \"level\" of the notification (info, success, error).\n# *\n#\
|
||
|
|
\ * @var string\n# */\n# public $level = 'info';\n# \n# /**\n# * The subject of\
|
||
|
|
\ the notification.\n# *\n# * @var string\n# */\n# public $subject;\n# \n# /**\n\
|
||
|
|
# * The notification's greeting.\n# *\n# * @var string\n# */\n# public $greeting;\n\
|
||
|
|
# \n# /**\n# * The notification's salutation.\n# *\n# * @var string\n# */\n# public\
|
||
|
|
\ $salutation;\n# \n# /**\n# * The \"intro\" lines of the notification.\n# *\n\
|
||
|
|
# * @var array\n# */\n# public $introLines = [];\n# \n# /**\n# * The \"outro\"\
|
||
|
|
\ lines of the notification.\n# *\n# * @var array\n# */\n# public $outroLines\
|
||
|
|
\ = [];\n# \n# /**\n# * The text / label for the action.\n# *\n# * @var string\n\
|
||
|
|
# */\n# public $actionText;\n# \n# /**\n# * The action URL.\n# *\n# * @var string\n\
|
||
|
|
# */\n# public $actionUrl;\n# \n# /**\n# * The name of the mailer that should\
|
||
|
|
\ send the notification.\n# *\n# * @var string\n# */\n# public $mailer;\n# \n\
|
||
|
|
# /**\n# * Indicate that the notification gives information about a successful\
|
||
|
|
\ operation.\n# *\n# * @return $this"
|
||
|
|
- name: error
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Indicate that the notification gives information about an error.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: level
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: level
|
||
|
|
comment: '# * Set the "level" of the notification (success, error, etc.).
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $level
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: subject
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: subject
|
||
|
|
comment: '# * Set the subject of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $subject
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: greeting
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: greeting
|
||
|
|
comment: '# * Set the greeting of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $greeting
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: salutation
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: salutation
|
||
|
|
comment: '# * Set the salutation of the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $salutation
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: line
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: line
|
||
|
|
comment: '# * Add a line of text to the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $line
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: lineIf
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: boolean
|
||
|
|
- name: line
|
||
|
|
comment: '# * Add a line of text to the notification if the given condition is true.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param bool $boolean
|
||
|
|
|
||
|
|
# * @param mixed $line
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: lines
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: lines
|
||
|
|
comment: '# * Add lines of text to the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param iterable $lines
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: linesIf
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: boolean
|
||
|
|
- name: lines
|
||
|
|
comment: '# * Add lines of text to the notification if the given condition is true.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param bool $boolean
|
||
|
|
|
||
|
|
# * @param iterable $lines
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: with
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: line
|
||
|
|
comment: '# * Add a line of text to the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param mixed $line
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: formatLine
|
||
|
|
visibility: protected
|
||
|
|
parameters:
|
||
|
|
- name: line
|
||
|
|
comment: '# * Format the given line of text.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \Illuminate\Contracts\Support\Htmlable|string|array $line
|
||
|
|
|
||
|
|
# * @return \Illuminate\Contracts\Support\Htmlable|string'
|
||
|
|
- name: action
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: text
|
||
|
|
- name: url
|
||
|
|
comment: '# * Configure the "call to action" button.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $text
|
||
|
|
|
||
|
|
# * @param string $url
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: mailer
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: mailer
|
||
|
|
comment: '# * Set the name of the mailer that should send the notification.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $mailer
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
- name: toArray
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get an array representation of the message.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return array'
|
||
|
|
traits:
|
||
|
|
- Illuminate\Contracts\Support\Htmlable
|
||
|
|
- Illuminate\Notifications\Action
|
||
|
|
interfaces: []
|