feature symfony#53209 [HttpKernel] Add support for custom HTTP status code for the #[MapQueryParameter] attribute (ovidiuenache)

This PR was merged into the 7.1 branch.

Discussion
----------

[HttpKernel] Add support for custom HTTP status code for the `#[MapQueryParameter]` attribute

| Q             | A
| ------------- | ---
| Branch?       | 7.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | symfony#52782
| License       | MIT

Issue symfony#52782 was created where the need to have a custom HTTP status code for the MapQueryParameter attribute was stated. As part of the discussion, `@nicolas`-grekas suggested an approach similar to the implementation of the MapQueryString attribute where such a status code can be provided in the attribute's constructor.

I believe having the possibility to control the status code returned for an invalid and non-nullable parameter with no default value would be a great addition so I took the liberty to create this PR.

This change is backward compatible.

Commits
-------

c9f33bb [HttpKernel] Add support for custom HTTP status code for the MapQueryParameter attribute

Author: nicolas-grekas

src/Symfony/Component/HttpKernel/Attribute/MapQueryParameter.php

@@ -11,12 +11,14 @@
 
 namespace Symfony\Component\HttpKernel\Attribute;
 
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver;
 
 /**
  * Can be used to pass a query parameter to a controller argument.
  *
  * @author Ruud Kamphuis <[email protected]>
+ * @author Ionut Enache <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
 final class MapQueryParameter extends ValueResolver
@@ -32,6 +34,7 @@ public function __construct(
         public int $flags = 0,
         public array $options = [],
         string $resolver = QueryParameterValueResolver::class,
+        public int $validationFailedStatusCode = Response::HTTP_NOT_FOUND,
     ) {
         parent::__construct($resolver);
     }

src/Symfony/Component/HttpKernel/CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add method `isKernelTerminating()` to `ExceptionEvent` that allows to check if an exception was thrown while the kernel is being terminated
  * Add `HttpException::fromStatusCode()`
+ * Add `$validationFailedStatusCode` argument to `#[MapQueryParameter]` that allows setting a custom HTTP status code when validation fails
 
 7.0
 ---

src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/QueryParameterValueResolver.php

@@ -15,14 +15,15 @@
 use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 
 /**
  * Resolve arguments of type: array, string, int, float, bool, \BackedEnum from query parameters.
  *
  * @author Ruud Kamphuis <[email protected]>
  * @author Nicolas Grekas <[email protected]>
  * @author Mateusz Anders <[email protected]>
+ * @author Ionut Enache <[email protected]>
  */
 final class QueryParameterValueResolver implements ValueResolverInterface
 {
@@ -33,12 +34,14 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         $name = $attribute->name ?? $argument->getName();
+        $validationFailedCode = $attribute->validationFailedStatusCode;
+
         if (!$request->query->has($name)) {
             if ($argument->isNullable() || $argument->hasDefaultValue()) {
                 return [];
             }
 
-            throw new NotFoundHttpException(sprintf('Missing query parameter "%s".', $name));
+            throw HttpException::fromStatusCode($validationFailedCode, sprintf('Missing query parameter "%s".', $name));
         }
 
         $value = $request->query->all()[$name];
@@ -52,7 +55,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
             $filtered = array_values(array_filter((array) $value, \is_array(...)));
 
             if ($filtered !== $value && !($attribute->flags & \FILTER_NULL_ON_FAILURE)) {
-                throw new NotFoundHttpException(sprintf('Invalid query parameter "%s".', $name));
+                throw HttpException::fromStatusCode($validationFailedCode, sprintf('Invalid query parameter "%s".', $name));
             }
 
             return $filtered;
@@ -103,7 +106,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         if (null === $value && !($attribute->flags & \FILTER_NULL_ON_FAILURE)) {
-            throw new NotFoundHttpException(sprintf('Invalid query parameter "%s".', $name));
+            throw HttpException::fromStatusCode($validationFailedCode, sprintf('Invalid query parameter "%s".', $name));
         }
 
         if (!\is_array($value)) {
@@ -117,7 +120,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         }
 
         if ($filtered !== $value && !($attribute->flags & \FILTER_NULL_ON_FAILURE)) {
-            throw new NotFoundHttpException(sprintf('Invalid query parameter "%s".', $name));
+            throw HttpException::fromStatusCode($validationFailedCode, sprintf('Invalid query parameter "%s".', $name));
         }
 
         return $argument->isVariadic() ? $filtered : [$filtered];