Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gpslab/domain-event-bundle
Library to create the domain layer of your DDD application
https://github.com/gpslab/domain-event-bundle
ddd domain-event infrastructure php symfony-bundle
Last synced: about 12 hours ago
JSON representation
Library to create the domain layer of your DDD application
- Host: GitHub
- URL: https://github.com/gpslab/domain-event-bundle
- Owner: gpslab
- License: mit
- Created: 2016-09-29T16:07:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-07-15T15:58:27.000Z (over 3 years ago)
- Last Synced: 2024-12-16T15:11:02.942Z (7 days ago)
- Topics: ddd, domain-event, infrastructure, php, symfony-bundle
- Language: PHP
- Size: 112 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/gpslab/domain-event-bundle)
[](https://packagist.org/packages/gpslab/domain-event-bundle)
[](https://packagist.org/packages/gpslab/domain-event-bundle)
[](https://travis-ci.org/gpslab/domain-event-bundle)
[](https://coveralls.io/github/gpslab/domain-event-bundle?branch=master)
[](https://scrutinizer-ci.com/g/gpslab/domain-event-bundle/?branch=master)
[](https://github.com/gpslab/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
------------
Pretty simple with [Composer](http://packagist.org), run:
```sh
composer req gpslab/domain-event-bundle
```
Configuration
-------------
Example configuration
```yml
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
-----
Create a domain event
```php
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
```php
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
```php
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('[email protected]')
->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
```yml
services:
SendEmailOnPurchaseOrderCreated:
arguments: [ '@mailer' ]
tags:
- { name: domain_event.listener, event: PurchaseOrderCreatedEvent, method: onPurchaseOrderCreated }
```
Publish events in listener
```php
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
--------------------
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.
```php
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('[email protected]')
->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
```yml
services:
SendEmailOnPurchaseOrderCreated:
arguments: [ '@mailer' ]
tags:
- { name: domain_event.listener, event: PurchaseOrderCreatedEvent }
```
Event subscribers
-----------------
Create subscriber
```php
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('[email protected]')
->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
```yml
services:
SendEmailOnPurchaseOrderCreated:
arguments: [ '@mailer' ]
tags:
- { name: domain_event.subscriber }
```
Use pull Predis queue
---------------------
Install [Predis](https://github.com/nrk/predis) with [Composer](http://packagist.org), run:
```sh
composer require predis/predis
```
Register services:
```yml
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:
```yml
gpslab_domain_event:
queue: 'GpsLab\Domain\Event\Queue\Pull\PredisPullEventQueue'
```
And now you can use custom queue:
```php
use GpsLab\Domain\Event\Queue\EventQueue;
$container->get(EventQueue::class)->publish($domain_event);
```
In latter pull events from queue:
```php
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
--------------------------
Install [Predis PubSub](https://github.com/Superbalist/php-pubsub-redis) adapter with [Composer](http://packagist.org), run:
```sh
composer require superbalist/php-pubsub-redis
```
Register services:
```yml
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:
```yml
gpslab_domain_event:
queue: 'GpsLab\Domain\Event\Queue\Subscribe\PredisSubscribeEventQueue'
```
And now you can use custom queue:
```php
use GpsLab\Domain\Event\Queue\EventQueue;
$container->get(EventQueue::class)->publish($domain_event);
```
Subscribe on the queue:
```php
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
-----------
You can use many queues for separation the flows. For example, you want to handle events of different Bounded Contexts
separately from each other.
```yml
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.
```php
$event = new PurchaseOrderCreatedEvent(
new CustomerId(1),
new \DateTimeImmutable()
);
$container->get('acme.domain.purchase_order.event.queue')->publish($event);
```
In **Article comment** Bounded Contexts.
```php
$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
-------
This bundle is under the [MIT license](http://opensource.org/licenses/MIT). See the complete license in the file: LICENSE