Abstract Class yii\apidoc\renderers\GuideRenderer
| Inheritance | yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component |
|---|---|
| Subclasses | yii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\html\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer |
| Available since version | 2.0 |
Base class for all Guide documentation renderers
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 |
| $guidePrefix | yii\apidoc\renderers\BaseRenderer | ||
| $guideUrl | yii\apidoc\renderers\BaseRenderer | ||
| $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\renderers\BaseRenderer |
| generateGuideUrl() | Generate an url to a guide page | yii\apidoc\renderers\BaseRenderer |
| init() | yii\apidoc\renderers\BaseRenderer | |
| render() | Render markdown files | yii\apidoc\renderers\GuideRenderer |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| generateLink() | Generate link markup | yii\apidoc\renderers\BaseRenderer |
| 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 |
Method Details
Loads guide structure from a set of files
| protected array loadGuideStructure ( $files ) | ||
| $files | array | |
Render markdown files
| public abstract void render ( $files, $targetDir ) | ||
| $files | array | List of markdown files to render |
| $targetDir | ||