dazzle-php/event

Dazzle Events & Dispatchers.

v0.5.0-beta 2017-07-16 22:30 UTC

Requires

• php: >=5.6.7
• dazzle-php/loop: 0.5.*

Requires (Dev)

• phpunit/phpunit: >=4.8.0 <5.4.0

MIT

• Kamil Jamroz
• The contributors

• event
• emitter
• dispatch
• event-driven
• event emitter
• dazzle
• dazzle-php

README

Note: This repository is part of Dazzle Project - 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 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

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 directory. Below is the list of provided examples as a reference and preferred consumption order:

• Quickstart
• Using multiple listeners
• Using disposable (one-time) listeners
• Using delayed listeners
• Using exact (multiple-times) listeners
• Using mixed listeners
• Cancelling
• Advanced: Asynchronous event-emitters
• Advanced: Copying events
• Advanced: Forwarding events
• Advanced: Chaining events propagation
• Advanced: Switching propagation modes of event-emitters

If any of the above examples has left you confused, please take a look in the tests 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.

Performance

The detailed information about this benchmark can be found in benchmark-on.php and benchmark-on-react.php files.

Memory Allocation Efficiency

The detailed information about this benchmark can be found in benchmark-once.php and 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 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. 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.
• Open tickets can be found in issues section.
• Current contributors are listed in graphs section
• To contact the author(s) see the information attached in composer.json file.

License

Dazzle Framework is open-sourced software licensed under the MIT license.

"Everything is possible. The impossible just takes longer." ― Dan Brown