vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/Frontend/GlobalTemplateVariablesListener.php line 98

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\CoreBundle\EventListener\Frontend;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  19. use Pimcore\Http\Request\Resolver\DocumentResolver;
  20. use Pimcore\Http\Request\Resolver\EditmodeResolver;
  21. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  22. use Psr\Log\LoggerAwareInterface;
  23. use Psr\Log\LoggerAwareTrait;
  24. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  25. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  26. use Symfony\Component\HttpKernel\Event\RequestEvent;
  27. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  28. use Symfony\Component\HttpKernel\KernelEvents;
  29. use Twig\Environment;
  31. /**
  32.  * @internal
  33.  */
  34. class GlobalTemplateVariablesListener implements EventSubscriberInterface, LoggerAwareInterface
  35. {
  36.     use LoggerAwareTrait;
  37.     use PimcoreContextAwareTrait;
  39.     /**
  40.      * @var array
  41.      */
  42.     protected $globalsStack = [];
  44.     public function __construct(
  45.         protected DocumentResolver $documentResolver,
  46.         protected EditmodeResolver $editmodeResolver,
  47.         protected Environment $twig
  48.     ) {
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public static function getSubscribedEvents()
  55.     {
  56.         return [
  57.             KernelEvents::CONTROLLER => ['onKernelController', 15], // has to be after DocumentFallbackListener
  58.             KernelEvents::RESPONSE => 'onKernelResponse',
  59.             KernelEvents::REQUEST => ['onKernelRequest', 700],
  60.         ];
  61.     }
  63.     public function onKernelRequest(RequestEvent $event)
  64.     {
  65.         // set the variables as soon as possible, so that we're not getting troubles in
  66.         // onKernelController() if the twig environment was already initialized before
  67.         // defining global variables is only possible before the twig environment was initialized
  68.         // however you can change the value of the variable at any time later on
  69.         if ($event->isMainRequest()) {
  70.             $this->twig->addGlobal('document', null);
  71.             $this->twig->addGlobal('editmode', false);
  72.         }
  73.     }
  75.     public function onKernelController(ControllerEvent $event)
  76.     {
  77.         $request = $event->getRequest();
  78.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  79.             return;
  80.         }
  82.         $globals = $this->twig->getGlobals();
  84.         try {
  85.             // it could be the case that the Twig environment is already initialized at this point
  86.             // then it's not possible anymore to add globals
  87.             $this->twig->addGlobal('document', $this->documentResolver->getDocument($request));
  88.             $this->twig->addGlobal('editmode', $this->editmodeResolver->isEditmode($request));
  89.             array_push($this->globalsStack, $globals);
  90.         } catch (\Exception $e) {
  91.             array_push($this->globalsStack, false);
  92.         }
  93.     }
  95.     /**
  96.      * @param ResponseEvent $event
  97.      */
  98.     public function onKernelResponse(ResponseEvent $event)
  99.     {
  100.         if (count($this->globalsStack)) {
  101.             $globals = array_pop($this->globalsStack);
  102.             if ($globals !== false) {
  103.                 $this->twig->addGlobal('document', $globals['document'] ?? null);
  104.                 $this->twig->addGlobal('editmode', $globals['editmode'] ?? null);
  105.             }
  106.         }
  107.     }
  108. }