vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/Frontend/BlockStateListener.php line 59

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\Document\Editable\Block\BlockStateStack;
  20. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  21. use Psr\Log\LoggerAwareInterface;
  22. use Psr\Log\LoggerAwareTrait;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. use Symfony\Component\HttpKernel\Event\RequestEvent;
  25. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  26. use Symfony\Component\HttpKernel\KernelEvents;
  28. /**
  29.  * Handles block state for sub requests (saves parent state and restores it after request completes)
  30.  *
  31.  * @internal
  32.  */
  33. class BlockStateListener implements EventSubscriberInterface, LoggerAwareInterface
  34. {
  35.     use LoggerAwareTrait;
  36.     use PimcoreContextAwareTrait;
  38.     /**
  39.      * @param BlockStateStack $blockStateStack
  40.      */
  41.     public function __construct(protected BlockStateStack $blockStateStack)
  42.     {
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public static function getSubscribedEvents(): array
  49.     {
  50.         return [
  51.             KernelEvents::REQUEST => 'onKernelRequest',
  52.             KernelEvents::RESPONSE => 'onKernelResponse',
  53.         ];
  54.     }
  56.     /**
  57.      * @param RequestEvent $event
  58.      */
  59.     public function onKernelRequest(RequestEvent $event)
  60.     {
  61.         $request = $event->getRequest();
  63.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  64.             return;
  65.         }
  67.         if ($request->get('disableBlockClearing')) {
  68.             return;
  69.         }
  71.         // main request already has a state on the stack
  72.         if ($event->isMainRequest()) {
  73.             return;
  74.         }
  76.         // this is for $this->action() in templates when they are inside a block element
  77.         // adds a new, empty block state to the stack which is used in the sub-request
  78.         $this->blockStateStack->push();
  79.     }
  81.     /**
  82.      * @param ResponseEvent $event
  83.      */
  84.     public function onKernelResponse(ResponseEvent $event)
  85.     {
  86.         $request = $event->getRequest();
  88.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  89.             return;
  90.         }
  92.         if ($request->get('disableBlockClearing')) {
  93.             return;
  94.         }
  96.         if ($this->blockStateStack->count() > 1) {
  97.             // restore parent block data by removing sub-request block state
  98.             $this->blockStateStack->pop();
  99.         }
  100.     }
  101. }