Abstract Class yii\apidoc\templates\html\GuideRenderer

Inheritanceyii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Subclassesyii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/GuideRenderer.php

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
afterMarkdownProcess() Callback that is called after markdown is processed. yii\apidoc\templates\html\GuideRenderer
fixMarkdownLinks() Adds guide name to link URLs in markdown yii\apidoc\templates\html\GuideRenderer
generateGuideFileName() Given markdown file name generates resulting html file name yii\apidoc\templates\html\GuideRenderer
generateLink() Generate link markup yii\apidoc\templates\html\GuideRenderer
loadGuideStructure() Loads guide structure from a set of files yii\apidoc\renderers\GuideRenderer

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
GUIDE_PREFIX 'guide-' Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options yii\apidoc\renderers\BaseRenderer

Property Details

$layout public property
public $layout null
$view public property

The view instance. This property is read-only.

public \yii\web\View $view null

Method Details

afterMarkdownProcess() protected method (available since version 2.0.5)

Callback that is called after markdown is processed.

You may override it to do some post processing. The default implementation fixes some markdown links using fixMarkdownLinks() on the output.

protected string afterMarkdownProcess ( $file, $output, $renderer )
$file string

The file that has been processed.

$output string

The rendered HTML output.

$renderer yii\apidoc\helpers\ApiMarkdown

The renderer instance.

fixMarkdownLinks() protected method

Adds guide name to link URLs in markdown

protected string fixMarkdownLinks ( $content )
$content string
generateApiUrl() public method

Generate an url to a type in apidocs

public mixed generateApiUrl ( $typeName )
$typeName
generateGuideFileName() protected method

Given markdown file name generates resulting html file name

protected string generateGuideFileName ( $file )
$file string

Markdown file name

generateLink() protected method

Generate link markup

protected mixed generateLink ( $text, $href, $options = [] )
$text
$href
$options array

Additional HTML attributes for the link.

getGuideReferences() public method

public void getGuideReferences ( )
getView() public method

public \yii\web\View getView ( )
return \yii\web\View

The view instance

init() public method

public void init ( )
render() public method

Renders a set of files given into target directory.

public void render ( $files, $targetDir )
$files array
$targetDir string