console\Controller $help

$help public read-only property (available since version 2.0.10) Whether to display help information about current command. public string getHelp ( )

console\Controller $helpSummary

$helpSummary public read-only property public string getHelpSummary ( )

console\Controller $color

$color public property Whether to enable ANSI color in the output. If not set, ANSI color will only be enabled for terminals that support it. public boolean $color = null

console\Controller $passedOptions

$passedOptions public read-only property The names of the options passed during execution public array getPassedOptions ( )

console\Application __construct()

__construct() public method Constructor. public void __construct ( $config = [] )$config array Name-value pairs that will be used to initialize the object properties. Note that the configuration must contain both $id and $basePath. throws yii\base\InvalidConfigException if either $id or $basePath configuration is missing.

console\Application runAction()

runAction() public method Runs a controller action specified by a route. This method parses the specified route and creates the corresponding child module(s), controller and action instances. It then calls yii\console\Controller::runAction() to run the action with the given parameters. If the route is empty, the method will use $defaultRoute. For example, to run public function actionTest($a, $b) assuming that the controller has options the following code should be used: \Yii::$app->runA

console\Application loadConfig()

loadConfig() protected method Loads the configuration. This method will check if the command line option OPTION_APPCONFIG is specified. If so, the corresponding file will be loaded as the application configuration. Otherwise, the configuration provided as the parameter will be returned back. protected array loadConfig ( $config )$config array The configuration provided in the constructor. return array The actual configuration to be used by the application.

console\Application handleRequest()

handleRequest() public method Handles the specified request. public yii\console\Response handleRequest ( $request )$request yii\console\Request The request to be handled return yii\console\Response The resulting response

console\Application getResponse()

getResponse() public method Returns the response component. public yii\console\Response getResponse ( )return yii\console\Response The response component.

console\Application init()

init() public method Initialize the application. public void init ( )