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() プロテクトスタティックメソッド

定義元: yii\helpers\BaseMarkdown::getParser()

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() パブリックスタティックメソッド

定義元: yii\helpers\BaseMarkdown::process()

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() パブリックスタティックメソッド

定義元: yii\helpers\BaseMarkdown::processParagraph()

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