onoi/event-dispatcher

A minimalistic interface to relay generic events to registered listeners

1.0.0 2015-03-25 23:19 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Packagist download count Dependency Status

A minimalistic event dispatcher (observer) interface that was part of the Semantic MediaWiki code base and is now being deployed as independent library.

Requirements

PHP 5.3/HHVM 3.3 or later

Installation

The recommended installation method for this library is by either adding the dependency to your composer.json

{
	"require": {
		"onoi/event-dispatcher": "~1.0"
	}
}

or to execute composer require onoi/event-dispatcher:~1.0.

Usage

class BarListener implements EventListener {

	public function execute( DispatchContext $dispatchContext = null ) {
		// Do something
	}

	public function isPropagationStopped() {
		return false;
	}
}
class ListenerCollectionRegistery implements EventListenerCollection {

	private $eventListenerCollection;

	public function __construct( EventListenerCollection $eventListenerCollection ) {
		$this->eventListenerCollection = $eventListenerCollection;
	}

	public function getCollection() {
		return $this->addToListenerCollection()->getCollection();
	}

	private function addToListenerCollection() {

		$this->eventListenerCollection->registerCallback( 'do.something', function() {
			// Do something
		} );

		$this->eventListenerCollection->registerListener( 'notify.bar', new BarListener() );

		return $this->eventListenerCollection;
	}
}
$eventDispatcherFactory = new EventDispatcherFactory();

$listenerCollectionRegistery = new ListenerCollectionRegistery(
	$eventDispatcherFactory->newGenericEventListenerCollection()
);

$eventDispatcher = $eventDispatcherFactory->newGenericEventDispatcher();
$eventDispatcher->addListenerCollection( $listenerCollectionRegistery );

class Foo {

	public function __construct( EventDispatcher $eventDispatcher ) {
		$this->eventDispatcher = $eventDispatcher;
	}

	public function doSomething() {
		$this->eventDispatcher->dispatch( 'do.something' );

		$dispatchContext = new DispatchContext();
		$dispatchContext->set( 'dosomethingelse', new \stdClass );

		$this->eventDispatcher->dispatch( 'notify.bar', $dispatchContext );
	}
}

$instance = new Foo( $eventDispatcher );
$instance->doSomething();

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guidelinee. A list of people who have made contributions in the past can be found here.

Tests

The library provides unit tests that covers the core-functionality normally run by the continues integration platform. Tests can also be executed manually using the PHPUnit configuration file found in the root directory.

Release notes

  • 1.0.0 initial release (2015-03-25)

License

GNU General Public License 2.0 or later.