PHPackages gpslab/domain-event-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. gpslab/domain-event-bundle ActiveSymfony-bundle[Utility & Helpers](/categories/utility) gpslab/domain-event-bundle ========================== Bundle to create the domain layer of your DDD application v2.3.1(4y ago)1427.1k2[1 PRs](https://github.com/gpslab/domain-event-bundle/pulls)MITPHPPHP >=5.5.0CI failing Since Apr 20Pushed 4y ago1 watchersCompare [ Source](https://github.com/gpslab/domain-event-bundle)[ Packagist](https://packagist.org/packages/gpslab/domain-event-bundle)[ Docs](https://github.com/gpslab/domain-event-bundle)[ RSS](/packages/gpslab-domain-event-bundle/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (6)Versions (19)Used By (0) [![Latest Stable Version](https://camo.githubusercontent.com/3d141b3d50dde05c9fe9a4b9378f51fc6aa96b8f14038edb81760212c6a7ae92/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030266c6162656c3d737461626c65)](https://packagist.org/packages/gpslab/domain-event-bundle)[![PHP Version Support](https://camo.githubusercontent.com/cc5118989d94d3611ad74a1b64ba769376f2fa33376c334a2ce7019bb5f311f7/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f7068702d762f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030)](https://packagist.org/packages/gpslab/domain-event-bundle)[![Total Downloads](https://camo.githubusercontent.com/1b3793cfc2bc4c41a46b95439fa48accea972ce48ebbd68a6ffe13718df38107/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030)](https://packagist.org/packages/gpslab/domain-event-bundle)[![Build Status](https://camo.githubusercontent.com/4dff34cb78416fa087ebeceac68494428953b9c23f3c3e5133309042dc29663e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636865636b732d7374617475732f6770736c61622f646f6d61696e2d6576656e742d62756e646c652f6d61737465722e7376673f6c6162656c3d6275696c64266d61784167653d33363030)](https://travis-ci.org/gpslab/domain-event-bundle)[![Coverage Status](https://camo.githubusercontent.com/ec5d1341603a3f5f5fc96b7b66f69f4343096ab43d40146a490f4d2b1c75c677/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030)](https://coveralls.io/github/gpslab/domain-event-bundle?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/a4b7fc2e0e4484535fd72e9fa7b6539eb9fc3957475c8c16d7370a664899610b/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030)](https://scrutinizer-ci.com/g/gpslab/domain-event-bundle/?branch=master)[![License](https://camo.githubusercontent.com/7947046344c9e3f241ed0d209819a589d159f3c9147b23903073d2d5ab961314/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6770736c61622f646f6d61696e2d6576656e742d62756e646c652e7376673f6d61784167653d33363030)](https://github.com/gpslab/domain-event-bundle) Domain event bundle =================== [](#domain-event-bundle) Bundle to create the domain layer of your [Domain-driven design (DDD)](https://en.wikipedia.org/wiki/Domain-driven_design) application. This [Symfony](https://symfony.com/) bundle is a wrapper for [gpslab/domain-event](https://github.com/gpslab/domain-event), look it for more details. Installation ------------ [](#installation) Pretty simple with [Composer](http://packagist.org), run: ``` composer req gpslab/domain-event-bundle ``` Configuration ------------- [](#configuration) Example configuration ``` gpslab_domain_event: # Event bus service # Support 'listener_located', 'queue' or a custom service # As a default used 'listener_located' bus: 'listener_located' # Event queue service # Support 'pull_memory', 'subscribe_executing' or a custom service # As a default used 'pull_memory' queue: 'pull_memory' # Event listener locator # Support 'symfony', 'container', 'direct_binding' or custom service # As a default used 'symfony' locator: 'symfony' # Publish domain events post a Doctrine flush event # As a default used 'false' publish_on_flush: true ``` Usage ----- [](#usage) Create a domain event ``` use GpsLab\Domain\Event\Event class PurchaseOrderCreatedEvent implements Event { private $customer_id; private $create_at; public function __construct(CustomerId $customer_id, \DateTimeImmutable $create_at) { $this->customer_id = $customer_id; $this->create_at = $create_at; } public function customerId(): CustomerId { return $this->customer_id; } public function createAt(): \DateTimeImmutable { return $this->create_at; } } ``` Raise your event ``` use GpsLab\Domain\Event\Aggregator\AbstractAggregateEvents; final class PurchaseOrder extends AbstractAggregateEvents { private $customer_id; private $create_at; public function __construct(CustomerId $customer_id) { $this->customer_id = $customer_id; $this->create_at = new \DateTimeImmutable(); $this->raise(new PurchaseOrderCreatedEvent($customer_id, $this->create_at)); } } ``` Create listener ``` use GpsLab\Domain\Event\Event; class SendEmailOnPurchaseOrderCreated { private $mailer; public function __construct(\Swift_Mailer $mailer) { $this->mailer = $mailer; } public function onPurchaseOrderCreated(PurchaseOrderCreatedEvent $event): void { $message = $this->mailer ->createMessage() ->setTo('recipient@example.com') ->setBody(sprintf( 'Purchase order created at %s for customer #%s', $event->createAt()->format('Y-m-d'), $event->customerId() )); $this->mailer->send($message); } } ``` Register event listener ``` services: SendEmailOnPurchaseOrderCreated: arguments: [ '@mailer' ] tags: - { name: domain_event.listener, event: PurchaseOrderCreatedEvent, method: onPurchaseOrderCreated } ``` Publish events in listener ``` use GpsLab\Domain\Event\Bus\EventBus; // get event bus from DI container $bus = $this->get(EventBus::class); // do what you need to do on your Domain $purchase_order = new PurchaseOrder(new CustomerId(1)); // this will clear the list of event in your AggregateEvents so an Event is trigger only once $events = $purchase_order->pullEvents(); // You can have more than one event at a time. foreach($events as $event) { $bus->publish($event); } // You can use one method //$bus->pullAndPublish($purchase_order); ``` Listener method name -------------------- [](#listener-method-name) You do not need to specify the name of the event handler method. By default, the [\_\_invoke](http://php.net/manual/en/language.oop5.magic.php#object.invoke) method is used. ``` use GpsLab\Domain\Event\Event; class SendEmailOnPurchaseOrderCreated { private $mailer; public function __construct(\Swift_Mailer $mailer) { $this->mailer = $mailer; } public function __invoke(PurchaseOrderCreatedEvent $event): void { $message = $this->mailer ->createMessage() ->setTo('recipient@example.com') ->setBody(sprintf( 'Purchase order created at %s for customer #%s', $event->createAt()->format('Y-m-d'), $event->customerId() )); $this->mailer->send($message); } } ``` Register event listener ``` services: SendEmailOnPurchaseOrderCreated: arguments: [ '@mailer' ] tags: - { name: domain_event.listener, event: PurchaseOrderCreatedEvent } ``` Event subscribers ----------------- [](#event-subscribers) Create subscriber ``` use GpsLab\Domain\Event\Event; use GpsLab\Domain\Event\Listener\Subscriber; class SendEmailOnPurchaseOrderCreated implements Subscriber { private $mailer; public function __construct(\Swift_Mailer $mailer) { $this->mailer = $mailer; } public static function subscribedEvents(): array { return [ PurchaseOrderCreatedEvent::class => ['onPurchaseOrderCreated'], ]; } public function onPurchaseOrderCreated(PurchaseOrderCreatedEvent $event): void { $message = $this->mailer ->createMessage() ->setTo('recipient@example.com') ->setBody(sprintf( 'Purchase order created at %s for customer #%s', $event->createAt()->format('Y-m-d'), $event->customerId() )); $this->mailer->send($message); } } ``` Register event subscriber ``` services: SendEmailOnPurchaseOrderCreated: arguments: [ '@mailer' ] tags: - { name: domain_event.subscriber } ``` Use pull Predis queue --------------------- [](#use-pull-predis-queue) Install [Predis](https://github.com/nrk/predis) with [Composer](http://packagist.org), run: ``` composer require predis/predis ``` Register services: ``` services: # Predis Predis\Client: arguments: [ '127.0.0.1' ] # Events serializer for queue GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer: arguments: [ '@serializer', 'json' ] # Predis event queue GpsLab\Domain\Event\Queue\Pull\PredisPullEventQueue: arguments: - '@Predis\Client' - '@GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer' - '@logger' - 'event_queue_name' ``` Change config for use custom queue: ``` gpslab_domain_event: queue: 'GpsLab\Domain\Event\Queue\Pull\PredisPullEventQueue' ``` And now you can use custom queue: ``` use GpsLab\Domain\Event\Queue\EventQueue; $container->get(EventQueue::class)->publish($domain_event); ``` In latter pull events from queue: ``` use GpsLab\Domain\Event\Queue\EventQueue; $queue = $container->get(EventQueue::class); $bus = $container->get(EventQueue::class); while ($event = $queue->pull()) { $bus->publish($event); } ``` Use Predis subscribe queue -------------------------- [](#use-predis-subscribe-queue) Install [Predis PubSub](https://github.com/Superbalist/php-pubsub-redis) adapter with [Composer](http://packagist.org), run: ``` composer require superbalist/php-pubsub-redis ``` Register services: ``` services: # Predis Predis\Client: arguments: [ '127.0.0.1' ] # Predis PubSub adapter Superbalist\PubSub\Redis\RedisPubSubAdapter: arguments: [ '@Predis\Client' ] # Events serializer for queue GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer: arguments: [ '@serializer', 'json' ] # Predis event queue GpsLab\Domain\Event\Queue\Subscribe\PredisSubscribeEventQueue: arguments: - '@Superbalist\PubSub\Redis\RedisPubSubAdapter' - '@GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer' - '@logger' - 'event_queue_name' ``` Change config for use custom queue: ``` gpslab_domain_event: queue: 'GpsLab\Domain\Event\Queue\Subscribe\PredisSubscribeEventQueue' ``` And now you can use custom queue: ``` use GpsLab\Domain\Event\Queue\EventQueue; $container->get(EventQueue::class)->publish($domain_event); ``` Subscribe on the queue: ``` use GpsLab\Domain\Event\Queue\EventQueue; $container->get(EventQueue::class)->subscribe(function (Event $event) { // do somthing }); ``` > **Note** > > You can use subscribe handlers as a services and [tag](http://symfony.com/doc/current/service_container/tags.html) it for optimize register. Many queues ----------- [](#many-queues) You can use many queues for separation the flows. For example, you want to handle events of different Bounded Contexts separately from each other. ``` services: acme.domain.purchase_order.event.queue: class: GpsLab\Domain\Event\Queue\Pull\PredisPullEventQueue arguments: - '@Superbalist\PubSub\Redis\RedisPubSubAdapter' - '@GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer' - '@logger' - 'purchase_order_event_queue' acme.domain.article_comment.event.queue: class: GpsLab\Domain\Event\Queue\Pull\PredisPullEventQueue arguments: - '@Superbalist\PubSub\Redis\RedisPubSubAdapter' - '@GpsLab\Domain\Event\Queue\Serializer\SymfonySerializer' - '@logger' - 'article_comment_event_queue' ``` And now you can use a different queues. In **Purchase order** Bounded Contexts. ``` $event = new PurchaseOrderCreatedEvent( new CustomerId(1), new \DateTimeImmutable() ); $container->get('acme.domain.purchase_order.event.queue')->publish($event); ``` In **Article comment** Bounded Contexts. ``` $event = new ArticleCommentedEvent( new ArticleId(1), new AuthorId(1), $comment new \DateTimeImmutable() ); $container->get('acme.domain.article_comment.event.queue')->publish($event); ``` > **Note** > > Similarly, you can split the subscribe queues. License ------- [](#license) This bundle is under the [MIT license](http://opensource.org/licenses/MIT). See the complete license in the file: LICENSE ### Health Score 36 — LowBetter than 82% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity32 Limited adoption so far Community9 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~88 days Recently: every ~162 days Total 18 Last Release 1821d ago Major Versions 1.1.x-dev → v2.0.02017-07-17 ### Community Maintainers ![](https://www.gravatar.com/avatar/9a6415c83577efe7b70d9ae4a3bb12958adc11c16e530ff844ff217b0fd0c54a?d=identicon)[Peter Gribanov](/maintainers/Peter%20Gribanov) --- Top Contributors [![peter-gribanov](https://avatars.githubusercontent.com/u/1954436?v=4)](https://github.com/peter-gribanov "peter-gribanov (161 commits)") --- Tags ddddomain-eventinfrastructurephpsymfony-bundle ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/gpslab-domain-event-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/gpslab-domain-event-bundle/health.svg)](https://phpackages.com/packages/gpslab-domain-event-bundle) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[contao/core-bundle Contao Open Source CMS 1231.6M2.4k](/packages/contao-core-bundle)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[codefog/contao-haste haste extension for Contao Open Source CMS 42650.8k139](/packages/codefog-contao-haste) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)