讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

Yii2的深入学习--事件Event

千浩酱_6527

千浩酱_6527

发布时间:2016-07-06 13:30:50

|

1198人浏览过

|

来源于php中文网

原创

我们先来看下事件在 Yii2 中的使用,如下内容摘自Yii2中文文档 事件可以将自定义代码注入到现有代码中的特定执行点。附加自定义代码到某个事件,当这个事件被触发时,这些代码就会自动执行。例如,邮件程序对象成功发出消息时可触发 messageSent 事件。如想

我们先来看下事件在 yii2 中的使用,如下内容摘自 yii2中文文档

事件可以将自定义代码“注入”到现有代码中的特定执行点。附加自定义代码到某个事件,当这个事件被触发时,这些代码就会自动执行。例如,邮件程序对象成功发出消息时可触发 messageSent 事件。如想追踪成功发送的消息,可以附加相应追踪代码到 messageSent 事件。

Yii 引入了名为 [[yii\base\Component]] 的基类以支持事件。如果一个类需要触发事件就应该继承 [[yii\base\Component]] 或其子类。

事件处理器(Event Handlers)

事件处理器是一个php 回调函数,当它所附加到的事件被触发时它就会执行。可以使用以下回调函数之一:

  • 字符串形式指定的 PHP 全局函数,如 'trim' ;
  • 对象名和方法名数组形式指定的对象方法,如 [$object, $method] ;
  • 类名和方法名数组形式指定的静态类方法,如 [$class, $method] ;
  • 匿名函数,如 function ($event) { ... } 。

事件处理器的格式是:

<span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> $event 是 yii\base\Event 或其子类的对象</span>
}

通过 $event 参数,事件处理器就获得了以下有关事件的信息:

  • [[yii\base\Event::name|event name]]:事件名
  • [[yii\base\Event::sender|event sender]]:调用 trigger() 方法的对象
  • [[yii\base\Event::data|custom data]]:附加事件处理器时传入的数据,默认为空,后文详述

附加事件处理器

调用 [[yii\base\Component::on()]] 方法来附加处理器到事件上。如:

<span style="color: #800080;">$foo</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Foo;

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是全局函数</span>
<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, 'function_name'<span style="color: #000000;">);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是对象方法</span>
<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, [<span style="color: #800080;">$object</span>, 'methodName'<span style="color: #000000;">]);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是静态类方法</span>
<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName'<span style="color: #000000;">]);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是匿名函数</span>
<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #008000;">//</span><span style="color: #008000;">事件处理逻辑</span>
});

附加事件处理器时可以提供额外数据作为 [[yii\base\Component::on()]] 方法的第三个参数。数据在事件被触发和处理器被调用时能被处理器使用。如:

<span style="color: #008000;">//</span><span style="color: #008000;"> 当事件被触发时以下代码显示 "abc"
// 因为 $event->data 包括被传递到 "on" 方法的数据</span>
<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #0000ff;">echo</span> <span style="color: #800080;">$event</span>-><span style="color: #000000;">data;
}</span>, 'abc');

事件处理器顺序

可以附加一个或多个处理器到一个事件。当事件被触发,已附加的处理器将按附加次序依次调用。如果某个处理器需要停止其后的处理器调用,可以设置 $event 参数的 [yii\base\Event::handled]] 属性为真,如下:

<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #800080;">$event</span>->handled = <span style="color: #0000ff;">true</span><span style="color: #000000;">;
});</span>

默认新附加的事件处理器排在已存在处理器队列的最后。因此,这个处理器将在事件被触发时最后一个调用。在处理器队列最前面插入新处理器将使该处理器最先调用,可以传递第四个参数 $append 为假并调用 [[yii\base\Component::on()]] 方法实现:

<span style="color: #800080;">$foo</span>->on(Foo::EVENT_HELLO, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #008000;">//</span><span style="color: #008000;"> 这个处理器将被插入到处理器队列的第一位...</span>
}, <span style="color: #800080;">$data</span>, <span style="color: #0000ff;">false</span>);

触发事件

事件通过调用 [[yii\base\Component::trigger()]] 方法触发,此方法须传递事件名,还可以传递一个事件对象,用来传递参数到事件处理器。如:

<span style="color: #000000;">namespace app\components;

</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Component;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Event;

