PHP 클래스 yii\apidoc\helpers\ApiMarkdown

부터: 2.0
저자: Carsten Brandt ([email protected])
상속: extends cebe\markdown\GithubMarkdown
파일 보기 프로젝트 열기: yiisoft/yii2-apidoc 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$blockTranslations translation for guide block types
$renderer yii\apidoc\renderers\BaseRenderer

보호된 프로퍼티들

프로퍼티 타입 설명
$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