0 follower

CActiveRecordBehavior

Package system.db.ar
Inheritance class CActiveRecordBehavior » CModelBehavior » CBehavior » CComponent
Implements IBehavior
Subclasses CTimestampBehavior
Source Code framework/db/ar/CActiveRecordBehavior.php
CActiveRecordBehavior is the base class for behaviors that can be attached to CActiveRecord. Compared with CModelBehavior, CActiveRecordBehavior attaches to more events that are only defined by CActiveRecord.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
enabled boolean whether this behavior is enabled CBehavior
owner CComponent the owner component that this behavior is attached to. CBehavior

Public Methods

Hide inherited methods

MethodDescriptionDefined 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. CActiveRecordBehavior
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

Hide inherited methods

MethodDescriptionDefined By
afterConstruct() Responds to CModel::onAfterConstruct event. CModelBehavior
afterDelete() Responds to CActiveRecord::onAfterDelete event. CActiveRecordBehavior
afterFind() Responds to CActiveRecord::onAfterFind event. CActiveRecordBehavior
afterSave() Responds to CActiveRecord::onAfterSave event. CActiveRecordBehavior
afterValidate() Responds to CModel::onAfterValidate event. CModelBehavior
beforeCount() Responds to CActiveRecord::onBeforeCount event. CActiveRecordBehavior
beforeDelete() Responds to CActiveRecord::onBeforeDelete event. CActiveRecordBehavior
beforeFind() Responds to CActiveRecord::onBeforeFind event. CActiveRecordBehavior
beforeSave() Responds to CActiveRecord::onBeforeSave event. CActiveRecordBehavior
beforeValidate() Responds to CModel::onBeforeValidate event. CModelBehavior

Method Details

afterDelete() method
protected void afterDelete(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#80 (show)
protected function afterDelete($event)
{
}

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

afterFind() method
protected void afterFind(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#100 (show)
protected function afterFind($event)
{
}

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

afterSave() method
protected void afterSave(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#59 (show)
protected function afterSave($event)
{
}

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

beforeCount() method (available since v1.1.14)
protected void beforeCount(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#111 (show)
protected function beforeCount($event)
{
}

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

beforeDelete() method
protected void beforeDelete(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#70 (show)
protected function beforeDelete($event)
{
}

Responds to CActiveRecord::onBeforeDelete event. Override this method and make it public if you want to handle the corresponding event of the owner. You may set CModelEvent::isValid to be false to quit the deletion process.

beforeFind() method
protected void beforeFind(CEvent $event)
$event CEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#90 (show)
protected function beforeFind($event)
{
}

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

beforeSave() method
protected void beforeSave(CModelEvent $event)
$event CModelEvent event parameter
Source Code: framework/db/ar/CActiveRecordBehavior.php#49 (show)
protected function beforeSave($event)
{
}

Responds to CActiveRecord::onBeforeSave event. Override this method and make it public if you want to handle the corresponding event of the owner. You may set CModelEvent::isValid to be false to quit the saving process.

events() method
public array events()
{return} array events (array keys) and the corresponding event handler methods (array values).
Source Code: framework/db/ar/CActiveRecordBehavior.php#29 (show)
public function events()
{
    return array_merge(parent::events(), array(
        'onBeforeSave'=>'beforeSave',
        'onAfterSave'=>'afterSave',
        'onBeforeDelete'=>'beforeDelete',
        'onAfterDelete'=>'afterDelete',
        'onBeforeFind'=>'beforeFind',
        'onAfterFind'=>'afterFind',
        'onBeforeCount'=>'beforeCount',
    ));
}

Declares events and the corresponding event handler methods. If you override this method, make sure you merge the parent result to the return value.

See Also