Événement 技术文档

1. 安装指南

安装 Événement 的推荐方式是通过 composer。运行以下命令即可：

$ composer require evenement/evenement

确保您的环境中已经安装了 Composer。

2. 项目的使用说明

本项目是一个用于 PHP 的简单事件派遣库。它旨在赋予用户强大的功能，同时保持简洁和易用。

创建发射器

首先，您需要创建一个事件发射器实例：

<?php
$emitter = new Evenement\EventEmitter();

添加监听器

接下来，您可以给特定的事件添加监听器：

<?php
$emitter->on('user.created', static function (User $user) use ($logger): void {
    $logger->log(sprintf("用户 '%s' 已创建。", $user->getLogin()));
});

移除监听器

如果您需要，也可以移除之前添加的监听器：

<?php
$emitter->removeListener('user.created', static function (User $user) use ($logger): void {
    $logger->log(sprintf("用户 '%s' 已创建。", $user->getLogin()));
});

触发事件

最后，通过以下方式触发一个事件：

<?php
$emitter->emit('user.created', [$user]);

3. 项目 API 使用文档

本项目提供了以下 API 方法：

• on(string $eventName, callable $listener): 添加一个监听器到指定事件。
• removeListener(string $eventName, callable $listener): 从指定事件移除一个监听器。
• emit(string $eventName, array $arguments = []): 触发一个事件。

4. 项目安装方式

本项目可以通过以下方式安装：

• 通过 Composer，运行以下命令：

$ composer require evenement/evenement

确保遵循上述安装指南中的步骤进行操作。

以上是对 Événement 项目的基本介绍和使用方法。希望这份技术文档能够帮助您更好地了解和运用本项目。如果您在使用过程中遇到任何问题或需要进一步的澄清，请参考项目的 GitHub 仓库或 MIT 许可证中的相关内容。