https://github.com/tinywan/webman-event

the event for webman plugin
https://github.com/tinywan/webman-event

dispatcher event php php-library symfony webman workerman

Last synced: 3 months ago
JSON representation

the event for webman plugin

• Host: GitHub
• URL: https://github.com/tinywan/webman-event
• Owner: Tinywan
• License: apache-2.0
• Archived: true
• Created: 2021-12-15T15:03:18.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-18T09:04:30.000Z (over 2 years ago)
• Last Synced: 2024-09-29T17:21:31.521Z (3 months ago)
• Topics: dispatcher, event, php, php-library, symfony, webman, workerman
• Language: PHP
• Homepage: https://www.workerman.net/webman
• Size: 62.5 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# webman event plugin

[![Latest Stable Version](http://poser.pugx.org/tinywan/event/v)](https://packagist.org/packages/tinywan/event) 

[![Total Downloads](http://poser.pugx.org/tinywan/event/downloads)](https://packagist.org/packages/tinywan/event) 

[![Latest Unstable Version](http://poser.pugx.org/tinywan/event/v/unstable)](https://packagist.org/packages/tinywan/event) 

[![License](http://poser.pugx.org/tinywan/event/license)](https://packagist.org/packages/tinywan/event) 

[![PHP Version Require](http://poser.pugx.org/tinywan/event/require/php)](https://packagist.org/packages/tinywan/event)

事件相比较中间件的优势是事件比中间件更加精准定位（或者说粒度更细），并且更适合一些业务场景的扩展。例如，我们通常会遇到用户注册或者登录后需要做一系列操作，通过事件系统可以做到不侵入原有代码完成登录的操作扩展，降低系统的耦合性的同时，也降低了BUG的可能性。

## 安装

```shell script

composer require tinywan/event

```

## 快速开始

### 监听事件

事件类 `LogErrorWriteEvent.php`

```php

namespace extend;

use Symfony\Contracts\EventDispatcher\Event;

class LogErrorWriteEvent extends Event

{

    const NAME = 'log.error.write';  // 事件名，事件的唯一标识

    public $log;

    public function __construct(array $log)

    {

        $this->log = $log;

    }

    public function handle()

    {

        return $this->log;

    }

}

```

事件监听

```php

return [

    // 事件监听

    'listener'    => [

        \extend\LogErrorWriteEvent::NAME => \extend\LogErrorWriteEvent::class,

        \extend\DingTalkEvent::NAME => \extend\DingTalkEvent::class,

    ],

];

```

### 事件订阅

订阅类 `LoggerSubscriber.php`

```php

namespace extend;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;

use Symfony\Contracts\EventDispatcher\Event;

class LoggerSubscriber implements EventSubscriberInterface

{

    public static function getSubscribedEvents(): array

    {

        // 监听的不同事件，当事件触发时，会调用 onResponse 方法

        return [

            \extend\LogErrorWriteEvent::NAME => 'onResponse',

            \extend\DingTalkEvent::NAME => 'onResponse',

        ];

    }

    /**

     * @desc: 触发事件

     * @param Event $event

     */

    public function onResponse(Event $event)

    {

        // 一些具体的业务逻辑

        var_dump($event->handle());

    }

}

```

事件订阅

```php

return [

    // 事件订阅

    'subscriber' => [

         \extend\LoggerSubscriber::class

    ],

];

```

### 事件触发器

触发 `LogErrorWriteEvent` 事件。

```php

$error = [

    'errorMessage' => '错误消息',

    'errorCode' => 500

];

Tinywan\Event::trigger(new \extend\LogErrorWriteEvent($error), \extend\LogErrorWriteEvent::NAME);

```

### 助手函数（推荐）

```php

$error = [

    'errorMessage' => '错误消息',

    'errorCode' => 500

];

event(new \extend\LogErrorWriteEvent($error), \extend\LogErrorWriteEvent::NAME);

```

执行结果

![打印结果](./trigger.png)

## License

This project is licensed under the [Apache 2.0 license](LICENSE).