事件

CodeIgniter 的 Events 功能提供了一种利用内部机制而不修改核心文件的方式。CodeIgniter 运行时遵循特定的执行流程,但有时你可能希望在执行流程的特定阶段引发某些操作。例如,你可能希望在控制器加载之前或之后运行一个脚本,或者你可能希望在其他位置触发自己的脚本。

事件遵循 发布/订阅 模式,即在脚本执行的某个时刻触发一个事件。其他脚本可以通过在 Events 类中注册来“订阅”该事件,以表明它们希望在触发该事件时执行操作。

启用事件

事件总是启用的,并全局可用。

定义事件

大多数事件在 app/Config/Events.php 文件中定义。你可以使用 Events 类的 on() 方法为一个事件订阅一个操作。第一个参数是要订阅的事件名称。第二个参数是一个回调,在触发该事件时会运行它:

<?php

use CodeIgniter\Events\Events;

Events::on('pre_system', ['MyClass', 'myFunction']);

在这个例子中,每当执行 pre_system 事件时,会创建 MyClass 的一个实例并运行 myFunction() 方法。注意,第二个参数可以是 PHP 支持的任何形式的 可调用项:

<?php

// Call a standalone function
Events::on('pre_system', 'some_function');

// Call on an instance method
$user = new User();
Events::on('pre_system', [$user, 'someMethod']);

// Call on a static method
Events::on('pre_system', 'SomeClass::someMethod');

// Use a Closure
Events::on('pre_system', static function (...$params) {
    // ...
});

设置优先级

由于可以为单个事件订阅多个方法,因此你需要一种定义这些方法调用顺序的方式。你可以通过在 on() 方法的第三个参数传递一个优先级值来实现这一点。较低的值会先执行,值 1 具有最高优先级,对较低值没有限制:

<?php

Events::on('post_controller_constructor', 'some_function', 25);

具有相同优先级的任何订阅者都会按定义的顺序执行。

从 v4.2.0 开始,定义了三个类常量供你使用,它们为值设置了一些有用的范围。你不需要使用它们,但你可能会发现它们有助于提高可读性:

<?php

use CodeIgniter\Events\Events;

Events::PRIORITY_LOW;    // 200
Events::PRIORITY_NORMAL; // 100
Events::PRIORITY_HIGH;   // 10

重要

常量 EVENT_PRIORITY_LOW、EVENT_PRIORITY_NORMAL 和 EVENT_PRIORITY_HIGH 已弃用,定义移至 app/Config/Constants.php。这些将在未来版本中删除。

对订阅者排序后,会按顺序执行所有订阅者。如果任何订阅者返回布尔假值,则将停止执行订阅者。

发布你自己的事件

Events 库也使你可以在自己的代码中简单地创建事件。要使用此功能,你只需要用事件名称调用 Events 类的 trigger() 方法:

<?php

\CodeIgniter\Events\Events::trigger('some_event');

通过添加更多参数,你可以向订阅者传递任意数量的参数。订阅者将以定义的相同顺序获取参数:

<?php

\CodeIgniter\Events\Events::trigger('some_events', $foo, $bar, $baz);

Events::on('some_event', static function ($foo, $bar, $baz) {
    // ...
});

模拟事件

在测试期间,你可能不希望事件实际触发,因为每天发送数百封电子邮件既缓慢又适得其反。你可以使用 simulate() 方法告诉 Events 类仅模拟运行事件。当值为 true 时,在 trigger 方法期间将跳过所有事件。但是其他一切都将正常工作。

<?php

Events::simulate(true);

你可以通过传递 false 来停止模拟:

<?php

Events::simulate(false);

事件点

以下是 CodeIgniter 核心代码中可用的事件点列表:

  • pre_system 在系统执行非常早期时调用。此时仅加载了 benchmark 和 events 类。没有进行路由或其他处理。

  • post_controller_constructor 在控制器实例化后但在任何方法调用发生前立即调用。

  • post_system 在向浏览器发送最终渲染页面后调用,在向浏览器发送最终数据后系统执行结束时调用。

  • email 从 CodeIgniter\Email\Email 成功发送邮件后调用。接收 Email 类属性数组作为参数。

  • DBQuery 在数据库查询成功或失败后调用。接收 Query 对象。

  • migrate 在对 latest() 或 regress() 的成功迁移调用后调用。接收 MigrationRunner 的当前属性以及方法名称。