minor symfony#59514 [HttpKernel] Improve MapQueryParameter handling of options (nicolas-grekas)

This PR was merged into the 7.3 branch.

Discussion
----------

[HttpKernel] Improve MapQueryParameter handling of options

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

Making the attribute better documented and more natural to use.

Commits
-------

496573f [HttpKernel] Improve MapQueryParameter handling of options

Author: nicolas-grekas

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

@@ -28,9 +28,9 @@ final class MapQueryParameter extends ValueResolver
      * @see https://php.net/manual/filter.constants for filter, flags and options
      *
      * @param string|null                                         $name     The name of the query parameter; if null, the name of the argument in the controller will be used
-     * @param (FILTER_VALIDATE_*)|(FILTER_SANITIZE_*)|null        $filter   The filter to pass to "filter_var()"
-     * @param int-mask-of<(FILTER_FLAG_*)|FILTER_NULL_ON_FAILURE> $flags    The flags to pass to "filter_var()"
-     * @param array                                               $options  The options to pass to "filter_var()"
+     * @param (FILTER_VALIDATE_*)|(FILTER_SANITIZE_*)|null        $filter   The filter to pass to "filter_var()", deduced from the type-hint if null
+     * @param int-mask-of<(FILTER_FLAG_*)|FILTER_NULL_ON_FAILURE> $flags
+     * @param array{min_range?: int|float, max_range?: int|float, regexp?: string, ...} $options
      * @param class-string<ValueResolverInterface>|string         $resolver The name of the resolver to use
      */
     public function __construct(

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

@@ -76,7 +76,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): array
         $enumType = null;
         $filter = match ($type) {
             'array' => \FILTER_DEFAULT,
-            'string' => \FILTER_DEFAULT,
+            'string' => isset($attribute->options['regexp']) ? \FILTER_VALIDATE_REGEXP : \FILTER_DEFAULT,
             'int' => \FILTER_VALIDATE_INT,
             'float' => \FILTER_VALIDATE_FLOAT,
             'bool' => \FILTER_VALIDATE_BOOL,

src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/QueryParameterValueResolverTest.php

@@ -108,50 +108,50 @@ public static function validDataProvider(): iterable
 
         yield 'parameter found and string with regexp filter that matches' => [
             Request::create('/', 'GET', ['firstName' => 'John']),
-            new ArgumentMetadata('firstName', 'string', false, false, false, attributes: [new MapQueryParameter(filter: \FILTER_VALIDATE_REGEXP, flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
+            new ArgumentMetadata('firstName', 'string', false, false, false, attributes: [new MapQueryParameter(options: ['regexp' => '/John/'])]),
             ['John'],
         ];
 
         yield 'parameter found and string with regexp filter that falls back to null on failure' => [
             Request::create('/', 'GET', ['firstName' => 'Fabien']),
-            new ArgumentMetadata('firstName', 'string', false, false, false, attributes: [new MapQueryParameter(filter: \FILTER_VALIDATE_REGEXP, flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
+            new ArgumentMetadata('firstName', 'string', false, false, false, attributes: [new MapQueryParameter(flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
             [null],
         ];
 
         yield 'parameter found and string variadic with regexp filter that matches' => [
             Request::create('/', 'GET', ['firstName' => ['John', 'John']]),
-            new ArgumentMetadata('firstName', 'string', true, false, false, attributes: [new MapQueryParameter(filter: \FILTER_VALIDATE_REGEXP, flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
+            new ArgumentMetadata('firstName', 'string', true, false, false, attributes: [new MapQueryParameter(options: ['regexp' => '/John/'])]),
             ['John', 'John'],
         ];
 
         yield 'parameter found and string variadic with regexp filter that falls back to null on failure' => [
             Request::create('/', 'GET', ['firstName' => ['John', 'Fabien']]),
-            new ArgumentMetadata('firstName', 'string', true, false, false, attributes: [new MapQueryParameter(filter: \FILTER_VALIDATE_REGEXP, flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
+            new ArgumentMetadata('firstName', 'string', true, false, false, attributes: [new MapQueryParameter(flags: \FILTER_NULL_ON_FAILURE, options: ['regexp' => '/John/'])]),
             ['John'],
         ];
 
         yield 'parameter found and integer' => [
-            Request::create('/', 'GET', ['age' => 123]),
+            Request::create('/', 'GET', ['age' => '123']),
             new ArgumentMetadata('age', 'int', false, false, false, attributes: [new MapQueryParameter()]),
             [123],
         ];
 
         yield 'parameter found and integer variadic' => [
-            Request::create('/', 'GET', ['age' => [123, 222]]),
+            Request::create('/', 'GET', ['age' => ['123', '222']]),
             new ArgumentMetadata('age', 'int', true, false, false, attributes: [new MapQueryParameter()]),
             [123, 222],
         ];
 
         yield 'parameter found and float' => [
-            Request::create('/', 'GET', ['price' => 10.99]),
+            Request::create('/', 'GET', ['price' => '10.99']),
             new ArgumentMetadata('price', 'float', false, false, false, attributes: [new MapQueryParameter()]),
             [10.99],
         ];
 
         yield 'parameter found and float variadic' => [
-            Request::create('/', 'GET', ['price' => [10.99, 5.99]]),
+            Request::create('/', 'GET', ['price' => ['10.99e2', '5.99']]),
             new ArgumentMetadata('price', 'float', true, false, false, attributes: [new MapQueryParameter()]),
-            [10.99, 5.99],
+            [1099.0, 5.99],
         ];
 
         yield 'parameter found and boolean yes' => [
@@ -209,7 +209,7 @@ public static function validDataProvider(): iterable
         ];
 
         yield 'parameter found and backing type variadic and at least one backing value not int nor string that fallbacks to null on failure' => [
-            Request::create('/', 'GET', ['suits' => [1, 'D']]),
+            Request::create('/', 'GET', ['suits' => ['1', 'D']]),
             new ArgumentMetadata('suits', Suit::class, false, false, false, attributes: [new MapQueryParameter(flags: \FILTER_NULL_ON_FAILURE)]),
             [null],
         ];
@@ -265,7 +265,7 @@ public static function invalidArgumentTypeProvider(): iterable
     public static function invalidOrMissingArgumentProvider(): iterable
     {
         yield 'parameter found and array variadic with parameter not array failure' => [
-            Request::create('/', 'GET', ['ids' => [['1', '2'], 1]]),
+            Request::create('/', 'GET', ['ids' => [['1', '2'], '1']]),
             new ArgumentMetadata('ids', 'array', true, false, false, attributes: [new MapQueryParameter()]),
             new NotFoundHttpException('Invalid query parameter "ids".'),
         ];