PHP Class yii\apidoc\commands\ApiController

Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends yii\apidoc\components\BaseController
Datei anzeigen Open project: yiisoft/yii2-apidoc

Public Properties

Property Type Description
$guide url to where the guide files are located
$guidePrefix prefix to prepend to all guide file names.

Public Methods

Method Description
actionIndex ( array $sourceDirs, string $targetDir ) : integer Renders API documentation files
options ( $actionID )

Protected Methods

Method Description
findFiles ( $path, $except = [] )
findRenderer ( $template ) : yii\apidoc\renderers\ApiRenderer

Method Details

actionIndex() public method

Renders API documentation files
public actionIndex ( array $sourceDirs, string $targetDir ) : integer
$sourceDirs array
$targetDir string
return integer

findFiles() protected method

protected findFiles ( $path, $except = [] )

findRenderer() protected method

protected findRenderer ( $template ) : yii\apidoc\renderers\ApiRenderer
return yii\apidoc\renderers\ApiRenderer

options() public method

public options ( $actionID )

Property Details

$guide public_oe property

url to where the guide files are located
public $guide

$guidePrefix public_oe property

prefix to prepend to all guide file names.
public $guidePrefix