PHP Class yii\apidoc\templates\html\ApiRenderer

Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends yii\apidoc\renderers\ApiRenderer, implements yii\base\ViewContextInterface
Afficher le fichier Open project: yiisoft/yii2-apidoc Class Usage Examples

Méthodes publiques

Свойство Type Description
$indexView path or alias of the view file to use for rendering the index page.
$layout path or alias of the layout file to use.
$typeView path or alias of the view file to use for rendering types (classes, interfaces, traits).

Méthodes publiques

Méthode Description
generateApiUrl ( $typeName )
getSourceUrl ( $type, $line = null )
getView ( ) : View
getViewPath ( )
init ( )
render ( Context $context, $targetDir ) Renders a given [[Context]].
renderClasses ( array $names ) : string
renderDefaultValue ( mixed $value ) : string Renders the default value.
renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
renderInterfaces ( array $names ) : string
renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
renderPropertySignature ( PropertyDoc $property, $context = null ) : string
renderTraits ( array $names ) : string

Méthodes protégées

Méthode Description
generateFileName ( string $typeName ) : string Generates file name for API page for a given type
generateLink ( $text, $href, $options = [] )
renderWithLayout ( string $viewFile, array $params ) : string Renders file applying layout

Method Details

generateApiUrl() public méthode

public generateApiUrl ( $typeName )

generateFileName() protected méthode

Generates file name for API page for a given type
protected generateFileName ( string $typeName ) : string
$typeName string
Résultat string

getSourceUrl() public méthode

public getSourceUrl ( $type, $line = null )

getView() public méthode

public getView ( ) : View
Résultat yii\web\View the view instance

getViewPath() public méthode

public getViewPath ( )

init() public méthode

public init ( )

render() public méthode

Renders a given [[Context]].
public render ( Context $context, $targetDir )
$context yii\apidoc\models\Context the api documentation context to render.
$targetDir

renderClasses() public méthode

public renderClasses ( array $names ) : string
$names array
Résultat string

renderDefaultValue() public méthode

Renders the default value.
Since: 2.1.1
public renderDefaultValue ( mixed $value ) : string
$value mixed
Résultat string

renderInheritance() public méthode

public renderInheritance ( yii\apidoc\models\ClassDoc $class ) : string
$class yii\apidoc\models\ClassDoc
Résultat string

renderInterfaces() public méthode

public renderInterfaces ( array $names ) : string
$names array
Résultat string

renderMethodSignature() public méthode

public renderMethodSignature ( yii\apidoc\models\MethodDoc $method, $context = null ) : string
$method yii\apidoc\models\MethodDoc
Résultat string

renderPropertySignature() public méthode

public renderPropertySignature ( PropertyDoc $property, $context = null ) : string
$property yii\apidoc\models\PropertyDoc
Résultat string

renderTraits() public méthode

public renderTraits ( array $names ) : string
$names array
Résultat string

renderWithLayout() protected méthode

Renders file applying layout
protected renderWithLayout ( string $viewFile, array $params ) : string
$viewFile string the view name
$params array the parameters (name-value pairs) that will be extracted and made available in the view file.
Résultat string

Property Details

$indexView public_oe property

path or alias of the view file to use for rendering the index page.
public $indexView

$layout public_oe property

path or alias of the layout file to use.
public $layout

$typeView public_oe property

path or alias of the view file to use for rendering types (classes, interfaces, traits).
public $typeView