Add AjaxTemplate attribute + listener and listener for setting custom response object

Author: nickygerritsen

webapp/src/Twig/Attribute/AjaxTemplate.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace App\Twig\Attribute;
+
+use Attribute;
+use Symfony\Bridge\Twig\Attribute\Template;
+
+/**
+ * This attribute can be used to render a different template when the request is an AJAX request.
+ */
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)]
+class AjaxTemplate extends Template
+{
+    /**
+     * @param array<mixed, mixed>|null $vars
+     */
+    public function __construct(
+        string $normalTemplate,
+        public string $ajaxTemplate,
+        ?array $vars = null,
+        bool $stream = false,
+    ) {
+        parent::__construct($normalTemplate, $vars, $stream);
+    }
+}

webapp/src/Twig/EventListener/AjaxTemplateAttributeListener.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace App\Twig\EventListener;
+
+use App\Twig\Attribute\AjaxTemplate;
+use Symfony\Bridge\Twig\Attribute\Template;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\HttpKernel\Event\ViewEvent;
+
+class AjaxTemplateAttributeListener
+{
+    // Priority needs to be > -128 to come before TemplateAttributeListener
+    #[AsEventListener]
+    public function onKernelView(ViewEvent $event): void
+    {
+        // Based on Symfony's TemplateAttributeListener
+
+        /** @var AjaxTemplate|null $ajaxTemplateAttribute */
+        $ajaxTemplateAttribute = $event->controllerArgumentsEvent?->getAttributes(AjaxTemplate::class)[0] ?? null;
+        if (!$ajaxTemplateAttribute) {
+            return;
+        }
+
+        // Create the template attribute that Symfony can use
+        $template = new Template(
+            template: $event->getRequest()->isXmlHttpRequest() ? $ajaxTemplateAttribute->ajaxTemplate : $ajaxTemplateAttribute->template,
+            vars: $ajaxTemplateAttribute->vars,
+            stream: $ajaxTemplateAttribute->stream,
+        );
+        $attributes = $event->controllerArgumentsEvent?->getAttributes();
+        $attributes[Template::class] = [$template];
+        $event->controllerArgumentsEvent?->setController($event->controllerArgumentsEvent->getController(), $attributes);
+    }
+}

webapp/src/Twig/EventListener/CustomResponseListener.php

@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+
+namespace App\Twig\EventListener;
+
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+
+/**
+ * This listener allows one to set a custom response object in a controller.
+ * It will then use that response, but use the content of the original controller response.
+ */
+class CustomResponseListener
+{
+    protected ?Response $response = null;
+
+    public function setCustomResponse(Response $response): void
+    {
+        $this->response = $response;
+    }
+
+    #[AsEventListener]
+    public function onKernelResponse(ResponseEvent $event): void
+    {
+        if ($this->response) {
+            $this->response->setContent($event->getResponse()->getContent());
+            $event->setResponse($this->response);
+
+            // Make sure to clear the response if we have more requests after this one.
+            $this->response = null;
+        }
+    }
+}