yii\apidoc\templates\bootstrap\RendererTrait - Yii2 类参考手册
Trait yii\apidoc\templates\bootstrap\RendererTrait
| Implemented by | yii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\bootstrap\GuideRenderer |
|---|
Common methods for renderers
Public Properties
隐藏继承的属性 Hide inherited properties
| 属性Property | 类型 Type | 简介 Description | 定义在 Defined By |
|---|---|---|---|
| $extensions | array | Official Yii extensions | yii\apidoc\templates\bootstrap\RendererTrait |
Public Methods
隐藏继承的方法 Hide inherited methods
| 方法 Method | 简介 Description | 定义在 Defined By |
|---|---|---|
| getNavTypes() | Returns nav TypeDocs | yii\apidoc\templates\bootstrap\RendererTrait |
Protected Methods
隐藏继承的方法 Hide inherited methods
| 方法 Method | 简介 Description | 定义在 Defined 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
Official Yii extensions
public array $extensions = ['apidoc', 'authclient', 'bootstrap', 'codeception', 'composer', 'debug', 'elasticsearch', 'faker', 'gii', 'httpclient', 'imagine', 'jui', 'mongodb', 'redis', 'shell', 'smarty', 'sphinx', 'swiftmailer', 'twig']
方法详情 Method Details
Returns types of a given class
| protected array filterTypes ( $types, $navClasses ) | ||
| $types | yii\apidoc\models\TypeDoc[] | |
| $navClasses | string | |
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 |
Returns category of TypeDoc
| protected string getTypeCategory ( $type ) | ||
| $type | yii\apidoc\models\TypeDoc | |