Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imroychen/php-event
A simple php event engine to reduce the coupling between project modules.(一个简单php事件引擎，以便解耦项目中的各模块)
https://github.com/imroychen/php-event
event fire-event php-event
Last synced: 28 days ago
JSON representation
A simple php event engine to reduce the coupling between project modules.(一个简单php事件引擎，以便解耦项目中的各模块)
- Host: GitHub
- URL: https://github.com/imroychen/php-event
- Owner: imroychen
- License: other
- Created: 2021-07-27T02:50:26.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-30T03:28:23.000Z (over 2 years ago)
- Last Synced: 2024-11-09T09:08:38.679Z (about 2 months ago)
- Topics: event, fire-event, php-event
- Language: PHP
- Homepage:
- Size: 107 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-EN.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Docs: [中文简体](./README.md), [English](./README-EN.md)
# Description
A simple php event engine to reduce the coupling between project modules.
## How to install and use
## 1.installation
1). Install using composer.
```shell script
composer require iry/php-event
compoer update
```
2).Traditional loading: add require_once('php-event PATH/start.php'); to your public file [example](./example/client.php)
# Add configuration
```php
iry\e\App::setCfg('\\MyNamespace\\event\\Setting');
```
### 3. Create class \\MyNamespace\event\\Setting
```
namespace \\MyNamespace\event;
class Config implements \iry\e\interfaces\Setting{
public function getPoolDriver()
public function getSubscribers(){}
public function getEventRules(){}
public function getTempPath(){}
}
```
Interface : [./src/Setting.php](./src/interfaces/Setting.php)
Please refer to the interface docking example: [./example/event/Setting.php](./example/event/Setting.php)
#### 方法
**public function getPoolDriver()**
//This package contains the following built-in drivers (DB (Sql DB), Sqlite, Redis, DbForLaravel, DbForTp).
Custom drive: 'Class Name(Contains namespace)'
Built-in drive: '@DbForLaravel?table=event_store'
For more built-in drivers, please refer to[./src/drivers/RADME.md](./src/drivers/RADME.md)
**public function getSubscribers()**
return array（recommended）|string
array: class list []: ['class1','class2'];
string: Example: _files:Subscriber Path/*.php_ (Automatically analyze the full name of the class from the code of these files)
**public function getEventRules()**
return ："string", Class Name，Example[./example/event/Event.php](./example/event/Event.php)
return："string"
**public function getTempPath()**
return："string",Return a directory path, do not add "/" at the end。 Example：_/tmp_
### 3.Srart Service (Service 在命令行下执行)
参考 [example/service.php](example/service.php)
```php
//启动守护进程
//$argv为所有的命令行参数 $_SERVER['argv']|| 如果是入口文件 也可使用$argv接收
iry\e\Service::start($argv);
```
### 4. Fire EVENT （Client）
#### Quick way
```php
use iry\e\Event;
Event::fire('Event Name',['argument 1','argument 2...'],'Delay broadcast for n seconds','Dependent event ID');
Event::fire('complete',[]);
Event::fire('complete',[],10);//Delay usage，Broadcast event message after 10 seconds
Event::fire('complete',[],0,5000);//5000 The current event will not be broadcast until the broadcast is confirmed
```
#### Use event objects
An event dependency chain will be automatically formed to ensure the sequence of events being broadcast successfully
```php
use iry\e\Fire;
$fire = new Fire();
$fire ->start('beforeRequest',['arguments1','...']);
//... Your code
$fire ->then('afterRequest',['arguments1','...']);
//... Your code
$fire ->then('complete',['arguments1','...']);
//The broadcast sequence is:
// beforeRequest > afterRequest > complete
$fire->getLastEventId();//Get the ID of the last event
```
This usage automatically forms an event dependency chain to ensure the sequence in which events are successfully broadcast.
**_"Complete"_** depends on _**"afterRequest"**_ and _"complete"_ will automatically wait for _"afterRequest"_ to be confirmed by all listeners before it is actually broadcast.
**_"AfterRequest"_** relies on **_"beforeRequest"_**, **_"afterRequest"_** will automatically wait for **_"beforeRequest"_** to be confirmed by all listeners before it is actually broadcast.