Remove custom event contexts. Use one class

silverstripe-terraformers · Jan 13, 2020 · 5838c80 · 5838c80
1 parent 914614b
commit 5838c80
Show file tree

Hide file tree

Showing 24 changed files with 231 additions and 782 deletions.
diff --git a/lang/en.yml b/lang/en.yml
@@ -16,5 +16,4 @@ en:
   SilverStripe\Snapshots\Handler\GridField\URLActionHandler:
     HANDLER_deleterecord: 'Delete record'
     HANDLER_archiverecord: 'Archive record'
-  SilverStripe\Snapshots\Handler\GridField\AlterationHandler:
     HANDLER_handleReorder: 'Reorder items'
diff --git a/src/Handler/CMSMain/ActionHandler.php b/src/Handler/CMSMain/ActionHandler.php
@@ -9,7 +9,6 @@
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\CMSMain\CMSMainContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -22,19 +21,18 @@ class ActionHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var CMSMainContext $context */
         $action = $context->getAction();
         /* @var HTTPResponse $result */
-        $result = $context->getResult();
+        $result = $context->get('result');
         if (!$result instanceof HTTPResponse) {
             return null;
         }
         if ((int) $result->getStatusCode() !== 200) {
             return null;
         }
 
-        $className = $context->getTreeClass();
-        $id = (int) $context->getId();
+        $className = $context->get('treeClass');
+        $id = (int) $context->get('id');
 
         if (!$id) {
             return null;

diff --git a/src/Handler/Form/FormSubmissionHandler.php b/src/Handler/Form/FormSubmissionHandler.php
@@ -5,9 +5,9 @@
 
 
 use SilverStripe\CMS\Model\SiteTree;
+use SilverStripe\Control\HTTPRequest;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\Form\FormContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -20,10 +20,12 @@ class FormSubmissionHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var FormContext $context */
         $action = $context->getAction();
         $page = $this->getPage($context);
-        $record = $context->getForm()->getRecord();
+        $record = null;
+        if ($form = $context->get('form')) {
+            $record = $form->getRecord();
+        }
 
         if ($page === null || $record === null) {
             return null;
@@ -35,12 +37,14 @@ protected function createSnapshot(EventContext $context): ?Snapshot
     }
 
     /**
-     * @param FormContext $context
+     * @param EventContext $context
      * @return SiteTree|null
      */
-    protected function getPage(FormContext $context): ?SiteTree
+    protected function getPage(EventContext $context): ?SiteTree
     {
-        $url = $context->getRequest()->getURL();
+        /* @var HTTPRequest $request */
+        $request = $context->get('request');
+        $url = $request->getURL();
         return $this->getCurrentPageFromRequestUrl($url);
     }
 }
diff --git a/src/Handler/Form/PublishHandler.php b/src/Handler/Form/PublishHandler.php
@@ -4,19 +4,20 @@
 namespace SilverStripe\Snapshots\Handler\Form;
 
 
