Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berliozframework/eventmanager
Berlioz Event Manager is a PHP event manager/dispatcher, respecting PSR-14 (Event Dispatcher) standard.
https://github.com/berliozframework/eventmanager
Last synced: about 1 month ago
JSON representation
Berlioz Event Manager is a PHP event manager/dispatcher, respecting PSR-14 (Event Dispatcher) standard.
- Host: GitHub
- URL: https://github.com/berliozframework/eventmanager
- Owner: BerliozFramework
- License: mit
- Created: 2018-01-30T21:55:32.000Z (almost 7 years ago)
- Default Branch: 1.x
- Last Pushed: 2021-09-08T20:47:55.000Z (over 3 years ago)
- Last Synced: 2024-08-09T10:12:42.796Z (5 months ago)
- Language: PHP
- Homepage: https://getberlioz.com
- Size: 23.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Berlioz Event Manager
[](https://github.com/BerliozFramework/EventManager/releases)
[](https://github.com/BerliozFramework/EventManager/blob/1.x/LICENSE)
[](https://github.com/BerliozFramework/EventManager/actions/workflows/tests.yml?query=branch%3A1.x)
[](https://www.codacy.com/manual/BerliozFramework/EventManager)
[](https://packagist.org/packages/berlioz/event-manager)
**Berlioz Event Manager** is a PHP event manager/dispatcher, respecting PSR-14 (Event Dispatcher) standard.
For more information, and use of Berlioz Framework, go to website and online documentation :
https://getberlioz.com
## Installation
### Composer
You can install **Berlioz Event Manager** with [Composer](https://getcomposer.org/), it's the recommended installation.
```bash
$ composer require berlioz/event-manager
```
### Dependencies
* **PHP** ^8.0
* Packages:
* **psr/event-dispatcher**
## Usage
### Dispatcher
To initialize the event dispatcher:
```php
use Berlioz\EventManager\EventDispatcher;
$dispatcher = new EventDispatcher();
```
To listen an event:
```php
use Berlioz\EventManager\EventDispatcher;
$callback = function($event) {
// Do something
return $event;
};
/** @var EventDispatcher $dispatcher */
// A named event
$dispatcher->addEventListener('event.name', $callback);
// Your event object
$dispatcher->addEventListener(MyEvent::class, $callback);
```
To dispatch an event:
```php
/** @var EventDispatcher $dispatcher */
use Berlioz\EventManager\Event\CustomEvent;
use Berlioz\EventManager\EventDispatcher;
// A named event
$dispatcher->dispatch(new CustomEvent('event.name'));
// Your event object
$dispatcher->dispatch(new MyEvent());
```
### Priority
You can define a priority in your listeners. The highest priority is in the first executions.
```php
use Berlioz\EventManager\Listener\ListenerInterface;
/** ... */
// Normal priority (0)
$dispatcher->addEventListener('event.name', $callback, ListenerInterface::PRIORITY_NORMAL);
// High priority (100)
$dispatcher->addEventListener('event.name', $callback, ListenerInterface::PRIORITY_HIGH);
// Low priority (-100)
$dispatcher->addEventListener('event.name', $callback, ListenerInterface::PRIORITY_LOW);
```
The priority argument is an integer ; you can so define your priority with integer value instead of constant.
### Add delegate dispatcher
You can delegate dispatch to another dispatcher who respects PSR-14. The delegated dispatchers are called after, only if
event isn't stopped.
```php
use Berlioz\EventManager\EventDispatcher;
$dispatcher = new EventDispatcher();
$dispatcher->addEventDispatcher(new MyCustomDispatcher());
```
### Add listener provider
You can add listener providers. Providers are called in the order of addition.
```php
use Berlioz\EventManager\EventDispatcher;
$dispatcher = new EventDispatcher();
$dispatcher->addListenerProvider(new MyListenerProvider());
```
### Default listener
The default listener is `\Berlioz\EventManager\Listener\Listener`. You can define your own default provider, he must
implement `\Berlioz\EventManager\Listener\ListenerInterface` interface.
To declare this into the dispatcher:
```php
use Berlioz\EventManager\EventDispatcher;
use Berlioz\EventManager\Provider\ListenerProvider;$myDefaultProvider = new ListenerProvider();
$dispatcher = new EventDispatcher(defaultProvider: $myDefaultProvider);
```