Class yii\apidoc\templates\json\ApiRenderer

Inheritanceyii\apidoc\templates\json\ApiRenderer » yii\apidoc\renderers\ApiRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Implementsyii\base\ViewContextInterface
Available since version2.0.5
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/json/ApiRenderer.php

The class for outputting documentation data structures as a JSON text.

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

Method Details

generateApiUrl() public method

Generate an url to a type in apidocs

public mixed generateApiUrl ( $typeName )
$typeName
generateFileName() protected method

protected void generateFileName ( $typeName )
$typeName
generateLink() protected method

Generate link markup

protected mixed generateLink ( $text, $href, $options = [] )
$text
$href
$options array

Additional HTML attributes for the link.

getSourceUrl() public method

public void getSourceUrl ( $type, $line null )
$type
$line
getViewPath() public method

public void getViewPath ( )
render() public method

Writes a given yii\apidoc\models\Context as JSON text to file 'types.json'.

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

The api documentation context to render.

$targetDir