Как использовать события в yii2?

Я могу объяснить события простым примером. Предположим, вы хотите сделать несколько вещей, когда пользователь сначала регистрируется на сайте, например:

1. Отправьте электронное письмо администратору.
2. Создайте уведомление.
3. вы называете это.

Вы можете попытаться вызвать несколько методов после успешного сохранения пользовательского объекта. Может быть так:

 if($model->save()){ $mailObj->sendNewUserMail($model); $notification->setNotification($model); } 

Пока это может показаться прекрасным, но что, если количество требований возрастает со временем? Скажем, 10 вещей должны произойти после регистрации пользователем пользователя? События приходят в такие ситуации.

Основы событий

События состоят из следующего цикла.

1. Вы определяете событие. Скажем, новая регистрация пользователя.
2. Вы называете это в своей модели. Может быть добавлено константа в модели User . Подобно const EVENT_NEW_USER='new_user'; , Это используется для добавления обработчиков и для запуска события.
3. Вы определяете метод, который должен что-то делать, когда происходит событие. Отправка сообщения электронной почты администратору. Он должен иметь параметр $event . Мы называем этот метод обработчиком.
4. Вы присоединяете этот обработчик к model используя свой метод, называемый on() . Вы можете вызывать этот метод много раз, вы хотите – просто вы можете подключить более одного обработчика к одному событию.
5. Вы запускаете событие, используя trigger() .

Обратите внимание, что все упомянутые выше методы являются частью класса Component . Почти все классы в yii2 унаследованы от этого класса. Да и ActiveRecord .

Дадим код

Для решения вышеупомянутой проблемы у нас может быть модель User.php . Я не буду писать весь код здесь.

 // in User.php i've declared constant that stores event name const EVENT_NEW_USER = 'new-user'; // say, whenever new user registers, below method will send an email. public function sendMail($event){ echo 'mail sent to admin'; // you code } // one more hanlder. public function notification($event){ echo 'notification created'; } 

Здесь следует помнить, что вы не обязаны создавать методы в классе, который создает событие. Вы можете добавить любой статический, не статический метод из любого класса.

Мне нужно приложить над обработчиком события. Основной способ, который я сделал, – использовать метод init() AR. Итак, вот как:

 // this should be inside User.php class. public function init(){ $this->on(self::EVENT_NEW_USER, [$this, 'sendMail']); $this->on(self::EVENT_NEW_USER, [$this, 'notification']); // first parameter is the name of the event and second is the handler. // For handlers I use methods sendMail and notification // from $this class. } 

Последняя вещь – вызвать событие. Теперь вам не нужно явно вызывать все необходимые методы, как мы это делали раньше. Вы можете заменить его следующим:

 if($model->save()){ $model->trigger(User::EVENT_NEW_USER); } 

Все обработчики будут автоматически вызваны.

Для «глобальных» событий.

При желании вы можете создать специализированный класс событий

 namespace your\handler\Event\Namespace; class EventUser extends Event { const EVENT_NEW_USER = 'new-user'; } 

определить хотя бы один класс обработчика:

 namespace your\handler\Event\Namespace; class handlerClass{ // public AND static public static function handleNewUser(EventUser $event) { // $event->user contain the "input" object echo 'mail sent to admin for'. $event->user->username; } } 

Внутри компонента компонента config (в данном случае) пользовательский компонент вставляет вам событие:

 'components' => [ 'user' => [ ... 'on new-user' => ['your\handler\Event\Namespace\handlerClass', 'handleNewUser'], ], ... ] 

Затем в вашем коде вы можете вызвать событие:

 Yii::$app->user->trigger(EventUser::EVENT_NEW_USER, new EventUser($user)); 

ДОБАВИТЬ

Вы также можете использовать закрытие:

• позволяет IDE «обнаруживать» использование функции (для навигации по коду)
• поместите некоторый (маленький) код, управляющий событием

пример:

 'components' => [ 'user' => [ ... 'on new-user' => function($param){ your\handler\Event\Namespace\handlerClass::handleNewUser($param);}, 'on increment' => function($param){ \Yii::$app->count += $param->value;}, ], ... ] 

По умолчанию Yii2 уже предоставляет некоторую декларацию о событиях, вы можете узнать больше об объяснении в BaseActiveRecord .

Вы можете использовать эту переменную так же, как декларировать ее вручную.

 public function init() { parent::init(); $this->on(self::EVENT_AFTER_INSERT, [$this, 'exampleMethodHere']); }