api/laravel/Mail/Attachment.yaml
2024-09-26 02:03:21 -07:00

178 lines
3.7 KiB
YAML

name: Attachment
class_comment: null
dependencies:
- name: Closure
type: class
source: Closure
- name: Container
type: class
source: Illuminate\Container\Container
- name: FilesystemFactory
type: class
source: Illuminate\Contracts\Filesystem\Factory
- name: Macroable
type: class
source: Illuminate\Support\Traits\Macroable
- name: RuntimeException
type: class
source: RuntimeException
- name: Macroable
type: class
source: Macroable
properties:
- name: as
visibility: public
comment: '# * The attached file''s filename.
# *
# * @var string|null'
- name: mime
visibility: public
comment: '# * The attached file''s mime type.
# *
# * @var string|null'
- name: resolver
visibility: protected
comment: '# * A callback that attaches the attachment to the mail message.
# *
# * @var \Closure'
methods:
- name: __construct
visibility: private
parameters:
- name: resolver
comment: "# * The attached file's filename.\n# *\n# * @var string|null\n# */\n#\
\ public $as;\n# \n# /**\n# * The attached file's mime type.\n# *\n# * @var string|null\n\
# */\n# public $mime;\n# \n# /**\n# * A callback that attaches the attachment\
\ to the mail message.\n# *\n# * @var \\Closure\n# */\n# protected $resolver;\n\
# \n# /**\n# * Create a mail attachment.\n# *\n# * @param \\Closure $resolver\n\
# * @return void"
- name: fromPath
visibility: public
parameters:
- name: path
comment: '# * Create a mail attachment from a path.
# *
# * @param string $path
# * @return static'
- name: fromData
visibility: public
parameters:
- name: data
- name: name
default: 'null'
comment: '# * Create a mail attachment from in-memory data.
# *
# * @param \Closure $data
# * @param string|null $name
# * @return static'
- name: fromStorage
visibility: public
parameters:
- name: path
comment: '# * Create a mail attachment from a file in the default storage disk.
# *
# * @param string $path
# * @return static'
- name: fromStorageDisk
visibility: public
parameters:
- name: disk
- name: path
comment: '# * Create a mail attachment from a file in the specified storage disk.
# *
# * @param string|null $disk
# * @param string $path
# * @return static'
- name: as
visibility: public
parameters:
- name: name
comment: '# * Set the attached file''s filename.
# *
# * @param string|null $name
# * @return $this'
- name: withMime
visibility: public
parameters:
- name: mime
comment: '# * Set the attached file''s mime type.
# *
# * @param string $mime
# * @return $this'
- name: attachWith
visibility: public
parameters:
- name: pathStrategy
- name: dataStrategy
comment: '# * Attach the attachment with the given strategies.
# *
# * @param \Closure $pathStrategy
# * @param \Closure $dataStrategy
# * @return mixed'
- name: attachTo
visibility: public
parameters:
- name: mail
- name: options
default: '[]'
comment: '# * Attach the attachment to a built-in mail type.
# *
# * @param \Illuminate\Mail\Mailable|\Illuminate\Mail\Message|\Illuminate\Notifications\Messages\MailMessage $mail
# * @param array $options
# * @return mixed'
- name: isEquivalent
visibility: public
parameters:
- name: attachment
- name: options
default: '[]'
comment: '# * Determine if the given attachment is equivalent to this attachment.
# *
# * @param \Illuminate\Mail\Attachment $attachment
# * @param array $options
# * @return bool'
traits:
- Closure
- Illuminate\Container\Container
- Illuminate\Support\Traits\Macroable
- RuntimeException
- Macroable
interfaces: []