[HttpKernel] Add #[ValueResolver] for specifying a parameter argument resolver

MatTheCat · MatTheCat · commit 998e944bcffc · 2023-01-16T11:13:15.000+01:00
diff --git a/src/Symfony/Component/HttpKernel/Attribute/ValueResolver.php b/src/Symfony/Component/HttpKernel/Attribute/ValueResolver.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Attribute;
+
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+
+#[\Attribute(\Attribute::TARGET_PARAMETER)]
+class ValueResolver
+{
+    /** @param class-string<ValueResolverInterface> $class */
+    public function __construct(
+        public readonly string $class
+    ) {
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Add `#[WithHttpStatus]` for defining status codes for exceptions
  * Use an instance of `Psr\Clock\ClockInterface` to generate the current date time in `DateTimeValueResolver`
  * Add `#[WithLogLevel]` for defining log levels for exceptions
+ * Add `#[ValueResolver]` for specifying a parameter argument resolver
 
 6.2
 ---
diff --git a/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php b/src/Symfony/Component/HttpKernel/Controller/ArgumentResolver.php
@@ -11,7 +11,9 @@
 
 namespace Symfony\Component\HttpKernel\Controller;
 
+use Psr\Container\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\ValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
@@ -45,7 +47,15 @@ public function getArguments(Request $request, callable $controller, \Reflection
         $arguments = [];
 
         foreach ($this->argumentMetadataFactory->createArgumentMetadata($controller, $reflector) as $metadata) {
+            if ($attributes = $metadata->getAttributesOfType(ValueResolver::class)) {
+                $resolverClass = reset($attributes)->class;
+            }
+
             foreach ($this->argumentValueResolvers as $resolver) {
+                if ($resolver::class !== ($resolverClass ?? $resolver::class)) {
+                    continue;
+                }
+
                 if ((!$resolver instanceof ValueResolverInterface || $resolver instanceof TraceableValueResolver) && !$resolver->supports($request, $metadata)) {
                     continue;
                 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php b/src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolverTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
+use Symfony\Component\HttpKernel\Attribute\ValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
@@ -283,6 +284,15 @@ public function testGetSessionMissMatchOnNull()
         self::$resolver->getArguments($request, $controller);
     }
 
+    public function testValueResolverAttribute()
+    {
+        $request = Request::create('/');
+        $request->attributes->set('foo', 'foo');
+        $controller = [new self(), 'controllerWithAttribute'];
+
+        $this->assertEquals(['foo'], self::$resolver->getArguments($request, $controller));
+    }
+
     public function __invoke($foo, $bar = null)
     {
     }
@@ -322,6 +332,10 @@ public function controllerWithSessionInterface(SessionInterface $session)
     public function controllerWithExtendingSession(ExtendingSession $session)
     {
     }
+
+    public function controllerWithAttribute(#[ValueResolver(RequestAttributeValueResolver::class)] $foo = 'bar')
+    {
+    }
 }
 
 function controller_function($foo, $foobar)

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use Symfony\Component\HttpFoundation\Session\Session;`
`17`	`17`	`use Symfony\Component\HttpFoundation\Session\SessionInterface;`
`18`	`18`	`use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;`
	`19`	`+use Symfony\Component\HttpKernel\Attribute\ValueResolver;`
`19`	`20`	`use Symfony\Component\HttpKernel\Controller\ArgumentResolver;`
`20`	`21`	`use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;`
`21`	`22`	`use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;`
`@@ -283,6 +284,15 @@ public function testGetSessionMissMatchOnNull()`
`283`	`284`	`self::$resolver->getArguments($request, $controller);`
`284`	`285`	`}`
`285`	`286`
	`287`	`+ public function testValueResolverAttribute()`
	`288`	`+ {`
	`289`	`+ $request = Request::create('/');`
	`290`	`+ $request->attributes->set('foo', 'foo');`
	`291`	`+ $controller = [new self(), 'controllerWithAttribute'];`
	`292`	`+`
	`293`	`+ $this->assertEquals(['foo'], self::$resolver->getArguments($request, $controller));`
	`294`	`+ }`
	`295`	`+`
`286`	`296`	`public function __invoke($foo, $bar = null)`
`287`	`297`	`{`
`288`	`298`	`}`
`@@ -322,6 +332,10 @@ public function controllerWithSessionInterface(SessionInterface $session)`
`322`	`332`	`public function controllerWithExtendingSession(ExtendingSession $session)`
`323`	`333`	`{`
`324`	`334`	`}`
	`335`	`+`
	`336`	`+ public function controllerWithAttribute(#[ValueResolver(RequestAttributeValueResolver::class)] $foo = 'bar')`
	`337`	`+ {`
	`338`	`+ }`
`325`	`339`	`}`
`326`	`340`
`327`	`341`	`function controller_function($foo, $foobar)`