PHP Класс yii\apidoc\helpers\ApiMarkdown

С версии: 2.0
Автор: Carsten Brandt ([email protected])
Наследование: extends cebe\markdown\GithubMarkdown
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$blockTranslations translation for guide block types
$renderer yii\apidoc\renderers\BaseRenderer

Защищенные свойства (Protected)

Свойство Тип Описание
$headings
$renderingContext

Открытые методы

Метод Описание
getHeadings ( ) : array
highlight ( string $code, string $language ) : string Highlights code
parse ( $text )
process ( string $content, yii\apidoc\models\TypeDoc $context = null, boolean $paragraph = false ) : string Converts markdown into HTML
renderTable ( $block ) Add bootstrap classes to tables.

Защищенные методы

Метод Описание
applyToc ( $content )
prepare ( )
renderCode ( $block )
renderHeadline ( $block )
renderLink ( $block )
translateBlockType ( $type )

Описание методов

applyToc() защищенный Метод

С версии: 2.0.5
protected applyToc ( $content )

getHeadings() публичный Метод

С версии: 2.0.5
public getHeadings ( ) : array
Результат array the headlines of this document

highlight() публичный статический Метод

Highlights code
Устаревший: since 2.0.5 this method is not used anymore, highlight.php is used for highlighting
public static highlight ( string $code, string $language ) : string
$code string code to highlight
$language string language of the code to highlight
Результат string HTML of highlighted code

parse() публичный Метод

public parse ( $text )

prepare() защищенный Метод

protected prepare ( )

process() публичный статический Метод

Converts markdown into HTML
public static process ( string $content, yii\apidoc\models\TypeDoc $context = null, boolean $paragraph = false ) : string
$content string
$context yii\apidoc\models\TypeDoc
$paragraph boolean
Результат string

renderCode() защищенный Метод

protected renderCode ( $block )

renderHeadline() защищенный Метод

protected renderHeadline ( $block )

renderTable() публичный Метод

Add bootstrap classes to tables.
public renderTable ( $block )

translateBlockType() защищенный Метод

С версии: 2.0.5
protected translateBlockType ( $type )

Описание свойств

$blockTranslations публичное статическое свойство

translation for guide block types
С версии: 2.0.5
public static $blockTranslations

$headings защищенное свойство

protected $headings

$renderer публичное статическое свойство

public static BaseRenderer,yii\apidoc\renderers $renderer
Результат yii\apidoc\renderers\BaseRenderer

$renderingContext защищенное свойство

protected $renderingContext