0 关注者

类 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 样式。默认值为 original。 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 公共静态属性

当未明确指定时使用的 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() 受保护静态方法

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

要使用的 Markdown 样式。参见 $flavors 以获取可用值。默认值为 $defaultFlavor，如果未设置。
抛出 yii\base\InvalidArgumentException

当给出未定义的样式时。

 

                protected static function getParser($flavor)
{
    if ($flavor === null) {
        $flavor = static::$defaultFlavor;
    }
    /* @var $parser \cebe\markdown\Markdown */
    if (!isset(static::$flavors[$flavor])) {
        throw new InvalidArgumentException("Markdown flavor '$flavor' is not defined.'");
    } elseif (!is_object($config = static::$flavors[$flavor])) {
        static::$flavors[$flavor] = Yii::createObject($config);
    }
    return static::$flavors[$flavor];
}
process() 公共静态方法

将 Markdown 转换为 HTML。

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

要解析的 Markdown 文本
$flavor string|null

要使用的 Markdown 样式。参见 $flavors 以获取可用值。默认值为 $defaultFlavor，如果未设置。
返回值 string

解析后的 HTML 输出
抛出 yii\base\InvalidArgumentException

当给出未定义的样式时。

 

                public static function process($markdown, $flavor = null)
{
    $parser = static::getParser($flavor);
    return $parser->parse($markdown);
}
processParagraph() 公共静态方法

将 Markdown 转换为 HTML，但只解析内联元素。

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

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

要解析的 Markdown 文本
$flavor string|null

要使用的 Markdown 样式。参见 $flavors 以获取可用值。默认值为 $defaultFlavor，如果未设置。
返回值 string

解析后的 HTML 输出
抛出 yii\base\InvalidArgumentException

当给出未定义的样式时。

 

                public static function processParagraph($markdown, $flavor = null)
{
    $parser = static::getParser($flavor);
    return $parser->parseParagraph($markdown);
}