vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/LegacyTemplateListener.php line 83

Open in your IDE?
  1. <?php
  3. namespace Pimcore\Bundle\CoreBundle\EventListener;
  5. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  6. use Sensio\Bundle\FrameworkExtraBundle\EventListener\TemplateListener;
  7. use Symfony\Component\HttpFoundation\Request;
  8. use Symfony\Component\HttpFoundation\StreamedResponse;
  9. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  10. use Symfony\Component\HttpKernel\Event\KernelEvent;
  11. use Symfony\Component\HttpKernel\KernelEvents;
  12. use Symfony\Component\Templating\EngineInterface;
  14. /**
  15.  * @deprecated
  16.  * Provides backward compatibility for PHP templates
  17.  */
  18. class LegacyTemplateListener extends TemplateListener
  19. {
  20.     /**
  21.      * @var EngineInterface
  22.      */
  23.     private $templateEngine;
  25.     /**
  26.      * @return EngineInterface
  27.      */
  28.     public function getTemplateEngine(): EngineInterface
  29.     {
  30.         return $this->templateEngine;
  31.     }
  33.     /**
  34.      * @param EngineInterface $templateEngine
  35.      */
  36.     public function setTemplateEngine(EngineInterface $templateEngine): void
  37.     {
  38.         $this->templateEngine = $templateEngine;
  39.     }
  41.     /**
  42.      * @inheritdoc
  43.      */
  44.     public function onKernelView(KernelEvent $event)
  45.     {
  47.         /* @var Template $template */
  48.         $request = $event->getRequest();
  49.         $template = $request->attributes->get('_template');
  51.         if (!$template instanceof Template) {
  52.             return;
  53.         }
  55.         if (!$event instanceof GetResponseForControllerResultEvent) {
  56.             return;
  57.         }
  59.         $parameters = $event->getControllerResult();
  60.         $owner = $template->getOwner();
  61.         list($controller, $action) = $owner;
  63.         // when the annotation declares no default vars and the action returns
  64.         // null, all action method arguments are used as default vars
  65.         if (null === $parameters) {
  66.             $parameters = $this->resolveDefaultParameters($request, $template, $controller, $action);
  67.         }
  69.         // attempt to render the actual response
  70.         $templating = $this->getTemplateEngine();
  72.         if ($template->isStreamable()) {
  73.             $callback = function () use ($templating, $template, $parameters) {
  74.                 return $templating->stream($template->getTemplate(), $parameters);
  75.             };
  77.             $event->setResponse(new StreamedResponse($callback));
  78.         }
  80.         // make sure the owner (controller+dependencies) is not cached or stored elsewhere
  81.         $template->setOwner([]);
  83.         $event->setResponse($templating->renderResponse($template->getTemplate(), $parameters));
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      */
  89.     public static function getSubscribedEvents()
  90.     {
  91.         return [
  92.             KernelEvents::CONTROLLER => ['onKernelController', -128],
  93.             KernelEvents::VIEW => 'onKernelView',
  94.         ];
  95.     }
  97.     private function resolveDefaultParameters(Request $request, Template $template, $controller, $action)
  98.     {
  99.         $parameters = [];
  100.         $arguments = $template->getVars();
  102.         if (0 === \count($arguments)) {
  103.             $r = new \ReflectionObject($controller);
  105.             $arguments = [];
  106.             foreach ($r->getMethod($action)->getParameters() as $param) {
  107.                 $arguments[] = $param;
  108.             }
  109.         }
  111.         // fetch the arguments of @Template.vars or everything if desired
  112.         // and assign them to the designated template
  113.         foreach ($arguments as $argument) {
  114.             if ($argument instanceof \ReflectionParameter) {
  115.                 $parameters[$name = $argument->getName()] = !$request->attributes->has($name) && $argument->isDefaultValueAvailable() ? $argument->getDefaultValue() : $request->attributes->get($name);
  116.             } else {
  117.                 $parameters[$argument] = $request->attributes->get($argument);
  118.             }
  119.         }
  121.         return $parameters;
  122.     }
  123. }