Abstract Class yii\apidoc\templates\html\GuideRenderer

All Classes | Properties | Methods | Constants

Inheritance	yii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Subclasses	yii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer
Available since version	2.0

Public Properties

Property	Type	Description	Defined By
$apiContext	yii\apidoc\models\Context	The yii\apidoc\models\Context currently being rendered.	yii\apidoc\renderers\BaseRenderer
$apiUrl			yii\apidoc\renderers\BaseRenderer
$controller	\yii\console\Controller	The apidoc controller instance.	yii\apidoc\renderers\BaseRenderer
$guidePrefix			yii\apidoc\renderers\BaseRenderer
$guideUrl			yii\apidoc\renderers\BaseRenderer
$layout			yii\apidoc\templates\html\GuideRenderer
$pageTitle	string	String to use as the title of the generated page.	yii\apidoc\renderers\BaseRenderer

Method	Description	Defined By
createSubjectLink()	Creates a link to a subject	yii\apidoc\renderers\BaseRenderer
createTypeLink()	Creates a link to a type (class, interface or trait)	yii\apidoc\renderers\BaseRenderer
generateApiUrl()	Generate an url to a type in apidocs	yii\apidoc\templates\html\GuideRenderer
generateGuideUrl()	Generate an url to a guide page	yii\apidoc\renderers\BaseRenderer
getGuideReferences()		yii\apidoc\templates\html\GuideRenderer
getView()		yii\apidoc\templates\html\GuideRenderer
init()		yii\apidoc\templates\html\GuideRenderer
render()	Renders a set of files given into target directory.	yii\apidoc\templates\html\GuideRenderer

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

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

$layout public property

public $layout = null

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