Yii - 创建事件

在Yii框架中，事件是在组件生命周期不同阶段发生的操作，而不是当前代码执行的流程。在框架中有两个基本的类来管理事件： [[yii\base\Component]] 和 [[yii\base\Object]]。这两个类提供了方法来声明、触发和处理事件。

组件事件

每个 Yii 组件都有一组可用事件。您可以使用[[yii\base\Component::on()]]方法监听一个事件，并使用[[yii\base\Component::trigger()]]方法触发它。

以下是一个如何监听和触发事件的示例：

use yii\base\Component; 

class MyComponent extends Component
{
    const EVENT_HELLO = 'hello';

    public function sayHello()
    {
        // 触发a事件
        $this->trigger(self::EVENT_HELLO);
    }
}

$myComponent = new MyComponent();

// 监听hello事件
$myComponent->on(MyComponent::EVENT_HELLO, function () {
    echo 'Hello World!';
});

// 调用方法
$myComponent->sayHello(); // 输出 'Hello World!'

在此示例中，我们定义了一个名为“hello”的事件。当MyComponent调用sayHello方法时，它会触发相应的事件。

处理器参数

您可以为事件处理程序提供参数。

$myComponent = new MyComponent();

//监听a事件
$myComponent->on(MyComponent::EVENT_HELLO, function ($event) {
    echo 'Hello ' . $event->param1 . ' ' . $event->param2;
});

//定义参数
$params = ['param1' => 'User', 'param2' => '2021'];

//调用方法
$myComponent->trigger(MyComponent::EVENT_HELLO, $params); 

在此示例中，我们在触发事件时为其提供了一个参数数组。在事件处理程序中，我们可以通过$event->param1和$event->param2访问相应的参数值。

优先级

您可以为每个事件处理程序设置优先级。默认情况下，所有处理程序将按其注册顺序执行。

$myComponent = new MyComponent();

$handler1 = function () {
    echo 'Handler 1 executed';
};

$handler2 = function () {
    echo 'Handler 2 executed';
};

//注册各种处理程序
$myComponent->on(MyComponent::EVENT_HELLO, $handler1);
$myComponent->on(MyComponent::EVENT_HELLO, $handler2, null, null, 1);

// 调用方法
$myComponent->sayHello(); // 输出 'Handler 2 executed Handler 1 executed'

在此示例中，我们使用处理程序注册时的最后一个参数设置了第二个处理程序的优先级。这表示第二个处理程序将在第一个处理程序之前执行。

取消事件

您可以使用[[yii\base\Event::isValid]]方法在事件处理程序中取消事件，从而避免其他处理程序执行。

以下是一个取消事件的示例：

$myComponent = new MyComponent();

//监听hello事件
$myComponent->on(MyComponent::EVENT_HELLO, function ($event) {
    $event->isValid = false;
    echo 'Hello World!';
});

// 调用方法
$myComponent->sayHello(); // 输出空

在此示例中，我们在事件处理程序中将isValid设置为false。这将取消相应的事件，使其不再执行其他处理程序。

总结

在Yii框架中，使用事件管理可让您轻松地实现模块化和松耦合代码。通过上述示例，您应该已经了解如何声明和使用自定义事件，如何注册监听器以及如何使用事件参数和优先级。