activecollab / eventsdispatcher
Dispatch events, and provide event handlers
Installs: 46 023
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=7.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.0
- phpunit/phpunit: ^5.0
This package is auto-updated.
Last update: 2024-10-24 07:50:37 UTC
README
This package offers simple events dispatcher, with listeners. Key concepts:
- Events are not arbitrary strings, but instances that encapsulate all relevant event data,
- When you specify a listener, you specify an event class (or interface) that you want to listen to,
- You can listen to entire classes of events, by specifying general enough event class (or interface),
- Listeners are callables, and event is always passed to it as the first (and only) argument.
General listener example:
<?php namespace MyApp; use ActiveCollab\EventsDispatcher\EventsDispatcher; use ActiveCollab\EventsDispatcher\Test\Fixtures\LicenseRenewedEvent\LicenseRenewedEventInterface; $dispatcher = new EventsDispatcher(); $dispatcher->listen(LicenseRenewedEventInterface::class, function (LicenseRenewedEventInterface $event) { print "License {$event->getLicenseKey()} has been renewed\n"; });
To specify a global listener, that handles all events, just go highly general with the specification:
<?php namespace MyApp; use ActiveCollab\EventsDispatcher\EventsDispatcher; use ActiveCollab\EventsDispatcher\Events\EventInterface; $dispatcher = new EventsDispatcher(); $dispatcher->listen(EventInterface::class, function (EventInterface $event) { print "Event " . get_class($event) . " handled\n"; });
Similar approach can be used to handle a class of events. Instead of using the base EventInterface
, register listener to a class, or interface that all events of a targeted type extend, or implement.
To trigger an event, call trigger()
method with event as the first (and only) argument:
<?php namespace MyApp; use ActiveCollab\EventsDispatcher\EventsDispatcher; use ActiveCollab\EventsDispatcher\Test\Fixtures\LicenseRenewedEvent\LicenseRenewedEvent; $dispatcher = new EventsDispatcher(); $dispatcher->trigger(new LicenseRenewedEvent( '123', '2016-12-31', '2017-12-31', 699.0 ));