PHP Trait yii\apidoc\templates\bootstrap\RendererTrait

Show file Open project: yiisoft/yii2-apidoc

Public Properties

Property	Type	Description
$extensions		official Yii extensions

Public Methods

Method	Description
getNavTypes ( yii\apidoc\models\TypeDoc $type, yii\apidoc\models\TypeDoc[] $types ) : array	Returns nav TypeDocs

Protected Methods

Method	Description
filterTypes ( yii\apidoc\models\TypeDoc[] $types, string $navClasses ) : array	Returns types of a given class
getTypeCategory ( yii\apidoc\models\TypeDoc $type ) : string	Returns category of TypeDoc

Method Details

filterTypes() protected method

Returns types of a given class

protected filterTypes ( yii\apidoc\models\TypeDoc[] $types, string $navClasses ) : array
$types	yii\apidoc\models\TypeDoc[]
$navClasses	string
return	array

getNavTypes() public method

Returns nav TypeDocs

public getNavTypes ( yii\apidoc\models\TypeDoc $type, yii\apidoc\models\TypeDoc[] $types ) : array
$type	yii\apidoc\models\TypeDoc	typedoc to take category from
$types	yii\apidoc\models\TypeDoc[]	TypeDocs to filter
return	array

getTypeCategory() protected method

Returns category of TypeDoc

protected getTypeCategory ( yii\apidoc\models\TypeDoc $type ) : string
$type	yii\apidoc\models\TypeDoc
return	string

Property Details

$extensions public property

official Yii extensions

public $extensions