Class yii\apidoc\commands\ApiController

All Classes | Properties | Methods

Inheritance	yii\apidoc\commands\ApiController » yii\apidoc\components\BaseController » yii\console\Controller
Available since version	2.0

Generate class API documentation.

Public Properties

Property	Type	Description	Defined 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

Method	Description	Defined By
actionIndex()	Renders API documentation files	yii\apidoc\commands\ApiController
options()		yii\apidoc\commands\ApiController

Method	Description	Defined By
findFiles()	Finds files	yii\apidoc\commands\ApiController
findRenderer()		yii\apidoc\commands\ApiController
loadContext()	Loads context from cache	yii\apidoc\components\BaseController
normalizeTargetDir()	Checks that target directory is valid. Asks questions in tricky cases.	yii\apidoc\components\BaseController
searchFiles()	Finds files to process	yii\apidoc\components\BaseController
storeContext()	Writes context into cache file	yii\apidoc\components\BaseController
updateContext()		yii\apidoc\components\BaseController

$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-'

actionIndex() public method

Renders API documentation files

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

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