</span><span style="color: #0000ff;">class</span> Foo <span style="color: #0000ff;">extends</span><span style="color: #000000;"> Component
{
    </span><span style="color: #0000ff;">const</span> EVENT_HELLO = 'hello'<span style="color: #000000;">;

    </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span><span style="color: #000000;"> bar()
    {
        </span><span style="color: #800080;">$this</span>->trigger(self::<span style="color: #000000;">EVENT_HELLO);
    }
}</span>

以上代码当调用 bar() ,它将触发名为 hello 的事件。

Tip: 推荐使用类常量来表示事件名。上例中,常量 EVENT_HELLO 用来表示 hello 。这有两个好处。第一,它可以防止拼写错误并支持 IDE 的自动完成。第二,只要简单检查常量声明就能了解一个类支持哪些事件。

有时想要在触发事件时同时传递一些额外信息到事件处理器。例如,邮件程序要传递消息信息到 messageSent 事件的处理器以便处理器了解哪些消息被发送了。为此,可以提供一个事件对象作为 [[yii\base\Component::trigger()]] 方法的第二个参数。这个事件对象必须是 [[yii\base\Event]] 类或其子类的实例。如:

<span style="color: #000000;">namespace app\components;

</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Component;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Event;

</span><span style="color: #0000ff;">class</span> MessageEvent <span style="color: #0000ff;">extends</span><span style="color: #000000;"> Event
{
    </span><span style="color: #0000ff;">public</span> <span style="color: #800080;">$message</span><span style="color: #000000;">;
}

</span><span style="color: #0000ff;">class</span> Mailer <span style="color: #0000ff;">extends</span><span style="color: #000000;"> Component
{
    </span><span style="color: #0000ff;">const</span> EVENT_MESSAGE_SENT = 'messageSent'<span style="color: #000000;">;

    </span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">function</span> send(<span style="color: #800080;">$message</span><span style="color: #000000;">)
    {
        </span><span style="color: #008000;">//</span><span style="color: #008000;"> ...发送 $message 的逻辑...</span>

        <span style="color: #800080;">$event</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> MessageEvent;
        </span><span style="color: #800080;">$event</span>->message = <span style="color: #800080;">$message</span><span style="color: #000000;">;
        </span><span style="color: #800080;">$this</span>->trigger(self::EVENT_MESSAGE_SENT, <span style="color: #800080;">$event</span><span style="color: #000000;">);
    }
}</span>

当 [[yii\base\Component::trigger()]] 方法被调用时,它将调用所有附加到命名事件(trigger 方法第一个参数)的事件处理器。

移除事件处理器

从事件移除处理器,调用 [[yii\base\Component::off()]] 方法。如:

<span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是全局函数</span>
<span style="color: #800080;">$foo</span>->off(Foo::EVENT_HELLO, 'function_name'<span style="color: #000000;">);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是对象方法</span>
<span style="color: #800080;">$foo</span>->off(Foo::EVENT_HELLO, [<span style="color: #800080;">$object</span>, 'methodName'<span style="color: #000000;">]);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是静态类方法</span>
<span style="color: #800080;">$foo</span>->off(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName'<span style="color: #000000;">]);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 处理器是匿名函数</span>
<span style="color: #800080;">$foo</span>->off(Foo::EVENT_HELLO, <span style="color: #800080;">$anonymousFunction</span>);

注意当匿名函数附加到事件后一般不要尝试移除匿名函数,除非你在某处存储了它。以上示例中,假设匿名函数存储为变量$anonymousFunction 。

jquery.hotkeys插件键盘按键监听事件代码
jquery.hotkeys插件键盘按键监听事件代码

jquery.hotkeys插件键盘按键监听事件代码

下载

移除事件的全部处理器,简单调用 [[yii\base\Component::off()]] 即可,不需要第二个参数:

<span style="color: #800080;">$foo</span>->off(Foo::EVENT_HELLO);

类级别的事件处理器

以上部分,我们叙述了在实例级别如何附加处理器到事件。有时想要一个类的所有实例而不是一个指定的实例都响应一个被触发的事件,并不是一个个附加事件处理器到每个实例,而是通过调用静态方法 [[yii\base\Event::on()]] 在类级别附加处理器。

例如,活动记录对象要在每次往数据库新增一条新记录时触发一个 [[yii\db\BaseActiveRecord::EVENT_AFTER_INSERT|EVENT_AFTER_INSERT]] 事件。要追踪每个活动记录对象的新增记录完成情况,应如下写代码:

<span style="color: #0000ff;">use</span><span style="color: #000000;"> Yii;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Event;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\db\ActiveRecord;

Event</span>::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    Yii</span>::trace(<span style="color: #008080;">get_class</span>(<span style="color: #800080;">$event</span>->sender) . ' is inserted'<span style="color: #000000;">);
});</span>

