vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/Frontend/ContentTemplateListener.php line 65

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\Http\Request\Resolver\PimcoreContextResolver;
  19. use Pimcore\Http\Request\Resolver\TemplateResolver;
  20. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  21. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  22. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  23. use Symfony\Component\HttpKernel\KernelEvents;
  25. /**
  26.  * If a contentTemplate attribute was set on the request (done by router when building a document route), extract the
  27.  * value and set it on the Template annotation. This handles custom template files being configured on documents.
  28.  */
  29. class ContentTemplateListener implements EventSubscriberInterface
  30. {
  31.     use PimcoreContextAwareTrait;
  33.     /**
  34.      * @var TemplateResolver
  35.      */
  36.     protected $templateResolver;
  38.     /**
  39.      * @param TemplateResolver $templateResolver
  40.      */
  41.     public function __construct(TemplateResolver $templateResolver)
  42.     {
  43.         $this->templateResolver = $templateResolver;
  44.     }
  46.     /**
  47.      * @inheritDoc
  48.      */
  49.     public static function getSubscribedEvents()
  50.     {
  51.         return [
  52.             // this must run after the TemplateControllerListener set a potential template and before the TemplateListener
  53.             // renders the view
  54.             KernelEvents::VIEW => ['onKernelView', 16]
  55.         ];
  56.     }
  58.     /**
  59.      * If there's a contentTemplate attribute set on the request, it was read from the document template setting from
  60.      * the router or from the sub-action renderer and takes precedence over the auto-resolved and manually configured
  61.      * template.
  62.      *
  63.      * @param GetResponseForControllerResultEvent $event
  64.      */
  65.     public function onKernelView(GetResponseForControllerResultEvent $event)
  66.     {
  67.         $request = $event->getRequest();
  69.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  70.             return;
  71.         }
  73.         $template = $request->attributes->get('_template');
  75.         // no @Template present -> nothing to do
  76.         if (null === $template || !($template instanceof Template)) {
  77.             return;
  78.         }
  80.         $resolvedTemplate = $this->templateResolver->getTemplate($request);
  81.         if (null === $resolvedTemplate) {
  82.             // no contentTemplate on the request -> nothing to do
  83.             return;
  84.         }
  86.         $template->setTemplate($resolvedTemplate);
  87.     }
  88. }