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);

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.

confirm() public method

Asks user to confirm by typing y or n.

A typical usage looks like the following:

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}

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 default implementation will return the help information extracted from the doc-comment of the parameters corresponding to the action method.

getActionHelp() public method

Returns the detailed help information for the specified action.

getActionHelpSummary() public method

Returns a one-line short summary describing the specified action.

getActionMethodReflection() protected method

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 from the doc-comment of the properties corresponding to the action options.

getHelp() public method

Returns help information for this controller.

You may override this method to return customized help. The default implementation returns help information retrieved from the PHPDoc comment.

getHelpSummary() public method

Returns one-line short summary describing this controller.

You may override this method to return customized summary. The default implementation returns first line from the PHPDoc comment.

getOptionValues() public method

Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.

getPassedOptionValues() public method

Returns the properties corresponding to the passed options

getPassedOptions() public method

Returns the names of valid options passed during execution.

isColorEnabled() public method

Returns a value indicating whether ANSI color is enabled.

ANSI color is enabled only if $color is set true or is not set and the terminal supports ANSI color.

optionAliases() public method (available since version 2.0.8)

Returns option alias names.

Child classes may override this method to specify alias options.

See also options().

options() public method

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

parseDocCommentDetail() protected method

Returns full description from the docblock.

parseDocCommentSummary() protected method

Returns the first line of docblock.

parseDocCommentTags() protected method

Parses the comment block into tags.

prompt() public method

Prompts the user for input and validates it

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);

runAction() public method

Runs an action with the specified action ID and parameters.

If the action ID is empty, the method will use $defaultAction.

See also createAction().

select() public method

Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.

stderr() public method

Prints a string to STDERR

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console.

Example:

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

stdout() public method

Prints a string to STDOUT

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console.

Example:

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);