HelpController

API reference › yii › console › controllers › HelpController

class	yii\console\controllers\HelpController
Extends	yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements	yii\base\ViewContextInterface, yii\base\Configurable
Since	2.0
Source	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.

Properties

Property	Type	Description	Defined by
$action	yii\base\Action<static>|null	The action that is currently being executed. Default: null.	yii\base\Controller
$behaviors read-only	array<yii\base\Behavior<static>>	List of behaviors attached to this component.	yii\base\Component
$color	bool|null	Whether to enable ANSI color in the output. Default: null.	yii\console\Controller
$commands read-only	array	All available command names.	HelpController
$defaultAction	string	The ID of the action that is used when the action ID is not specified in the request. Default: 'index'.	yii\base\Controller
$help	bool	Whether to display help information about current command. Default: false. Available since 2.0.10.	yii\console\Controller
$helpSummary read-only	string	The one-line short summary describing this controller.	yii\console\Controller
$id	string	The ID of this controller. Default: null.	yii\base\Controller
$interactive	bool	Whether to run the command interactively. Default: true.	yii\console\Controller
$layout	string|null|false	The name of the layout to be applied to this controller’s views. Default: null.	yii\base\Controller
$module	yii\base\T	The module that this controller belongs to. Default: null.	yii\base\Controller
$modules read-only	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$passedOptions read-only	array	The names of the options passed during execution.	yii\console\Controller
$passedOptionValues read-only	array	The properties corresponding to the passed options.	yii\console\Controller
$request	yii\console\Request	The request object.	yii\console\Controller
$response	yii\console\Response	The response object.	yii\console\Controller
$route read-only	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$silentExitOnException	bool|null	If true - script finish with ExitCode::OK in case of exception. false - ExitCode::UNSPECIFIED_ERROR. Default: null. Available since 2.0.36.	yii\console\Controller
$uniqueId read-only	string	The controller ID that is prefixed with the module ID (if any).	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

Methods

Method	Description	Defined by
__construct()		yii\base\Controller
__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
__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.	HelpController
actionList()	List all available controllers and actions in machine readable format.	HelpController
actionListActionOptions()	List all available options for the $action in machine readable format.	HelpController
actions()	Declares external actions for the controller.	yii\base\Controller
actionUsage()	Displays usage information for $action.	HelpController
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() static	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.	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.	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
getPassedOptions()	Returns the names of valid options passed during execution.	yii\console\Controller
getPassedOptionValues()	Returns the properties corresponding to the passed options.	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
bindInjectedParams() protected final	Fills parameters based on types and names in action method signature.	yii\base\Controller
formatOptionAliases() protected		HelpController
formatOptionHelp() protected	Generates a well-formed string for an argument or option.	HelpController
getActionMethodReflection() protected		yii\console\Controller
getCommandDescriptions() protected	Returns an array of commands an their descriptions.	HelpController
getCommandHelp() protected	Displays the overall information of the command.	HelpController
getDefaultHelp() protected	Displays all available commands.	HelpController
getDefaultHelpHeader() protected	Return a default help header.	HelpController
getModuleCommands() protected	Returns available commands of a specified module.	HelpController
getScriptName() protected		HelpController
getSubCommandHelp() protected	Displays the detailed information of a command action.	HelpController
parseDocCommentDetail() protected	Returns full description from the docblock.	yii\console\Controller
parseDocCommentSummary() protected	Returns the first line of docblock.	yii\console\Controller
parseDocCommentTags() protected	Parses the comment block into tags.	yii\console\Controller
validateControllerClass() protected	Validates if the given class is a valid console controller class.	HelpController

Events

Event	Type	Description	Defined by
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised right before executing a controller action. Event name: 'beforeAction'.	yii\base\Controller
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised right after executing a controller action. Event name: 'afterAction'.	yii\base\Controller

Method details

actionIndex()

public function actionIndex(string|null $command = null): int

Displays available commands or the detailed information about a particular command.

Parameters

Parameter	Type	Description
$command	string|null	The name of the command to show help about. If not provided, all available commands will be displayed.

Returns

int: The exit status

Throws

• yii\console\Exception: if the command for help is unknown

actionList()

public function actionList(): mixed

List all available controllers and actions in machine readable format.

This is used for shell completion.

Returns

mixed

Since

2.0.11

actionListActionOptions()

public function actionListActionOptions(string $action): mixed

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

This is used for shell completion.

Parameters

Parameter	Type	Description
$action	string	Route to action

Returns

mixed

Since

2.0.11

actionUsage()

public function actionUsage(string $action): mixed

Displays usage information for $action.

Parameters

Parameter	Type	Description
$action	string	Route to action

Returns

mixed

Since

2.0.11

getActions()

public function getActions(yii\console\Controller $controller): array

Returns all available actions of the specified controller.

Parameters

Parameter	Type	Description
$controller	yii\console\Controller	The controller instance

Returns

array: All available action IDs.

getCommands()

public function getCommands(): array

Returns all available command names.

Returns

array: All available command names

formatOptionAliases()

protected function formatOptionAliases(yii\console\Controller $controller, string $option): string

Parameters

Parameter	Type	Description
$controller	yii\console\Controller	The controller instance
$option	string	The option name

Returns

string: The formatted string for the alias argument or option

Since

2.0.8

formatOptionHelp()

protected function formatOptionHelp(string $name, bool $required, string $type, mixed $defaultValue, string $comment): string

Generates a well-formed string for an argument or option.

Parameters

Parameter	Type	Description
$name	string	The name of the argument or option
$required	bool	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

Returns

string: The formatted string for the argument or option

getCommandDescriptions()

protected function getCommandDescriptions(): array

Returns an array of commands an their descriptions.

Returns

array: All available commands as keys and their description as values.

getCommandHelp()

protected function getCommandHelp(yii\console\Controller $controller): mixed

Displays the overall information of the command.

Parameters

Parameter	Type	Description
$controller	yii\console\Controller	The controller instance

Returns

mixed

getDefaultHelp()

protected function getDefaultHelp(): mixed

Displays all available commands.

Returns

mixed

getDefaultHelpHeader()

protected function getDefaultHelpHeader(): string

Return a default help header.

Returns

string: Default help header.

Since

2.0.11

getModuleCommands()

protected function getModuleCommands(yii\base\Module $module): array

Returns available commands of a specified module.

Parameters

Parameter	Type	Description
$module	yii\base\Module	The module instance

Returns

array: The available command names

getScriptName()

protected function getScriptName(): string

Returns

string: The name of the cli script currently running.

getSubCommandHelp()

protected function getSubCommandHelp(yii\console\Controller $controller, string $actionID): mixed

Displays the detailed information of a command action.

Parameters

Parameter	Type	Description
$controller	yii\console\Controller	The controller instance
$actionID	string	Action ID

Returns

mixed

Throws

• yii\console\Exception: if the action does not exist

validateControllerClass()

protected function validateControllerClass(string $controllerClass): bool

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

Parameters

Parameter	Type	Description
$controllerClass	string

Returns

bool