Method | Description | |
---|---|---|
actionIndex ( string $command = null ) : integer | Displays available commands or the detailed information about a particular command. | |
getActions ( |
Returns all available actions of the specified controller. | |
getCommands ( ) : array | Returns all available command names. |
Method | Description | |
---|---|---|
formatOptionAliases ( |
||
formatOptionHelp ( string $name, boolean $required, string $type, mixed $defaultValue, string $comment ) : string | Generates a well-formed string for an argument or option. | |
getCommandDescriptions ( ) : array | Returns an array of commands an their descriptions. | |
getCommandHelp ( |
Displays the overall information of the command. | |
getDefaultHelp ( ) | Displays all available commands. | |
getDefaultHelpHeader ( ) : string | Return a default help header. | |
getModuleCommands ( |
Returns available commands of a specified module. | |
getScriptName ( ) : string | ||
getSubCommandHelp ( |
Displays the detailed information of a command action. | |
validateControllerClass ( string $controllerClass ) : boolean | Validates if the given class is a valid console controller class. |
public actionIndex ( string $command = null ) : integer | ||
$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 |
protected formatOptionAliases ( |
||
$controller | the controller instance | |
$option | string | the option name |
return | string | the formatted string for the alias argument or option |
protected formatOptionHelp ( string $name, boolean $required, string $type, mixed $defaultValue, string $comment ) : string | ||
$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 the argument or option |
public getActions ( |
||
$controller | the controller instance | |
return | array | all available action IDs. |
protected getCommandDescriptions ( ) : array | ||
return | array | all available commands as keys and their description as values. |
protected getCommandHelp ( |
||
$controller | the controller instance |
public getCommands ( ) : array | ||
return | array | all available command names |
protected getDefaultHelpHeader ( ) : string | ||
return | string | default help header. |
protected getModuleCommands ( |
||
$module | the module instance | |
return | array | the available command names |
protected getScriptName ( ) : string | ||
return | string | the name of the cli script currently running. |
protected getSubCommandHelp ( |
||
$controller | the controller instance | |
$actionID | string | action ID |
protected validateControllerClass ( string $controllerClass ) : boolean | ||
$controllerClass | string | |
return | boolean |