-use SilverStripe\Snapshots\Listener\Form\FormContext;
+use SilverStripe\Forms\Form;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
 class PublishHandler extends FormSubmissionHandler
 {
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var FormContext $context */
         $snapshot = parent::createSnapshot($context);
         if ($snapshot) {
             // mark publish actions as WasPublished - the status flags rely on this being set correctly
-            if ($context->getForm()->getName() === 'EditForm') {
+            /* @var Form $form */
+            $form = $context->get('form');
+            if ($form->getName() === 'EditForm') {
                 foreach ($snapshot->Items() as $item) {
                     $item->WasPublished = true;
                     $item->write();

diff --git a/src/Handler/Form/SaveHandler.php b/src/Handler/Form/SaveHandler.php
@@ -5,7 +5,6 @@
 
 
 use SilverStripe\ORM\ValidationException;
-use SilverStripe\Snapshots\Listener\Form\FormContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -18,7 +17,7 @@ class SaveHandler extends FormSubmissionHandler
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var FormContext $context */
+
         $page = $this->getPage($context);
         if (!$page || !$page->isModifiedOnDraft()) {
             return null;

diff --git a/src/Handler/GraphQL/GenericHandler.php b/src/Handler/GraphQL/GenericHandler.php
@@ -6,7 +6,6 @@
 
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\GraphQL\GraphQLMiddlewareContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -19,7 +18,6 @@ class GenericHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var GraphQLMiddlewareContext $context */
         $action = $context->getAction();
         $message = $this->getMessage($action);
         $page = $this->getPageFromReferrer();

diff --git a/src/Handler/GraphQL/MutationHandler.php b/src/Handler/GraphQL/MutationHandler.php
@@ -6,7 +6,6 @@
 
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\GraphQL\GraphQLMutationContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -21,7 +20,6 @@ class MutationHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var GraphQLMutationContext $context */
         $type = $context->getAction();
         $action = static::ACTION_PREFIX . $type;
         $message = $this->getMessage($action);

diff --git a/src/Handler/GridField/AlterationHandler.php b/src/Handler/GridField/AlterationHandler.php
@@ -3,9 +3,9 @@
 
 namespace SilverStripe\Snapshots\Handler\GridField;
 
+use SilverStripe\Forms\Form;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\GridField\GridFieldContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -18,10 +18,10 @@ class AlterationHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var GridFieldContext $context */
         $action = $context->getAction();
         $message = $this->getMessage($action);
-        $form = $context->getGridField()->getForm();
+        /* @var Form $form */
+        $form = $context->get('gridField')->getForm();
 
         if (!$form) {
             return null;

diff --git a/src/Handler/GridField/URLActionHandler.php b/src/Handler/GridField/URLActionHandler.php
@@ -3,9 +3,9 @@
 
 namespace SilverStripe\Snapshots\Handler\GridField;
 
+use SilverStripe\Forms\Form;
 use SilverStripe\ORM\ValidationException;
 use SilverStripe\Snapshots\Handler\HandlerAbstract;
-use SilverStripe\Snapshots\Listener\GridField\GridFieldContext;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;
 
@@ -18,10 +18,10 @@ class URLActionHandler extends HandlerAbstract
      */
     protected function createSnapshot(EventContext $context): ?Snapshot
     {
-        /* @var GridFieldContext $context */
         $action = $context->getAction();
         $message = $this->getMessage($action);
-        $form = $context->getGridField()->getForm();
+        /* @var Form $form */
+        $form = $context->get('gridField')->getForm();
 
         if (!$form) {
             return null;

diff --git a/src/Handler/HandlerAbstract.php b/src/Handler/HandlerAbstract.php
@@ -3,10 +3,7 @@
 
 namespace SilverStripe\Snapshots\Handler;
 
-
-use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Config\Configurable;
-use SilverStripe\Snapshots\Dispatch\Context;
 use SilverStripe\Snapshots\Listener\CurrentPage;
 use SilverStripe\Snapshots\Listener\EventContext;
 use SilverStripe\Snapshots\Snapshot;

diff --git a/src/Listener/CMSMain/CMSMainActionListener.php b/src/Listener/CMSMain/CMSMainActionListener.php
@@ -3,15 +3,10 @@
 namespace SilverStripe\Snapshots\Listener\CMSMain;
 
 use SilverStripe\CMS\Controllers\CMSMain;
-use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\Control\HTTPRequest;
-use SilverStripe\Control\HTTPResponse;
 use SilverStripe\Core\Extension;
-use SilverStripe\ORM\DataObject;
-use SilverStripe\ORM\ValidationException;
-use SilverStripe\Snapshots\Dispatch\Context;
 use SilverStripe\Snapshots\Dispatch\Dispatcher;
-use SilverStripe\Snapshots\Snapshot;
+use SilverStripe\Snapshots\Listener\EventContext;
 
 /**
  * Class CMSMainAction
@@ -32,11 +27,13 @@ class CMSMainActionListener extends Extension
     public function afterCallActionHandler(HTTPRequest $request, $action, $result): void {
         Dispatcher::singleton()->trigger(
             'cmsAction',
-            new CMSMainContext(
+            new EventContext(
                 $action,
-                $result,
-                $this->owner->config()->get('tree_class'),
-                $request->requestVar('ID')
+                [
+                    'result' => $result,
+                    'treeClass' => $this->owner->config()->get('tree_class'),
+                    'id' => $request->requestVar('ID'),
+                ]
             )
         );
     }

diff --git a/src/Listener/CMSMain/CMSMainContext.php b/src/Listener/CMSMain/CMSMainContext.php
diff --git a/src/Listener/EventContext.php b/src/Listener/EventContext.php
@@ -4,21 +4,55 @@
 namespace SilverStripe\Snapshots\Listener;
 
 
-abstract class EventContext
+use phpDocumentor\Reflection\Types\Scalar;
+
+class EventContext
 {
-    abstract public function getAction(): string;
+    /**
+     * @var string
+     */
+    private $action;
+
+    /**
+     * @var array
+     */
+    private $meta = [];
+
+    /**
+     * EventContext constructor.
+     * @param string $action
+     * @param array $meta
+     */
+    public function __construct(string $action, array $meta = [])
+    {
+        $this->action = $action;
+        $this->meta = $meta;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAction(): string
+    {
+        return $this->action;
+    }
+
+    /**
+     * @param string $name
+     * @return string|int|bool|float|null
+     */
+    public function get(string $name)
+    {
+        return $this->meta[$name] ?? null;
+    }
 
     /**
      * @param $name
-     * @return |null
+     * @return string|int|bool|float|null
      */
     public function __get($name)
     {
-        $method = 'get' . ucfirst($name);
-        if (method_exists($this, $method)) {
-            return $this->$method();
-        }
-
-        return null;
+        return $this->get($name);
     }
+
 }