Class yii\apidoc\templates\html\ApiRenderer

All Classes | Properties | Methods | Constants

Inheritance	yii\apidoc\templates\html\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Subclasses	yii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\online\ApiRenderer
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php

The base class for HTML API documentation renderers.

Public Properties

Hide inherited 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
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$controller	yii\console\Controller	The apidoc controller instance.	yii\apidoc\renderers\BaseRenderer
$guidePrefix			yii\apidoc\renderers\BaseRenderer
$guideUrl			yii\apidoc\renderers\BaseRenderer
$indexView	string	Path or alias of the view file to use for rendering the index page.	yii\apidoc\templates\html\ApiRenderer
$layout	string	Path or alias of the layout file to use.	yii\apidoc\templates\html\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
$view	yii\web\View	The view instance	yii\apidoc\templates\html\ApiRenderer
$viewPath	string	The view path that may be prefixed to a relative view name.	yii\apidoc\templates\html\ApiRenderer

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
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
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
generateApiUrl()	Generate an url to a type in apidocs	yii\apidoc\templates\html\ApiRenderer
generateGuideUrl()	Generate an url to a guide page	yii\apidoc\renderers\BaseRenderer
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getSourceUrl()		yii\apidoc\templates\html\ApiRenderer
getView()		yii\apidoc\templates\html\ApiRenderer
getViewPath()		yii\apidoc\templates\html\ApiRenderer
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()		yii\apidoc\templates\html\ApiRenderer
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
render()	Renders a given yii\apidoc\models\Context.	yii\apidoc\templates\html\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
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

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

Constants

Hide inherited constants

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

Property Details

$indexView public property

Path or alias of the view file to use for rendering the index page.

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

$layout public property

Path or alias of the layout file to use.

public string $layout = null

$typeView public property

Path or alias of the view file to use for rendering types (classes, interfaces, traits).

public string $typeView = '@yii/apidoc/templates/html/views/type.php'

$view public read-only property

The view instance

public yii\web\View getView ( )

$viewPath public read-only property

The view path that may be prefixed to a relative view name.

public string getViewPath ( )

Method Details

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

generateLink() protected method

Generate link markup

protected mixed generateLink ( $text, $href, $options = [] )
$text
$href
$options	array	Additional HTML attributes for the link.

getSourceUrl() public method

public void getSourceUrl ( $type, $line = null )
$type
$line

getView() public method

public yii\web\View getView ( )
return	yii\web\View	The view instance

getViewPath() public method

public string getViewPath ( )
return	string	The view path that may be prefixed to a relative view name.

init() public method

public void init ( )

render() public method

Renders a given yii\apidoc\models\Context.

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

renderClasses() public method

public string renderClasses ( $names )
$names	array

renderDefaultValue() public method (available since version 2.1.1)

Renders the default value.

public string renderDefaultValue ( $value )
$value	mixed

renderInheritance() public method

public string renderInheritance ( $class )
$class	yii\apidoc\models\ClassDoc

renderInterfaces() public method

public string renderInterfaces ( $names )
$names	array

renderMethodSignature() public method

public string renderMethodSignature ( $method, $context = null )
$method	yii\apidoc\models\MethodDoc
$context

renderPropertySignature() public method

public string renderPropertySignature ( $property, $context = null )
$property	yii\apidoc\models\PropertyDoc
$context	mixed

renderTraits() public method

public string renderTraits ( $names )
$names	array

renderWithLayout() protected method

Renders file applying layout

protected string renderWithLayout ( $viewFile, $params )
$viewFile	string	The view name
$params	array	The parameters (name-value pairs) that will be extracted and made available in the view file.