walmsles/silverstripe-event-dispatch

Integrate walmsles/event-dispatch into Silverstripe

silverstripe-event-dispatch

Silverstripe integration of walmsles/event-dispatch PHP module., _(*1)

Maintainer Contact

• Michael Walmsley (michael.walmsley@outlook.com)

Requirements

• Silverstripe 3.3 (earlier versions probably OK but not tested)

Installation

composer install walmsles/silverstripe-event-dispatch, _(*2)

Documentation

A nice decoupled event dispatch model integrated into Silverstripe using a publish/subscribe mechanism., _(*3)

Event Module allows registration of listeners to arbitrary events which can be fired anywhere and at anytime. Listeners are any valid callable PHP structure as defined by PHP's call_user_func_array. e.g. Closure, function name, array definining Class instance and method (array($this, 'myMethod')), _(*4)

Calling Methods

There are two ways to call functions on the event dispatcher that have identical results - EventDispatcher::dispatch('myEvent', array('event data', 'event data 2')); - EventDispatcher::inst()->dispatch('myEvent', array('event data', 'event data 2'));, _(*5)

While the first method is more concise as it uses __callStatic to forward the calls the second method will allow your IDE to autocomplete the available methods. The choice is yours., _(*6)

EventDispatcher::inst()->subscribe('myEvent', function($myData1, $myData2) {
    // so somehting with $myData

    return $myData1 . ' ' . $myData2;
});

/** @var array $responses */
$responses = EventDispatcher::inst()->dispatch('myEvent', array('event data', 'event data 2'));

Full documentation is available here, _(*7)