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 風味。	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 property

當未明確指定時，要使用的 markdown 風味。預設為 original。

另請參閱 $flavors。

public static string $defaultFlavor = 'original'

$flavors public static property

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 method

protected static \cebe\markdown\Parser getParser ( $flavor )
$flavor	string\|null	要使用的 markdown 風格。請參閱 $flavors 以取得可用值。如果未設定，則預設為 $defaultFlavor。
throws	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

將 markdown 轉換為 HTML。

public static string process ( $markdown, $flavor = null )
$markdown	string	要解析的 markdown 文字
$flavor	string\|null	要使用的 markdown 風格。請參閱 $flavors 以取得可用值。如果未設定，則預設為 $defaultFlavor。
return	string	已解析的 HTML 輸出
throws	yii\base\InvalidArgumentException	當給定未定義的風格時。

原始碼

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

processParagraph() public static method

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

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

public static string processParagraph ( $markdown, $flavor = null )
$markdown	string	要解析的 markdown 文字
$flavor	string\|null	要使用的 markdown 風格。請參閱 $flavors 以取得可用值。如果未設定，則預設為 $defaultFlavor。
return	string	已解析的 HTML 輸出
throws	yii\base\InvalidArgumentException	當給定未定義的風格時。

原始碼

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