Markdown
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. |
|
| static protected bool | $withSecuredEncoding | Indicates if secure encoding should be enabled. |
Methods
Render the Markdown template into HTML.
Render the Markdown template into text.
Parse the given Markdown text into HTML.
Get a Markdown converter instance.
Get the HTML component paths.
Get the text component paths.
Get the component paths.
Register new mail component paths.
Set the default theme to be used.
Get the theme currently being used by the renderer.
Enable secured encoding when parsing Markdown.
Disable secured encoding when parsing Markdown.
Flush the class's global state.
Details
__construct(Factory $view, array $options = [])
Create a new Markdown renderer instance.
HtmlString
render(string $view, array $data = [], CssToInlineStyles|null $inliner = null)
Render the Markdown template into HTML.
HtmlString
renderText(string $view, array $data = [])
Render the Markdown template into text.
static HtmlString
parse(string $text, bool $encoded = false)
Parse the given Markdown text into HTML.
static MarkdownConverter
converter(array $config = [])
| internal |
Get a Markdown converter instance.
array
htmlComponentPaths()
Get the HTML component paths.
array
textComponentPaths()
Get the text component paths.
protected 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.
string
getTheme()
Get the theme currently being used by the renderer.
static void
withSecuredEncoding()
Enable secured encoding when parsing Markdown.
static void
withoutSecuredEncoding()
Disable secured encoding when parsing Markdown.
static void
flushState()
Flush the class's global state.