Documentation

DisplayMarkdown extends AbstractExtension
in package

Table of Contents

Methods

displayMarkdown()  : string|MarkupInterface
Render a scalar or common metadata array value as safe Markdown HTML.
getFilters()  : mixed
{@inheritdoc}
getName()  : mixed
{@inheritdoc}
allowedMarkdownTags()  : array<string|int, mixed>
HTML tags allowed after Markdown conversion.
normalizeInlineBulletList()  : string
Convert metadata-style inline bullets into valid Markdown list lines.
normalizeMarkdownInput()  : string
Normalize escaped newlines commonly found in JSON-derived metadata.
normalizeValue()  : string
Normalize metadata values before Drupal text-format processing.
renderInlineMarkdown()  : string
Render inline Markdown safely.
renderMarkdown()  : string
Convert Markdown text to sanitized HTML.
renderMarkdownFallback()  : string
Render common Markdown syntax when league/commonmark is unavailable.

Methods

displayMarkdown()

Render a scalar or common metadata array value as safe Markdown HTML.

public displayMarkdown(mixed $value[, string $format = 'markdown' ]) : string|MarkupInterface
Parameters
$value : mixed
$format : string = 'markdown'
Return values
string|MarkupInterface

allowedMarkdownTags()

HTML tags allowed after Markdown conversion.

private allowedMarkdownTags() : array<string|int, mixed>
Return values
array<string|int, mixed>

normalizeInlineBulletList()

Convert metadata-style inline bullets into valid Markdown list lines.

private normalizeInlineBulletList(string $text) : string

Some descriptions arrive as one-line text like "Intro. * item * item". CommonMark only treats bullets as lists when they start a line.

Parameters
$text : string
Return values
string

normalizeMarkdownInput()

Normalize escaped newlines commonly found in JSON-derived metadata.

private normalizeMarkdownInput(string $text) : string
Parameters
$text : string
Return values
string

normalizeValue()

Normalize metadata values before Drupal text-format processing.

private normalizeValue(mixed $value) : string
Parameters
$value : mixed
Return values
string

renderInlineMarkdown()

Render inline Markdown safely.

private renderInlineMarkdown(string $text) : string
Parameters
$text : string
Return values
string

renderMarkdown()

Convert Markdown text to sanitized HTML.

private renderMarkdown(string $text, string $format) : string
Parameters
$text : string
$format : string
Return values
string

renderMarkdownFallback()

Render common Markdown syntax when league/commonmark is unavailable.

private renderMarkdownFallback(string $text) : string
Parameters
$text : string
Return values
string

        
On this page

Search results