CHelpCommand
| Package | system.console |
|---|---|
| Inheritance | class CHelpCommand » CConsoleCommand » CComponent |
| Since | 1.0 |
| Version | $Id: CHelpCommand.php 1678 2010-01-07 21:02:00Z qiang.xue $ |
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 |
| help | string | Provides the command description. | CHelpCommand |
| name | string | the command name. | 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 |
| 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 |
| 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() | CConsoleCommand | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getHelp() | Provides the command description. | CHelpCommand |
| getName() | 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 |
| pluralize() | Converts a word to its plural form. | CConsoleCommand |
| raiseEvent() | Raises an event. | CComponent |
| renderFile() | Renders a view file. | CConsoleCommand |
| run() | Execute the action. | CHelpCommand |
| usageError() | Displays a usage error. | 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. |
Provides the command description.
run()
method
|
public void run(array $args)
| ||
| $args | array | command line parameters specific for this command |
Execute the action.