Migrate Signal/Slots to PSR-14 EventDispatcher with backwards compati…

…bility
linawolf · Sep 29, 2020 · a667843 · a667843
1 parent 84b09a2
commit a667843
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 14 deletions.
diff --git a/Classes/Compatibility/SlotReplacement.php b/Classes/Compatibility/SlotReplacement.php
@@ -0,0 +1,35 @@
+<?php
+namespace Medienreaktor\FormDoubleOptIn\Compatibility;
+
+use Medienreaktor\FormDoubleOptIn\Controller\DoubleOptInController;
+use Medienreaktor\FormDoubleOptIn\Domain\Finishers\DoubleOptInFormFinisher;
+use Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn;
+use Medienreaktor\FormDoubleOptIn\Event\AfterOptInCreationEvent;
+use Medienreaktor\FormDoubleOptIn\Event\AfterOptInValidationEvent;
+use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
+
+class SlotReplacement
+{
+
+    /**
+     * signalSlotDispatcher
+     *
+     * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
+     */
+    protected $signalSlotDispatcher;
+
+    public function injectSignalSlotDispatcher(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $dispatcher): void
+    {
+        $this->signalSlotDispatcher = $dispatcher;
+    }
+
+    public function onOptInRecordCreated(AfterOptInCreationEvent $event): void
+    {
+        $this->signalSlotDispatcher->dispatch(DoubleOptInFormFinisher::class, 'afterOptInCreation', [$event->getOptIn()]);
+    }
+
+    public function onOptInRecordValidated(AfterOptInValidationEvent $event): void
+    {
+        $this->signalSlotDispatcher->dispatch(DoubleOptInController::class, 'afterOptInValidation', [$event->getOptIn()]);
+    }
+}
diff --git a/Classes/Controller/DoubleOptInController.php b/Classes/Controller/DoubleOptInController.php
@@ -1,6 +1,9 @@
 <?php
 namespace Medienreaktor\FormDoubleOptIn\Controller;
 
+use Medienreaktor\FormDoubleOptIn\Event\AfterOptInValidationEvent;
+use Psr\EventDispatcher\EventDispatcherInterface;
+
 /*
  * DoubleOptInController
  */
@@ -15,20 +18,18 @@ class DoubleOptInController extends \TYPO3\CMS\Extbase\Mvc\Controller\ActionCont
     protected $optInRepository;
 
     /**
-     * signalSlotDispatcher
-     *
-     * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
+     * @var \Psr\EventDispatcher\EventDispatcherInterface
      */
-    protected $signalSlotDispatcher;
+    protected $eventDispatcher;
 
     public function injectOptInRepository(\Medienreaktor\FormDoubleOptIn\Domain\Repository\OptInRepository $optInRepository): void
     {
         $this->optInRepository = $optInRepository;
     }
 
-    public function injectSignalSlotDispatcher(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $dispatcher): void
+    public function injectEventDispatcher(\Psr\EventDispatcher\EventDispatcherInterface $eventDispatcher): void
     {
-        $this->signalSlotDispatcher = $dispatcher;
+        $this->eventDispatcher = $eventDispatcher;
     }
 
     /**
@@ -49,7 +50,7 @@ public function validationAction()
                 $optIn->setValidationDate(new \DateTime);
                 $this->optInRepository->update($optIn);
 
-                $this->signalSlotDispatcher->dispatch(__CLASS__, 'afterOptInValidation', [$optIn]);
+                $this->eventDispatcher->dispatch(new AfterOptInValidationEvent($optIn));
 
                 $success = TRUE;
             }

diff --git a/Classes/Domain/Finishers/DoubleOptInFormFinisher.php b/Classes/Domain/Finishers/DoubleOptInFormFinisher.php
@@ -2,6 +2,8 @@
 namespace Medienreaktor\FormDoubleOptIn\Domain\Finishers;
 
 use Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn;
+use Medienreaktor\FormDoubleOptIn\Event\AfterOptInCreationEvent;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use TYPO3\CMS\Core\Mail\MailMessage;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManager;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
@@ -21,20 +23,18 @@ class DoubleOptInFormFinisher extends \TYPO3\CMS\Form\Domain\Finishers\EmailFini
     protected $optInRepository;
 
     /**
-     * signalSlotDispatcher
-     *
-     * @var \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
+     * @var \Psr\EventDispatcher\EventDispatcherInterface
      */
-    protected $signalSlotDispatcher;
+    protected $eventDispatcher;
 
     public function injectOptInRepository(\Medienreaktor\FormDoubleOptIn\Domain\Repository\OptInRepository $optInRepository): void
     {
         $this->optInRepository = $optInRepository;
     }
 
-    public function injectSignalSlotDispatcher(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $dispatcher): void
+    public function injectEventDispatcher(\Psr\EventDispatcher\EventDispatcherInterface $eventDispatcher): void
     {
-        $this->signalSlotDispatcher = $dispatcher;
+        $this->eventDispatcher = $eventDispatcher;
     }
 
     /**
@@ -91,7 +91,7 @@ protected function executeInternal()
 
         $this->optInRepository->add($optIn);
 
-        $this->signalSlotDispatcher->dispatch(__CLASS__, 'afterOptInCreation', [$optIn]);
+        $this->eventDispatcher->dispatch(new AfterOptInCreationEvent($optIn));
 
         $persistenceManager = $this->objectManager->get(\TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::class);
         $persistenceManager->persistAll();

diff --git a/Classes/Event/AfterOptInCreationEvent.php b/Classes/Event/AfterOptInCreationEvent.php
@@ -0,0 +1,26 @@
+<?php
+namespace Medienreaktor\FormDoubleOptIn\Event;
+
+use Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn;
+
+/**
+ * Event after OptIn record has been created.
+ */
+final class AfterOptInCreationEvent
+{
+
+    /**
+     * @var \Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn
+     */
+     private $optIn;
+
+     public function __construct(\Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn $optIn)
+     {
+         $this->optIn = $optIn;
+     }
+
+     public function getOptIn()
+     {
+         return $this->optIn;
+     }
+}
diff --git a/Classes/Event/AfterOptInValidationEvent.php b/Classes/Event/AfterOptInValidationEvent.php
@@ -0,0 +1,26 @@
+<?php
+namespace Medienreaktor\FormDoubleOptIn\Event;
+
+use Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn;
+
+/**
+ * Event after OptIn record has been validated.
+ */
+final class AfterOptInValidationEvent
+{
+
+    /**
+     * @var \Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn
+     */
+     private $optIn;
+
+     public function __construct(\Medienreaktor\FormDoubleOptIn\Domain\Model\OptIn $optIn)
+     {
+         $this->optIn = $optIn;
+     }
+
+     public function getOptIn()
+     {
+         return $this->optIn;
+     }
+}
diff --git a/Configuration/Services.yaml b/Configuration/Services.yaml
@@ -7,3 +7,15 @@ services:
 
   Medienreaktor\FormDoubleOptIn\:
     resource: '../Classes/*'
+
+  # EventListeners
+  Medienreaktor\FormDoubleOptIn\Compatibility\SlotReplacement:
+    tags:
+      - name: event.listener
+        identifier: 'legacy-slot'
+        method: 'onOptInRecordCreated'
+        event: Medienreaktor\FormDoubleOptIn\Event\AfterOptInCreationEvent
+      - name: event.listener
+        identifier: 'legacy-slot'
+        method: 'onOptInRecordValidated'
+        event: Medienreaktor\FormDoubleOptIn\Event\AfterOptInValidationEvent