bugadani/event_source

A library to create event sources easily

EventSource

EventSource is a simple library for PHP 5.4+ to create event source objects., _(*1)

Usage

EventSource trait

When you wish to make one of your classes an event source, simply use the EventSource trait in them and call the initializer method., _(*2)

class SomeClass {
    use EventSource\EventSource;

    public function __construct() {
        //initialize defines the events that can be used
        $this->initialize(['fooEvent', 'barEvent']);
    }

    public function someMethod() {
        $this->raise('fooEvent', $someOptionalParameter);
    }
}

You can use the on($eventName, $callback) method to define event handlers which will be notified if the given event is raised., _(*3)

$someObject = new SomeClass();
$someObject->on('fooEvent', function($someParameter = null) {
    //do something
});

You can also remove event handlers using the remove($eventName, $callback) method., _(*4)

Event class

Alternatively, you have the option to manually create Event objects that are used by EventSource to manage the event handlers. The Event class has the following methods:, _(*5)

• on($callback) - register a new callback to handle the event
• remove($callback) - removes a previously registered callback
• raise(optional $parameter) - raises the event

One downside is when using the Event class directly is that raise() is a public method, so any outside code may trigger events., _(*6)

Installation

Using Composer

"require": {
    "bugadani/event_source": "1.*"
}