CConsoleCommandRunner
| 包 | system.console |
|---|---|
| 继承 | class CConsoleCommandRunner » CComponent |
| 可用自 | 1.0 |
| 版本 | $Id$ |
CConsoleCommandRunner manages commands and executes the requested command.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| commands | array | list of all available commands (command name=>command configuration). | CConsoleCommandRunner |
| scriptName | string | the entry script name | CConsoleCommandRunner |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __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 |
| addCommands() | Adds commands from the specified command path. | CConsoleCommandRunner |
| 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 |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| createCommand() | CConsoleCommandRunner | |
| 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 |
| findCommands() | Searches for commands under the specified directory. | CConsoleCommandRunner |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getScriptName() | CConsoleCommandRunner | |
| 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 |
| raiseEvent() | Raises an event. | CComponent |
| run() | Executes the requested command. | CConsoleCommandRunner |
属性详情
commands
属性
public array $commands;
list of all available commands (command name=>command configuration). Each command configuration can be either a string or an array. If the former, the string should be the class name or class path alias of the command. If the latter, the array must contain a 'class' element which specifies the command's class name or class path alias. The rest name-value pairs in the array are used to initialize the corresponding command properties. For example,
array(
'email'=>array(
'class'=>'path.to.Mailer',
'interval'=>3600,
),
'log'=>'path.to.LoggerCommand',
)
scriptName
属性
只读
public string getScriptName()
the entry script name
方法详情
addCommands()
方法
|
public void addCommands(string $path)
| ||
| $path | string | the alias of the directory containing the command class files. |
Adds commands from the specified command path. If a command already exists, the new one will be ignored.
createCommand()
方法
|
public CConsoleCommand createCommand(string $name)
| ||
| $name | string | command name (case-insensitive) |
| {return} | CConsoleCommand | the command object. Null if the name is invalid. |
findCommands()
方法
|
public array findCommands(string $path)
| ||
| $path | string | the directory containing the command class files. |
| {return} | array | list of commands (command name=>command class file) |
Searches for commands under the specified directory.
getScriptName()
方法
|
public string getScriptName()
| ||
| {return} | string | the entry script name |
run()
方法
|
public void run(array $args)
| ||
| $args | array | list of user supplied parameters (including the entry script name and the command name). |
Executes the requested command.