Skip to content

README-EN.md

Latest commit

 

History

History
97 lines (76 loc) · 3.61 KB

README-EN.md

File metadata and controls

97 lines (76 loc) · 3.61 KB

Docs: 中文简体, English

Description

A simple php event engine to reduce the coupling between project modules.

How to install and use

1.installation

1). Install using composer.

composer require iry/php-event
compoer update

2).Traditional loading: add require_once('php-event PATH/start.php'); to your public file example

Add configuration

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

Please refer to the interface docking example: ./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

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

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

//启动守护进程
//$argv为所有的命令行参数 $_SERVER['argv']|| 如果是入口文件 也可使用$argv接收
iry\e\Service::start($argv);

4. Fire EVENT （Client）

Quick way

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

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.