class Markdown (View source)

Properties

protected Factory $view The view factory implementation.
protected string $theme The current theme being used when generating emails.
protected array $componentPaths The registered component paths.

Methods

void
__construct(Factory $view, array $options = [])

Create a new Markdown renderer instance.

render(string $view, array $data = [], CssToInlineStyles|null $inliner = null)

Render the Markdown template into HTML.

renderText(string $view, array $data = [])

Render the Markdown template into text.

static HtmlString
parse(string $text)

Parse the given Markdown text into HTML.

array
htmlComponentPaths()

Get the HTML component paths.

array
textComponentPaths()

Get the text component paths.

array
componentPaths()

Get the component paths.

void
loadComponentsFrom(array $paths = [])

Register new mail component paths.

$this
theme(string $theme)

Set the default theme to be used.

Details

void __construct(Factory $view, array $options = [])

Create a new Markdown renderer instance.

Parameters

Factory $view
array $options

Return Value

void

HtmlString render(string $view, array $data = [], CssToInlineStyles|null $inliner = null)

Render the Markdown template into HTML.

Parameters

string $view
array $data
CssToInlineStyles|null $inliner

Return Value

HtmlString

HtmlString renderText(string $view, array $data = [])

Render the Markdown template into text.

Parameters

string $view
array $data

Return Value

HtmlString

static HtmlString parse(string $text)

Parse the given Markdown text into HTML.

Parameters

string $text

Return Value

HtmlString

array htmlComponentPaths()

Get the HTML component paths.

Return Value

array

array textComponentPaths()

Get the text component paths.

Return Value

array

protected array componentPaths()

Get the component paths.

Return Value

array

void loadComponentsFrom(array $paths = [])

Register new mail component paths.

Parameters

array $paths

Return Value

void

$this theme(string $theme)

Set the default theme to be used.

Parameters

string $theme

Return Value

$this