https://github.com/ghostwriter/event-dispatcher
Provides an Event Dispatcher implementation for PHP
https://github.com/ghostwriter/event-dispatcher
event-dispatcher ghostwriter
Last synced: 29 days ago
JSON representation
Provides an Event Dispatcher implementation for PHP
- Host: GitHub
- URL: https://github.com/ghostwriter/event-dispatcher
- Owner: ghostwriter
- License: other
- Created: 2021-11-24T15:08:50.000Z (over 3 years ago)
- Default Branch: 5.0.x
- Last Pushed: 2025-04-22T00:48:04.000Z (about 1 month ago)
- Last Synced: 2025-04-22T01:29:43.882Z (about 1 month ago)
- Topics: event-dispatcher, ghostwriter
- Language: PHP
- Homepage: https://github.com/ghostwriter/event-dispatcher
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Event Dispatcher
[](https://github.com/sponsors/ghostwriter)
[](https://github.com/ghostwriter/event-dispatcher/actions/workflows/automation.yml)
[](https://www.php.net/supported-versions)
[](https://packagist.org/packages/ghostwriter/event-dispatcher)
Provides an Event Dispatcher implementation for PHP.
## Installation
You can install the package via composer:
``` bash
composer require ghostwriter/event-dispatcher
```
### Star ⭐️ this repo if you find it useful
You can also star (🌟) this repo to find it easier later.
### Usage
Registering and dispatching an Event Listener.
```php
use Ghostwriter\EventDispatcher\EventDispatcher;
use Ghostwriter\EventDispatcher\ListenerProvider;
// Create an event class
final class ExampleEvent
{
}
// Create an Event Listener
final class ExampleEventListener
{
public function __invoke(ExampleEvent $event): void
{
// Handle the event, e.g., print the event class name
// echo $event::class;
}
}
// Create a ListenerProvider
$listenerProvider = ListenerProvider::new(); // or new ListenerProvider(Container::getInstance())
// Bind the Listener to the Event
$listenerProvider->bind(ExampleEvent::class, ExampleEventListener::class);
// Create an EventDispatcher
$dispatcher = EventDispatcher::new($listenerProvider); // or new EventDispatcher($listenerProvider)
// Dispatch the Event.
$event = $dispatcher->dispatch(new ExampleEvent());
// Assert the Event is the same as the dispatched Event
assert($event instanceof ExampleEvent);
```
### Event Subscriber
Registering an Event Subscriber.
```php
use Ghostwriter\EventDispatcher\Interface\ListenerProviderInterface;
use Ghostwriter\EventDispatcher\Interface\SubscriberInterface;
use Override;
final class EventSubscriber implements SubscriberInterface {
/**
* @throws Throwable
*/
#[Override]
public function __invoke(ListenerProviderInterface $provider): void
{
// InvokableListener '::__invoke'
$provider->bind(
TestEvent::class,
TestEventListener::class,
);
}
}
// Create a ListenerProvider
$listenerProvider = ListenerProvider::new(); // or new ListenerProvider(Container::getInstance())
// Subscribe the EventSubscriber
$listenerProvider->subscribe(EventSubscriber::class);
// Create an EventDispatcher
$dispatcher = EventDispatcher::new($listenerProvider); // or new EventDispatcher($listenerProvider)
// Dispatch the Event.
$event = $dispatcher->dispatch(new TestEvent());
// Assert the Event is the same as the dispatched Event
assert($event instanceof TestEvent);
```
### Changelog
Please see [CHANGELOG.md](./CHANGELOG.md) for more information what has changed recently.
### Security
If you discover any security related issues, please email `[email protected]` or create a [Security Advisory](https://github.com/ghostwriter/event-dispatcher/security/advisories/new) instead of using the issue tracker.
## License
The BSD-4-Clause. Please see [License File](./LICENSE) for more information.