yii\helpers\BaseMarkdown - Yii2 类参考手册

Class yii\helpers\BaseMarkdown

Inheritance	yii\helpers\BaseMarkdown
Subclasses	yii\helpers\Markdown
Available since version	2.0

BaseMarkdown provides concrete implementation for yii\helpers\Markdown.

Do not use BaseMarkdown. Use yii\helpers\Markdown instead.

Public Properties

隐藏继承的属性 Hide inherited properties

属性Property	类型 Type	简介 Description	定义在 Defined By
$defaultFlavor	string	The markdown flavor to use when none is specified explicitly.	yii\helpers\BaseMarkdown
$flavors	array	A map of markdown flavor names to corresponding parser class configurations.	yii\helpers\BaseMarkdown

Public Methods

隐藏继承的方法 Hide inherited methods

方法 Method	简介 Description	定义在 Defined By
process()	Converts markdown into HTML.	yii\helpers\BaseMarkdown
processParagraph()	Converts markdown into HTML but only parses inline elements.	yii\helpers\BaseMarkdown

Protected Methods

隐藏继承的方法 Hide inherited methods

方法 Method	简介 Description	定义在 Defined By
getParser()		yii\helpers\BaseMarkdown

属性详情 Property Details

$defaultFlavor public static property

The markdown flavor to use when none is specified explicitly. Defaults to original.

请参阅 $flavors.

public static string $defaultFlavor = 'original'

$flavors public static property

A map of markdown flavor names to corresponding parser class configurations.

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]]

方法详情 Method Details

getParser() protected static method

protected static \cebe\markdown\Parser getParser ( $flavor )
$flavor	string	The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set.
throws	yii\base\InvalidArgumentException	when an undefined flavor is given.

process() public static method

Converts markdown into HTML.

public static string process ( $markdown, $flavor = null )
$markdown	string	The markdown text to parse
$flavor	string	The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set.
return	string	The parsed HTML output
throws	yii\base\InvalidArgumentException	when an undefined flavor is given.

processParagraph() public static method

Converts markdown into HTML but only parses inline elements.

This can be useful for parsing small comments or description lines.

public static string processParagraph ( $markdown, $flavor = null )
$markdown	string	The markdown text to parse
$flavor	string	The markdown flavor to use. See $flavors for available values. Defaults to $defaultFlavor, if not set.
return	string	The parsed HTML output
throws	yii\base\InvalidArgumentException	when an undefined flavor is given.