PHP Class yii\apidoc\components\BaseController

Since: 2.0

Author: Carsten Brandt ([email protected])

Inheritance: extends yii\console\Controller

Public Properties

Property	Type	Description
$exclude		files to exclude.
$pageTitle		page title
$template		template to use for rendering

Method	Description
options ( $actionID )

Method	Description
findFiles ( string $dir, array $except = [] ) : array	Finds files
findRenderer ( string $template ) : BaseRenderer
loadContext ( string $location ) : Context	Loads context from cache
normalizeTargetDir ( string $target ) : boolean \| string	Checks that target directory is valid. Asks questions in tricky cases.
searchFiles ( array $sourceDirs ) : array \| boolean	Finds files to process
storeContext ( Context $context, string $location )	Writes context into cache file
updateContext ( Context $context )

Finds files

abstract protected findFiles ( string $dir, array $except = [] ) : array
$dir	string	directory to search files in.
$except	array	list of names to exclude from search.
return	array	files found.

abstract protected findRenderer ( string $template ) : BaseRenderer
$template	string
return	yii\apidoc\renderers\BaseRenderer

Loads context from cache

protected loadContext ( string $location ) : Context
$location	string
return	yii\apidoc\models\Context

Checks that target directory is valid. Asks questions in tricky cases.

protected normalizeTargetDir ( string $target ) : boolean \| string
$target	string
return	boolean \| string

public options ( $actionID )

Finds files to process

protected searchFiles ( array $sourceDirs ) : array \| boolean
$sourceDirs	array
return	array \| boolean	list of files to process or false on failure

Writes context into cache file

protected storeContext ( Context $context, string $location )
$context	yii\apidoc\models\Context
$location	string

protected updateContext ( Context $context )
$context	yii\apidoc\models\Context

files to exclude.

public $exclude

page title

public $pageTitle

template to use for rendering

public $template