yiicod/yii2-listener

The simple and powerful event listener for the Yii2 framework

1.0.7 2018-04-09 20:21 UTC

Requires

• symfony/finder: ~3.0|~4.0
• yiisoft/yii2: 2.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.1

MIT

• Alexey Orlov

README

Provides listener logic. Command parses chosen paths to find all listener/subscribers (depends on ListenerInterface and SubscriberInterface implementation). Where listener can be used for single event and subscriber can be used for bunch of events.

Installation

Either run

php composer.phar require --prefer-dist yiicod/yii2-listener "*"

or add

"yii2-listener": "*"

to your composer.json file

Web config

'bootstrap' => ['listener'],
'components' => [
    'listener' => [
        'class' => 'yiicod\listener\components\Listener'
    ],
]

Console config

'controllerMap' => [
    'listener' => [
        'class' => \yiicod\listener\commands\Listener::class
    ],
]

Run command. This command will warm and prepare all listeners and subscriptions. Run this command each time when you create new Listener or Subscription.

listener/parse

For trigger event use yii manual: http://www.yiiframework.com/doc-2.0/guide-concept-events.html#class-level-event-handlers

Listener usage

namespace frontend\observers\listeners;

use yii\db\ActiveRecord;
use yiicod\listener\components\listeners\ListenerAbstract;

class TestListener extends ListenerAbstract
{
   /**
    * Call on event method
    */
   public function handle($event)
   {
       // TODO: Implement handle() method.
   }

   /**
    * Return event name for emit
    * @return string
    */
   public static function event(): string
   {
       return ActiveRecord::class . '@' . ActiveRecord::EVENT_AFTER_FIND;
   }
}

Usage subscriber

namespace frontend\observers\subscribers;

use yii\db\ActiveRecord;
use yiicod\listener\components\listeners\SubscriberAbstract;

class TestSubscriber extends SubscriberAbstract
{
   /**
    * @return array
    * [
    *      'event_class@event1' => 'on'
    *      'event_class@event2' => 'on'
    * ]
    */
   public static function subscribe(): array
   {
       return [
           ActiveRecord::class . '@' . ActiveRecord::EVENT_BEFORE_INSERT => 'on',
           ActiveRecord::class . '@' . ActiveRecord::EVENT_AFTER_INSERT => 'on'
       ];
   }

   /**
    * Call on event method
    */
   public function on($event)
   {
       // Handle
   }
}