Yii2 event-如何使用事件

原创

熬夜的花斑狗

发布于 2022-01-10 02:25:12

69400

代码可运行

文章被收录于专栏：开发+运维+架构开发+运维+架构

运行总次数：0

代码可运行

这里说的是通过行为的方式绑定事件

定义行为事件类：EventService.php

<?php
namespace api\components;

use Yii;
use yii\base\Behavior;
use yii\base\Application;

/**
 * 事件类
 */
class EventService extends Behavior
{
    // 定义事件名
    const EVENT_BEFORE_DEMO1 = 'beforeDemo1';

    /**
     * [ 事件绑定处理程序 ]
     * @return [type] [description]
     */
    public function events()
    {
        return [
            Application::EVENT_BEFORE_REQUEST => 'demo',
            self::EVENT_BEFORE_DEMO1 => 'demo1',
        ];
    }

    /**
     * [ 事件测试 ]
     * @param  [type] $event [description]
     * @return [type]        [description]
     */
    public function demo($event)
    {
        Yii::info(['message'=>'事件测试（自动触发）'], 'demo');
    }

    /**
     * [ 事件测试1 ]
     * @param  [type] $event [description]
     * @return [type]        [description]
     */
    public function demo1($event)
    {
        $log = [
            'message' => '事件测试1',
            'ip' => $event->ip,
            'route' => $event->route,
        ];
        Yii::info($log, 'demo1');
    }
}

定义数据格式类：MyEvent.php

<?php
namespace api\components;

use Yii;
use yii\base\Model;
use yii\base\Event;

/**
 * ContactForm is the model behind the contact form.
 */
class MyEvent extends Event
{
    /** @var [type] [ 请求路由 ] */
    public $route;

    /** @var [type] [ 请求IP ] */
    public $ip;

}

配置自动触发事件

在config/main.php中components同级定义
    'name' => 'My Api',
    'as behaviors' => 'api\components\EventService',
    'components' => [ ... ]

在行为函数中手动触发行为事件

    /**
     * [ 首页 ]
     * @return [type] [description]
     */
    public function actionIndex()
    {
        $event = new MyEvent();
        // 传递参数
        $event->ip = Yii::$app->request->userIP;
        $event->route = Yii::$app->requestedRoute;

        // 手动触发事件
        Yii::$app->trigger(EventService::EVENT_BEFORE_DEMO1, $event);
    }

查看日志

2020-08-05 14:43:47 [127.0.0.1][-][-][info][demo] [
    'message' => '事件测试（自动触发）',
]
    in E:\data\www\project\php\yii2\advanced\api\components\EventService.php:35
2020-08-05 14:43:47 [127.0.0.1][-][-][info][demo1] [
    'message' => '事件测试1',
    'ip' => '127.0.0.1',
    'route' => 'site/index',
]
    in E:\data\www\project\php\yii2\advanced\api\components\EventService.php:50
    in E:\data\www\project\php\yii2\advanced\api\controllers\SiteController.php:84
2020-08-05 14:43:47 [127.0.0.1][-][-][info][application] $_GET = []