[HttpFoundation] ParameterBag::getEnum()

nikophil · nikophil · commit df7d44ac7b60 · 2022-12-29T16:21:03.000+01:00
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Create migration for session table when pdo handler is used
+ * Add `ParameterBar::getEnum()`
 
 6.2
 ---
diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php
@@ -141,6 +141,27 @@ public function getBoolean(string $key, bool $default = false): bool
         return $this->filter($key, $default, \FILTER_VALIDATE_BOOL);
     }
 
+    /**
+     * Returns the parameter value converted to an enum.
+     *
+     * @template T of \BackedEnum
+     *
+     * @param class-string<T> $class
+     * @param ?T $default
+     *
+     * @return ?T
+     */
+    public function getEnum(string $key, string $class, ?\BackedEnum $default = null): ?\BackedEnum
+    {
+        $value = $this->get($key);
+
+        if (null === $value) {
+            return $default;
+        }
+
+        return $class::tryFrom($value) ?? $default;
+    }
+
     /**
      * Filter key.
      *
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php
@@ -226,4 +226,23 @@ public function testGetBoolean()
         $this->assertFalse($bag->getBoolean('string_false'), '->getBoolean() gets the string false as boolean false');
         $this->assertFalse($bag->getBoolean('unknown'), '->getBoolean() returns false if a parameter is not defined');
     }
+
+    public function testGetEnum()
+    {
+        $parameters = ['valid-value' => 1, 'invalid-value' => 2];
+        $bag = new ParameterBag($parameters);
+
+        $this->assertSame(Foo::Bar, $bag->getEnum('valid-value', Foo::class));
+
+        $this->assertNull($bag->getEnum('invalid-value', Foo::class));
+        $this->assertSame(Foo::Bar, $bag->getEnum('invalid-value', Foo::class, Foo::Bar));
+
+        $this->assertNull($bag->getEnum('invalid-key', Foo::class));
+        $this->assertSame(Foo::Bar, $bag->getEnum('invalid-key', Foo::class, Foo::Bar));
+    }
+}
+
+enum Foo: int
+{
+    case Bar = 1;
 }
