bug #37327 [HttpFoundation] Allow null in InputBag@set (taylorotwell)

chalasr · chalasr · commit 4773c5ea296b · 2020-06-18T01:21:27.000+02:00
This PR was squashed before being merged into the 5.1 branch (closes #37327). Discussion ---------- [HttpFoundation] Allow `null` in InputBag@set This allows `null` to be passed to InputBag's `set` method. | Q | A | ------------- | --- | Branch? | 5.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT Previously, `null` was an allowed value to the InputBag's `set` method. At some point this was deprecated. It would be very nice for us to be able to set this to `null`. For example, this ability drives a very popular feature of Laravel where we ship a middleware that converts all empty strings to `null` on incoming requests. Note that the `get` method already specifically allows `null` and `null` is a valid decoded JSON value. Commits ------- 14ec6a7 [HttpFoundation] Allow `null` in InputBag@set
diff --git a/src/Symfony/Component/HttpFoundation/InputBag.php b/src/Symfony/Component/HttpFoundation/InputBag.php
@@ -72,12 +72,12 @@ public function add(array $inputs = [])
     /**
      * Sets an input by name.
      *
-     * @param string|array $value
+     * @param string|array|null $value
      */
     public function set(string $key, $value)
     {
-        if (!is_scalar($value) && !\is_array($value) && !method_exists($value, '__toString')) {
-            trigger_deprecation('symfony/http-foundation', '5.1', 'Passing "%s" as a 2nd Argument to "%s()" is deprecated, pass a string or an array instead.', get_debug_type($value), __METHOD__);
+        if (null !== $value && !is_scalar($value) && !\is_array($value) && !method_exists($value, '__toString')) {
+            trigger_deprecation('symfony/http-foundation', '5.1', 'Passing "%s" as a 2nd Argument to "%s()" is deprecated, pass a string, array, or null instead.', get_debug_type($value), __METHOD__);
         }
 
         $this->parameters[$key] = $value;
diff --git a/src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php
@@ -51,7 +51,7 @@ public function testFilterArray()
     public function testSetWithNonStringishOrArrayIsDeprecated()
     {
         $bag = new InputBag();
-        $this->expectDeprecation('Since symfony/http-foundation 5.1: Passing "Symfony\Component\HttpFoundation\InputBag" as a 2nd Argument to "Symfony\Component\HttpFoundation\InputBag::set()" is deprecated, pass a string or an array instead.');
+        $this->expectDeprecation('Since symfony/http-foundation 5.1: Passing "Symfony\Component\HttpFoundation\InputBag" as a 2nd Argument to "Symfony\Component\HttpFoundation\InputBag::set()" is deprecated, pass a string, array, or null instead.');
         $bag->set('foo', new InputBag());
     }
 

Original file line number	Diff line number	Diff line change
`@@ -72,12 +72,12 @@ public function add(array $inputs = [])`
`72`	`72`	`/**`
`73`	`73`	`* Sets an input by name.`
`74`	`74`	`*`
`75`		`- * @param string\|array $value`
	`75`	`+ * @param string\|array\|null $value`
`76`	`76`	`*/`
`77`	`77`	`public function set(string $key, $value)`
`78`	`78`	`{`
`79`		`- if (!is_scalar($value) && !\is_array($value) && !method_exists($value, '__toString')) {`
`80`		`- trigger_deprecation('symfony/http-foundation', '5.1', 'Passing "%s" as a 2nd Argument to "%s()" is deprecated, pass a string or an array instead.', get_debug_type($value), __METHOD__);`
	`79`	`+ if (null !== $value && !is_scalar($value) && !\is_array($value) && !method_exists($value, '__toString')) {`
	`80`	`+ trigger_deprecation('symfony/http-foundation', '5.1', 'Passing "%s" as a 2nd Argument to "%s()" is deprecated, pass a string, array, or null instead.', get_debug_type($value), __METHOD__);`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`$this->parameters[$key] = $value;`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function testFilterArray()`
`51`	`51`	`public function testSetWithNonStringishOrArrayIsDeprecated()`
`52`	`52`	`{`
`53`	`53`	`$bag = new InputBag();`
`54`		`- $this->expectDeprecation('Since symfony/http-foundation 5.1: Passing "Symfony\Component\HttpFoundation\InputBag" as a 2nd Argument to "Symfony\Component\HttpFoundation\InputBag::set()" is deprecated, pass a string or an array instead.');`
	`54`	`+ $this->expectDeprecation('Since symfony/http-foundation 5.1: Passing "Symfony\Component\HttpFoundation\InputBag" as a 2nd Argument to "Symfony\Component\HttpFoundation\InputBag::set()" is deprecated, pass a string, array, or null instead.');`
`55`	`55`	`$bag->set('foo', new InputBag());`
`56`	`56`	`}`
`57`	`57`