PHP Class yii\console\Markdown

Based on cebe/markdown.
Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends cebe\markdown\Parser, use trait cebe\markdown\block\FencedCodeTrait, use trait cebe\markdown\inline\CodeTrait, use trait cebe\markdown\inline\EmphStrongTrait, use trait cebe\markdown\inline\StrikeoutTrait
Show file Open project: yiisoft/yii2 Class Usage Examples

Protected Properties

Property Type Description
$escapeCharacters these are "escapeable" characters. When using one of these prefixed with a backslash, the character will be outputted without the backslash and is not interpreted as markdown.

Protected Methods

Method Description
renderCode ( array $block ) : string Renders a code block
renderEmph ( array $element ) : string Renders empathized elements.
renderInlineCode ( array $element ) : string Renders an inline code span ``.
renderParagraph ( string $block ) : string Render a paragraph block
renderStrike ( array $element ) : string Renders the strike through feature.
renderStrong ( array $element ) : string Renders strong elements.

Method Details

renderCode() protected method

Renders a code block
protected renderCode ( array $block ) : string
$block array
return string

renderEmph() protected method

Renders empathized elements.
protected renderEmph ( array $element ) : string
$element array
return string

renderInlineCode() protected method

Renders an inline code span ``.
protected renderInlineCode ( array $element ) : string
$element array
return string

renderParagraph() protected method

Render a paragraph block
protected renderParagraph ( string $block ) : string
$block string
return string

renderStrike() protected method

Renders the strike through feature.
protected renderStrike ( array $element ) : string
$element array
return string

renderStrong() protected method

Renders strong elements.
protected renderStrong ( array $element ) : string
$element array
return string

Property Details

$escapeCharacters protected property

these are "escapeable" characters. When using one of these prefixed with a backslash, the character will be outputted without the backslash and is not interpreted as markdown.
protected $escapeCharacters