Class yii\helpers\BaseMarkdown
| Inheritance | yii\helpers\BaseMarkdown |
|---|---|
| Subclasses | yii\helpers\Markdown |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseMarkdown.php |
BaseMarkdown provides concrete implementation for yii\helpers\Markdown.
Do not use BaseMarkdown. Use yii\helpers\Markdown instead.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $defaultFlavor | string | The markdown flavor to use when none is specified explicitly. | yii\helpers\BaseMarkdown |
| $flavors | array | A map of markdown flavor names to corresponding parser class configurations. | yii\helpers\BaseMarkdown |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| process() | Converts markdown into HTML. | yii\helpers\BaseMarkdown |
| processParagraph() | Converts markdown into HTML but only parses inline elements. | yii\helpers\BaseMarkdown |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getParser() | yii\helpers\BaseMarkdown |
Property Details
The markdown flavor to use when none is specified explicitly.
Defaults to original.
See also $flavors.
A map of markdown flavor names to corresponding parser class configurations.
'original' => ['class' => 'cebe\markdown\Markdown', 'html5' => true], 'gfm' => ['class' => 'cebe\markdown\GithubMarkdown', 'html5' => true], 'gfm-comment' => ['class' => 'cebe\markdown\GithubMarkdown', 'html5' => true, 'enableNewlines' => true], 'extra' => ['class' => 'cebe\markdown\MarkdownExtra', 'html5' => true]
]
Method Details
| protected static \cebe\markdown\Parser getParser ( $flavor ) | ||
| $flavor | string|null | The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set. |
| throws | yii\base\InvalidArgumentException | when an undefined flavor is given. |
|---|---|---|
Converts markdown into HTML.
| public static string process ( $markdown, $flavor = null ) | ||
| $markdown | string | The markdown text to parse |
| $flavor | string|null | The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set. |
| return | string | The parsed HTML output |
|---|---|---|
| throws | yii\base\InvalidArgumentException | when an undefined flavor is given. |
Converts markdown into HTML but only parses inline elements.
This can be useful for parsing small comments or description lines.
| public static string processParagraph ( $markdown, $flavor = null ) | ||
| $markdown | string | The markdown text to parse |
| $flavor | string|null | The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set. |
| return | string | The parsed HTML output |
|---|---|---|
| throws | yii\base\InvalidArgumentException | when an undefined flavor is given. |