CHelpCommand
Package | system.console |
---|---|
Inheritance | class CHelpCommand » CConsoleCommand » CComponent |
Since | 1.0 |
Source Code | framework/console/CHelpCommand.php |
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:
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.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
commandRunner | CConsoleCommandRunner | the command runner instance | CConsoleCommand |
defaultAction | string | the name of the default action. | CConsoleCommand |
help | string | Provides the command description. | CHelpCommand |
name | string | the command name. | CConsoleCommand |
optionHelp | array | Provides the command option help information. | CConsoleCommand |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | CComponent |
__construct() | Constructor. | CConsoleCommand |
__get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
__isset() | Checks if a property value is null. | CComponent |
__set() | Sets value of a component property. | CComponent |
__unset() | Sets a component property to be null. | CComponent |
asa() | Returns the named behavior object. | CComponent |
attachBehavior() | Attaches a behavior to this component. | CComponent |
attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
attachEventHandler() | Attaches an event handler to an event. | CComponent |
behaviors() | Returns a list of behaviors that this command should behave as. | CConsoleCommand |
buildFileList() | Builds the file list of a directory. | CConsoleCommand |
canGetProperty() | Determines whether a property can be read. | CComponent |
canSetProperty() | Determines whether a property can be set. | CComponent |
confirm() | Asks user to confirm by typing y or n. | CConsoleCommand |
copyFiles() | Copies a list of files from one place to another. | CConsoleCommand |
detachBehavior() | Detaches a behavior from the component. | CComponent |
detachBehaviors() | Detaches all behaviors from the component. | CComponent |
detachEventHandler() | Detaches an existing event handler. | CComponent |
disableBehavior() | Disables an attached behavior. | CComponent |
disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
enableBehavior() | Enables an attached behavior. | CComponent |
enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
ensureDirectory() | Creates all parent directories if they do not exist. | CConsoleCommand |
evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
getCommandRunner() | Returns the command runner instance | CConsoleCommand |
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
getHelp() | Provides the command description. | CHelpCommand |
getName() | Returns the command name. | CConsoleCommand |
getOptionHelp() | Provides the command option help information. | CConsoleCommand |
hasEvent() | Determines whether an event is defined. | CComponent |
hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
hasProperty() | Determines whether a property is defined. | CComponent |
init() | Initializes the command object. | CConsoleCommand |
onAfterAction() | This event is raised after an action finishes execution. | CConsoleCommand |
onBeforeAction() | This event is raised before an action is to be executed. | CConsoleCommand |
pluralize() | Converts a word to its plural form. | CConsoleCommand |
prompt() | Reads input via the readline PHP extension if that's available, or fgets() if readline is not installed. | CConsoleCommand |
raiseEvent() | Raises an event. | CComponent |
renderFile() | Renders a view file. | CConsoleCommand |
run() | Execute the action. | CHelpCommand |
usageError() | Displays a usage error. | CConsoleCommand |
Protected Methods
Method | Description | Defined By |
---|---|---|
afterAction() | This method is invoked right after an action finishes execution. | CConsoleCommand |
beforeAction() | This method is invoked right before an action is to be executed. | CConsoleCommand |
resolveRequest() | Parses the command line arguments and determines which action to perform. | CConsoleCommand |
Events
Event | Description | Defined By |
---|---|---|
onBeforeAction | This event is raised before an action is to be executed. | CConsoleCommand |
onAfterAction | This event is raised after an action finishes execution. | CConsoleCommand |
Property Details
help property read-only
public string getHelp()
Provides the command description.
Method Details
getHelp() method
public string getHelp() | ||
{return} | string | the command description. |
Source Code: framework/console/CHelpCommand.php#72 (show)
public function getHelp()
{
return parent::getHelp().' [command-name]';
}
Provides the command description.
run() method
public integer run(array $args) | ||
$args | array | command line parameters specific for this command |
{return} | integer | non zero application exit code after printing help |
Source Code: framework/console/CHelpCommand.php#37 (show)
public function run($args)
{
$runner=$this->getCommandRunner();
$commands=$runner->commands;
if(isset($args[0]))
$name=strtolower($args[0]);
if(!isset($args[0]) || !isset($commands[$name]))
{
if(!empty($commands))
{
echo "Yii command runner (based on Yii v".Yii::getVersion().")\n";
echo "Usage: ".$runner->getScriptName()." <command-name> [parameters...]\n";
echo "\nThe following commands are available:\n";
$commandNames=array_keys($commands);
sort($commandNames);
echo ' - '.implode("\n - ",$commandNames);
echo "\n\nTo see individual command help, use the following:\n";
echo " ".$runner->getScriptName()." help <command-name>\n";
}
else
{
echo "No available commands.\n";
echo "Please define them under the following directory:\n";
echo "\t".Yii::app()->getCommandPath()."\n";
}
}
else
echo $runner->createCommand($name)->getHelp();
return 1;
}
Execute the action.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CHelpCommand