PHP Class yii\apidoc\components\BaseController

Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends yii\console\Controller
Datei anzeigen Open project: yiisoft/yii2-apidoc Class Usage Examples

Public Properties

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

Public Methods

Method Description
options ( $actionID )

Protected Methods

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 )

Method Details

findFiles() abstract protected method

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.

findRenderer() abstract protected method

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

loadContext() protected method

Loads context from cache
protected loadContext ( string $location ) : Context
$location string
return yii\apidoc\models\Context

normalizeTargetDir() protected method

Checks that target directory is valid. Asks questions in tricky cases.
protected normalizeTargetDir ( string $target ) : boolean | string
$target string
return boolean | string

options() public method

public options ( $actionID )

searchFiles() protected method

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

storeContext() protected method

Writes context into cache file
protected storeContext ( Context $context, string $location )
$context yii\apidoc\models\Context
$location string

updateContext() protected method

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

Property Details

$exclude public_oe property

files to exclude.
public $exclude

$pageTitle public_oe property

page title
public $pageTitle

$template public_oe property

template to use for rendering
public $template