Markdown
in package
Table of Contents
- $componentPaths : array<string|int, mixed>
- The registered component paths.
- $theme : string
- The current theme being used when generating emails.
- $view : Factory
- The view factory implementation.
- __construct() : void
- Create a new Markdown renderer instance.
- htmlComponentPaths() : array<string|int, mixed>
- Get the HTML component paths.
- loadComponentsFrom() : void
- Register new mail component paths.
- markdownComponentPaths() : array<string|int, mixed>
- Get the Markdown component paths.
- parse() : HtmlString
- Parse the given Markdown text into HTML.
- render() : HtmlString
- Render the Markdown template into HTML.
- renderText() : HtmlString
- Render the Markdown template into HTML.
- theme() : $this
- Set the default theme to be used.
- componentPaths() : array<string|int, mixed>
- Get the component paths.
Properties
$componentPaths
The registered component paths.
protected
array<string|int, mixed>
$componentPaths
= []
$theme
The current theme being used when generating emails.
protected
string
$theme
= 'default'
$view
The view factory implementation.
protected
Factory
$view
Methods
__construct()
Create a new Markdown renderer instance.
public
__construct(Factory $view[, array<string|int, mixed> $options = [] ]) : void
Parameters
- $view : Factory
- $options : array<string|int, mixed> = []
Return values
void —htmlComponentPaths()
Get the HTML component paths.
public
htmlComponentPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —loadComponentsFrom()
Register new mail component paths.
public
loadComponentsFrom([array<string|int, mixed> $paths = [] ]) : void
Parameters
- $paths : array<string|int, mixed> = []
Return values
void —markdownComponentPaths()
Get the Markdown component paths.
public
markdownComponentPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —parse()
Parse the given Markdown text into HTML.
public
static parse(string $text) : HtmlString
Parameters
- $text : string
Return values
HtmlString —render()
Render the Markdown template into HTML.
public
render(string $view[, array<string|int, mixed> $data = [] ][, CssToInlineStyles|null $inliner = null ]) : HtmlString
Parameters
- $view : string
- $data : array<string|int, mixed> = []
- $inliner : CssToInlineStyles|null = null
Return values
HtmlString —renderText()
Render the Markdown template into HTML.
public
renderText(string $view[, array<string|int, mixed> $data = [] ]) : HtmlString
Parameters
- $view : string
- $data : array<string|int, mixed> = []
Return values
HtmlString —theme()
Set the default theme to be used.
public
theme(string $theme) : $this
Parameters
- $theme : string
Return values
$this —componentPaths()
Get the component paths.
protected
componentPaths() : array<string|int, mixed>