Class yii\apidoc\commands\ApiController

Inheritanceyii\apidoc\commands\ApiController » yii\apidoc\components\BaseController » yii\console\Controller
Available since version2.0

Generate class API documentation.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$exclude string|array Files to exclude. yii\apidoc\components\BaseController
$guide string Url to where the guide files are located yii\apidoc\commands\ApiController
$guidePrefix string Prefix to prepend to all guide file names. yii\apidoc\commands\ApiController
$pageTitle string Page title yii\apidoc\components\BaseController
$template string Template to use for rendering yii\apidoc\components\BaseController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
actionIndex() Renders API documentation files yii\apidoc\commands\ApiController
options() yii\apidoc\commands\ApiController

Property Details

$guide public property

Url to where the guide files are located

public string $guide null
$guidePrefix public property

Prefix to prepend to all guide file names.

public string $guidePrefix 'guide-'

Method Details

actionIndex() public method

Renders API documentation files

public integer actionIndex ( array $sourceDirs, $targetDir )
$sourceDirs array
$targetDir string
return integer

Status code.

findFiles() protected method

Finds files

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

List of names to exclude from search.

return array

Files found.

findRenderer() protected method

protected yii\apidoc\renderers\ApiRenderer findRenderer ( $template )
$template string
options() public method

public void options ( $actionID )
$actionID