Requirements

Installation

composer require spiral-packages/event-bus

protectedconstLOAD = [// ...    \Spiral\EventBus\Bootloader\EventBusBootloader::class,];

namespaceApp\Bootloader;useSpiral\EventBus\Bootloader\EventBusBootloaderasBaseBootloaderclass EventBusBootloaderextends BaseBootloader{protectedconstLISTENS = [        \App\Event\UserCreated::class => [            \App\Listener\SendWelcomeMessageListener::class        ],//...    ];}

Usage

<?phpdeclare(strict_types=1);return ['queueConnection' =>env('EVENT_BUS_QUEUE_CONNECTION'),// default queue connection for Listeners with \Spiral\EventBus\QueueableInterface'discoverListeners' =>env('EVENT_BUS_DISCOVER_LISTENERS',true),// Discover listeners with \Spiral\EventBus\Attribute\Listener attribute'listeners' => [        UserDeleted::class => [            DeleteUserComments::class,        ]    ],'interceptors' => [        BroadcastEventInterceptor::class    ]];

class MyPackageBootloaderextendsSpiral\Boot\Bootloader\Bootloader{publicfunctionstart(Spiral\EventBus\ListenerRegistryInterface$registry)     {$registry->addListener(UserDeleted::class, DeleteUserComments::class);    }}

Event example

class UserDeleted {publicfunction__construct(publicstring$name) {}}

Listener example

class DeleteUserComments {publicfunction__construct(privateCommentService$service) {}publicfunction__invoke(UserDeleted$event)    {$this->service->deleteCommentsForUser($event->name);    }}

Listener example with attributes

useSpiral\EventBus\Attribute\Listener;class DeleteUserComments {publicfunction__construct(privateCommentService$service) {}        #[Listener]publicfunctionhandleDeletedUser(UserDeleted$event)    {$this->service->deleteCommentsForUser($event->usernname);    }        #[Listener]publicfunctionhandleCreatedUser(UserCreated$event)    {$this->service->creaateUserProfile($event->usernname);    }        #[Listener]publicfunctionnotifyAdmins(UserCreated|UserDeleted$event)    {$this->service->notifyAdmins($event->usernname);    }}

Listener example that should be handled in a queue

class DeleteUserCommentsimplements \Spiral\EventBus\QueueableInterface{// ...}

Event dispatching

useSymfony\Component\EventDispatcher\EventDispatcherInterface;class UserService {publicfunction__construct(privateEventDispatcherInterface$events) {}publicfunctiondeleteUserById(string$id):void    {$user = User::findById($id);//..$this->events->dispatch(newUserDeleted($user->username)        );    }}

Interceptors

namespaceApp\Bootloader;useSpiral\EventBus\Bootloader\EventBusBootloaderasBaseBootloaderclass EventBusBootloaderextends BaseBootloader{protectedconstINTERCEPTORS = [        \App\Event\Interceptor\BroadcastEventInterceptor::class,//...    ];}

<?phpdeclare(strict_types=1);return [// ...'interceptors' => [        BroadcastEventInterceptor::class    ]];

namespaceApp\Event\Interceptor;useSpiral\Broadcasting\BroadcastInterface;class BroadcastEventInterceptorimplements \Spiral\Core\CoreInterceptorInterface{publicfunction__construct(privateBroadcastInterface$broadcast    ) {}publicfunctionprocess(string$eventName,string$action, array ,CoreInterface$core):mixed    {$event =$parameters['event'];// Event object$listeners =$parameters['listeners'];// array of invokable listeners$result =$core->callAction($eventName,$action,$parameters);if ($eventinstanceof ShouldBroadcastInterface) {$this->broadcast->publish($event->getBroadcasTopics(),\json_encode($event->toBroadcast())            );        }return$result;    }}

Testing

composertest

class EventDispatcherTestextends TestCase{use \Spiral\EventBus\Testing\InteractsWithEvents;publicfunctiontestDispatchEvent():void    {$events =$this->fakeEventDispatcher();$this->getDispatcher()->dispatch(newSimpleEvent());$events->assertListening(SimpleEvent::class, SimpleListener::class);$events->assertListening(SimpleEvent::class, ListenerWithAttributes::class,'methodA');$events->assertDispatched(SimpleEvent::class)$events->assertDispatched(SimpleEvent::class,function(SimpleEvent$event) {return$event->someProperty ==='foo';        });$events->assertDispatchedTimes(SimpleEvent::class,10);$events->assertNotDispatched(AnotherSimpleEvent::class);$events->assertNotDispatched(AnotherSimpleEvent::class);$events->assertNothingDispatched();    }}

Changelog

Contributing

Security Vulnerabilities

Credits

License