每当 [[yii\db\BaseActiveRecord|ActiveRecord]] 或其子类的实例触发 [[yii\db\BaseActiveRecord::EVENT_AFTER_INSERT|EVENT_AFTER_INSERT]] 事件时,这个事件处理器都会执行。在这个处理器中,可以通过 $event->sender 获取触发事件的对象。

当对象触发事件时,它首先调用实例级别的处理器,然后才会调用类级别处理器。

可调用静态方法[[yii\base\Event::trigger()]]来触发一个类级别事件。类级别事件不与特定对象相关联。因此,它只会引起类级别事件处理器的调用。如:

<span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Event;

Event</span>::on(Foo::className(), Foo::EVENT_HELLO, <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #0000ff;">echo</span> <span style="color: #800080;">$event</span>->sender;  <span style="color: #008000;">//</span><span style="color: #008000;"> 显示 "app\models\Foo"</span>
<span style="color: #000000;">});

Event</span>::trigger(Foo::className(), Foo::EVENT_HELLO);

注意这种情况下 $event->sender 指向触发事件的类名而不是对象实例。

Note: 因为类级别的处理器响应类和其子类的所有实例触发的事件,必须谨慎使用,尤其是底层的基类,如 [[yii\base\Object]]。

移除类级别的事件处理器只需调用[[yii\base\Event::off()]],如:

<span style="color: #008000;">//</span><span style="color: #008000;"> 移除 $handler</span>
Event::off(Foo::className(), Foo::EVENT_HELLO, <span style="color: #800080;">$handler</span><span style="color: #000000;">);

</span><span style="color: #008000;">//</span><span style="color: #008000;"> 移除 Foo::EVENT_HELLO 事件的全部处理器</span>
Event::off(Foo::className(), Foo::EVENT_HELLO);

全局事件

所谓全局事件实际上是一个基于以上叙述的事件机制的戏法。它需要一个全局可访问的单例,如应用实例。

事件触发者不调用其自身的 trigger() 方法,而是调用单例的 trigger() 方法来触发全局事件。类似地,事件处理器被附加到单例的事件。如:

<span style="color: #0000ff;">use</span><span style="color: #000000;"> Yii;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> yii\base\Event;
</span><span style="color: #0000ff;">use</span><span style="color: #000000;"> app\components\Foo;

Yii</span>::<span style="color: #800080;">$app</span>->on('bar', <span style="color: #0000ff;">function</span> (<span style="color: #800080;">$event</span><span style="color: #000000;">) {
    </span><span style="color: #0000ff;">echo</span> <span style="color: #008080;">get_class</span>(<span style="color: #800080;">$event</span>->sender);  <span style="color: #008000;">//</span><span style="color: #008000;"> 显示 "app\components\Foo"</span>
<span style="color: #000000;">});

Yii</span>::<span style="color: #800080;">$app</span>->trigger('bar', <span style="color: #0000ff;">new</span> Event(['sender' => <span style="color: #0000ff;">new</span> Foo]));

全局事件的一个好处是当附加处理器到一个对象要触发的事件时,不需要产生该对象。相反,处理器附加和事件触发都通过单例(如应用实例)完成。

然而,因为全局事件的命名空间由各方共享,应合理命名全局事件,如引入一些命名空间(例:"frontend.mail.sent", "backend.mail.sent")。

 


热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

0

2026.11.17

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

0

2026.11.17

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

0

2026.11.17

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

0

2026.11.17

SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写

SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。

0

2026.11.17

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

180

2026.11.12

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

120

2026.11.12

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

100

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习

thinkphp基础介绍和yii2基础介绍
thinkphp基础介绍和yii2基础介绍

共10课时 | 2.6万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn