console\controllers\HelpController getSubCommandHelp()

getSubCommandHelp() protected method Displays the detailed information of a command action. protected void getSubCommandHelp ( $controller, $actionID )$controller yii\console\Controller The controller instance $actionID string Action ID throws yii\console\Exception if the action does not exist

console\controllers\HelpController getScriptName()

getScriptName() protected method protected string getScriptName ( )return string The name of the cli script currently running.

console\controllers\HelpController getCommandHelp()

getCommandHelp() protected method Displays the overall information of the command. protected void getCommandHelp ( $controller )$controller yii\console\Controller The controller instance

console\controllers\HelpController getCommands()

getCommands() public method Returns all available command names. public array getCommands ( )return array All available command names

console\controllers\HelpController getDefaultHelp()

getDefaultHelp() protected method Displays all available commands. protected void getDefaultHelp ( )

console\controllers\HelpController getModuleCommands()

getModuleCommands() protected method Returns available commands of a specified module. protected array getModuleCommands ( $module )$module yii\base\Module The module instance return array The available command names

console\controllers\HelpController formatOptionHelp()

formatOptionHelp() protected method Generates a well-formed string for an argument or option. protected string formatOptionHelp ( $name, $required, $type, $defaultValue, $comment )$name string The name of the argument or option $required boolean Whether the argument is required $type string The type of the option or argument $defaultValue mixed The default value of the option or argument $comment string Comment about the option or argument return string The formatted string for

console\controllers\HelpController getCommandDescriptions()

getCommandDescriptions() protected method Returns an array of commands an their descriptions. protected array getCommandDescriptions ( )return array All available commands as keys and their description as values.

console\controllers\HelpController getActions()

getActions() public method Returns all available actions of the specified controller. public array getActions ( $controller )$controller yii\console\Controller The controller instance return array All available action IDs.

console\controllers\HelpController actionIndex()

actionIndex() public method Displays available commands or the detailed information about a particular command. public integer actionIndex ( $command = null )$command string The name of the command to show help about. If not provided, all available commands will be displayed. return integer The exit status throws yii\console\Exception if the command for help is unknown