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

172 lines
3.9 KiB
YAML

name: Markdown
class_comment: null
dependencies:
- name: ViewFactory
type: class
source: Illuminate\Contracts\View\Factory
- name: HtmlString
type: class
source: Illuminate\Support\HtmlString
- name: Str
type: class
source: Illuminate\Support\Str
- name: Environment
type: class
source: League\CommonMark\Environment\Environment
- name: CommonMarkCoreExtension
type: class
source: League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension
- name: TableExtension
type: class
source: League\CommonMark\Extension\Table\TableExtension
- name: MarkdownConverter
type: class
source: League\CommonMark\MarkdownConverter
- name: CssToInlineStyles
type: class
source: TijsVerkoyen\CssToInlineStyles\CssToInlineStyles
properties:
- name: view
visibility: protected
comment: '# * The view factory implementation.
# *
# * @var \Illuminate\Contracts\View\Factory'
- name: theme
visibility: protected
comment: '# * The current theme being used when generating emails.
# *
# * @var string'
- name: componentPaths
visibility: protected
comment: '# * The registered component paths.
# *
# * @var array'
methods:
- name: __construct
visibility: public
parameters:
- name: view
- name: options
default: '[]'
comment: "# * The view factory implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
View\\Factory\n# */\n# protected $view;\n# \n# /**\n# * The current theme being\
\ used when generating emails.\n# *\n# * @var string\n# */\n# protected $theme\
\ = 'default';\n# \n# /**\n# * The registered component paths.\n# *\n# * @var\
\ array\n# */\n# protected $componentPaths = [];\n# \n# /**\n# * Create a new\
\ Markdown renderer instance.\n# *\n# * @param \\Illuminate\\Contracts\\View\\\
Factory $view\n# * @param array $options\n# * @return void"
- name: render
visibility: public
parameters:
- name: view
- name: data
default: '[]'
- name: inliner
default: 'null'
comment: '# * Render the Markdown template into HTML.
# *
# * @param string $view
# * @param array $data
# * @param \TijsVerkoyen\CssToInlineStyles\CssToInlineStyles|null $inliner
# * @return \Illuminate\Support\HtmlString'
- name: renderText
visibility: public
parameters:
- name: view
- name: data
default: '[]'
comment: '# * Render the Markdown template into text.
# *
# * @param string $view
# * @param array $data
# * @return \Illuminate\Support\HtmlString'
- name: parse
visibility: public
parameters:
- name: text
comment: '# * Parse the given Markdown text into HTML.
# *
# * @param string $text
# * @return \Illuminate\Support\HtmlString'
- name: htmlComponentPaths
visibility: public
parameters: []
comment: '# * Get the HTML component paths.
# *
# * @return array'
- name: textComponentPaths
visibility: public
parameters: []
comment: '# * Get the text component paths.
# *
# * @return array'
- name: componentPaths
visibility: protected
parameters: []
comment: '# * Get the component paths.
# *
# * @return array'
- name: loadComponentsFrom
visibility: public
parameters:
- name: paths
default: '[]'
comment: '# * Register new mail component paths.
# *
# * @param array $paths
# * @return void'
- name: theme
visibility: public
parameters:
- name: theme
comment: '# * Set the default theme to be used.
# *
# * @param string $theme
# * @return $this'
- name: getTheme
visibility: public
parameters: []
comment: '# * Get the theme currently being used by the renderer.
# *
# * @return string'
traits:
- Illuminate\Support\HtmlString
- Illuminate\Support\Str
- League\CommonMark\Environment\Environment
- League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension
- League\CommonMark\Extension\Table\TableExtension
- League\CommonMark\MarkdownConverter
- TijsVerkoyen\CssToInlineStyles\CssToInlineStyles
interfaces: []