Класс yii\helpers\BaseMarkdown
| Наследование | yii\helpers\BaseMarkdown |
|---|---|
| Подклассы | yii\helpers\Markdown |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseMarkdown.php |
BaseMarkdown предоставляет конкретную реализацию для yii\helpers\Markdown.
Не используйте BaseMarkdown. Используйте yii\helpers\Markdown вместо этого.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $defaultFlavor | строка | Формат Markdown, который следует использовать, если он не указан явно. | yii\helpers\BaseMarkdown |
| $flavors | массив | Словарь имён форматов Markdown и соответствующих конфигураций классов парсеров. | yii\helpers\BaseMarkdown |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| process() | Преобразует Markdown в HTML. | yii\helpers\BaseMarkdown |
| processParagraph() | Преобразует Markdown в HTML, но анализирует только встроенные элементы. | yii\helpers\BaseMarkdown |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getParser() | yii\helpers\BaseMarkdown |
Подробное описание свойств
$defaultFlavor публическое статическое свойство
Формат Markdown, который следует использовать, если он не указан явно. По умолчанию original.
См. также $flavors.
public static string $defaultFlavor = 'original'
$flavors публическое статическое свойство
Словарь имён форматов Markdown и соответствующих конфигураций классов парсеров.
public static array $flavors = ['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]]
Подробное описание методов
getParser() защищённый статический метод
| защищённый статический \cebe\markdown\Parser getParser ( $flavor ) | ||
|---|---|---|
| $flavor | строка |
Формат Markdown для использования. Доступные значения см. в $flavors. По умолчанию $defaultFlavor, если не задано. |
| throws | yii\base\InvalidParamException |
при передаче неопределённого формата. |
process() публичный статический метод
Преобразует Markdown в HTML.
| публичный статический строка process ( $markdown, $flavor = null ) | ||
|---|---|---|
| $markdown | строка |
Текст Markdown для парсинга |
| $flavor | строка |
Формат Markdown для использования. Доступные значения см. в $flavors. По умолчанию $defaultFlavor, если не задано. |
| return | строка |
Выходной HTML-код |
| throws | yii\base\InvalidParamException |
при передаче неопределённого формата. |
processParagraph() публичный статический метод
Преобразует Markdown в HTML, но анализирует только встроенные элементы.
Это может быть полезно для парсинга коротких комментариев или строк описания.
| публичный статический строка processParagraph ( $markdown, $flavor = null ) | ||
|---|---|---|
| $markdown | строка |
Текст Markdown для парсинга |
| $flavor | строка |
Формат Markdown для использования. Доступные значения см. в $flavors. По умолчанию $defaultFlavor, если не задано. |
| return | строка |
Выходной HTML-код |
| throws | yii\base\InvalidParamException |
при передаче неопределённого формата. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-helpers-basemarkdown.html
