PHP Class yii\apidoc\helpers\ApiMarkdown

Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends cebe\markdown\GithubMarkdown
Datei anzeigen Open project: yiisoft/yii2-apidoc Class Usage Examples

Public Properties

Property Type Description
$blockTranslations translation for guide block types
$renderer yii\apidoc\renderers\BaseRenderer

Protected Properties

Property Type Description
$headings
$renderingContext

Public Methods

Method Description
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.

Protected Methods

Method Description
applyToc ( $content )
prepare ( )
renderCode ( $block )
renderHeadline ( $block )
renderLink ( $block )
translateBlockType ( $type )

Method Details

applyToc() protected method

Since: 2.0.5
protected applyToc ( $content )

getHeadings() public method

Since: 2.0.5
public getHeadings ( ) : array
return array the headlines of this document

highlight() public static method

Highlights code
Deprecation: 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
return string HTML of highlighted code

parse() public method

public parse ( $text )

prepare() protected method

protected prepare ( )

process() public static method

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
return string

renderCode() protected method

protected renderCode ( $block )

renderHeadline() protected method

protected renderHeadline ( $block )

renderTable() public method

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

translateBlockType() protected method

Since: 2.0.5
protected translateBlockType ( $type )

Property Details

$blockTranslations public_oe static_oe property

translation for guide block types
Since: 2.0.5
public static $blockTranslations

$headings protected_oe property

protected $headings

$renderer public_oe static_oe property

public static BaseRenderer,yii\apidoc\renderers $renderer
return yii\apidoc\renderers\BaseRenderer

$renderingContext protected_oe property

protected $renderingContext