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

プロパティの詳細

継承されたプロパティを隠す

(詳細説明とGitHubへのリンク)

明示的に指定されていない場合に使用するMarkdownフレーバー。デフォルトは`original`です。

こちらも参照してください $flavors.

(コード説明 - 型、変数名、デフォルト値)
(詳細説明とGitHubへのリンク)

Markdownフレーバー名と対応するパーサーのクラス設定のマップ。

(コード説明 - 配列の内容詳細)

メソッドの詳細

継承されたメソッドを隠す

(詳細説明とGitHubへのリンク)

(コード説明 - メソッドのシグネチャとパラメーター)
$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 メソッド

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 メソッド

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);
}