PHP Class yii\apidoc\components\BaseController

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

Méthodes publiques

Свойство Type Description
$exclude files to exclude.
$pageTitle page title
$template template to use for rendering

Méthodes publiques

Méthode Description
options ( $actionID )

Méthodes protégées

Méthode 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 méthode

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.
Résultat array files found.

findRenderer() abstract protected méthode

abstract protected findRenderer ( string $template ) : BaseRenderer
$template string
Résultat yii\apidoc\renderers\BaseRenderer

loadContext() protected méthode

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

normalizeTargetDir() protected méthode

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

options() public méthode

public options ( $actionID )

searchFiles() protected méthode

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

storeContext() protected méthode

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

updateContext() protected méthode

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