Class CHelpCommand

CHelpCommand represents a console help command.

CHelpCommand displays the available command list or the help instructions about a specific command.

To use this command, enter the following on the command line:

php path/to/entry_script.php help [command name]

In the above, if the command name is not provided, it will display all available commands.

CComponent

CConsoleCommand

CHelpCommand

Package: system\console
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/console/CHelpCommand.php

Methods summary
`public integer`	# `run( array $args )` Execute the action. Execute the action. Parameters `$args` `array` $args command line parameters specific for this command Returns `integer` non zero application exit code after printing help Overrides `CConsoleCommand::run()`
`public string`	# `getHelp( )` Provides the command description. Provides the command description. Returns `string` the command description. Overrides `CConsoleCommand::getHelp()`

Methods inherited from CConsoleCommand
`__construct(), afterAction(), beforeAction(), behaviors(), buildFileList(), confirm(), copyFiles(), ensureDirectory(), getCommandRunner(), getName(), getOptionHelp(), init(), onAfterAction(), onBeforeAction(), pluralize(), prompt(), renderFile(), resolveRequest(), usageError()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties inherited from CConsoleCommand
`$defaultAction`

Magic properties summary
`public string`	`$help`	# The command description. The command description.

Magic properties inherited from CConsoleCommand
`$commandRunner, $name, $optionHelp`