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

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