PHP Class yii\apidoc\renderers\BaseRenderer

Since: 2.0

Author: Carsten Brandt ([email protected])

Inheritance: extends yii\base\Component

Public Properties

Property	Type	Description
$apiContext		the [[Context]] currently being rendered.
$apiUrl
$controller		the apidoc controller instance. Can be used to control output.
$guidePrefix
$guideUrl
$pageTitle		string to use as the title of the generated page.

Method	Description
createSubjectLink ( PropertyDoc \| yii\apidoc\models\MethodDoc \| yii\apidoc\models\ConstDoc \| EventDoc $subject, string $title = null, array $options = [] ) : string	creates a link to a subject
createTypeLink ( yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc \| yii\apidoc\models\ClassDoc[] \| yii\apidoc\models\InterfaceDoc[] \| yii\apidoc\models\TraitDoc[] \| string \| string[] $types, BaseDoc $context = null, string $title = null, array $options = [] ) : string	creates a link to a type (class, interface or trait)
generateApiUrl ( $typeName ) : mixed	Generate an url to a type in apidocs
generateGuideUrl ( string $file ) : string	Generate an url to a guide page
init ( )

Method	Description
generateLink ( $text, $href, array $options = [] ) : mixed	generate link markup

Method	Description
resolveNamespace ( BaseDoc \| string $context ) : string

creates a link to a subject

public createSubjectLink ( PropertyDoc \| yii\apidoc\models\MethodDoc \| yii\apidoc\models\ConstDoc \| EventDoc $subject, string $title = null, array $options = [] ) : string
$subject	yii\apidoc\models\PropertyDoc \| yii\apidoc\models\MethodDoc \| yii\apidoc\models\ConstDoc \| yii\apidoc\models\EventDoc
$title	string
$options	array	additional HTML attributes for the link.
return	string

creates a link to a type (class, interface or trait)

public createTypeLink ( yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc \| yii\apidoc\models\ClassDoc[] \| yii\apidoc\models\InterfaceDoc[] \| yii\apidoc\models\TraitDoc[] \| string \| string[] $types, BaseDoc $context = null, string $title = null, array $options = [] ) : string
$types	yii\apidoc\models\ClassDoc \| yii\apidoc\models\InterfaceDoc \| yii\apidoc\models\TraitDoc \| yii\apidoc\models\ClassDoc[] \| yii\apidoc\models\InterfaceDoc[] \| yii\apidoc\models\TraitDoc[] \| string \| string[]
$context	yii\apidoc\models\BaseDoc
$title	string	a title to be used for the link TODO check whether [[yii\...\|Class]] is supported
$options	array	additional HTML attributes for the link.
return	string

Generate an url to a type in apidocs

abstract public generateApiUrl ( $typeName ) : mixed
$typeName
return	mixed

Generate an url to a guide page

public generateGuideUrl ( string $file ) : string
$file	string
return	string

generate link markup

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

public init ( )

the [[Context]] currently being rendered.

public $apiContext

public $apiUrl

the apidoc controller instance. Can be used to control output.

public $controller

public $guidePrefix

public $guideUrl

string to use as the title of the generated page.

public $pageTitle