yii\apidoc\templates\online\ApiRenderer - Yii2 类参考手册
Class yii\apidoc\templates\online\ApiRenderer
Inheritance | yii\apidoc\templates\online\ApiRenderer » yii\apidoc\templates\html\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Available since version | 2.0 |
Public Properties
隐藏继承的属性 Hide inherited properties
Public Methods
隐藏继承的方法 Hide inherited methods
Protected Methods
隐藏继承的方法 Hide inherited methods
方法 Method | 简介 Description | 定义在 Defined By |
---|---|---|
generateFileName() | Generates file name for API page for a given type | yii\apidoc\templates\online\ApiRenderer |
generateLink() | Generate link markup | yii\apidoc\templates\html\ApiRenderer |
renderWithLayout() | Renders file applying layout | yii\apidoc\templates\html\ApiRenderer |
常量 Constants
隐藏继承的常量 Hide inherited 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
方法详情 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 |
Renders a given \yii\apidoc\templates\online\Context.
public void render ( $context, $targetDir ) | ||
$context | yii\apidoc\models\Context | The api documentation context to render. |
$targetDir | string |