sbooker/yii2-event-component

Attaches events to all models

2.0.2 2017-06-09 08:16 UTC

BSD-3-Clause

• Serge Booker

• event
• extension
• yii2

README

Attaches events to all application models in a very simple way. You just list your event handlers in config/_events.php this way: [ 'event\sender\ClassName' => [ 'eventName' => [ 'event\handler\ClassName' => 'methodName' ] ] ];

See example below.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist sbooker/yii2-event-component "*"

or add

"sbooker/yii2-event-component": "*"

to the require section of your composer.json file.

Usage

    Define app component in main config components section like in this example: 
    'components' => [
    ...
          'eventManager'=> [
              'class'     => 'bariew\eventManager\EventManager',
              'events'    => [
                  'app\models\User' => [
                      'afterInsert' => [
                          ['app\models\Email', 'userRegistration'],
                          'eventQueue',
                      ],  
                  ]
              ],
              'handlers' => [
                  'eventQueue' => function (Event $event) {
                      \Yii::$app->eventQueue->push($event);
                  }  
              ]
          ],
    ]

    Explanation: in the example we defined that after creating new User model ('afterInsert')
    Email::userRegistration($event) method will be called.

    Since 1.1.0 you may also not define event manager, but just put _events.php
    into your config folder returning the same 'events' array as in example:

    <?php
    return [
        'app\models\User' => [
            'afterInsert' => [
                ['app\models\Email', 'userRegistration']
            ],
        ]
    ];

    since 1.3.0 handler can also keep additional data and $append boolean as for Event::on() method eg:
    ... [$handlerClassName, $handlerMethodName, ['myData'], false]