如何在 yii2 中使用事件？

我可以通过一个简单的例子来解释事件。比方说，当用户首次注册到网站时，您希望做一些事情，例如：

1. 向管理员发送电子邮件。
2. 创建通知。
3. 你能说出它的名字。

您可以尝试在成功保存用户对象后调用几个方法。也许像这样：

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

到目前为止，这似乎很好，但是如果需求数量随着时间的推移而增长怎么办？说用户注册后必须发生10件事？在这种情况下，事件会派上用场。

事件基础知识

事件由以下循环组成。

1. 定义一个事件。比如说，新用户注册。
2. 您可以在模型中命名它。也许在模型中添加常量。喜欢。这用于添加处理程序和触发事件。Userconst EVENT_NEW_USER='new_user';
3. 定义一个在事件发生时应执行某些操作的方法。例如，向管理员发送电子邮件。它必须有一个参数。我们将此方法称为处理程序。$event
4. 您将该处理程序附加到 using 它是一个名为 的方法。您可以多次调用此方法 - 只需将多个处理程序附加到单个事件即可。modelon()
5. 通过使用 触发事件。trigger()

请注意，上面提到的所有方法都是类的一部分。Yii2 中几乎所有的类都继承了这个类。是的。ComponentActiveRecord

让我们编写代码

为了解决上面提到的问题，我们可以有模型。我不会在这里编写所有代码。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';
}

这里要记住的一件事是，您不必在创建事件的类中创建方法。您可以从任何类中添加任何静态、非静态方法。

我需要将上述处理程序附加到事件。我做的基本方法是使用AR的方法。所以这是如何：init()

// 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.
  parent::init(); // DON'T Forget to call the parent method.
}

最后一件事是触发一个事件。现在，您不需要像以前那样显式调用所有必需的方法。您可以通过以下方式替换它：

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;
    }
}

在配置的组件部分内（在本例中为）用户组件插入 you 事件：

'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;},
  ],   
  ... 
]