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	字串	當未明確指定時，要使用的 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

方法詳情

隱藏繼承的方法

getParser() 受保護的靜態方法

定義於： yii\helpers\BaseMarkdown::getParser()

受保護的靜態 \cebe\markdown\Parser getParser ( $flavor )
$flavor	字串\|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() 公有的靜態方法

定義於： yii\helpers\BaseMarkdown::process()

將 markdown 轉換為 HTML。

公有的靜態字串 process ( $markdown, $flavor = null )
$markdown	字串	要解析的 markdown 文字
$flavor	字串\|null	要使用的 markdown 風格。請參閱 $flavors 以取得可用的值。如果未設定，則預設為 $defaultFlavor。
回傳	字串	解析後的 HTML 輸出
拋出	yii\base\InvalidArgumentException	當給定未定義的風格時。

原始碼

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

processParagraph() 公有的靜態方法

定義於： yii\helpers\BaseMarkdown::processParagraph()

將 markdown 轉換為 HTML，但僅解析行內元素。

這對於解析小型註解或描述行很有用。

公有的靜態字串 processParagraph ( $markdown, $flavor = null )
$markdown	字串	要解析的 markdown 文字
$flavor	字串\|null	要使用的 markdown 風格。請參閱 $flavors 以取得可用的值。如果未設定，則預設為 $defaultFlavor。
回傳	字串	解析後的 HTML 輸出
拋出	yii\base\InvalidArgumentException	當給定未定義的風格時。

原始碼

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