0 关注者

类 yii\helpers\Markdown

继承	yii\helpers\Markdown » yii\helpers\BaseMarkdown
可用版本	2.0
源代码	https://github.com/yiisoft/yii2/blob/master/framework/helpers/Markdown.php

Markdown 提供将 Markdown 转换为 HTML 的功能。

基本用法如下

$myHtml = Markdown::process($myText); // use original markdown flavor
$myHtml = Markdown::process($myText, 'gfm'); // use github flavored markdown
$myHtml = Markdown::process($myText, 'extra'); // use markdown extra

您可以使用 $flavors 属性配置多个风格。

有关更多详细信息，请参阅 Markdown 库文档。

注意: Markdown 库与 PHPDoc 注释一起使用，因此如果您将其与 PHP opcache 一起使用，请确保它不剥离注释。

公共属性

隐藏继承的属性

属性	类型	描述	定义于
$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

方法详情

隐藏继承的方法

getParser() protected static method

定义于: yii\helpers\BaseMarkdown::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() public static method

定义于: yii\helpers\BaseMarkdown::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() public static method

定义于: yii\helpers\BaseMarkdown::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);
}