https://github.com/dazzle-php/event
Dazzle Async Events & Dispatchers
https://github.com/dazzle-php/event
async dazzle dispatcher event event-driven event-emitter event-handler event-handling php php-lib php7
Last synced: 10 months ago
JSON representation
Dazzle Async Events & Dispatchers
- Host: GitHub
- URL: https://github.com/dazzle-php/event
- Owner: dazzle-php
- License: mit
- Created: 2017-06-24T19:05:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-20T18:06:07.000Z (over 8 years ago)
- Last Synced: 2025-03-22T04:23:50.523Z (11 months ago)
- Topics: async, dazzle, dispatcher, event, event-driven, event-emitter, event-handler, event-handling, php, php-lib, php7
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Dazzle Events & Dispatchers
[](https://travis-ci.org/dazzle-php/event)
[](https://scrutinizer-ci.com/g/dazzle-php/event/?branch=master)
[](https://scrutinizer-ci.com/g/dazzle-php/event/?branch=master)
[](https://packagist.org/packages/dazzle-php/event)
[](https://packagist.org/packages/dazzle-php/event)
[](https://packagist.org/packages/dazzle-php/event/license)
> **Note:** This repository is part of [Dazzle Project](https://github.com/dazzle-php/dazzle) - the next-gen library for PHP. The project's purpose is to provide PHP developers with a set of complete tools to build functional async applications. Please, make sure you read the attached README carefully and it is guaranteed you will be surprised how easy to use and powerful it is. In the meantime, you might want to check out the rest of our async libraries in [Dazzle repository](https://github.com/dazzle-php) for the full extent of Dazzle experience.
## Description
Dazzle Event is a library which purpose is to provide all of the tools that are required to implement event-based architecture in any application. It delivers classes and interfaces designed specifically for that exact purpose and is designed to be easy to work with, efficient and effective.
## Feature Highlights
Dazzle Event features:
* Support for working with events, event-dispatchers and event-handlers,
* Support for synchronous events,
* Support for asynchronous events using loop,
* Built-in event handlers,
* Built-in expanded interfaces for attaching listeners and managing events propagation,
* ...and more.
## Provided Example(s)
### Quickstart
```php
use Dazzle\Event\EventEmitter;
$emitter = new EventEmitter();
$emitter->on('script.start', function($user, $time) {
echo "User '$user' has started this script at $time.\n";
});
$emitter->emit('script.start', [ get_current_user(), date('H:i:s Y-m-d') ]);
```
### Additional
Additional examples can be found in [example](https://github.com/dazzle-php/event/tree/master/example) directory. Below is the list of provided examples as a reference and preferred consumption order:
- [Quickstart](https://github.com/dazzle-php/event/blob/master/example/events_quickstart.php)
- [Using multiple listeners](https://github.com/dazzle-php/event/blob/master/example/events_handlers_multiple.php)
- [Using disposable (one-time) listeners](https://github.com/dazzle-php/event/blob/master/example/events_handlers_disposable.php)
- [Using delayed listeners](https://github.com/dazzle-php/event/blob/master/example/events_handlers_delayed.php)
- [Using exact (multiple-times) listeners](https://github.com/dazzle-php/event/blob/master/example/events_handlers_exact.php)
- [Using mixed listeners](https://github.com/dazzle-php/event/blob/master/example/events_handlers_mixed.php)
- [Cancelling](https://github.com/dazzle-php/event/blob/master/example/events_cancelling.php)
- [__Advanced:__ Asynchronous event-emitters](https://github.com/dazzle-php/event/blob/master/example/advanced_async_emitters.php)
- [__Advanced:__ Copying events](https://github.com/dazzle-php/event/blob/master/example/advanced_flow_copying_events.php)
- [__Advanced:__ Forwarding events](https://github.com/dazzle-php/event/blob/master/example/advanced_flow_forwarding_events.php)
- [__Advanced:__ Chaining events propagation](https://github.com/dazzle-php/event/blob/master/example/advanced_flow_chaining.php)
- [__Advanced:__ Switching propagation modes of event-emitters](https://github.com/dazzle-php/event/blob/master/example/advanced_flow_switching_modes.php)
If any of the above examples has left you confused, please take a look in the [tests](https://github.com/dazzle-php/event/tree/master/test) directory as well.
## Comparison
This section contains Dazzle vs React comparison many users requested. If you are wondering why this section has been created, see the [author's note](https://github.com/dazzle-php/dazzle/blob/master/NOTE.md).
#### Performance
The detailed information about this benchmark can be found in [benchmark-on.php](https://github.com/dazzle-php/event/blob/master/example-bench/benchmark-on.php) and [benchmark-on-react.php](https://github.com/dazzle-php/event/blob/master/example-bench/benchmark-on-react.php) files.
#### Memory Allocation Efficiency
The detailed information about this benchmark can be found in [benchmark-once.php](https://github.com/dazzle-php/event/blob/master/example-bench/benchmark-once.php) and [benchmark-once-react.php](https://github.com/dazzle-php/event/blob/master/example-bench/benchmark-once-react.php) files.
#### Details
| Detail | Dazzle Event | React-equivalent |
| :--- | :---: | :---: |
| Active support | X | ? |
| Provided well-formed documentation | X | X |
| Provided well-formed set of tests with at least 80% coverage and API examples | X | X |
| Use of events with continous listeners | X | X |
| Use of events with single-use listeners | X | X |
| Use of events with delayed listeners | X | |
| Use of events with exact-time listeners | X | |
| Use of events with mixed-type listeners | X | |
| Cancelling listeners | X | X |
| Asynchronous emitters | X | |
| Copying events | X | |
| Forwarding events | X | |
| Different modes of events propagation | X | |
## Requirements
Dazzle Event requires:
* PHP-5.6 or PHP-7.0+,
* UNIX or Windows OS.
## Installation
To install this library make sure you have [composer](https://getcomposer.org/) installed, then run following command:
```
$> composer require dazzle-php/event
```
## Tests
Tests can be run via:
```
$> vendor/bin/phpunit -d memory_limit=1024M
```
## Versioning
Versioning of Dazzle libraries is being shared between all packages included in [Dazzle Project](https://github.com/dazzle-php/dazzle). That means the releases are being made concurrently for all of them. On one hand this might lead to "empty" releases for some packages at times, but don't worry. In the end it is far much easier for contributors to maintain and -- what's the most important -- much more straight-forward for users to understand the compatibility and inter-operability of the packages.
## Contributing
Thank you for considering contributing to this repository!
- The contribution guide can be found in the [contribution tips](https://github.com/dazzle-php/event/blob/master/CONTRIBUTING.md).
- Open tickets can be found in [issues section](https://github.com/dazzle-php/event/issues).
- Current contributors are listed in [graphs section](https://github.com/dazzle-php/event/graphs/contributors)
- To contact the author(s) see the information attached in [composer.json](https://github.com/dazzle-php/event/blob/master/composer.json) file.
## License
Dazzle Framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
"Everything is possible. The impossible just takes longer." ― Dan Brown