minor #46936 Fix deprecation in InputBag for non-scalar values (fritzmg, chalasr)

chalasr · chalasr · commit f9e831737884 · 2022-07-15T18:25:04.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- Fix deprecation in `InputBag` for non-scalar values | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | In Symfony 6.0, `InputBag::get` was changed so that when you are retrieving a non-scalar value from it, it will throw a `BadRequestException`. This is also correctly documented in the UPGRADE.md. However, the deprecation in Symfony 5.4 assumes something different: it says that non-**string** values are deprecated. This PR fixes that. Commits ------- 6245bac Revert removal of Stringable check de23ac8 also fix the test 30444a8 fix deprecation
diff --git a/src/Symfony/Component/HttpFoundation/InputBag.php b/src/Symfony/Component/HttpFoundation/InputBag.php
@@ -36,7 +36,7 @@ public function get(string $key, $default = null)
         $value = parent::get($key, $this);
 
         if (null !== $value && $this !== $value && !\is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
-            trigger_deprecation('symfony/http-foundation', '5.1', 'Retrieving a non-string value from "%s()" is deprecated, and will throw a "%s" exception in Symfony 6.0, use "%s::all($key)" instead.', __METHOD__, BadRequestException::class, __CLASS__);
+            trigger_deprecation('symfony/http-foundation', '5.1', 'Retrieving a non-scalar value from "%s()" is deprecated, and will throw a "%s" exception in Symfony 6.0, use "%s::all($key)" instead.', __METHOD__, BadRequestException::class, __CLASS__);
         }
 
         return $this === $value ? $default : $value;
diff --git a/src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/InputBagTest.php
@@ -72,10 +72,10 @@ public function testSetWithNonScalarOrArrayIsDeprecated()
     /**
      * @group legacy
      */
-    public function testGettingANonStringValueIsDeprecated()
+    public function testGettingANonScalarValueIsDeprecated()
     {
         $bag = new InputBag(['foo' => ['a', 'b']]);
-        $this->expectDeprecation('Since symfony/http-foundation 5.1: Retrieving a non-string value from "Symfony\Component\HttpFoundation\InputBag::get()" is deprecated, and will throw a "Symfony\Component\HttpFoundation\Exception\BadRequestException" exception in Symfony 6.0, use "Symfony\Component\HttpFoundation\InputBag::all($key)" instead.');
+        $this->expectDeprecation('Since symfony/http-foundation 5.1: Retrieving a non-scalar value from "Symfony\Component\HttpFoundation\InputBag::get()" is deprecated, and will throw a "Symfony\Component\HttpFoundation\Exception\BadRequestException" exception in Symfony 6.0, use "Symfony\Component\HttpFoundation\InputBag::all($key)" instead.');
         $bag->get('foo');
     }
 

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function get(string $key, $default = null)`
`36`	`36`	`$value = parent::get($key, $this);`
`37`	`37`
`38`	`38`	`if (null !== $value && $this !== $value && !\is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {`
`39`		`- trigger_deprecation('symfony/http-foundation', '5.1', 'Retrieving a non-string value from "%s()" is deprecated, and will throw a "%s" exception in Symfony 6.0, use "%s::all($key)" instead.', __METHOD__, BadRequestException::class, __CLASS__);`
	`39`	`+ trigger_deprecation('symfony/http-foundation', '5.1', 'Retrieving a non-scalar value from "%s()" is deprecated, and will throw a "%s" exception in Symfony 6.0, use "%s::all($key)" instead.', __METHOD__, BadRequestException::class, __CLASS__);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`return $this === $value ? $default : $value;`
Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,10 @@ public function testSetWithNonScalarOrArrayIsDeprecated()`
`72`	`72`	`/**`
`73`	`73`	`* @group legacy`
`74`	`74`	`*/`
`75`		`- public function testGettingANonStringValueIsDeprecated()`
	`75`	`+ public function testGettingANonScalarValueIsDeprecated()`
`76`	`76`	`{`
`77`	`77`	`$bag = new InputBag(['foo' => ['a', 'b']]);`
`78`		`- $this->expectDeprecation('Since symfony/http-foundation 5.1: Retrieving a non-string value from "Symfony\Component\HttpFoundation\InputBag::get()" is deprecated, and will throw a "Symfony\Component\HttpFoundation\Exception\BadRequestException" exception in Symfony 6.0, use "Symfony\Component\HttpFoundation\InputBag::all($key)" instead.');`
	`78`	`+ $this->expectDeprecation('Since symfony/http-foundation 5.1: Retrieving a non-scalar value from "Symfony\Component\HttpFoundation\InputBag::get()" is deprecated, and will throw a "Symfony\Component\HttpFoundation\Exception\BadRequestException" exception in Symfony 6.0, use "Symfony\Component\HttpFoundation\InputBag::all($key)" instead.');`
`79`	`79`	`$bag->get('foo');`
`80`	`80`	`}`
`81`	`81`