0 follower

CModelEvent

Package system.base
Inheritance class CModelEvent » CEvent » CComponent
Since 1.0
Version $Id$
Source Code framework/base/CModelEvent.php
CModelEvent class.

CModelEvent represents the event parameters needed by events raised by a model.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
handled boolean whether the event is handled. CEvent
isValid boolean whether the model is in valid status and should continue its normal method execution cycles. CModelEvent
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
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

isValid property
public boolean $isValid;

whether the model is in valid status and should continue its normal method execution cycles. Defaults to true. For example, when this event is raised in a CFormModel object when executing CModel::beforeValidate, if this property is false by the event handler, the CModel::validate method will quit after handling this event. If true, the normal execution cycles will continue, including performing the real validations and calling CModel::afterValidate.