symfony · linaori · Aug 30, 2016 · Aug 30, 2016 · ogizanagi · Aug 30, 2016
diff --git a/UPGRADE-3.2.md b/UPGRADE-3.2.md
@@ -80,3 +80,8 @@ Yaml
  * Mappings with a colon (`:`) that is not followed by a whitespace are deprecated
    and will lead to a `ParseException` in Symfony 4.0 (e.g. `foo:bar` must be
    `foo: bar`).
+
+HttpKernel
+----------
+
+ * Added the `$isNullable` argument to the `ArgumentMetadata` as deprecated optional value, but will no longer be optional as of 4.0.
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -132,6 +132,8 @@ HttpKernel
    have your own `ControllerResolverInterface` implementation, you should
    inject an `ArgumentResolverInterface` instance.
 
+ * The `$isNullable` argument to the `ArgumentMetadata` is no longer optional.
+
 Serializer
 ----------
 

diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/SecurityUserValueResolverTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/SecurityUserValueResolverTest.php
@@ -26,7 +26,7 @@ public function testResolveNoToken()
     {
         $tokenStorage = new TokenStorage();
         $resolver = new SecurityUserValueResolver($tokenStorage);
-        $metadata = new ArgumentMetadata('foo', UserInterface::class, false, false, null);
+        $metadata = new ArgumentMetadata('foo', UserInterface::class, false, false, null, false);
 
         $this->assertFalse($resolver->supports(Request::create('/'), $metadata));
     }
@@ -39,7 +39,7 @@ public function testResolveNoUser()
         $tokenStorage->setToken($token);
 
         $resolver = new SecurityUserValueResolver($tokenStorage);
-        $metadata = new ArgumentMetadata('foo', get_class($mock), false, false, null);
+        $metadata = new ArgumentMetadata('foo', get_class($mock), false, false, null, false);
 
         $this->assertFalse($resolver->supports(Request::create('/'), $metadata));
     }
@@ -48,7 +48,7 @@ public function testResolveWrongType()
     {
         $tokenStorage = new TokenStorage();
         $resolver = new SecurityUserValueResolver($tokenStorage);
-        $metadata = new ArgumentMetadata('foo', null, false, false, null);
+        $metadata = new ArgumentMetadata('foo', null, false, false, null, false);
 
         $this->assertFalse($resolver->supports(Request::create('/'), $metadata));
     }
@@ -62,7 +62,7 @@ public function testResolve()
         $tokenStorage->setToken($token);
 
         $resolver = new SecurityUserValueResolver($tokenStorage);
-        $metadata = new ArgumentMetadata('foo', UserInterface::class, false, false, null);
+        $metadata = new ArgumentMetadata('foo', UserInterface::class, false, false, null, false);
 
         $this->assertTrue($resolver->supports(Request::create('/'), $metadata));
         $this->assertSame(array($user), iterator_to_array($resolver->resolve(Request::create('/'), $metadata)));

diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+3.2.0
+-----
+ * Added the `$isNullable` argument to the `ArgumentMetadata` as deprecated optional value, but will no longer be optional as of 4.0.
+
 3.1.0
 -----
  * deprecated passing objects as URI attributes to the ESI and SSI renderers

diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php
@@ -74,7 +74,7 @@ public function getArguments(Request $request, $controller)
                 $representative = get_class($representative);
             }
 
-            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).', $representative, $metadata->getName()));
+            throw new \RuntimeException(sprintf('Controller "%s" requires that you provide a value for the "$%s" argument. Either the argument is nullable and no null value has been provided, no default value has been provided or because there is a non optional argument after this one.', $representative, $metadata->getName()));
         }
 
         return $arguments;

diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/DefaultValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/DefaultValueResolver.php
@@ -27,14 +27,14 @@ final class DefaultValueResolver implements ArgumentValueResolverInterface
      */
     public function supports(Request $request, ArgumentMetadata $argument)
     {
-        return $argument->hasDefaultValue();
+        return $argument->hasDefaultValue() || $argument->isNullable();
     }
 
     /**
      * {@inheritdoc}
      */
     public function resolve(Request $request, ArgumentMetadata $argument)
     {
-        yield $argument->getDefaultValue();
+        yield $argument->hasDefaultValue() ? $argument->getDefaultValue() : null;
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php
@@ -23,21 +23,28 @@ class ArgumentMetadata
     private $isVariadic;
     private $hasDefaultValue;
     private $defaultValue;
+    private $isNullable;
 
     /**
      * @param string $name
      * @param string $type
      * @param bool   $isVariadic
      * @param bool   $hasDefaultValue
      * @param mixed  $defaultValue
+     * @param bool   $isNullable
      */
-    public function __construct($name, $type, $isVariadic, $hasDefaultValue, $defaultValue)
+    public function __construct($name, $type, $isVariadic, $hasDefaultValue, $defaultValue, $isNullable = null)
     {
         $this->name = $name;
         $this->type = $type;
         $this->isVariadic = $isVariadic;
         $this->hasDefaultValue = $hasDefaultValue;
         $this->defaultValue = $defaultValue;
+        $this->isNullable = (bool) $isNullable;
+
+        if (null === $isNullable) {
+            @trigger_error(sprintf('As of 3.2 the $isNullable argument has been added to %s with a default value. As of 4.0 the argument will become mandatory.', __CLASS__), E_USER_DEPRECATED);
+        }
     }
 
     /**
@@ -84,6 +91,16 @@ public function hasDefaultValue()
         return $this->hasDefaultValue;
     }
 
+    /**
+     * Returns whether the argument is nullable in PHP 7.1 or higher.
+     *
+     * @return bool
+     */
+    public function isNullable()
+    {
+        return $this->isNullable;
+    }
+
     /**
      * Returns the default value of the argument.
      *

diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php
@@ -34,7 +34,7 @@ public function createArgumentMetadata($controller)
         }
 
         foreach ($reflection->getParameters() as $param) {
-            $arguments[] = new ArgumentMetadata($param->getName(), $this->getType($param), $this->isVariadic($param), $this->hasDefaultValue($param), $this->getDefaultValue($param));
+            $arguments[] = new ArgumentMetadata($param->getName(), $this->getType($param), $this->isVariadic($param), $this->hasDefaultValue($param), $this->getDefaultValue($param), $this->isNullable($param));
         }
 
         return $arguments;
@@ -64,6 +64,23 @@ private function hasDefaultValue(\ReflectionParameter $parameter)
         return $parameter->isDefaultValueAvailable();
     }
 
+    /**
+     * Returns if the argument is allowed to be null but is still mandatory.
+     *
+     * @param \ReflectionParameter $parameter
+     *
+     * @return bool
+     */
+    private function isNullable(\ReflectionParameter $parameter)
+    {
+        if (PHP_VERSION_ID >= 70000) {
+            return null !== ($type = $parameter->getType()) && $type->allowsNull();
+        }
+
+        // fallback for supported php 5.x versions
+        return $this->hasDefaultValue($parameter) && null === $this->getDefaultValue($parameter);
+    }
+
     /**
      * Returns a default value if available.
      *

diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php
@@ -19,6 +19,7 @@
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
 use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\ExtendingRequest;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\NullableController;
 use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\VariadicController;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -202,6 +203,32 @@ public function testGetArgumentWithoutArray()
         $resolver->getArguments($request, $controller);
     }
 
+    /**
+     * @requires PHP 7.1
+     */
+    public function testGetNullableArguments()
+    {
+        $request = Request::create('/');
+        $request->attributes->set('foo', 'foo');
+        $request->attributes->set('bar', new \stdClass());
+        $request->attributes->set('mandatory', 'mandatory');
+        $controller = array(new NullableController(), 'action');
+
+        $this->assertEquals(array('foo', new \stdClass(), 'value', 'mandatory'), self::$resolver->getArguments($request, $controller));
+    }
+
+    /**
+     * @requires PHP 7.1
+     */
+    public function testGetNullableArgumentsWithDefaults()
+    {
+        $request = Request::create('/');
+        $request->attributes->set('mandatory', 'mandatory');
+        $controller = array(new NullableController(), 'action');
+
+        $this->assertEquals(array(null, null, 'value', 'mandatory'), self::$resolver->getArguments($request, $controller));
+    }
+
     public function __invoke($foo, $bar = null)
     {
     }

diff --git a/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataFactoryTest.php b/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataFactoryTest.php
@@ -15,10 +15,14 @@
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory;
 use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\BasicTypesController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\NullableController;
 use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\VariadicController;
 
 class ArgumentMetadataFactoryTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @var ArgumentMetadataFactory
+     */
     private $factory;
 
     protected function setUp()
@@ -31,9 +35,9 @@ public function testSignature1()
         $arguments = $this->factory->createArgumentMetadata(array($this, 'signature1'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', self::class, false, false, null),
-            new ArgumentMetadata('bar', 'array', false, false, null),
-            new ArgumentMetadata('baz', 'callable', false, false, null),
+            new ArgumentMetadata('foo', self::class, false, false, null, false),
+            new ArgumentMetadata('bar', 'array', false, false, null, false),
+            new ArgumentMetadata('baz', 'callable', false, false, null, false),
         ), $arguments);
     }
 
@@ -42,9 +46,9 @@ public function testSignature2()
         $arguments = $this->factory->createArgumentMetadata(array($this, 'signature2'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', self::class, false, true, null),
-            new ArgumentMetadata('bar', __NAMESPACE__.'\FakeClassThatDoesNotExist', false, true, null),
-            new ArgumentMetadata('baz', 'Fake\ImportedAndFake', false, true, null),
+            new ArgumentMetadata('foo', self::class, false, true, null, true),
+            new ArgumentMetadata('bar', __NAMESPACE__.'\FakeClassThatDoesNotExist', false, true, null, true),
+            new ArgumentMetadata('baz', 'Fake\ImportedAndFake', false, true, null, true),
         ), $arguments);
     }
 
