vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/ControllerViewModelListener.php line 57

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\Http\Request\Resolver\ViewModelResolver;
  18. use Pimcore\Templating\Model\ViewModelInterface;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  23. class ControllerViewModelListener implements EventSubscriberInterface
  24. {
  25.     /**
  26.      * @var ViewModelResolver
  27.      */
  28.     protected $viewModelResolver;
  30.     /**
  31.      * @param ViewModelResolver $viewModelResolver
  32.      */
  33.     public function __construct(ViewModelResolver $viewModelResolver)
  34.     {
  35.         $this->viewModelResolver = $viewModelResolver;
  36.     }
  38.     /**
  39.      * @inheritDoc
  40.      */
  41.     public static function getSubscribedEvents()
  42.     {
  43.         return [
  44.             // set a higher priority to make this run before the @Template annotation
  45.             // handler kicks in (SensioFrameworkExtraBundle) to make sure the ViewModel
  46.             // is processed before template is rendered
  47.             KernelEvents::VIEW => ['onKernelView', 10]
  48.         ];
  49.     }
  51.     /**
  52.      * When action uses the Template annotation, add ViewModel variables to the controller result
  53.      * before proceeding to render the template.
  54.      *
  55.      * @param GetResponseForControllerResultEvent $event
  56.      */
  57.     public function onKernelView(GetResponseForControllerResultEvent $event)
  58.     {
  59.         $request = $event->getRequest();
  61.         // only alter requests with a @Template annotation
  62.         $template = $request->attributes->get('_template');
  63.         if (null === $template) {
  64.             return;
  65.         }
  67.         $result = $event->getControllerResult();
  69.         // controller returned a ViewModel instance -> transform the model to array and return
  70.         if ($result instanceof ViewModelInterface) {
  71.             $event->setControllerResult($result->getParameters()->all());
  73.             return;
  74.         }
  76.         // view model is empty -> nothing to do
  77.         $view = $this->viewModelResolver->getViewModel($event->getRequest());
  78.         if (null === $view || $view->count() === 0) {
  79.             return;
  80.         }
  82.         if (null === $result) {
  83.             // empty result -> add view model params
  84.             $event->setControllerResult($view->getParameters()->all());
  85.         } else {
  86.             // add missing view model params to result
  87.             if (is_array($result)) {
  88.                 $result = array_replace($view->getParameters()->all(), $result);
  90.                 $event->setControllerResult($result);
  91.             }
  92.         }
  93.     }
  94. }