pimcore/lib/Pimcore/Bundle/CoreBundle/EventListener/TemplateControllerListener.php line 64

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;
  17. use Pimcore\Controller\TemplateControllerInterface;
  18. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  19. use Symfony\Component\DependencyInjection\ContainerInterface;
  20. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  22. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  23. use Symfony\Component\HttpKernel\KernelEvents;
  25. /**
  26.  * Handles the attributes set by TemplateControllerInterface and injects them into the Template annotation which is
  27.  * then processed by SensioFrameworkExtraBundle. This allows us to add view auto-rendering without depending on annotations.
  28.  */
  29. class TemplateControllerListener implements EventSubscriberInterface
  30. {
  31.     /**
  32.      * @var ContainerInterface
  33.      */
  34.     protected $container;
  36.     /**
  37.      * @var string
  38.      */
  39.     protected $defaultEngine;
  41.     /**
  42.      * @param ContainerInterface $container
  43.      * @param string $defaultEngine
  44.      */
  45.     public function __construct(ContainerInterface $container, $defaultEngine = 'twig')
  46.     {
  47.         $this->container     = $container;
  48.         $this->defaultEngine = $defaultEngine;
  49.     }
  51.     /**
  52.      * @inheritDoc
  53.      */
  54.     public static function getSubscribedEvents()
  55.     {
  56.         // the view event needs to run before the SensioFrameworkExtraBundle TemplateListener
  57.         // handles the Template annotation
  58.         return [
  59.             KernelEvents::CONTROLLER => 'onKernelController',
  60.             KernelEvents::VIEW       => ['onKernelView', 32]
  61.         ];
  62.     }
  64.     public function onKernelController(FilterControllerEvent $event)
  65.     {
  66.         $request  = $event->getRequest();
  67.         $callable = $event->getController();
  69.         // if controller implements TemplateControllerInterface, register it as attribute as we need it later in onKernelView
  70.         $templateController = false;
  71.         if (is_object($callable) && $callable instanceof TemplateControllerInterface) {
  72.             $templateController = true;
  73.         } elseif (is_array($callable) && is_object($callable[0]) && $callable[0] instanceof TemplateControllerInterface) {
  74.             $templateController = true;
  75.         }
  77.         if ($templateController) {
  78.             $request->attributes->set(TemplateControllerInterface::ATTRIBUTE_TEMPLATE_CONTROLLER, $callable);
  79.         }
  80.     }
  82.     public function onKernelView(GetResponseForControllerResultEvent $event)
  83.     {
  84.         $request = $event->getRequest();
  86.         // don't do anything if there's already a Template annotation in place
  87.         if ($request->attributes->has('_template')) {
  88.             return;
  89.         }
  91.         if (!$request->attributes->has(TemplateControllerInterface::ATTRIBUTE_TEMPLATE_CONTROLLER)) {
  92.             return;
  93.         }
  95.         if ($request->attributes->has(TemplateControllerInterface::ATTRIBUTE_AUTO_RENDER)) {
  96.             $controller = $request->attributes->get(TemplateControllerInterface::ATTRIBUTE_TEMPLATE_CONTROLLER);
  98.             $engine = $this->defaultEngine;
  99.             if ($request->attributes->has(TemplateControllerInterface::ATTRIBUTE_AUTO_RENDER_ENGINE)) {
  100.                 $engine = $request->attributes->get(TemplateControllerInterface::ATTRIBUTE_AUTO_RENDER_ENGINE);
  101.             }
  103.             $guesser = $this->container->get('sensio_framework_extra.view.guesser');
  105.             $template = new Template([]);
  106.             $template->setOwner($controller);
  107.             $template->setEngine($engine);
  108.             $templateReference = $guesser->guessTemplateName($controller, $request, $engine);
  110.             if ($templateReference->get('bundle') == 'AppBundle') {
  111.                 $templateReference->set('bundle', '');
  112.             }
  114.             $template->setTemplate($templateReference);
  116.             // inject Template annotation into the request - will be used by SensioFrameworkExtraBundle
  117.             $request->attributes->set('_template', $template);
  118.         }
  119.     }
  120. }