getActionOptionsHelp() public method Returns the help information for the options for the action. The returned value should be an array. The keys are the option names, and the values are the corresponding help information. Each value must be an array of the following structure: type: string, the PHP type of this argument. default: string, the default value of this argument comment: string, the comment of this argument The default implementation will return the help information extracted fro

getActionMethodReflection() protected method protected ReflectionMethod getActionMethodReflection ( $action )$action yii\base\Action

getActionHelpSummary() public method Returns a one-line short summary describing the specified action. public string getActionHelpSummary ( $action )$action yii\base\Action Action to get summary for return string A one-line short summary describing the specified action.

getActionArgsHelp() public method Returns the help information for the anonymous arguments for the action. The returned value should be an array. The keys are the argument names, and the values are the corresponding help information. Each value must be an array of the following structure: required: boolean, whether this argument is required. type: string, the PHP type of this argument. default: string, the default value of this argument comment: string, the comment of this argument The defa

getActionHelp() public method Returns the detailed help information for the specified action. public string getActionHelp ( $action )$action yii\base\Action Action to get help for return string The detailed help information for the specified action.

confirm() public method Asks user to confirm by typing y or n. public boolean confirm ( $message, $default = false )$message string To echo out before waiting for user input $default boolean This value is returned if no selection is made. return boolean Whether user confirmed. Will return true if $interactive is false.

ansiFormat() public method Formats a string with ANSI codes You may pass additional parameters using the constants defined in yii\helpers\Console. Example: echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE); public string ansiFormat ( $string )$string string The string to be formatted

bindActionParams() public method Binds the parameters to the action. This method is invoked by yii\base\Action when it begins to run with the given parameters. This method will first bind the parameters with the options available to the action. It then validates the given arguments. public array bindActionParams ( $action, $params )$action yii\base\Action The action to be bound with parameters $params array The parameters to be bound to the action return array The valid parameters th

$passedOptionValues public read-only property The properties corresponding to the passed options public array getPassedOptionValues ( )

$interactive public property Whether to run the command interactively. public boolean $interactive = true