CModelBehavior
| Package | system.base |
|---|---|
| Inheritance | class CModelBehavior » CBehavior » CComponent |
| Implements | IBehavior |
| Subclasses | CActiveRecordBehavior |
| Version | $Id: CModelBehavior.php 3515 2011-12-28 12:29:24Z mdomba $ |
| Source Code | framework/base/CModelBehavior.php |
CModelBehavior is a base class for behaviors that are attached to a model component.
The model should extend from CModel or its child classes.
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 |
| afterConstruct() | Responds to CModel::onAfterConstruct event. | CModelBehavior |
| afterValidate() | Responds to CModel::onAfterValidate event. | CModelBehavior |
| 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 |
| beforeValidate() | Responds to CModel::onBeforeValidate event. | CModelBehavior |
| 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. | CModelBehavior |
| 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 |
Method Details
afterConstruct()
method
|
public void afterConstruct(CEvent $event)
| ||
| $event | CEvent | event parameter |
Responds to CModel::onAfterConstruct event. Overrides this method if you want to handle the corresponding event of the owner.
afterValidate()
method
|
public void afterValidate(CEvent $event)
| ||
| $event | CEvent | event parameter |
Responds to CModel::onAfterValidate event. Overrides this method if you want to handle the corresponding event of the owner.
beforeValidate()
method
|
public void beforeValidate(CModelEvent $event)
| ||
| $event | CModelEvent | event parameter |
Responds to CModel::onBeforeValidate event. Overrides this method if you want to handle the corresponding event of the owner. You may set CModelEvent::isValid to be false to quit the validation process.
events()
method
|
public array events()
| ||
| {return} | array | events (array keys) and the corresponding event handler methods (array values). |
Source Code: framework/base/CModelBehavior.php#30 (show)
public function events()
{
return array(
'onAfterConstruct'=>'afterConstruct',
'onBeforeValidate'=>'beforeValidate',
'onAfterValidate'=>'afterValidate',
);
}
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.