Class 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 string 当没有明确指定时使用的 markdown 风格. yii\helpers\BaseMarkdown
$flavors array Markdown 映射到相应解析器类的风格名称的配置. yii\helpers\BaseMarkdown

公共方法

隐藏继承的方法

方法描述定义在
process() 将 markdown 转换为 HTML. yii\helpers\BaseMarkdown
processParagraph() 将 markdown 转换为 HTML 但仅解析内联元素. yii\helpers\BaseMarkdown

受保护的方法

隐藏继承的方法

方法描述定义在
getParser() yii\helpers\BaseMarkdown

属性详情

$defaultFlavor public static 属性

当没有明确指定时使用的 markdown 风格. 默认为original.

参见 $flavors.

public static string $defaultFlavor 'original'
$flavors public static 属性

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() protected static 方法

protected static \cebe\markdown\Parser getParser ( $flavor )
$flavor string

要使用的 markdown 风格. 有关可用值, 请参加 $flavors. 如果未设置, 默认为 $defaultFlavor.

throws yii\base\InvalidArgumentException

当给出不确定的风格时.

process() public static 方法

将 markdown 转换为 HTML.

public static string process ( $markdown, $flavor null )
$markdown string

要转换的 markdown 文本.

$flavor string

要使用的 markdown 风格. 有关可用值, 请参加 $flavors. 如果未设置, 默认为 $defaultFlavor.

return string

转换后的 HTML.

throws yii\base\InvalidArgumentException

当给出不确定的风格时.

processParagraph() public static 方法

将 markdown 转换为 HTML 但仅解析内联元素.

这对于解析小注释或描述很有用.

public static string processParagraph ( $markdown, $flavor null )
$markdown string

要转换的 markdown 文本.

$flavor string

要使用的 markdown 风格. 有关可用值, 请参加 $flavors. 如果未设置, 默认为 $defaultFlavor.

return string

转换后的 HTML.

throws yii\base\InvalidArgumentException

当给出不确定的风格时.