Download the PHP package hoa/event without Composer

On this page you can find all versions of the php package hoa/event. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Please rate this library. Is it a good library?

All versions of event with dependencies

Informations about the package event

Hoa


Build status Code coverage Packagist License

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.

Hoa\Event

Help on IRC Help on Gitter Documentation Board

This library allows to use events and listeners in PHP. This is an observer design-pattern implementation.

Learn more.

Installation

With Composer, to include this library into your dependencies, you need to require hoa/event:

For more installation procedures, please read the Source page.

Testing

Before running the test suites, the development dependencies must be installed:

Then, to run all the test suites:

For more information, please read the contributor guide.

Quick usage

We propose a quick overview of how to use events and listeners.

Events

An event is:

In Hoa, an event channel has the following form: hoa://Event/LibraryName/AnId:pseudo-class#anAnchor. For instance, the hoa://Event/Exception channel contains all exceptions that have been thrown. The hoa://Event/Stream/StreamName:close-before contains all streams that are about to close. Thus, the following example will observe all thrown exceptions:

Because attach expects a callable and because Hoa's callable implementation is smart, we can directly attach a stream to an event, like:

This way, all exceptions will be printed on the Foo.log file.

Listeners

Contrary to an event, a listener is:

The Hoa\Event\Listenable interface requires the on method to be present to register a listener to a listener ID. For instance, the following example listens the message listener ID, i.e. when a message is received by the WebSocket server, the closure is executed:

Documentation

The hack book of Hoa\Event contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

More documentation can be found on the project's website: hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details.


Version
Requires php Version >=7.1
hoa/consistency Version ~2.0
hoa/exception Version ~2.0

The package hoa/event contains the following files

Loading the files please wait ....