Class yii\apidoc\templates\bootstrap\ApiRenderer

All Classes | Properties | Methods | Constants
Inheritanceyii\apidoc\templates\bootstrap\ApiRenderer » yii\apidoc\templates\html\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Implementsyii\base\ViewContextInterface
Uses Traitsyii\apidoc\templates\bootstrap\RendererTrait
Available since version2.0

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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
$indexView yii\apidoc\templates\bootstrap\ApiRenderer
$layout yii\apidoc\templates\bootstrap\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

Hide inherited methods

MethodDescriptionDefined 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\ApiRenderer
generateGuideUrl() Generate an url to a guide page yii\apidoc\renderers\BaseRenderer
getNavTypes() Returns nav TypeDocs yii\apidoc\templates\bootstrap\RendererTrait
getSourceUrl() yii\apidoc\templates\bootstrap\ApiRenderer
getView() yii\apidoc\templates\html\ApiRenderer
getViewPath() yii\apidoc\templates\html\ApiRenderer
init() yii\apidoc\templates\html\ApiRenderer
render() Renders a given \yii\apidoc\templates\bootstrap\Context. yii\apidoc\templates\bootstrap\ApiRenderer
renderClasses() yii\apidoc\templates\html\ApiRenderer
renderDefaultValue() Renders the default value. yii\apidoc\templates\html\ApiRenderer
renderInheritance() yii\apidoc\templates\html\ApiRenderer
renderInterfaces() yii\apidoc\templates\html\ApiRenderer
renderMethodSignature() yii\apidoc\templates\html\ApiRenderer
renderPropertySignature() yii\apidoc\templates\html\ApiRenderer
renderTraits() yii\apidoc\templates\html\ApiRenderer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
filterTypes() Returns types of a given class yii\apidoc\templates\bootstrap\RendererTrait
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
getTypeCategory() Returns category of TypeDoc yii\apidoc\templates\bootstrap\RendererTrait
renderWithLayout() Renders file applying layout yii\apidoc\templates\html\ApiRenderer

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
GUIDE_PREFIX 'guide-' Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options yii\apidoc\renderers\BaseRenderer

Property Details

$indexView public property
public $indexView = '@yii/apidoc/templates/bootstrap/views/index.php'
$layout public property
public $layout = '@yii/apidoc/templates/bootstrap/layouts/api.php'

Method Details

getSourceUrl() public method

public void getSourceUrl ( $type, $line = null )
$type
$line
render() public method

Renders a given \yii\apidoc\templates\bootstrap\Context.

public void render ( $context, $targetDir )
$context yii\apidoc\models\Context

The api documentation context to render.
$targetDir