[TwigBridge] Add #[Template()] to describe how to render arrays returned by controllers

Author: nicolas-grekas

Attribute/Template.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::TARGET_FUNCTION)]
+class Template
+{
+    public function __construct(
+        /**
+         * The name of the template to render.
+         */
+        public string $template,
+
+        /**
+         * The controller method arguments to pass to the template.
+         */
+        public ?array $vars = null,
+
+        /**
+         * Enables streaming the template.
+         */
+        public bool $stream = false,
+    ) {
+    }
+}

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `form_label_content` and `form_help_content` block to form themes
+ * Add `#[Template()]` to describe how to render arrays returned by controllers
 
 6.1
 ---

EventListener/TemplateAttributeListener.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\EventListener;
+
+use Symfony\Bridge\Twig\Attribute\Template;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
+use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\Event\ViewEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+use Twig\Environment;
+
+class TemplateAttributeListener implements EventSubscriberInterface
+{
+    public function __construct(
+        private Environment $twig,
+    ) {
+    }
+
+    public function onKernelView(ViewEvent $event)
+    {
+        $parameters = $event->getControllerResult();
+
+        if (!\is_array($parameters ?? [])) {
+            return;
+        }
+        $attribute = $event->getRequest()->attributes->get('_template');
+
+        if (!$attribute instanceof Template && !$attribute = $event->controllerArgumentsEvent?->getAttributes()[Template::class][0] ?? null) {
+            return;
+        }
+
+        $parameters ??= $this->resolveParameters($event->controllerArgumentsEvent, $attribute->vars);
+        $status = 200;
+
+        foreach ($parameters as $k => $v) {
+            if (!$v instanceof FormInterface) {
+                continue;
+            }
+            if ($v->isSubmitted() && !$v->isValid()) {
+                $status = 422;
+            }
+            $parameters[$k] = $v->createView();
+        }
+
+        $event->setResponse($attribute->stream
+            ? new StreamedResponse(fn () => $this->twig->display($attribute->template, $parameters), $status)
+            : new Response($this->twig->render($attribute->template, $parameters), $status)
+        );
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::VIEW => ['onKernelView', -128],
+        ];
+    }
+
+    private function resolveParameters(ControllerArgumentsEvent $event, ?array $vars): array
+    {
+        if ([] === $vars) {
+            return [];
+        }
+
+        $parameters = $event->getNamedArguments();
+
+        if (null !== $vars) {
+            $parameters = array_intersect_key($parameters, array_flip($vars));
+        }
+
+        return $parameters;
+    }
+}

Tests/EventListener/TemplateAttributeListenerTest.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Tests\EventListener;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Twig\EventListener\TemplateAttributeListener;
+use Symfony\Bridge\Twig\Tests\Fixtures\TemplateAttributeController;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
+use Symfony\Component\HttpKernel\Event\ViewEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Twig\Environment;
+
+class TemplateAttributeListenerTest extends TestCase
+{
+    public function testAttribute()
+    {
+        $twig = $this->createMock(Environment::class);
+        $twig->expects($this->exactly(2))
+            ->method('render')
+            ->withConsecutive(
+                ['templates/foo.html.twig', ['foo' => 'bar']],
+                ['templates/foo.html.twig', ['bar' => 'Bar', 'buz' => 'def']]
+            )
+            ->willReturn('Bar');
+
+        $request = new Request();
+        $kernel = $this->createMock(HttpKernelInterface::class);
+        $controllerArgumentsEvent = new ControllerArgumentsEvent($kernel, [new TemplateAttributeController(), 'foo'], ['Bar'], $request, null);
+        $listener = new TemplateAttributeListener($twig);
+
+        $event = new ViewEvent($kernel, $request, HttpKernelInterface::MAIN_REQUEST, ['foo' => 'bar'], $controllerArgumentsEvent);
+        $listener->onKernelView($event);
+        $this->assertSame('Bar', $event->getResponse()->getContent());
+
+        $event = new ViewEvent($kernel, $request, HttpKernelInterface::MAIN_REQUEST, null, $controllerArgumentsEvent);
+        $listener->onKernelView($event);
+        $this->assertSame('Bar', $event->getResponse()->getContent());
+
+        $event = new ViewEvent($kernel, $request, HttpKernelInterface::MAIN_REQUEST, null);
+        $listener->onKernelView($event);
+        $this->assertNull($event->getResponse());
+    }
+
+    public function testForm()
+    {
+        $request = new Request();
+        $kernel = $this->createMock(HttpKernelInterface::class);
+        $controllerArgumentsEvent = new ControllerArgumentsEvent($kernel, [new TemplateAttributeController(), 'foo'], [], $request, null);
+        $listener = new TemplateAttributeListener($this->createMock(Environment::class));
+
+        $form = $this->createMock(FormInterface::class);
+        $form->expects($this->once())->method('createView');
+        $form->expects($this->once())->method('isSubmitted')->willReturn(true);
+        $form->expects($this->once())->method('isValid')->willReturn(false);
+
+        $event = new ViewEvent($kernel, $request, HttpKernelInterface::MAIN_REQUEST, ['bar' => $form], $controllerArgumentsEvent);
+        $listener->onKernelView($event);
+
+        $this->assertSame(422, $event->getResponse()->getStatusCode());
+    }
+}

Tests/Fixtures/TemplateAttributeController.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Tests\Fixtures;
+
+use Symfony\Bridge\Twig\Attribute\Template;
+
+class TemplateAttributeController
+{
+    #[Template('templates/foo.html.twig', vars: ['bar', 'buz'])]
+    public function foo($bar, $baz = 'abc', $buz = 'def')
+    {
+    }
+}

composer.json

@@ -30,7 +30,7 @@
         "symfony/form": "^6.1",
         "symfony/html-sanitizer": "^6.1",
         "symfony/http-foundation": "^5.4|^6.0",
-        "symfony/http-kernel": "^5.4|^6.0",
+        "symfony/http-kernel": "^6.2",
         "symfony/intl": "^5.4|^6.0",
         "symfony/mime": "^5.4|^6.0",
         "symfony/polyfill-intl-icu": "~1.0",
@@ -58,7 +58,7 @@
         "symfony/console": "<5.4",
         "symfony/form": "<6.1",
         "symfony/http-foundation": "<5.4",
-        "symfony/http-kernel": "<5.4",
+        "symfony/http-kernel": "<6.2",
         "symfony/translation": "<5.4",
         "symfony/workflow": "<5.4"
     },