# Class yii\console\controllers\HelpController

Inheritance | yii\console\controllers\HelpController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/HelpController.php

Provides help information about console commands.

This command displays the available command list in the application or the detailed instructions about using a specific command.

This command can be used as follows on command line:

    yii help [command name]

In the above, if the command name is not provided, all available commands will be displayed.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$action | yii\base\Action|null | The action that is currently being executed. | yii\base\Controller
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$color | boolean|null | Whether to enable ANSI color in the output. | yii\console\Controller
$commands | array | All available command names. This property is read-only. | yii\console\controllers\HelpController
$defaultAction | string | The ID of the action that is used when the action ID is not specified in the request. | yii\base\Controller
$help | boolean | Whether to display help information about current command. | yii\console\Controller
$helpSummary | string | This property is read-only. | yii\console\Controller
$id | string | The ID of this controller. | yii\base\Controller
$interactive | boolean | Whether to run the command interactively. | yii\console\Controller
$layout | null|string|false | The name of the layout to be applied to this controller's views. | yii\base\Controller
$module | yii\base\Module | The module that this controller belongs to. | yii\base\Controller
$modules | yii\base\Module[] | All ancestor modules that this controller is located within. This property is read-only. | yii\base\Controller
$passedOptionValues | array | The properties corresponding to the passed options. This property is read-only. | yii\console\Controller
$passedOptions | array | The names of the options passed during execution. This property is read-only. | yii\console\Controller
$request | yii\console\Request |  | yii\console\Controller
$response | yii\console\Response |  | yii\console\Controller
$route | string | The route (module ID, controller ID and action ID) of the current request. This property is read-only. | yii\base\Controller
$silentExitOnException | boolean|null | If true - script finish with `ExitCode::OK` in case of exception. | yii\console\Controller
$uniqueId | string | The controller ID that is prefixed with the module ID (if any). This property is read-only. | yii\base\Controller
$view | yii\base\View|yii\web\View | The view object that can be used to render views or view files. | yii\base\Controller
$viewPath | string | The directory containing the view files for this controller. | yii\base\Controller

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() |  | yii\base\Controller
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
actionIndex() | Displays available commands or the detailed information about a particular command. | yii\console\controllers\HelpController
actionList() | List all available controllers and actions in machine readable format. | yii\console\controllers\HelpController
actionListActionOptions() | List all available options for the $action in machine readable format. | yii\console\controllers\HelpController
actionUsage() | Displays usage information for $action. | yii\console\controllers\HelpController
actions() | Declares external actions for the controller. | yii\base\Controller
afterAction() | This method is invoked right after an action is executed. | yii\base\Controller
ansiFormat() | Formats a string with ANSI codes. | yii\console\Controller
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
beforeAction() | This method is invoked right before an action is executed. | yii\console\Controller
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
bindActionParams() | Binds the parameters to the action. | yii\console\Controller
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
confirm() | Asks user to confirm by typing y or n. | yii\console\Controller
createAction() | Creates an action based on the given action ID. | yii\base\Controller
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
findLayoutFile() | Finds the applicable layout file. | yii\base\Controller
getActionArgsHelp() | Returns the help information for the anonymous arguments for the action. | yii\console\Controller
getActionHelp() | Returns the detailed help information for the specified action. | yii\console\Controller
getActionHelpSummary() | Returns a one-line short summary describing the specified action. | yii\console\Controller
getActionOptionsHelp() | Returns the help information for the options for the action. | yii\console\Controller
getActions() | Returns all available actions of the specified controller. | yii\console\controllers\HelpController
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getCommands() | Returns all available command names. | yii\console\controllers\HelpController
getHelp() | Returns help information for this controller. | yii\console\Controller
getHelpSummary() | Returns one-line short summary describing this controller. | yii\console\Controller
getModules() | Returns all ancestor modules of this controller. | yii\base\Controller
getOptionValues() | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. | yii\console\Controller
getPassedOptionValues() | Returns the properties corresponding to the passed options. | yii\console\Controller
getPassedOptions() | Returns the names of valid options passed during execution. | yii\console\Controller
getRoute() | Returns the route of the current request. | yii\base\Controller
getUniqueId() | Returns the unique ID of the controller. | yii\base\Controller
getView() | Returns the view object that can be used to render views or view files. | yii\base\Controller
getViewPath() | Returns the directory containing view files for this controller. | yii\base\Controller
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\Controller
isColorEnabled() | Returns a value indicating whether ANSI color is enabled. | yii\console\Controller
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
optionAliases() | Returns option alias names. | yii\console\Controller
options() | 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. | yii\console\Controller
prompt() | Prompts the user for input and validates it. | yii\console\Controller
render() | Renders a view and applies layout if available. | yii\base\Controller
renderContent() | Renders a static string by applying a layout. | yii\base\Controller
renderFile() | Renders a view file. | yii\base\Controller
renderPartial() | Renders a view without applying layout. | yii\base\Controller
run() | Runs a request specified in terms of a route. | yii\base\Controller
runAction() | Runs an action with the specified action ID and parameters. | yii\console\Controller
select() | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. | yii\console\Controller
setView() | Sets the view object to be used by this controller. | yii\base\Controller
setViewPath() | Sets the directory that contains the view files. | yii\base\Controller
stderr() | Prints a string to STDERR. | yii\console\Controller
stdout() | Prints a string to STDOUT. | yii\console\Controller
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
bindInjectedParams() | Fills parameters based on types and names in action method signature. | yii\base\Controller
formatOptionAliases() |  | yii\console\controllers\HelpController
formatOptionHelp() | Generates a well-formed string for an argument or option. | yii\console\controllers\HelpController
getActionMethodReflection() |  | yii\console\Controller
getCommandDescriptions() | Returns an array of commands an their descriptions. | yii\console\controllers\HelpController
getCommandHelp() | Displays the overall information of the command. | yii\console\controllers\HelpController
getDefaultHelp() | Displays all available commands. | yii\console\controllers\HelpController
getDefaultHelpHeader() | Return a default help header. | yii\console\controllers\HelpController
getModuleCommands() | Returns available commands of a specified module. | yii\console\controllers\HelpController
getScriptName() |  | yii\console\controllers\HelpController
getSubCommandHelp() | Displays the detailed information of a command action. | yii\console\controllers\HelpController
parseDocCommentDetail() | Returns full description from the docblock. | yii\console\Controller
parseDocCommentSummary() | Returns the first line of docblock. | yii\console\Controller
parseDocCommentTags() | Parses the comment block into tags. | yii\console\Controller
validateControllerClass() | Validates if the given class is a valid console controller class. | yii\console\controllers\HelpController

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_AFTER_ACTION | yii\base\ActionEvent | An event raised right after executing a controller action. | yii\base\Controller
EVENT_BEFORE_ACTION | yii\base\ActionEvent | An event raised right before executing a controller action. | yii\base\Controller

