Add ControllerAttributeListener

symfony · codedmonkey · Feb 15, 2022 · Feb 17, 2022 · Feb 17, 2022 · 27a2403c633d93d9137d31012a14cc89af9f9b32
commit 27a2403c633d93d9137d31012a14cc89af9f9b32
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/controller.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/controller.php
@@ -0,0 +1,21 @@
+<?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\DependencyInjection\Loader\Configurator;
+
+use Symfony\Component\HttpKernel\EventListener\ControllerAttributeListener;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('controller_attribute_listener', ControllerAttributeListener::class)
+            ->tag('kernel.event_subscriber')
+    ;
+};
diff --git a/src/Symfony/Component/HttpKernel/Attribute/ControllerAttributeInterface.php b/src/Symfony/Component/HttpKernel/Attribute/ControllerAttributeInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\HttpKernel\Attribute;
+
+/**
+ * Marker interface for controller attributes
+ */
+interface ControllerAttributeInterface
+{
+}
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ControllerAttributeListener.php b/src/Symfony/Component/HttpKernel/EventListener/ControllerAttributeListener.php
@@ -0,0 +1,82 @@
+<?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\EventListener;
+
+use Doctrine\Persistence\Proxy;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Attribute\ControllerAttributeInterface;
+use Symfony\Component\HttpKernel\Event\ControllerEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * The ControllerAttributeListener class parses attributes marked
+ * as controller attributes in controllers.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Tim Goudriaan <tim@codedmonkey.com>
+ */
+class ControllerAttributeListener implements EventSubscriberInterface
+{
+    public function onKernelController(ControllerEvent $event)
+    {
+        $controller = $event->getController();
+
+        if (!\is_array($controller) && method_exists($controller, '__invoke')) {
+            $controller = [$controller, '__invoke'];
+        }
+
+        if (!\is_array($controller)) {
+            return;
+        }
+
+        $className = self::getRealClass(\get_class($controller[0]));
+        $object = new \ReflectionClass($className);
+        $method = $object->getMethod($controller[1]);
+
+        $classAttributes = $object->getAttributes(ControllerAttributeInterface::class, \ReflectionAttribute::IS_INSTANCEOF);
+        $methodAttributes = $method->getAttributes(ControllerAttributeInterface::class, \ReflectionAttribute::IS_INSTANCEOF);
+
+        $attributes = [];
+        foreach (array_merge($classAttributes, $methodAttributes) as $attribute) {
+            if ($attribute->isRepeated()) {
+                $attributes[$attribute->getName()][] = $attribute->newInstance();
+            } else {
+                // method attribute overrides class attribute
+                $attributes[$attribute->getName()] = $attribute->newInstance();
+            }
+        }
+
+        $request = $event->getRequest();
+        $request->attributes->set('_controller_attributes', $attributes);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [KernelEvents::CONTROLLER => 'onKernelController'];
+    }
+
+    private static function getRealClass(string $class): string
+    {
+        if (class_exists(Proxy::class)) {
+            if (false === $pos = strrpos($class, '\\'.Proxy::MARKER.'\\')) {
+                return $class;
+            }
+
+            return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
+        }
+
+        return $class;
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/ControllerAttributeListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/ControllerAttributeListenerTest.php
@@ -0,0 +1,185 @@
+<?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\Tests\EventListener;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\ControllerEvent;
+use Symfony\Component\HttpKernel\EventListener\ControllerAttributeListener;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\FooController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\RepeatableFooController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\ControllerAttributeAtClassAndMethodController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\ControllerAttributeAtClassController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\ControllerAttributeAtMethodController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\RepeatableControllerAttributeAtClassAndMethodController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\RepeatableControllerAttributeAtClassController;
+use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\RepeatableControllerAttributeAtMethodController;
+
+class ControllerAttributeListenerTest extends TestCase
+{
+    public function testAttributeAtClass()
+    {
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new ControllerAttributeAtClassController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener = new ControllerAttributeListener();
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertEquals('class', $attributes[FooController::class]->bar);
+    }
+
+    public function testAttributeAtMethod()
+    {
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new ControllerAttributeAtMethodController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener = new ControllerAttributeListener();
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertEquals('method', $attributes[FooController::class]->bar);
+    }
+
+    public function testAttributeAtClassAndMethod()
+    {
+        $listener = new ControllerAttributeListener();
+
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new ControllerAttributeAtClassAndMethodController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertEquals('method', $attributes[FooController::class]->bar);
+
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new ControllerAttributeAtClassAndMethodController(), 'bar'],
+            $request,
+            null
+        );
+
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertEquals('class', $attributes[FooController::class]->bar);
+    }
+
+    public function testRepeatableAttributeAtClass()
+    {
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new RepeatableControllerAttributeAtClassController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener = new ControllerAttributeListener();
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertCount(2, $attributes[RepeatableFooController::class]);
+        $this->assertEquals('class1', $attributes[RepeatableFooController::class][0]->bar);
+        $this->assertEquals('class2', $attributes[RepeatableFooController::class][1]->bar);
+    }
+
+    public function testRepeatableAttributeAtMethod()
+    {
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new RepeatableControllerAttributeAtMethodController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener = new ControllerAttributeListener();
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertCount(2, $attributes[RepeatableFooController::class]);
+        $this->assertEquals('method1', $attributes[RepeatableFooController::class][0]->bar);
+        $this->assertEquals('method2', $attributes[RepeatableFooController::class][1]->bar);
+    }
+
+    public function testRepeatableAttributeAtClassAndMethod()
+    {
+        $listener = new ControllerAttributeListener();
+
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new RepeatableControllerAttributeAtClassAndMethodController(), 'foo'],
+            $request,
+            null
+        );
+
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertCount(4, $attributes[RepeatableFooController::class]);
+        $this->assertEquals('class1', $attributes[RepeatableFooController::class][0]->bar);
+        $this->assertEquals('class2', $attributes[RepeatableFooController::class][1]->bar);
+        $this->assertEquals('method1', $attributes[RepeatableFooController::class][2]->bar);
+        $this->assertEquals('method2', $attributes[RepeatableFooController::class][3]->bar);
+
+        $request = new Request();
+
+        $event = new ControllerEvent(
+            $this->getMockBuilder(HttpKernelInterface::class)->getMock(),
+            [new RepeatableControllerAttributeAtClassAndMethodController(), 'bar'],
+            $request,
+            null
+        );
+
+        $listener->onKernelController($event);
+
+        $this->assertNotNull($attributes = $request->attributes->get('_controller_attributes'));
+        $this->assertCount(1, $attributes);
+        $this->assertCount(2, $attributes[RepeatableFooController::class]);
+        $this->assertEquals('class1', $attributes[RepeatableFooController::class][0]->bar);
+        $this->assertEquals('class2', $attributes[RepeatableFooController::class][1]->bar);
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fixtures/Attribute/FooController.php b/src/Symfony/Component/HttpKernel/Tests/Fixtures/Attribute/FooController.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Symfony\Component\HttpKernel\Tests\Fixtures\Attribute;
+
+use Symfony\Component\HttpKernel\Attribute\ControllerAttributeInterface;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
+class FooController implements ControllerAttributeInterface
+{
+    public function __construct(
+        public string $bar
+    ) {}
+}
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fixtures/Attribute/RepeatableFooController.php b/src/Symfony/Component/HttpKernel/Tests/Fixtures/Attribute/RepeatableFooController.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Symfony\Component\HttpKernel\Tests\Fixtures\Attribute;
+
+use Symfony\Component\HttpKernel\Attribute\ControllerAttributeInterface;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class RepeatableFooController implements ControllerAttributeInterface
+{
+    public function __construct(
+        public string $bar
+    ) {}
+}
diff --git a/...nt/HttpKernel/Tests/Fixtures/Controller/ControllerAttributeAtClassAndMethodController.php b/...nt/HttpKernel/Tests/Fixtures/Controller/ControllerAttributeAtClassAndMethodController.php
@@ -0,0 +1,27 @@
+<?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\Tests\Fixtures\Controller;
+
+use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\FooController;
+
+#[FooController(bar: 'class')]
+class ControllerAttributeAtClassAndMethodController
+{
+    #[FooController(bar: 'method')]
+    public function foo()
+    {
+    }
+
+    public function bar()
+    {
+    }
+}
diff --git a/...y/Component/HttpKernel/Tests/Fixtures/Controller/ControllerAttributeAtClassController.php b/...y/Component/HttpKernel/Tests/Fixtures/Controller/ControllerAttributeAtClassController.php
@@ -0,0 +1,22 @@
+<?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\Tests\Fixtures\Controller;
+
+use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\FooController;
+
+#[FooController(bar: 'class')]
+class ControllerAttributeAtClassController
+{
+    public function foo()
+    {
+    }
+}