Merge pull request #29 from biig-io/feature/events-in-domainevents

Support for embedded events in DomainEvents

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+
+- Support for embbeded events in the `DomainEvent`
 
 ## [1.3.0] - 2018-03-14
 ### Added

README.md

@@ -25,6 +25,7 @@ Domain Events:
 * [Domain event dispatcher](docs/domain_event_dispatcher.md)
 * [Injection of the dispatcher in Doctrine entities](docs/injection_in_doctrine_entities.md)
 * [Symfony serializer integration](docs/symfony_serializer_integration.md)
+* [Learn how do more with our cookbooks](docs/cookbooks.md)
 
 
 Installation

Tests/Event/DomainEventTest.php

@@ -5,6 +5,7 @@
 use Biig\Component\Domain\Event\DomainEvent;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\EventDispatcher\GenericEvent;
 
 class DomainEventTest extends TestCase
 {
@@ -13,4 +14,11 @@ public function testItIsInstanceOfSymfonyEvent()
         $event = new DomainEvent();
         $this->assertInstanceOf(Event::class, $event);
     }
+
+    public function testItAcceptAnEventAsParameter()
+    {
+        $event = new DomainEvent(null, [], new GenericEvent());
+
+        $this->assertInstanceOf(GenericEvent::class, $event->getOriginalEvent());
+    }
 }

docs/cookbooks.md

@@ -0,0 +1,32 @@
+Cookbooks
+=========
+
+This section is about some things you can do while using this component.
+
+1. [Use events from another component in the domain dispatcher](#support_other_events)
+
+
+Support other events
+--------------------
+
+In some special cases you may have to handle some other events. For example
+the workflow of Symfony dispatch events specific to this composant. You can
+transform these events by redefining the dispatcher and transform the event:
+
+```php
+<?php
+
+class WorkflowDomainEventDispatcher extends DomainEventDispatcher
+{
+    public function dispatch($eventName, Event $event = null)
+    {
+        if ($event instanceof \Symfony\Component\Workflow\Event\Event) {
+            $event = new DomainEvent($event->getSubject(), [], $event);
+        }
+
+        return parent::dispatch($eventName, $event);
+    }
+}
+```
+
+You can do this because the domain event support embedded events. 👍

src/Event/DomainEvent.php

@@ -2,8 +2,27 @@
 
 namespace Biig\Component\Domain\Event;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class DomainEvent extends GenericEvent
 {
+    /**
+     * @var Event
+     */
+    private $originalEvent;
+
+    public function __construct($subject = null, $arguments = [], Event $originalEvent = null)
+    {
+        parent::__construct($subject, $arguments);
+        $this->originalEvent = $originalEvent;
+    }
+
+    /**
+     * @return Event
+     */
+    public function getOriginalEvent(): ?Event
+    {
+        return $this->originalEvent;
+    }
 }