Class yii\apidoc\commands\GuideController

All Classes | Properties | Methods

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

This command can render documentation stored as markdown files such as the yii guide or your own applications documentation setup.

Public Properties

Property	Type	Description	Defined By
$apiDocs	string	Path or URL to the api docs to allow links to classes and properties/methods.	yii\apidoc\commands\GuideController
$exclude	string\|array	Files to exclude.	yii\apidoc\components\BaseController
$guidePrefix	string	Prefix to prepend to all output file names generated for the guide.	yii\apidoc\commands\GuideController
$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\GuideController
options()		yii\apidoc\commands\GuideController

Method	Description	Defined By
findFiles()	Finds files	yii\apidoc\commands\GuideController
findRenderer()		yii\apidoc\commands\GuideController
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

$apiDocs public property

Path or URL to the api docs to allow links to classes and properties/methods.

public string $apiDocs = null

$guidePrefix public property

Prefix to prepend to all output file names generated for the guide.

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\GuideRenderer findRenderer ( $template )
$template	string

options() public method

public void options ( $actionID )
$actionID