bug #46957 [HttpFoundation] Fix \Stringable support in InputBag::get() (chalasr)

fabpot · fabpot · commit 69302fb4a7d6 · 2022-07-22T18:13:32.000+02:00
This PR was merged into the 6.0 branch. Discussion ---------- [HttpFoundation] Fix `\Stringable` support in `InputBag::get()` | Q | A | ------------- | --- | Branch? | 6.0 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Spotted in symfony/symfony#46936 (comment), thanks @fritzmg. Commits ------- 6dfe92e091 [HttpFoundation] Fix `\Stringable` support in `InputBag::get()`
diff --git a/InputBag.php b/InputBag.php
@@ -33,7 +33,7 @@ public function get(string $key, mixed $default = null): string|int|float|bool|n
 
         $value = parent::get($key, $this);
 
-        if (null !== $value && $this !== $value && !\is_scalar($value)) {
+        if (null !== $value && $this !== $value && !\is_scalar($value) && !$value instanceof \Stringable) {
             throw new BadRequestException(sprintf('Input value "%s" contains a non-scalar value.', $key));
         }
 
diff --git a/Tests/InputBagTest.php b/Tests/InputBagTest.php
@@ -19,13 +19,19 @@ class InputBagTest extends TestCase
 {
     public function testGet()
     {
-        $bag = new InputBag(['foo' => 'bar', 'null' => null, 'int' => 1, 'float' => 1.0, 'bool' => false]);
+        $bag = new InputBag(['foo' => 'bar', 'null' => null, 'int' => 1, 'float' => 1.0, 'bool' => false, 'stringable' => new class() implements \Stringable {
+            public function __toString(): string
+            {
+                return 'strval';
+            }
+        }]);
 
         $this->assertSame('bar', $bag->get('foo'), '->get() gets the value of a string parameter');
         $this->assertSame('default', $bag->get('unknown', 'default'), '->get() returns second argument as default if a parameter is not defined');
         $this->assertNull($bag->get('null', 'default'), '->get() returns null if null is set');
         $this->assertSame(1, $bag->get('int'), '->get() gets the value of an int parameter');
         $this->assertSame(1.0, $bag->get('float'), '->get() gets the value of a float parameter');
+        $this->assertSame('strval', $bag->get('stringable'), '->get() gets the string value of a \Stringable parameter');
         $this->assertFalse($bag->get('bool'), '->get() gets the value of a bool parameter');
     }
 

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function get(string $key, mixed $default = null): string\|int\|float\|bool\|n`
`33`	`33`
`34`	`34`	`$value = parent::get($key, $this);`
`35`	`35`
`36`		`- if (null !== $value && $this !== $value && !\is_scalar($value)) {`
	`36`	`+ if (null !== $value && $this !== $value && !\is_scalar($value) && !$value instanceof \Stringable) {`
`37`	`37`	`throw new BadRequestException(sprintf('Input value "%s" contains a non-scalar value.', $key));`
`38`	`38`	`}`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,19 @@ class InputBagTest extends TestCase`
`19`	`19`	`{`
`20`	`20`	`public function testGet()`
`21`	`21`	`{`
`22`		`- $bag = new InputBag(['foo' => 'bar', 'null' => null, 'int' => 1, 'float' => 1.0, 'bool' => false]);`
	`22`	`+ $bag = new InputBag(['foo' => 'bar', 'null' => null, 'int' => 1, 'float' => 1.0, 'bool' => false, 'stringable' => new class() implements \Stringable {`
	`23`	`+ public function __toString(): string`
	`24`	`+ {`
	`25`	`+ return 'strval';`
	`26`	`+ }`
	`27`	`+ }]);`
`23`	`28`
`24`	`29`	`$this->assertSame('bar', $bag->get('foo'), '->get() gets the value of a string parameter');`
`25`	`30`	`$this->assertSame('default', $bag->get('unknown', 'default'), '->get() returns second argument as default if a parameter is not defined');`
`26`	`31`	`$this->assertNull($bag->get('null', 'default'), '->get() returns null if null is set');`
`27`	`32`	`$this->assertSame(1, $bag->get('int'), '->get() gets the value of an int parameter');`
`28`	`33`	`$this->assertSame(1.0, $bag->get('float'), '->get() gets the value of a float parameter');`
	`34`	`+ $this->assertSame('strval', $bag->get('stringable'), '->get() gets the string value of a \Stringable parameter');`
`29`	`35`	`$this->assertFalse($bag->get('bool'), '->get() gets the value of a bool parameter');`
`30`	`36`	`}`
`31`	`37`