[Routing] Add FQCN aliases for routes targeting invokable classes

fancyweb · fancyweb · commit 6f19dad39eee · 2023-04-20T20:14:04.000+02:00
defining one route only
diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Add FQCN aliases for routes loaded from attributes/annotations targeting invokable classes defining one route only
+
 6.2
 ---
 
diff --git a/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php
@@ -125,20 +125,29 @@ public function load(mixed $class, string $type = null): RouteCollection
             return $collection;
         }
 
+        $invoke = false;
         foreach ($class->getMethods() as $method) {
             $this->defaultRouteIndex = 0;
             foreach ($this->getAnnotations($method) as $annot) {
                 $this->addRoute($collection, $annot, $globals, $class, $method);
+                if ('__invoke' === $method->name) {
+                    $invoke = true;
+                }
             }
         }
 
         if (0 === $collection->count() && $class->hasMethod('__invoke')) {
             $globals = $this->resetGlobals();
             foreach ($this->getAnnotations($class) as $annot) {
                 $this->addRoute($collection, $annot, $globals, $class, $class->getMethod('__invoke'));
+                $invoke = true;
             }
         }
 
+        if ($invoke && 1 === $collection->count()) {
+            $collection->addAlias($class->name, key($collection->all()));
+        }
+
         return $collection;
     }
 
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/AnnotationFixtures/InvokableMethodController.php b/src/Symfony/Component/Routing/Tests/Fixtures/AnnotationFixtures/InvokableMethodController.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AnnotationFixtures;
+
+use Symfony\Component\Routing\Annotation\Route;
+
+class InvokableMethodController
+{
+    /**
+     * @Route("/here", name="lol", methods={"GET", "POST"}, schemes={"https"})
+     */
+    public function __invoke()
+    {
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/InvokableMethodController.php b/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/InvokableMethodController.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures;
+
+use Symfony\Component\Routing\Annotation\Route;
+
+class InvokableMethodController
+{
+    #[Route(path: '/here', name: 'lol', methods: ["GET", "POST"], schemes: ['https'])]
+
+    public function __invoke()
+    {
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTestCase.php b/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTestCase.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Routing\Tests\Loader;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Routing\Alias;
 use Symfony\Component\Routing\Loader\AnnotationClassLoader;
 use Symfony\Component\Routing\Tests\Fixtures\AnnotationFixtures\AbstractClassController;
 
@@ -72,6 +73,17 @@ public function testInvokableControllerLoader()
         $this->assertEquals('/here', $routes->get('lol')->getPath());
         $this->assertEquals(['GET', 'POST'], $routes->get('lol')->getMethods());
         $this->assertEquals(['https'], $routes->get('lol')->getSchemes());
+        $this->assertEquals(new Alias('lol'), $routes->getAlias($this->getNamespace().'\InvokableController'));
+    }
+
+    public function testInvokableMethodControllerLoader()
+    {
+        $routes = $this->loader->load($this->getNamespace().'\InvokableMethodController');
+        $this->assertCount(1, $routes);
+        $this->assertEquals('/here', $routes->get('lol')->getPath());
+        $this->assertEquals(['GET', 'POST'], $routes->get('lol')->getMethods());
+        $this->assertEquals(['https'], $routes->get('lol')->getSchemes());
+        $this->assertEquals(new Alias('lol'), $routes->getAlias($this->getNamespace().'\InvokableMethodController'));
     }
 
     public function testInvokableLocalizedControllerLoading()

Original file line number	Diff line number	Diff line change
`@@ -125,20 +125,29 @@ public function load(mixed $class, string $type = null): RouteCollection`
`125`	`125`	`return $collection;`
`126`	`126`	`}`
`127`	`127`
	`128`	`+ $invoke = false;`
`128`	`129`	`foreach ($class->getMethods() as $method) {`
`129`	`130`	`$this->defaultRouteIndex = 0;`
`130`	`131`	`foreach ($this->getAnnotations($method) as $annot) {`
`131`	`132`	`$this->addRoute($collection, $annot, $globals, $class, $method);`
	`133`	`+ if ('__invoke' === $method->name) {`
	`134`	`+ $invoke = true;`
	`135`	`+ }`
`132`	`136`	`}`
`133`	`137`	`}`
`134`	`138`
`135`	`139`	`if (0 === $collection->count() && $class->hasMethod('__invoke')) {`
`136`	`140`	`$globals = $this->resetGlobals();`
`137`	`141`	`foreach ($this->getAnnotations($class) as $annot) {`
`138`	`142`	`$this->addRoute($collection, $annot, $globals, $class, $class->getMethod('__invoke'));`
	`143`	`+ $invoke = true;`
`139`	`144`	`}`
`140`	`145`	`}`
`141`	`146`
	`147`	`+ if ($invoke && 1 === $collection->count()) {`
	`148`	`+ $collection->addAlias($class->name, key($collection->all()));`
	`149`	`+ }`
	`150`	`+`
`142`	`151`	`return $collection;`
`143`	`152`	`}`
`144`	`153`