Class yii\helpers\BaseMarkdown

所有类 | 属性 | 方法

继承	yii\helpers\BaseMarkdown
子类	yii\helpers\Markdown
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/helpers/BaseMarkdown.php

BaseMarkdown 为 yii\helpers\Markdown 提供了具体的实现。

不要使用类 BaseMarkdown。使用 yii\helpers\Markdown 来替代。

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$defaultFlavor	\yii\helpers\在没有显式指定时使用的	Markdown 风格字符串。默认风格设置为 `original`。	yii\helpers\BaseMarkdown
$flavors	array	将标记风格名称映射到相应解析器类配置的映射。	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 \yii\helpers\在没有显式指定时使用的 $defaultFlavor = 'original'

$flavors 公共静态属性

将标记风格名称映射到相应解析器类配置的映射。

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 \cebe\markdown\Parser getParser($flavor)
$flavor	string	关于 markdown 使用的风格。请参考 $flavors 可用的值。默认为 $defaultFlavor，如果没有设置的情况下。
throws	yii\base\InvalidArgumentException	当指定的风格不存在时发生异常。

process() 公共静态方法

将 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() 公共静态方法

将 markdown 转换为 HTML 但是只解析内联元素。

这对于解析小注释或描述行非常有用。

public static string processParagraph($markdown, $flavor = null)
$markdown	string	要解析的 markdown 文本
$flavor	string	关于 markdown 使用的风格。请参考 $flavors 可用的值。默认为 $defaultFlavor，如果没有设置的情况下。
return	string	解析的 HTML 输出
throws	yii\base\InvalidArgumentException	当指定的风格不存在时发生异常。