BaseMarkdown

API reference › yii › helpers › BaseMarkdown

class	`yii\helpers\BaseMarkdown`
Since	2.0
Source	`framework/helpers/BaseMarkdown.php`

1 subclass

BaseMarkdown provides concrete implementation for Markdown.

Do not use BaseMarkdown. Use Markdown instead.

Properties

Property	Type	Description	Defined by
`$defaultFlavor` static	`string`	The markdown flavor to use when none is specified explicitly. Default: `'original'`.	`BaseMarkdown`
`$flavors` static	`array`	A map of markdown flavor names to corresponding parser class configurations. Default: `['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]]`.	`BaseMarkdown`

Method	Description	Defined by
`process()` static	Converts markdown into HTML.	`BaseMarkdown`
`processParagraph()` static	Converts markdown into HTML but only parses inline elements.	`BaseMarkdown`
`getParser()` protected static		`BaseMarkdown`

public static string $defaultFlavor = 'original'

The markdown flavor to use when none is specified explicitly.

Defaults to original.

public static function process(string $markdown, string|null $flavor = null): string

Converts markdown into HTML.

Parameters

Parameter	Type	Description
`$markdown`	`string`	The markdown text to parse
`$flavor`	`string\|null`	The markdown flavor to use. See `$flavors` for available values. Defaults to `$defaultFlavor`, if not set.

Returns

string: The parsed HTML output

Throws

public static function processParagraph(string $markdown, string|null $flavor = null): string

Converts markdown into HTML but only parses inline elements.

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

Parameters

Parameter	Type	Description
`$markdown`	`string`	The markdown text to parse
`$flavor`	`string\|null`	The markdown flavor to use. See `$flavors` for available values. Defaults to `$defaultFlavor`, if not set.

Returns

string: The parsed HTML output

Throws

protected static function getParser(string|null $flavor): cebe\markdown\Parser

Parameters

Parameter	Type	Description
`$flavor`	`string\|null`	The markdown flavor to use. See `$flavors` for available values. Defaults to `$defaultFlavor`, if not set.

Returns

cebe\markdown\Parser

Throws