CConsoleCommandBehavior
| 包 | system.console |
|---|---|
| 继承 | class CConsoleCommandBehavior » CBehavior » CComponent |
| 实现 | IBehavior |
| 可用自 | 1.1.11 |
| 源码 | framework/console/CConsoleCommandBehavior.php |
CConsoleCommandBehavior is a base class for behaviors that are attached to a console command component.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| enabled | boolean | 行为是否被启用。 | CBehavior |
| owner | CComponent | 此行为被连接到该所有者的组件。 | CBehavior |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __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 |
| asa() | Returns the named behavior object. | CComponent |
| attach() | 对组件附加行为对象。 | CBehavior |
| 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 |
| detach() | 从组件中分离行为对象。 | CBehavior |
| 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 |
| events() | Declares events and the corresponding event handler methods. | CConsoleCommandBehavior |
| getEnabled() | Returns 行为是否被启用。 | CBehavior |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getOwner() | Returns 此行为被连接到该所有者的组件。 | CBehavior |
| 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 |
| setEnabled() | Sets 行为是否被启用。 | CBehavior |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| afterAction() | Responds to CConsoleCommand::onAfterAction event. | CConsoleCommandBehavior |
| beforeAction() | Responds to CConsoleCommand::onBeforeAction event. | CConsoleCommandBehavior |
方法详情
afterAction()
方法
|
protected void afterAction(CConsoleCommandEvent $event)
| ||
| $event | CConsoleCommandEvent | event parameter |
Responds to CConsoleCommand::onAfterAction event. Override this method and make it public if you want to handle the corresponding event of the owner.
beforeAction()
方法
|
protected void beforeAction(CConsoleCommandEvent $event)
| ||
| $event | CConsoleCommandEvent | event parameter |
Responds to CConsoleCommand::onBeforeAction event. Override this method and make it public if you want to handle the corresponding event of the owner.
events()
方法
|
public array events()
| ||
| {return} | array | events (array keys) and the corresponding event handler methods (array values). |
源码： framework/console/CConsoleCommandBehavior.php#29 (显示)
public function events()
{
return array(
'onBeforeAction' => 'beforeAction',
'onAfterAction' => 'afterAction'
);
}
Declares events and the corresponding event handler methods. The default implementation returns 'onAfterConstruct', 'onBeforeValidate' and 'onAfterValidate' events and handlers. If you override this method, make sure you merge the parent result to the return value.