helmich / flow-eventbroker
TYPO3 Flow package containing an event dispatching mechanism
Fund package maintenance!
martin-helmich
donate.helmich.me
Installs: 39
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 5
Forks: 0
Open Issues: 0
Type:typo3-flow-package
Requires
- typo3/flow: *
This package is auto-updated.
Last update: 2024-10-28 05:02:07 UTC
README
A simple event dispatching library for TYPO3 Flow.
Installation
The package is available on Packagist. Use the following setup in your composer manifest:
{
"require": {
"helmich/flow-eventbroker": "*"
}
}
Examples
Publishing events
Events are regular methods that are tagged with an @Event\Event
annotation:
<?php
namespace My\Example;
use Helmich\EventBroker\Annotations as Event;
class Emitter {
public function doSomething() {
// ...
$this->publishSomeEvent(new SomeEvent("foo"));
}
/**
* @Event\Event
*/
protected function publishSomeEvent(SomeEvent $event) {
}
}
Subscribing to events
Listeners are also regular methods, that are tagged with an @Event\Listener
annotation.
The event class to listen for is specified as parameter within the annotation.
<?php
namespace My\Example;
use Helmich\EventBroker\Annotations as Event;
class Listener {
/**
* @Event\Listener("My\Example\SomeEvent")
*/
public function myListener(SomeEvent $event) {
}
}
Synchronous and asynchronous events
By defaults, listeners will be called asynchronously. In the default implementation, events will be queued and dispatched in an event loop at the end of the main application run (other, later implementations might do this completely asynchronously by dispatching events to another process).
You can explicitly declare listeners to be processed synchronously (when the event is published)
by using the "sync" tag in the @Event\Listener
annotation:
<?php
namespace My\Example;
use Helmich\EventBroker\Annotations as Event;
class Listener {
/**
* @Event\Listener("My\Example\SomeEvent", sync=TRUE)
*/
public function myListener(SomeEvent $event) { }
}
To-Do
- Add unit test coverage
- Provide mechanisms for asynchronous event processing