Set twig globals after first admin instanciation (#8125)

Co-authored-by: Antoine Roué <[email protected]>
sonata-project · Nov 20, 2023 · aab78ff · aab78ff
1 parent fad2b3f
commit aab78ff
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 198 deletions.
diff --git a/src/Controller/CRUDController.php b/src/Controller/CRUDController.php
@@ -989,6 +989,25 @@ final public function configureAdmin(Request $request): void
         $this->templateRegistry = $this->admin->getTemplateRegistry();
     }
 
+    /**
+     * Add twig globals which are used in every template.
+     */
+    final public function setTwigGlobals(Request $request): void
+    {
+        $twig = $this->container->get('twig');
+        \assert($twig instanceof Environment);
+
+        $twig->addGlobal('admin', $this->admin);
+
+        if ($this->isXmlHttpRequest($request)) {
+            $baseTemplate = $this->templateRegistry->getTemplate('ajax');
+        } else {
+            $baseTemplate = $this->templateRegistry->getTemplate('layout');
+        }
+
+        $twig->addGlobal('base_template', $baseTemplate);
+    }
+
     /**
      * Renders a view while passing mandatory parameters on to the template.
      *

diff --git a/src/EventListener/AdminEventListener.php b/src/EventListener/AdminEventListener.php
diff --git a/src/EventListener/ConfigureCRUDControllerListener.php b/src/EventListener/ConfigureCRUDControllerListener.php
@@ -38,6 +38,8 @@ public function onKernelController(ControllerEvent $event): void
         $request = $event->getRequest();
 
         $controller->configureAdmin($request);
+
+        $controller->setTwigGlobals($request);
     }
 
     public static function getSubscribedEvents(): array

diff --git a/src/Resources/config/event_listener.php b/src/Resources/config/event_listener.php
@@ -13,19 +13,11 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-use Sonata\AdminBundle\EventListener\AdminEventListener;
 use Sonata\AdminBundle\EventListener\ConfigureCRUDControllerListener;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $containerConfigurator->services()
 
-        ->set('sonata.admin.event_listener.admin_event', AdminEventListener::class)
-            ->tag('kernel.event_subscriber')
-            ->args([
-                new ReferenceConfigurator('twig'),
-                new ReferenceConfigurator('sonata.admin.request.fetcher'),
-            ])
-
         ->set('sonata.admin.event_listener.configure_crud_controller', ConfigureCRUDControllerListener::class)
             ->tag('kernel.event_subscriber');
 };
diff --git a/tests/Controller/CRUDControllerTest.php b/tests/Controller/CRUDControllerTest.php
@@ -74,6 +74,7 @@
 use Symfony\Component\Validator\ConstraintViolation;
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Twig\Environment;
+use Twig\Loader\ArrayLoader;
 
 /**
  * @author Andrej Hudec <[email protected]>
@@ -383,6 +384,32 @@ public function testConfigureAdminWithoutTemplateRegistryThrowsException(): void
         $controller->configureAdmin($this->request);
     }
 
+    public function testSetTwigGlobals(): void
+    {
+        $twig = new Environment(new ArrayLoader([]));
+        $this->container->set('twig', $twig);
+
+        $this->controller->setTwigGlobals($this->request);
+
+        $globals = $twig->getGlobals();
+        static::assertSame($this->admin, $globals['admin']);
+        static::assertSame('@SonataAdmin/standard_layout.html.twig', $globals['base_template']);
+    }
+
+    public function testSetTwigGlobalsWithAjaxRequest(): void
+    {
+        $this->request->request->set('_xml_http_request', true);
+
+        $twig = new Environment(new ArrayLoader([]));
+        $this->container->set('twig', $twig);
+
+        $this->controller->setTwigGlobals($this->request);
+
+        $globals = $twig->getGlobals();
+        static::assertSame($this->admin, $globals['admin']);
+        static::assertSame('@SonataAdmin/ajax_layout.html.twig', $globals['base_template']);
+    }
+
     public function testGetBaseTemplate(): void
     {
         static::assertSame(

diff --git a/tests/EventListener/AdminEventListenerTest.php b/tests/EventListener/AdminEventListenerTest.php
diff --git a/tests/EventListener/ConfigureCRUDControllerListenerTest.php b/tests/EventListener/ConfigureCRUDControllerListenerTest.php
@@ -22,6 +22,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Twig\Environment;
 
 final class ConfigureCRUDControllerListenerTest extends TestCase
 {
@@ -64,6 +65,21 @@ public function testItConfiguresCRUDController(): void
             ->with($request)
             ->willReturn($admin);
 
+        $twig = $this->createMock(Environment::class);
+        $container->set('twig', $twig);
+
+        $matcher = static::exactly(2);
+        $twig
+            ->expects($matcher)
+            ->method('addGlobal')
+            ->willReturnCallback(static function (string $name) use ($matcher) {
+                match ($matcher->getInvocationCount()) {
+                    1 => static::assertSame($name, 'admin'),
+                    2 => static::assertSame($name, 'base_template'),
+                    default => throw new \LogicException('Exactly 2 calls'),
+                };
+            });
+
         $this->listener->onKernelController($controllerEvent);
     }
 }