@@ -53,8 +57,8 @@ public function testSignature3()
         $arguments = $this->factory->createArgumentMetadata(array($this, 'signature3'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('bar', __NAMESPACE__.'\FakeClassThatDoesNotExist', false, false, null),
-            new ArgumentMetadata('baz', 'Fake\ImportedAndFake', false, false, null),
+            new ArgumentMetadata('bar', __NAMESPACE__.'\FakeClassThatDoesNotExist', false, false, null, false),
+            new ArgumentMetadata('baz', 'Fake\ImportedAndFake', false, false, null, false),
         ), $arguments);
     }
 
@@ -63,9 +67,9 @@ public function testSignature4()
         $arguments = $this->factory->createArgumentMetadata(array($this, 'signature4'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', null, false, true, 'default'),
-            new ArgumentMetadata('bar', null, false, true, 500),
-            new ArgumentMetadata('baz', null, false, true, array()),
+            new ArgumentMetadata('foo', null, false, true, 'default', false),
+            new ArgumentMetadata('bar', null, false, true, 500, false),
+            new ArgumentMetadata('baz', null, false, true, array(), false),
         ), $arguments);
     }
 
@@ -74,8 +78,8 @@ public function testSignature5()
         $arguments = $this->factory->createArgumentMetadata(array($this, 'signature5'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', 'array', false, true, null),
-            new ArgumentMetadata('bar', null, false, false, null),
+            new ArgumentMetadata('foo', 'array', false, true, null, true),
+            new ArgumentMetadata('bar', null, false, false, null, false),
         ), $arguments);
     }
 
@@ -87,8 +91,8 @@ public function testVariadicSignature()
         $arguments = $this->factory->createArgumentMetadata(array(new VariadicController(), 'action'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', null, false, false, null),
-            new ArgumentMetadata('bar', null, true, false, null),
+            new ArgumentMetadata('foo', null, false, false, null, false),
+            new ArgumentMetadata('bar', null, true, false, null, false),
         ), $arguments);
     }
 
@@ -100,9 +104,24 @@ public function testBasicTypesSignature()
         $arguments = $this->factory->createArgumentMetadata(array(new BasicTypesController(), 'action'));
 
         $this->assertEquals(array(
-            new ArgumentMetadata('foo', 'string', false, false, null),
-            new ArgumentMetadata('bar', 'int', false, false, null),
-            new ArgumentMetadata('baz', 'float', false, false, null),
+            new ArgumentMetadata('foo', 'string', false, false, null, false),
+            new ArgumentMetadata('bar', 'int', false, false, null, false),
+            new ArgumentMetadata('baz', 'float', false, false, null, false),
+  
D411
      ), $arguments);
+    }
+
+    /**
+     * @requires PHP 7.1
+     */
+    public function testNullableTypesSignature()
+    {
+        $arguments = $this->factory->createArgumentMetadata(array(new NullableController(), 'action'));
+
+        $this->assertEquals(array(
+            new ArgumentMetadata('foo', 'string', false, false, null, true),
+            new ArgumentMetadata('bar', \stdClass::class, false, false, null, true),
+            new ArgumentMetadata('baz', 'string', false, true, 'value', true),
+            new ArgumentMetadata('mandatory', null, false, false, null, false),
         ), $arguments);
     }
 

diff --git a/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataTest.php b/src/Symfony/Component/HttpKernel/Tests/ControllerMetadata/ArgumentMetadataTest.php
@@ -15,10 +15,21 @@
 
 class ArgumentMetadataTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDefaultValueAvailable()
+    /**
+     * @group legacy
+     */
+    public function testWithBcLayerForNullable()
     {
         $argument = new ArgumentMetadata('foo', 'string', false, true, 'default value');
 
+        $this->assertFalse($argument->isNullable());
+    }
+
+    public function testDefaultValueAvailable()
+    {
+        $argument = new ArgumentMetadata('foo', 'string', false, true, 'default value', true);
+
+        $this->assertTrue($argument->isNullable());
         $this->assertTrue($argument->hasDefaultValue());
         $this->assertSame('default value', $argument->getDefaultValue());
     }
@@ -28,8 +39,9 @@ public function testDefaultValueAvailable()
      */
     public function testDefaultValueUnavailable()
     {
-        $argument = new ArgumentMetadata('foo', 'string', false, false, null);
+        $argument = new ArgumentMetadata('foo', 'string', false, false, null, false);
 
+        $this->assertFalse($argument->isNullable());
         $this->assertFalse($argument->hasDefaultValue());
         $argument->getDefaultValue();
     }

diff --git a/src/Symfony/Component/HttpKernel/Tests/Fixtures/Controller/NullableController.php b/src/Symfony/Component/HttpKernel/Tests/Fixtures/Controller/NullableController.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\HttpKernel\Tests\Fixtures\Controller;
+
+class NullableController
+{
+    public function action(? string $foo, ? \stdClass $bar, ? string $baz = 'value', $mandatory)
+    {
+    }
+}