[HttpKernel] [MapQueryString] added key argument to MapQueryString attribute

feymo · fabpot · commit ac1f54c8afce · 2024-12-10T18:37:16.000+01:00
diff --git a/src/Symfony/Component/HttpKernel/Attribute/MapQueryString.php b/src/Symfony/Component/HttpKernel/Attribute/MapQueryString.php
@@ -37,6 +37,7 @@ public function __construct(
         public readonly string|GroupSequence|array|null $validationGroups = null,
         string $resolver = RequestPayloadValueResolver::class,
         public readonly int $validationFailedStatusCode = Response::HTTP_NOT_FOUND,
+        public readonly ?string $key = null,
     ) {
         parent::__construct($resolver);
     }
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `$key` argument to `#[MapQueryString]` that allows using a specific key for argument resolving
+
 7.2
 ---
 
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/RequestPayloadValueResolver.php
@@ -186,7 +186,7 @@ public static function getSubscribedEvents(): array
 
     private function mapQueryString(Request $request, ArgumentMetadata $argument, MapQueryString $attribute): ?object
     {
-        if (!($data = $request->query->all()) && ($argument->isNullable() || $argument->hasDefaultValue())) {
+        if (!($data = $request->query->all($attribute->key)) && ($argument->isNullable() || $argument->hasDefaultValue())) {
             return null;
         }
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestPayloadValueResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/RequestPayloadValueResolverTest.php
@@ -874,6 +874,27 @@ public function testBoolArgumentInJsonBody()
 
         $this->assertTrue($event->getArguments()[0]->value);
     }
+
+    public function testConfigKeyForQueryString()
+    {
+        $serializer = new Serializer([new ObjectNormalizer()]);
+        $validator = $this->createMock(ValidatorInterface::class);
+        $resolver = new RequestPayloadValueResolver($serializer, $validator);
+
+        $argument = new ArgumentMetadata('filtered', QueryPayload::class, false, false, null, false, [
+            MapQueryString::class => new MapQueryString(key: 'value'),
+        ]);
+        $request = Request::create('/', Request::METHOD_GET, ['value' => ['page' => 1.0]]);
+
+        $kernel = $this->createMock(HttpKernelInterface::class);
+        $arguments = $resolver->resolve($request, $argument);
+        $event = new ControllerArgumentsEvent($kernel, function () {}, $arguments, $request, HttpKernelInterface::MAIN_REQUEST);
+
+        $resolver->onKernelControllerArguments($event);
+
+        $this->assertInstanceOf(QueryPayload::class, $event->getArguments()[0]);
+        $this->assertSame(1.0, $event->getArguments()[0]->page);
+    }
 }
 
 class RequestPayload

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ public function __construct(`
`37`	`37`	`public readonly string\|GroupSequence\|array\|null $validationGroups = null,`
`38`	`38`	`string $resolver = RequestPayloadValueResolver::class,`
`39`	`39`	`public readonly int $validationFailedStatusCode = Response::HTTP_NOT_FOUND,`
	`40`	`+ public readonly ?string $key = null,`
`40`	`41`	`) {`
`41`	`42`	`parent::__construct($resolver);`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ public static function getSubscribedEvents(): array`
`186`	`186`
`187`	`187`	`private function mapQueryString(Request $request, ArgumentMetadata $argument, MapQueryString $attribute): ?object`
`188`	`188`	`{`
`189`		`- if (!($data = $request->query->all()) && ($argument->isNullable() \|\| $argument->hasDefaultValue())) {`
	`189`	`+ if (!($data = $request->query->all($attribute->key)) && ($argument->isNullable() \|\| $argument->hasDefaultValue())) {`
`190`	`190`	`return null;`
`191`	`191`	`}`
`192`	`192`