Class yii\apidoc\templates\bootstrap\GuideRenderer
| Inheritance | yii\apidoc\templates\bootstrap\GuideRenderer » yii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component |
|---|---|
| Uses Traits | yii\apidoc\templates\bootstrap\RendererTrait |
| Available since version | 2.0 |
Public 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 | ||
| $controller | \yii\console\Controller | The apidoc controller instance. | yii\apidoc\renderers\BaseRenderer |
| $extensions | array | Official Yii extensions | yii\apidoc\templates\bootstrap\RendererTrait |
| $guidePrefix | yii\apidoc\renderers\BaseRenderer | ||
| $guideUrl | yii\apidoc\renderers\BaseRenderer | ||
| $layout | yii\apidoc\templates\bootstrap\GuideRenderer | ||
| $pageTitle | string | String to use as the title of the generated page. | yii\apidoc\renderers\BaseRenderer |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| 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 |
| generateApiUrl() | Generate an url to a type in apidocs | yii\apidoc\templates\html\GuideRenderer |
| generateGuideUrl() | Generate an url to a guide page | yii\apidoc\renderers\BaseRenderer |
| getGuideReferences() | yii\apidoc\templates\html\GuideRenderer | |
| getNavTypes() | Returns nav TypeDocs | yii\apidoc\templates\bootstrap\RendererTrait |
| getView() | yii\apidoc\templates\html\GuideRenderer | |
| init() | yii\apidoc\templates\html\GuideRenderer | |
| render() | Renders a set of files given into target directory. | yii\apidoc\templates\bootstrap\GuideRenderer |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| afterMarkdownProcess() | Callback that is called after markdown is processed. | yii\apidoc\templates\html\GuideRenderer |
| filterTypes() | Returns types of a given class | yii\apidoc\templates\bootstrap\RendererTrait |
| fixMarkdownLinks() | Adds guide name to link URLs in markdown | yii\apidoc\templates\html\GuideRenderer |
| generateGuideFileName() | Given markdown file name generates resulting html file name | yii\apidoc\templates\html\GuideRenderer |
| generateLink() | Generate link markup | yii\apidoc\templates\html\GuideRenderer |
| getTypeCategory() | Returns category of TypeDoc | yii\apidoc\templates\bootstrap\RendererTrait |
| loadGuideStructure() | Loads guide structure from a set of files | yii\apidoc\renderers\GuideRenderer |
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 |