CConsoleCommandEvent
| 包 | system.console |
|---|---|
| 继承 | class CConsoleCommandEvent » CEvent » CComponent |
| 可用自 | 1.1.11 |
| 源码 | framework/console/CConsoleCommandEvent.php |
CConsoleCommandEvent class.
CConsoleCommandEvent represents the event parameters needed by events raised by a console command.
CConsoleCommandEvent represents the event parameters needed by events raised by a console command.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| action | string | the action name | CConsoleCommandEvent |
| exitCode | integer | exit code of application. | CConsoleCommandEvent |
| handled | boolean | whether the event is handled. | CEvent |
| params | mixed | additional event parameters. | CEvent |
| sender | object | the sender of this event | CEvent |
| stopCommand | boolean | whether the action should be executed. | CConsoleCommandEvent |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CConsoleCommandEvent |
| __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 |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| 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 |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| 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 |
属性详情
action
属性
public string $action;
the action name
exitCode
属性
public integer $exitCode;
exit code of application. This property is available in CConsoleCommand::onAfterAction event and will be set to the exit code returned by the console command action. You can set it to change application exit code.
stopCommand
属性
public boolean $stopCommand;
whether the action should be executed. If this property is set true by the event handler, the console command action will quit after handling this event. If false, which is the default, the normal execution cycles will continue, including performing the action and calling CConsoleCommand::afterAction.
方法详情
__construct()
方法
|
public void __construct(mixed $sender=NULL, string $params=NULL, string $action=NULL, integer $exitCode=0)
| ||
| $sender | mixed | sender of the event |
| $params | string | the parameters to be passed to the action method. |
| $action | string | the action name |
| $exitCode | integer | the application exit code |
源码： framework/console/CConsoleCommandEvent.php#47 (显示)
public function __construct($sender=null,$params=null,$action=null,$exitCode=0){
parent::__construct($sender,$params);
$this->action=$action;
$this->exitCode=$exitCode;
}
Constructor.