[HttpKernel] Support backed enums in #[MapQueryParameter]

andersmateusz · nicolas-grekas · commit d05390c43cde · 2023-07-20T10:39:26.000+02:00
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 6.4
 ---
 
+ * Support backed enums in #[MapQueryParameter]
  * `BundleInterface` no longer extends `ContainerAwareInterface`
  * Add optional `$className` parameter to `ControllerEvent::getAttributes()`
  * Add native return types to `TraceableEventDispatcher` and to `MergeExtensionConfigurationPass`
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/QueryParameterValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/QueryParameterValueResolver.php
@@ -18,8 +18,11 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
+ * Resolve arguments of type: array, string, int, float, bool, \BackedEnum from query parameters.
+ *
  * @author Ruud Kamphuis <ruud@ticketswap.com>
  * @author Nicolas Grekas <p@tchwork.com>
+ * @author Mateusz Anders <anders_mateusz@outlook.com>
  */
 final class QueryParameterValueResolver implements ValueResolverInterface
 {
@@ -39,8 +42,9 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         $value = $request->query->all()[$name];
+        $type = $argument->getType();
 
-        if (null === $attribute->filter && 'array' === $argument->getType()) {
+        if (null === $attribute->filter && 'array' === $type) {
             if (!$argument->isVariadic()) {
                 return [(array) $value];
             }
@@ -59,20 +63,25 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
             'options' => $attribute->options,
         ];
 
-        if ('array' === $argument->getType() || $argument->isVariadic()) {
+        if ('array' === $type || $argument->isVariadic()) {
             $value = (array) $value;
             $options['flags'] |= \FILTER_REQUIRE_ARRAY;
         } else {
             $options['flags'] |= \FILTER_REQUIRE_SCALAR;
         }
 
-        $filter = match ($argument->getType()) {
+        $enumType = null;
+        $filter = match ($type) {
             'array' => \FILTER_DEFAULT,
             'string' => \FILTER_DEFAULT,
             'int' => \FILTER_VALIDATE_INT,
             'float' => \FILTER_VALIDATE_FLOAT,
             'bool' => \FILTER_VALIDATE_BOOL,
-            default => throw new \LogicException(sprintf('#[MapQueryParameter] cannot be used on controller argument "%s$%s" of type "%s"; one of array, string, int, float or bool should be used.', $argument->isVariadic() ? '...' : '', $argument->getName(), $argument->getType() ?? 'mixed'))
+            default => match ($enumType = is_subclass_of($type, \BackedEnum::class) ? (new \ReflectionEnum($type))->getBackingType()->getName() : null) {
+                'int' => \FILTER_VALIDATE_INT,
+                'string' => \FILTER_DEFAULT,
+                default => throw new \LogicException(sprintf('#[MapQueryParameter] cannot be used on controller argument "%s$%s" of type "%s"; one of array, string, int, float, bool or \BackedEnum should be used.', $argument->isVariadic() ? '...' : '', $argument->getName(), $type ?? 'mixed')),
+            }
         };
 
         $value = filter_var($value, $attribute->filter ?? $filter, $options);
@@ -81,6 +90,22 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
             throw new NotFoundHttpException(sprintf('Invalid query parameter "%s".', $name));
         }
 
+        if (null !== $enumType && null !== $value) {
+            $enumFrom = static function ($value) use ($type, $name) {
+                if (null !== $value && !\is_string($value) && !\is_int($value)) {
+                    throw new NotFoundHttpException(sprintf('Invalid query parameter "%s": expecting an int or string, got "%s".', $name, get_debug_type($value)));
+                }
+
+                try {
+                   return null === $value ? null : $type::from($value);
+                } catch (\ValueError $e) {
+                    throw new NotFoundHttpException(sprintf('Invalid query parameter "%s": '.$e->getMessage().'.', $name), $e);
+                }
+            };
+
+            $value = \is_array($value) ? array_map($enumFrom, $value) : $enumFrom($value);
+        }
+
         if (!\is_array($value)) {
             return [$value];
         }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/QueryParameterValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/QueryParameterValueResolverTest.php
@@ -18,6 +18,7 @@
 use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Suit;
 
 class QueryParameterValueResolverTest extends TestCase
 {
@@ -176,6 +177,33 @@ public static function provideTestResolve(): iterable
             'Invalid query parameter "isVerified".',
         ];
 
+        yield 'parameter found and backing value' => [
+            Request::create('/', 'GET', ['suit' => 'H']),
+            new ArgumentMetadata('suit', Suit::class, false, false, false, attributes: [new MapQueryParameter()]),
+            [Suit::Hearts],
+            null,
+        ];
+        yield 'parameter found and backing value variadic' => [
+            Request::create('/', 'GET', ['suit' => ['H', 'D']]),
+            new ArgumentMetadata('suit', Suit::class, true, false, false, attributes: [new MapQueryParameter()]),
+            [Suit::Hearts, Suit::Diamonds],
+            null,
+        ];
+        yield 'parameter found and backing type not int nor string' => [
+            Request::create('/', 'GET', ['suit' => 1]),
+            new ArgumentMetadata('suit', Suit::class, false, false, false, attributes: [new MapQueryParameter(filter: \FILTER_VALIDATE_BOOL)]),
+            [],
+            NotFoundHttpException::class,
+            'Invalid query parameter "suit": expecting an int or string, got "bool".',
+        ];
+        yield 'parameter found and backing type not valid backing value for enum' => [
+            Request::create('/', 'GET', ['suit' => 10.99]),
+            new ArgumentMetadata('suit', Suit::class, false, false, false, attributes: [new MapQueryParameter()]),
+            [],
+            NotFoundHttpException::class,
+            'Invalid query parameter "suit":',
+        ];
+
         yield 'parameter not found but nullable' => [
             Request::create('/', 'GET'),
             new ArgumentMetadata('firstName', 'string', false, false, false, true, [new MapQueryParameter()]),
@@ -203,14 +231,14 @@ public static function provideTestResolve(): iterable
             new ArgumentMetadata('standardClass', \stdClass::class, false, false, false, attributes: [new MapQueryParameter()]),
             [],
             \LogicException::class,
-            '#[MapQueryParameter] cannot be used on controller argument "$standardClass" of type "stdClass"; one of array, string, int, float or bool should be used.',
+            '#[MapQueryParameter] cannot be used on controller argument "$standardClass" of type "stdClass"; one of array, string, int, float, bool or \BackedEnum should be used.',
         ];
         yield 'unsupported type variadic' => [
             Request::create('/', 'GET', ['standardClass' => 'test']),
             new ArgumentMetadata('standardClass', \stdClass::class, true, false, false, attributes: [new MapQueryParameter()]),
             [],
             \LogicException::class,
-            '#[MapQueryParameter] cannot be used on controller argument "...$standardClass" of type "stdClass"; one of array, string, int, float or bool should be used.',
+            '#[MapQueryParameter] cannot be used on controller argument "...$standardClass" of type "stdClass"; one of array, string, int, float, bool or \BackedEnum should be used.',
         ];
     }
 
