pimcore/lib/Pimcore/Bundle/CoreBundle/EventListener/Frontend/BlockStateListener.php line 62

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Bundle\CoreBundle\EventListener\Frontend;
  17. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  18. use Pimcore\Document\Tag\Block\BlockStateStack;
  19. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  20. use Psr\Log\LoggerAwareInterface;
  21. use Psr\Log\LoggerAwareTrait;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  23. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  24. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  25. use Symfony\Component\HttpKernel\KernelEvents;
  27. /**
  28.  * Handles block state for sub requests (saves parent state and restores it after request completes)
  29.  */
  30. class BlockStateListener implements EventSubscriberInterface, LoggerAwareInterface
  31. {
  32.     use LoggerAwareTrait;
  33.     use PimcoreContextAwareTrait;
  35.     /**
  36.      * @var BlockStateStack
  37.      */
  38.     protected $blockStateStack;
  40.     /**
  41.      * @param \Pimcore\Document\Tag\Block\BlockStateStack $blockStateStack
  42.      */
  43.     public function __construct(BlockStateStack $blockStateStack)
  44.     {
  45.         $this->blockStateStack = $blockStateStack;
  46.     }
  48.     /**
  49.      * @inheritDoc
  50.      */
  51.     public static function getSubscribedEvents()
  52.     {
  53.         return [
  54.             KernelEvents::REQUEST  => 'onKernelRequest',
  55.             KernelEvents::RESPONSE => 'onKernelResponse'
  56.         ];
  57.     }
  59.     /**
  60.      * @param GetResponseEvent $event
  61.      */
  62.     public function onKernelRequest(GetResponseEvent $event)
  63.     {
  64.         $request = $event->getRequest();
  66.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  67.             return;
  68.         }
  70.         if ($request->get('disableBlockClearing')) {
  71.             return;
  72.         }
  74.         // master request already has a state on the stack
  75.         if ($event->isMasterRequest()) {
  76.             return;
  77.         }
  79.         // this is for $this->action() in templates when they are inside a block element
  80.         // adds a new, empty block state to the stack which is used in the sub-request
  81.         $this->blockStateStack->push();
  82.     }
  84.     /**
  85.      * @param FilterResponseEvent $event
  86.      */
  87.     public function onKernelResponse(FilterResponseEvent $event)
  88.     {
  89.         $request = $event->getRequest();
  91.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  92.             return;
  93.         }
  95.         if ($request->get('disableBlockClearing')) {
  96.             return;
  97.         }
  99.         if ($this->blockStateStack->count() > 1) {
  100.             // restore parent block data by removing sub-request block state
  101.             $this->blockStateStack->pop();
  102.         }
  103.     }
  104. }