События в Yii2

Yii2-события для MVC
Веб-представление, которое наследуется от yii\web\View
EVENT_BEGIN_BODY
EVENT_END_BODY
 
Model
EVENT_AFTER_VALIDATE
EVENT_BEFORE_VALIDATE
 
Module или Controller
EVENT_AFTER_ACTION - afterAction
EVENT_BEFORE_ACTION - beforeAction
 
Компонент представления 
yii\base\View
EVENT_AFTER_RENDER
EVENT_BEFORE_RENDER
EVENT_END_PAGE
EVENT_BEGIN_PAGE
 
Cвязанные с БД
yii\db\BaseActiveRecord
EVENT_INIT
EVENT_AFTER_FIND
EVENT_BEFORE_INSERT (перед сохранением данных в БД)
EVENT_AFTER_INSERT
EVENT_BEFORE_UPDATE
EVENT_AFTER_UPDATE
EVENT_BEFORE_DELETE
EVENT_AFTER_DELETE
yii\db\ActiveQuery
EVENT_INIT
yii\db\Connection
EVENT_AFTER_OPEN (наступает после подключения к БД)
EVENT_BEGIN_TRANSACTION
EVENT_COMMIT_TRANSACTION
EVENT_ROLLBACK_TRANSACTION
 
Yii2-события уровня запросов
yii\base\Application
EVENT_BEFORE_REQUEST - beforeRequest
EVENT_AFTER_REQUEST - afterRequest
yii\web\Response
EVENT_BEFORE_SEND
EVENT_AFTER_SEND
EVENT_AFTER_PREPARE
 
Yii2-события для компонентов по умолчанию
yii\i18n\MessageSource
EVENT_MISSING_TRANSLATION
yii\mail\BaseMailer
EVENT_BEFORE_SEND
EVENT_AFTER_SEND
 
yii\web\User События связанные с авторизацией
EVENT_BEFORE_LOGIN
EVENT_AFTER_LOGIN
EVENT_BEFORE_LOGOUT
EVENT_AFTER_LOGOUT

• в методах объектов и классов;
• в конфигурации приложения.

Установка обработчиков событий в методах объектов и классов.

$this->on(yii\web\Controller::EVENT_AFTER_ACTION, Yii::$app->comp->get_hello());

$this->on(yii\web\Controller::EVENT_AFTER_ACTION, [$this, 'fun_test']);
    

$this->on(yii\web\Controller::EVENT_AFTER_ACTION, ['common\behaviors\Slug', 'name']);
    

$this->on(yii\web\Controller::EVENT_AFTER_ACTION, function ($event) {
    if($this->text == 'Привет') $this->text = 'Приветствую!';
});

Установка обработчиков событий в конфигурации приложения.

