Class yii\apidoc\templates\html\ApiRenderer
| Inheritance | yii\apidoc\templates\html\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component |
|---|---|
| Implements | yii\base\ViewContextInterface |
| Subclasses | yii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\online\ApiRenderer |
| Available since version | 2.0 |
The base class for HTML API 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 | ||
| $indexView | string | Path or alias of the view file to use for rendering the index page. | yii\apidoc\templates\html\ApiRenderer |
| $layout | string | Path or alias of the layout file to use. | yii\apidoc\templates\html\ApiRenderer |
| $pageTitle | string | String to use as the title of the generated page. | yii\apidoc\renderers\BaseRenderer |
| $typeView | string | Path or alias of the view file to use for rendering types (classes, interfaces, traits). | yii\apidoc\templates\html\ApiRenderer |
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| generateFileName() | Generates file name for API page for a given type | yii\apidoc\templates\html\ApiRenderer |
| generateLink() | Generate link markup | yii\apidoc\templates\html\ApiRenderer |
| renderWithLayout() | Renders file applying layout | yii\apidoc\templates\html\ApiRenderer |
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 |
Property Details
Path or alias of the view file to use for rendering the index page.
Path or alias of the layout file to use.
Path or alias of the view file to use for rendering types (classes, interfaces, traits).
Method Details
Generate an url to a type in apidocs
| public mixed generateApiUrl ( $typeName ) | ||
| $typeName | ||
Generates file name for API page for a given type
| protected string generateFileName ( $typeName ) | ||
| $typeName | string | |
Generate link markup
| protected mixed generateLink ( $text, $href, $options = [] ) | ||
| $text | ||
| $href | ||
| $options | array | Additional HTML attributes for the link. |
| public void getSourceUrl ( $type, $line = null ) | ||
| $type | ||
| $line | ||
| public \yii\web\View getView ( ) | ||
| return | \yii\web\View | The view instance |
|---|---|---|
| public void getViewPath ( ) |
| public void init ( ) |
Renders a given yii\apidoc\models\Context.
| public void render ( $context, $targetDir ) | ||
| $context | yii\apidoc\models\Context | The api documentation context to render. |
| $targetDir | ||
| public string renderClasses ( $names ) | ||
| $names | array | |
Renders the default value.
| public string renderDefaultValue ( $value ) | ||
| $value | mixed | |
| public string renderInheritance ( $class ) | ||
| $class | yii\apidoc\models\ClassDoc | |
| public string renderInterfaces ( $names ) | ||
| $names | array | |
| public string renderMethodSignature ( $method, $context = null ) | ||
| $method | yii\apidoc\models\MethodDoc | |
| $context | ||
| public string renderPropertySignature ( $property, $context = null ) | ||
| $property | yii\apidoc\models\PropertyDoc | |
| $context | ||
| public string renderTraits ( $names ) | ||
| $names | array | |
Renders file applying layout
| protected string renderWithLayout ( $viewFile, $params ) | ||
| $viewFile | string | The view name |
| $params | array | The parameters (name-value pairs) that will be extracted and made available in the view file. |