Add getArray method to ParameterBag

Korbeil · Korbeil · commit 6fc5b9565243 · 2020-10-30T13:21:38.000+01:00
diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php
@@ -169,6 +169,21 @@ public function getBoolean(string $key, bool $default = false)
         return $this->filter($key, $default, \FILTER_VALIDATE_BOOLEAN);
     }
 
+    /**
+     * Returns the parameter value converted to array.
+     *
+     * @return array The filtered value
+     */
+    public function getArray(string $key, array $default = [])
+    {
+        $value = $this->parameters[$key] ?? $default;
+        if (!is_array($value)) {
+            throw new BadRequestException(sprintf('Unexpected value for parameter "%s": expecting "array", got "%s".', $key, get_debug_type($value)));
+        }
+
+        return $value;
+    }
+
     /**
      * Filter key.
      *
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php
@@ -141,6 +141,21 @@ public function testGetInt()
         $this->assertEquals(0, $bag->getInt('unknown'), '->getInt() returns zero if a parameter is not defined');
     }
 
+    public function testGetArray()
+    {
+        $bag = new ParameterBag(['array' => ['a', 'b', 'c']]);
+
+        $this->assertEquals(['a', 'b', 'c'], $bag->getArray('array'), '->getArray() gets a value of parameter as array');
+        $this->assertEquals([], $bag->getArray('unknown'), '->getArray() returns empty array if a parameter is not defined');
+    }
+
+    public function testArrayThrowsForNonArrayValues()
+    {
+        $this->expectException(BadRequestException::class);
+        $bag = new ParameterBag(['foo' => 'bar']);
+        $bag->getArray('foo');
+    }
+
     public function testFilter()
     {
         $bag = new ParameterBag([
