Versions
Look up a class, method, property or event

CEvent

Package system.base
Inheritance class CEvent » CComponent
Subclasses CConsoleCommandEvent, CErrorEvent, CExceptionEvent, CMissingTranslationEvent, CModelEvent, COutputEvent
Since 1.0
Source Code framework/base/CComponent.php
CEvent is the base class for all event classes.

It encapsulates the parameters associated with an event. The sender property describes who raises the event. And the handled property indicates if the event is handled. If an event handler sets handled to true, those handlers that are not invoked yet will not be invoked anymore.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
handled boolean whether the event is handled. CEvent
params mixed additional event parameters. CEvent
sender object the sender of this event CEvent

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CEvent
__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

Property Details

handled property
public boolean $handled;

whether the event is handled. Defaults to false. When a handler sets this true, the rest of the uninvoked event handlers will not be invoked anymore.

params property (available since v1.1.7)
public mixed $params;

additional event parameters.

sender property
public object $sender;

the sender of this event

Method Details

__construct() method
public void __construct(mixed $sender=NULL, mixed $params=NULL)
$sender mixed sender of the event
$params mixed additional parameters for the event
Source Code: framework/base/CComponent.php#658 (show)
public function __construct($sender=null,$params=null)
{
    
$this->sender=$sender;
    
$this->params=$params;
}

Constructor.

Be the first person to leave a comment

Please to leave your comment.