Abstract Class yii\apidoc\components\BaseController

All Classes | Properties | Methods
Inheritanceyii\apidoc\components\BaseController » yii\console\Controller
Subclassesyii\apidoc\commands\ApiController, yii\apidoc\commands\GuideController
Available since version2.0

Command to render API Documentation files

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$exclude string|array Files to exclude. yii\apidoc\components\BaseController
$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
options() yii\apidoc\components\BaseController

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
findFiles() Finds files yii\apidoc\components\BaseController
findRenderer() yii\apidoc\components\BaseController
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

Property Details

$exclude public property

Files to exclude.

public string|array $exclude = null
$pageTitle public property

Page title

public string $pageTitle = null
$template public property

Template to use for rendering

public string $template = 'bootstrap'

Method Details

findFiles() protected abstract method

Finds files

protected abstract array findFiles ( $dir, $except = [] )
$dir string

Directory to search files in.
$except array

List of names to exclude from search.
return array

Files found.
findRenderer() protected abstract method

protected abstract yii\apidoc\renderers\BaseRenderer findRenderer ( $template )
$template string
loadContext() protected method

Loads context from cache

protected yii\apidoc\models\Context loadContext ( $location )
$location string
normalizeTargetDir() protected method

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

protected boolean|string normalizeTargetDir ( $target )
$target string
options() public method

public void options ( $actionID )
$actionID
searchFiles() protected method

Finds files to process

protected array|boolean searchFiles ( $sourceDirs )
$sourceDirs array
return array|boolean

List of files to process or false on failure
storeContext() protected method

Writes context into cache file

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

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