Trait yii\apidoc\templates\bootstrap\RendererTrait

Implemented byyii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\bootstrap\GuideRenderer

Common methods for renderers

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$extensions array Official Yii extensions yii\apidoc\templates\bootstrap\RendererTrait

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getNavTypes() Returns nav TypeDocs yii\apidoc\templates\bootstrap\RendererTrait

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
filterTypes() Returns types of a given class yii\apidoc\templates\bootstrap\RendererTrait
getTypeCategory() Returns category of TypeDoc yii\apidoc\templates\bootstrap\RendererTrait

Property Details

$extensions public property

Official Yii extensions

public array $extensions = ['apidoc''authclient''bootstrap''codeception''composer''debug''elasticsearch''faker''gii''imagine''jui''mongodb''redis''smarty''sphinx''swiftmailer''twig']

Method Details

filterTypes() protected method

Returns types of a given class

protected array filterTypes ( $types, $navClasses )
$types yii\apidoc\models\TypeDoc[]
$navClasses string
getNavTypes() public method

Returns nav TypeDocs

public array getNavTypes ( $type, $types )
$type yii\apidoc\models\TypeDoc

Typedoc to take category from

$types yii\apidoc\models\TypeDoc[]

TypeDocs to filter

getTypeCategory() protected method

Returns category of TypeDoc

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