'comp' => [
    'class' => 'common\components\Comp',
    'age' => 23,
    'on '. \yii\db\ActiveRecord::EVENT_INIT => function ($event) {
    или тоже самое: 'on init' => function ($event) {
    },
],
        

class Comp extends \common\models\Post{}
            

$config['on afterAction'] = function ($event) {
    \app\components\GoogleAnalytics::collect();
};

'on afterAction' => function () {
      exit('Событие после выполнения действия контроллера.');
  },
            

Yii::$app->on('afterAction', function ($event) {
      exit('Событие после выполнения действия контроллера.');
  });
                

События для самого приложения (Yii::$app).

'on beforeRequest' => function () {
    exit('Остановка перед запуском приложения.');
},

\Yii::$app->on(\yii\base\Application::EVENT_BEFORE_REQUEST, function ($event) {
      exit('Остановка перед запуском приложения.');
  });
    

Порядок обработки событий.

К одному событию можно присоединить несколько обработчиков. При срабатывании события обработчики будут вызываться в том порядке, к котором они присоединялись к событию.
Чтобы запретить в обработчике вызов всех следующих за ним обработчиков, необходимо установить свойство [[yii\base\Event::handled]] параметра $event в true:

$foo->on(Foo::EVENT_HELLO, function ($event) {
      $event->handled = true;
  });
        

Чтобы обработчик присоединился к началу очереди и запускался первым, при вызове [[yii\base\Component::on()]] в качестве четвертого параметра $append следует передать false:

$foo->on(Foo::EVENT_HELLO, function ($event) {
      // ...
  }, $data, false);
            

Отсоединение обработчиков событий.

Для отсоединения обработчика от события используется метод [[yii\base\Component::off()]].
Устанавливается аналогично методу on().

Чтобы отсоединить ВСЕ обработчики от события:
$obj->off(Class::EVENT_HELLO);

$this->off(yii\web\Controller::EVENT_AFTER_ACTION);
            

Инициирование событий (создание своих).

События инициируются при вызове метода [[yii\base\Component::trigger()]].
Класс, в котором инициируются события, должен наследовать от [[yii\base\Component]] или потомка этого класса.

Пример.
Создаем свой класс и подключаем его как компонент в файле config\main.php в массиве components

<?php
  namespace common\components;
  use yii\base\Component;
  use yii\base\Event;
  class Comp extends Component
  {
      const EVENT_HELLO = 'hello';
      public function bar()
      {
          $this->trigger(self::EVENT_HELLO); //инициирование события
          /*
           * Основной функционал метода
           */
      }
     public function linking(){
            $this->on(self::EVENT_HELLO, function ($event) {
                    exit('Привет!');
            });
     }       
  }
            

Показанный выше код инициирует событие hello при каждом вызове метода bar(). Событие привязывается в методе linking(). Поэтому вначале должен быть выполнен данный метод.

Использование:

<div>//Привязываем свой обработчик в этом методе
  Yii::$app->comp->linking();</div><div>
  //Вызываем метод который инициирует событие 
  Yii::$app->comp->bar(); //Привет!</div>
            

Привязку события можно производить в любом месте (не нужен метод linking()), например в действии контроллера:

Yii::$app->comp->on(\common\components\Comp::EVENT_HELLO, function ($event) {
    exit('Привет!');
  });
  Yii::$app->comp->bar();
                    

Если нужна привязка для всех объектов данного класса, то удобно применять специальный метод __construct() (добавить в класс) для того, чтобы не вызывать отдельно метод привязывающий событие.

  public function __construct(){
    parent::__construct();
     $this->on(self::EVENT_HELLO, function ($event) {
            exit('Привет!');
     });
  }
                        

Обработчики событий на уровне класса.

В примерах выше, обработчики событий привязывались к определенному объекту (экземпляру класса) и при создании нового экземпляра необходимо было бы привязывать обработчики снова (если не применять специальный метод __construct()).

Если нужно вызывать событие для каждого экземпляра класса, а привязку сделать за его пределами – применяется статический метод [[yii\base\Event::on()]].

Пример раздела «Инициирование событий» при этом будет выглядеть так:

<?php
  namespace common\components;
  use yii\base\Component;
  use yii\base\Event;
  class Comp extends Component
  {
      const EVENT_HELLO = 'hello';
      public function bar()
      {
          $this->trigger(self::EVENT_HELLO); //инициирование события
     /*
      * Основной функционал метода
      */
      }
  }
            

Привязка ко всем экземплярам класса за пределами класса выглядит так:

\yii\base\Event::on(\common\components\Comp::className(), \common\components\Comp::EVENT_HELLO, function ($event) {
    exit('Привет!');
  });
                

Теперь при создании любого экземпляра класса сработает событие при вызове метода его инициирующего.

$new_comp1 = new \common\components\Comp();       
$new_comp1->bar(); //метод выполняющий нужный код + инициирующий событие
$new_comp2 = new \common\components\Comp();       
$new_comp2->bar(); //метод выполняющий нужный код + инициирующий событие
                    

Event::on(Controller::className(), 'beforeAction', function ($event) {
    //нужный код, например вызов метода какого-то объекта
});

Глобальные события.

//Устанавливаем обработчик события на пользовательский компонент приложения- класс Comp
  Yii::$app->on('comp', function ($event) {
    exit (get_class($event->sender));  // выводит "common\components\Comp"
  });

//Инициируем событие в нужный момент
  Yii::$app->trigger('comp', new \yii\base\Event(['sender' => new \common\components\Comp]));