peridot-php/event-emitter

EventEmitter is a very simple event dispatching library for PHP

dev-master / 2.0.x-dev 2015-04-18 16:26 UTC

This package is not auto-updated.

Last update: 2024-10-26 18:49:19 UTC


README

EventEmitter is a very simple event dispatching library for PHP. It is a fork of Événement aiming to provide additional functionality and PHP 5.6 features like variadic arguments.

It is very strongly inspired by the EventEmitter API found in node.js.

Build Status

Fetch

The recommended way to install EventEmitter is through composer.

Just create a composer.json file for your project:

{
    "require": {
        "peridot/event-emitter": "2.0.*"
    }
}

And run these two commands to install it:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar install

Now you can add the autoloader, and you will have access to the library:

<?php
require 'vendor/autoload.php';

Usage

Creating an Emitter

<?php
$emitter = new Peridot\EventEmitter();

Adding Listeners

<?php
$emitter->on('user.created', function (User $user) use ($logger) {
    $logger->log(sprintf("User '%s' was created.", $user->getLogin()));
});

Emitting Events

<?php
$emitter->emit('user.created', $user);

Tests

$ vendor/bin/phpunit

License

MIT, see LICENSE.