## Constants

Hide inherited constants

Constant | Value | Description | Defined By
--- | --- | --- | ---
EXIT_CODE_ERROR | 1 | Deprecated since 2.0.13. Use yii\console\ExitCode::UNSPECIFIED_ERROR instead. | yii\console\Controller
EXIT_CODE_NORMAL | 0 | Deprecated since 2.0.13. Use yii\console\ExitCode::OK instead. | yii\console\Controller

## Property Details

$commands public property

All available command names. This property is read-only.

public array $commands = null

## Method Details

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

actionList() public method (available since version 2.0.11)

List all available controllers and actions in machine readable format.

This is used for shell completion.

public void actionList ( )

actionListActionOptions() public method (available since version 2.0.11)

List all available options for the $action in machine readable format.

This is used for shell completion.

public void actionListActionOptions ( $action )
$action | string | Route to action

actionUsage() public method (available since version 2.0.11)

Displays usage information for $action.

public void actionUsage ( $action )
$action | string | Route to action

formatOptionAliases() protected method (available since version 2.0.8)

protected string formatOptionAliases ( $controller, $option )
$controller | yii\console\Controller | The controller instance
$option | string | The option name
return | string | The formatted string for the alias argument or option

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 the argument or option

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.

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.

getCommandHelp() protected method

Displays the overall information of the command.

protected void getCommandHelp ( $controller )
$controller | yii\console\Controller | The controller instance

getCommands() public method

Returns all available command names.

public array getCommands ( )
return | array | All available command names

getDefaultHelp() protected method

Displays all available commands.

protected void getDefaultHelp ( )

getDefaultHelpHeader() protected method (available since version 2.0.11)

Return a default help header.

protected string getDefaultHelpHeader ( )
return | string | Default help header.

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

getScriptName() protected method

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

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

validateControllerClass() protected method

Validates if the given class is a valid console controller class.

protected boolean validateControllerClass ( $controllerClass )
$controllerClass | string |