solophp/event-dispatcher

Minimal, PSR-14 compatible event dispatcher with priorities and stoppable propagation.

v1.0.0 2025-08-10 16:08 UTC

Requires

• php: ^8.1
• psr/event-dispatcher: ^1.0

Requires (Dev)

• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.7

MIT

• event
• dispatcher
• event dispatcher
• event listener
• psr-14

README

Minimal, PSR-14 compatible event dispatcher with priorities and stoppable propagation.

Features:

• PSR-14 compliant (psr/event-dispatcher)
• Listeners, subscribers, priorities, stoppable events
• Factories for quick setup

Requirements & Install

composer require solophp/event-dispatcher

Usage

use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\EventDispatcher\ListenerProviderInterface;
use Solo\EventDispatcher\{EventDispatcher, ListenerProvider, EventSubscriberInterface};

final class UserRegistered
{
    public function __construct(public string $username) {}
}

final class WelcomeEmailSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
            UserRegistered::class => ['onUserRegistered', 10],
        ];
    }

    public function onUserRegistered(UserRegistered $event): void
    {
        // send email
        echo "Welcome, {$event->username}!" . PHP_EOL;
    }
}

$provider = new ListenerProvider(); // implements ListenerProviderInterface
$provider->addSubscriber(new WelcomeEmailSubscriber());

$dispatcher = new EventDispatcher($provider); // implements EventDispatcherInterface
$dispatcher->dispatch(new UserRegistered('john'));

Usage with factory

use Solo\EventDispatcher\Factory\EventDispatcherFactory;

// Build dispatcher via a single call
$dispatcher = EventDispatcherFactory::create(
    listeners: [
        // Map event class to listeners with optional priorities
        UserRegistered::class => [
            [fn (UserRegistered $e) => print "Welcome, {$e->username}!\n", 10],
        ],
    ],
    subscribers: [
        new WelcomeEmailSubscriber(),
        // or provide a factory callable if constructor args are needed:
        // fn () => new WelcomeEmailSubscriber(...)
    ],
);

$dispatcher->dispatch(new UserRegistered('john'));

Subscribers map format (supported variants):

return [
  EventClass::class => 'methodName',
  // or with priority
  EventClass::class => ['methodName', 10],
  // or multiple handlers
  EventClass::class => [ ['firstMethod', 20], ['secondMethod', 0] ],
];

Testing

# Run tests
composer test

# Run code sniffer
composer cs

# Fix code style issues
composer cs-fix

License

This project is open-sourced under the MIT license.