Class yii\apidoc\templates\online\ApiRenderer

All Classes | Properties | Methods | Constants

Inheritance	yii\apidoc\templates\online\ApiRenderer » yii\apidoc\templates\html\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Implements	yii\base\ViewContextInterface
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
$indexView			yii\apidoc\templates\online\ApiRenderer
$layout			yii\apidoc\templates\online\ApiRenderer
$pageTitle	string	String to use as the title of the generated page.	yii\apidoc\renderers\BaseRenderer
$typeView	string	Path or alias of the view file to use for rendering types (classes, interfaces, traits).	yii\apidoc\templates\html\ApiRenderer

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\online\ApiRenderer
generateGuideUrl()	Generate an url to a guide page	yii\apidoc\renderers\BaseRenderer
getSourceUrl()		yii\apidoc\templates\html\ApiRenderer
getView()		yii\apidoc\templates\html\ApiRenderer
getViewPath()		yii\apidoc\templates\html\ApiRenderer
init()		yii\apidoc\templates\html\ApiRenderer
render()	Renders a given \yii\apidoc\templates\online\Context.	yii\apidoc\templates\online\ApiRenderer
renderClasses()		yii\apidoc\templates\html\ApiRenderer
renderDefaultValue()	Renders the default value.	yii\apidoc\templates\html\ApiRenderer
renderInheritance()		yii\apidoc\templates\html\ApiRenderer
renderInterfaces()		yii\apidoc\templates\html\ApiRenderer
renderMethodSignature()		yii\apidoc\templates\html\ApiRenderer
renderPropertySignature()		yii\apidoc\templates\html\ApiRenderer
renderTraits()		yii\apidoc\templates\html\ApiRenderer

Method	Description	Defined By
generateFileName()	Generates file name for API page for a given type	yii\apidoc\templates\online\ApiRenderer
generateLink()	Generate link markup	yii\apidoc\templates\html\ApiRenderer
renderWithLayout()	Renders file applying layout	yii\apidoc\templates\html\ApiRenderer

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

$indexView public property

public $indexView = '@yii/apidoc/templates/online/views/index.php'

$layout public property

public $layout = false

generateApiUrl() public method

Generate an url to a type in apidocs

public mixed generateApiUrl ( $typeName )
$typeName

generateFileName() protected method

Generates file name for API page for a given type

protected string generateFileName ( $typeName )
$typeName	string

render() public method

Renders a given \yii\apidoc\templates\online\Context.

public void render ( $context, $targetDir )
$context	yii\apidoc\models\Context	The api documentation context to render.
$targetDir