[Messenger] added interfaces to be type-hinted even when not using a Container

fabpot · fabpot · commit 963fde9fb176 · 2018-09-07T22:30:04.000+02:00
diff --git a/src/Symfony/Component/Messenger/Handler/Locator/AbstractHandlerLocator.php b/src/Symfony/Component/Messenger/Handler/Locator/AbstractHandlerLocator.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Handler\Locator;
+
+use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
+
+/**
+ * @author Miha Vrhovnik <miha.vrhovnik@gmail.com>
+ * @author Samuel Roze <samuel.roze@gmail.com>
+ */
+abstract class AbstractHandlerLocator implements HandlerLocatorInterface
+{
+    public function resolve($message): callable
+    {
+        $messageClass = \get_class($message);
+
+        if (null === $handler = $this->resolveFromClass($messageClass)) {
+            throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $messageClass));
+        }
+
+        return $handler;
+    }
+
+    private function resolveFromClass(string $class): ?callable
+    {
+        if ($handler = $this->getHandler($class)) {
+            return $handler;
+        }
+
+        foreach (class_implements($class, false) as $interface) {
+            if ($handler = $this->getHandler($interface)) {
+                return $handler;
+            }
+        }
+
+        foreach (class_parents($class, false) as $parent) {
+            if ($handler = $this->getHandler($parent)) {
+                return $handler;
+            }
+        }
+
+        return null;
+    }
+
+    abstract protected function getHandler(string $class);
+}
diff --git a/src/Symfony/Component/Messenger/Handler/Locator/ContainerHandlerLocator.php b/src/Symfony/Component/Messenger/Handler/Locator/ContainerHandlerLocator.php
@@ -12,13 +12,12 @@
 namespace Symfony\Component\Messenger\Handler\Locator;
 
 use Psr\Container\ContainerInterface;
-use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
 
 /**
  * @author Miha Vrhovnik <miha.vrhovnik@gmail.com>
  * @author Samuel Roze <samuel.roze@gmail.com>
  */
-class ContainerHandlerLocator implements HandlerLocatorInterface
+class ContainerHandlerLocator extends AbstractHandlerLocator
 {
     private $container;
 
@@ -27,39 +26,7 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    public function resolve($message): callable
-    {
-        $messageClass = \get_class($message);
-
-        if (null === $handler = $this->resolveFromClass($messageClass)) {
-            throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $messageClass));
-        }
-
-        return $handler;
-    }
-
-    private function resolveFromClass($class): ?callable
-    {
-        if ($handler = $this->getHandler($class)) {
-            return $handler;
-        }
-
-        foreach (class_implements($class, false) as $interface) {
-            if ($handler = $this->getHandler($interface)) {
-                return $handler;
-            }
-        }
-
-        foreach (class_parents($class, false) as $parent) {
-            if ($handler = $this->getHandler($parent)) {
-                return $handler;
-            }
-        }
-
-        return null;
-    }
-
-    private function getHandler($class)
+    protected function getHandler(string $class)
     {
         $handlerKey = 'handler.'.$class;
 
diff --git a/src/Symfony/Component/Messenger/Handler/Locator/HandlerLocator.php b/src/Symfony/Component/Messenger/Handler/Locator/HandlerLocator.php
@@ -11,12 +11,10 @@
 
 namespace Symfony\Component\Messenger\Handler\Locator;
 
-use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;
-
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
  */
-class HandlerLocator implements HandlerLocatorInterface
+class HandlerLocator extends AbstractHandlerLocator
 {
     /**
      * Maps a message (its class) to a given handler.
@@ -28,14 +26,8 @@ public function __construct(array $messageToHandlerMapping = array())
         $this->messageToHandlerMapping = $messageToHandlerMapping;
     }
 
-    public function resolve($message): callable
+    protected function getHandler(string $class)
     {
-        $messageKey = \get_class($message);
-
-        if (!isset($this->messageToHandlerMapping[$messageKey])) {
-            throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $messageKey));
-        }
-
-        return $this->messageToHandlerMapping[$messageKey];
+        return $this->messageToHandlerMapping[$class] ?? null;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,10 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger\Handler\Locator;`
`13`	`13`
`14`		`-use Symfony\Component\Messenger\Exception\NoHandlerForMessageException;`
`15`		`-`
`16`	`14`	`/**`
`17`	`15`	`* @author Samuel Roze <[email protected]>`
`18`	`16`	`*/`
`19`		`-class HandlerLocator implements HandlerLocatorInterface`
	`17`	`+class HandlerLocator extends AbstractHandlerLocator`
`20`	`18`	`{`
`21`	`19`	`/**`
`22`	`20`	`* Maps a message (its class) to a given handler.`
`@@ -28,14 +26,8 @@ public function __construct(array $messageToHandlerMapping = array())`
`28`	`26`	`$this->messageToHandlerMapping = $messageToHandlerMapping;`
`29`	`27`	`}`
`30`	`28`
`31`		`- public function resolve($message): callable`
	`29`	`+ protected function getHandler(string $class)`
`32`	`30`	`{`
`33`		`- $messageKey = \get_class($message);`
`34`		`-`
`35`		`- if (!isset($this->messageToHandlerMapping[$messageKey])) {`
`36`		`- throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $messageKey));`
`37`		`- }`
`38`		`-`
`39`		`- return $this->messageToHandlerMapping[$messageKey];`
	`31`	`+ return $this->messageToHandlerMapping[$class] ?? null;`
`40`	`32`	`}`
`41`	`33`	`}`