[HttpKernel] Allow to inject PSR-7 ServerRequest in controllers.

symfony · dunglas · May 25, 2015 · May 25, 2015 · May 26, 2015 · May 26, 2015
commit d950b5330fed244d9084fe87f79acfbfa6827a40
diff --git a/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php b/src/Symfony/Component/HttpKernel/Controller/ControllerResolver.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\HttpKernel\Controller;
 
 use Psr\Log\LoggerInterface;
+use Symfony\Bridge\PsrHttpMessage\Factory\DiactorosFactory;
+use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -22,21 +24,27 @@
  * the controller method arguments.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ * @author Kévin Dunglas <dunglas@gmail.com>
  *
  * @api
  */
 class ControllerResolver implements ControllerResolverInterface
 {
     private $logger;
+    private $httpMessageFactory;
 
     /**
      * Constructor.
      *
      * @param LoggerInterface $logger A LoggerInterface instance
      */
-    public function __construct(LoggerInterface $logger = null)
+    public function __construct(LoggerInterface $logger = null, HttpMessageFactoryInterface $httpMessageFactory = null)
     {
         $this->logger = $logger;
+
+        if (null === $httpMessageFactory && class_exists('Symfony\Bridge\PsrHttpMessage\Factory\DiactorosFactory')) {
+            $this->httpMessageFactory = new DiactorosFactory();
+        }
     }
 
     /**
@@ -112,21 +120,43 @@ protected function doGetArguments(Request $request, $controller, array $paramete
         foreach ($parameters as $param) {
             if (array_key_exists($param->name, $attributes)) {
                 $arguments[] = $attributes[$param->name];
-            } elseif ($param->getClass() && $param->getClass()->isInstance($request)) {
-                $arguments[] = $request;
-            } elseif ($param->isDefaultValueAvailable()) {
-                $arguments[] = $param->getDefaultValue();
-            } else {
-                if (is_array($controller)) {
-                    $repr = sprintf('%s::%s()', get_class($controller[0]), $controller[1]);
-                } elseif (is_object($controller)) {
-                    $repr = get_class($controller);
-                } else {
-                    $repr = $controller;
+
+                continue;
+            }
+
+            if ($class = $param->getClass()) {
+                if ($class->isInstance($request)) {
+                    $arguments[] = $request;
+
+                    continue;
                 }
 
-                throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument (because there is no default value or because there is a non optional argument after this one).', $repr, $param->name));
+                if ($class->implementsInterface('Psr\Http\Message\ServerRequestInterface')) {
+                    if (null === $this->httpMessageFactory) {
+                        throw new \RuntimeException('The PSR-7 Bridge must be installed to inject instances of Psr\Http\Message\ServerRequestInterface in controllers.');
+                    }
+
+                    $arguments[] = $this->httpMessageFactory->createRequest($request);
+
+                    continue;
+                }
+            }
+
+            if ($param->isDefaultValueAvailable()) {
+                $arguments[] = $param->getDefaultValue();
+
+                continue;
             }
+
+            if (is_array($controller)) {
+                $repr = sprintf('%s::%s()', get_class($controller[0]), $controller[1]);
+            } elseif (is_object($controller)) {
+                $repr = get_class($controller);
+            } else {
+                $repr = $controller;
+            }
+
+            throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument (because there is no default value or because there is a non optional argument after this one).', $repr, $param->name));
         }
 
         return $arguments;
@@ -157,7 +187,7 @@ protected function createController($controller)
     }
 
     /**
-     * Returns an instantiated controller
+     * Returns an instantiated controller.
      *
      * @param string $class A class name
      *

diff --git a/src/Symfony/Component/HttpKernel/HttpKernel.php b/src/Symfony/Component/HttpKernel/HttpKernel.php
@@ -146,6 +146,15 @@ private function handleRaw(Request $request, $type = self::MASTER_REQUEST)
         // call controller
         $response = call_user_func_array($controller, $arguments);
 
+        // handle PSR-7 responses
+        if ($response instanceof ResponseInterface) {
+            if (null === $this->httpFoundationFactory) {
+                throw new \RuntimeException('The PSR-7 Bridge must be installed to handle instances of Psr\Http\Message\ResponseInterface.');
+            }
+
+            $response = $this->httpFoundationFactory->createResponse($response);
+        }
+
         // view
         if (!$response instanceof Response) {
             $event = new GetResponseForControllerResultEvent($this, $request, $type, $response);

diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ControllerResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ControllerResolverTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\HttpKernel\Tests\Controller;
 
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolver;
 use Symfony\Component\HttpFoundation\Request;
@@ -195,6 +196,11 @@ public function testGetArguments()
         $request = Request::create('/');
         $controller = array(new self(), 'controllerMethod5');
         $this->assertEquals(array($request), $resolver->getArguments($request, $controller), '->getArguments() injects the request');
+
+        $request = Request::create('/');
+        $controller = array(new self(), 'controllerMethod6');
+        $args = $resolver->getArguments($request, $controller);
+        $this->assertInstanceOf('Psr\Http\Message\ServerRequestInterface', $args[0], '->getArguments() injects the PSR ServerRequest');
     }
 
     public function testCreateControllerCanReturnAnyCallable()
@@ -235,6 +241,10 @@ protected static function controllerMethod4()
     protected function controllerMethod5(Request $request)
     {
     }
+
+    protected function controllerMethod6(ServerRequestInterface $request)
+    {
+    }
 }
 
 function some_controller_function($foo, $foobar)

diff --git a/src/Symfony/Component/HttpKernel/composer.json b/src/Symfony/Component/HttpKernel/composer.json
@@ -15,6 +15,12 @@
             "homepage": "https://symfony.com/contributors"
         }
     ],
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/dunglas/psr-http-message-bridge"
+        }
+    ],
     "require": {
         "php": ">=5.3.9",
         "symfony/event-dispatcher": "~2.5.9|~2.6,>=2.6.2|~3.0.0",
@@ -38,7 +44,9 @@
         "symfony/stopwatch": "~2.3|~3.0.0",
         "symfony/templating": "~2.2|~3.0.0",
         "symfony/translation": "~2.0,>=2.0.5|~3.0.0",
-        "symfony/var-dumper": "~2.6|~3.0.0"
+        "symfony/var-dumper": "~2.6|~3.0.0",
+        "symfony/psr-http-message-bridge": "dev-wip",
+        "zendframework/zend-diactoros": "~1.0"
     },
     "conflict": {
         "symfony/config": "<2.7"
@@ -50,7 +58,9 @@
         "symfony/console": "",
         "symfony/dependency-injection": "",
         "symfony/finder": "",
-        "symfony/var-dumper": ""
+        "symfony/var-dumper": "",
+        "symfony/psr-http-message-bridge": "To enable PSR-7 support.",
+        "zendframework/zend-diactoros": "To enable PSR-7 support."
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\HttpKernel\\": "" }