CConsoleCommandBehavior

Package	system.console
Inheritance	class CConsoleCommandBehavior » CBehavior » CComponent
Implements	IBehavior
Since	1.1.11
Source Code	framework/console/CConsoleCommandBehavior.php

CConsoleCommandBehavior is a base class for behaviors that are attached to a console command component.

Public Properties

Property	Type	Description	Defined By
enabled	boolean	whether this behavior is enabled	CBehavior
owner	CComponent	the owner component that this behavior is attached to.	CBehavior

Public Methods

Method	Description	Defined By
__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()	Attaches the behavior object to the component.	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()	Detaches the behavior object from the component.	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 whether this behavior is enabled	CBehavior
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getOwner()	Returns the owner component that this behavior is attached to.	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 whether this behavior is enabled	CBehavior

Protected Methods

Method	Description	Defined By
afterAction()	Responds to CConsoleCommand::onAfterAction event.	CConsoleCommandBehavior
beforeAction()	Responds to CConsoleCommand::onBeforeAction event.	CConsoleCommandBehavior

Method Details

afterAction() method

protected void afterAction(CConsoleCommandEvent $event)
$event	CConsoleCommandEvent	event parameter

Source Code: framework/console/CConsoleCommandBehavior.php#50 (show)

protected function afterAction($event)
{
}

Responds to CConsoleCommand::onAfterAction event. Override this method and make it public if you want to handle the corresponding event of the owner.

beforeAction() method

protected void beforeAction(CConsoleCommandEvent $event)
$event	CConsoleCommandEvent	event parameter

Source Code: framework/console/CConsoleCommandBehavior.php#41 (show)

protected function beforeAction($event)
{
}

Responds to CConsoleCommand::onBeforeAction event. Override this method and make it public if you want to handle the corresponding event of the owner.

events() method

public array events()
{return}	array	events (array keys) and the corresponding event handler methods (array values).

Source Code: framework/console/CConsoleCommandBehavior.php#29 (show)

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.