Yii: attaching events to models

Question

I have a User model which is bundled in a module installed on my Yii application. This module is third party and I do not want to alter its code.

I also have a Cv Model that has a BELONGS_TO relation with the User model.

My question is: How can I delete the cv when a user is deleted ? I know that I can achieve this with on delete cascade ... on mysql. However, i do need to delete other data such as a photo, files, etc.

What I have tried

I have created a component that is preloaded on my application. This component attaches to an onAfterDelete event

class EventListener extends CComponent 
{
    public function init() {

        Yii::import("application.modules.users.models.User");

        User::model()->attachEventHandler('onAfterDelete', array($this, 'deleteUser'));
    }


    public function deleteUser($event)
    {
        // stuff here ...
    }
}

However this does not work.

Any suggestions ?

Look any 'on%' method in User's class and it's parents for know which events this model supports. — Sergey, Sep 25 '12 at 11:23
I usually create new class `myUser` extends `User` where I write down my onAfterDelete — Sergey, Sep 25 '12 at 11:26
@Sergey When a User model is deleted, isn't onAfterDelete event raised automatically? — antoniom, Sep 25 '12 at 11:41

score 2 · Accepted Answer · answered Sep 25 '12 at 11:43

2

This may help you.

User::model() is a singleton

$user1 = User::model();
$user2 = new User; // will be used in insert action
$user3 = User::model()->findByPk(10); // will be used in update/delete action

$user1, $user2 and $user3 are completely different objects. You can attach events to objects, in this case you have to add events to all these 3 objects individually.

$user1->attachEventHandler(...);
$user2->attachEventHandler(...);
$user3->attachEventHandler(...);

look like Yii does not provide any way to add events at Class level.

answered Sep 25 '12 at 11:43

SuVeRa

2,784
2
20
27

ok, I have reached to the same conclusion, but is there any way to attach an event handler to EVERY model created, without altering the base User model? – antoniom Sep 25 '12 at 11:45
1

However, you could run the attachEventHandler() on the ->init() method of the User model class, so EVERY user model would have the event handler attached. – Michael Butler Mar 26 '15 at 17:53

score 1 · Answer 2 · answered Apr 03 '16 at 18:32

Well, guys, I have just stumbled upon the same problem and I solved it this way:

You should use the init() of a Model, not your event listener collection class.

In my case I have devModel class:

    public function init()
{
    parent::init(); 
    $this->onLicenseUpdated = array(new MEventProcessor, 'licenseUpdateHandler');
}

And the handler is licenseUpdateHandler($event) in a MEventProcessor class.

This way every time you work with model instance, it'll call init() for every object and attach the event handler to every instance of this Model.

Now any time the event (in my case onLicenseUpdated()) is invoked for the model - the handler will be called too.

score 0 · Answer 3 · answered Oct 06 '15 at 18:11

You could also to use Behaviors.

1 - behaviors can listen to events : you just have to override their events() method

class MyBehavior extends Behavior {

public function events() {
    return [
        ActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate',
    ];
}

public function beforeValidate($event) {
    // ...
}

}

2 - although it is more common to attach a behavior to a component in the component's behaviors() method, you can also attach them dynamically and keep the original code unmodified :

use app\components\MyBehavior;

 // attach a behavior object

 $component->attachBehavior('myBehavior1', new MyBehavior);

You will find some useful documentation here :

Yii: attaching events to models

3 Answers3