vendor/sensio/framework-extra-bundle/src/EventListener/TemplateListener.php line 79

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Psr\Container\ContainerInterface;
  15. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  16. use Sensio\Bundle\FrameworkExtraBundle\Templating\TemplateGuesser;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpFoundation\StreamedResponse;
  21. use Symfony\Component\HttpKernel\Event\KernelEvent;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  24. use Twig\Environment;
  26. /**
  27.  * Handles the Template annotation for actions.
  28.  *
  29.  * Depends on pre-processing of the ControllerListener.
  30.  *
  31.  * @author Fabien Potencier <fabien@symfony.com>
  32.  */
  33. class TemplateListener implements EventSubscriberInterface, ServiceSubscriberInterface
  34. {
  35.     private $templateGuesser;
  36.     private $twig;
  37.     private $container;
  39.     public function __construct(TemplateGuesser $templateGuesser, Environment $twig = null)
  40.     {
  41.         $this->templateGuesser = $templateGuesser;
  42.         $this->twig = $twig;
  43.     }
  45.     public function setContainer(ContainerInterface $container): void
  46.     {
  47.         $this->container = $container;
  48.     }
  50.     /**
  51.      * Guesses the template name to render and its variables and adds them to
  52.      * the request object.
  53.      */
  54.     public function onKernelController(KernelEvent $event)
  55.     {
  56.         $request = $event->getRequest();
  57.         $template = $request->attributes->get('_template');
  59.         if (!$template instanceof Template) {
  60.             return;
  61.         }
  63.         $controller = $event->getController();
  64.         if (!\is_array($controller) && method_exists($controller, '__invoke')) {
  65.             $controller = [$controller, '__invoke'];
  66.         }
  67.         $template->setOwner($controller);
  69.         // when no template has been given, try to resolve it based on the controller
  70.         if (null === $template->getTemplate()) {
  71.             $template->setTemplate($this->templateGuesser->guessTemplateName($controller, $request));
  72.         }
  73.     }
  75.     /**
  76.      * Renders the template and initializes a new response object with the
  77.      * rendered template content.
  78.      */
  79.     public function onKernelView(KernelEvent $event)
  80.     {
  81.         /* @var Template $template */
  82.         $request = $event->getRequest();
  83.         $template = $request->attributes->get('_template');
  85.         if (!$template instanceof Template) {
  86.             return;
  87.         }
  89.         if (null === $this->twig) {
  90.             if (!$this->container || !$this->container->has('twig')) {
  91.                 throw new \LogicException('You can not use the "@Template" annotation if the Twig Bundle is not available.');
  92.             }
  94.             $this->twig = $this->container->get('twig');
  95.         }
  97.         $parameters = $event->getControllerResult();
  98.         $owner = $template->getOwner();
  99.         list($controller, $action) = $owner;
  101.         // when the annotation declares no default vars and the action returns
  102.         // null, all action method arguments are used as default vars
  103.         if (null === $parameters) {
  104.             $parameters = $this->resolveDefaultParameters($request, $template, $controller, $action);
  105.         }
  107.         // attempt to render the actual response
  108.         if ($template->isStreamable()) {
  109.             $callback = function () use ($template, $parameters) {
  110.                 $this->twig->display($template->getTemplate(), $parameters);
  111.             };
  113.             $event->setResponse(new StreamedResponse($callback));
  114.         } else {
  115.             $event->setResponse(new Response($this->twig->render($template->getTemplate(), $parameters)));
  116.         }
  118.         // make sure the owner (controller+dependencies) is not cached or stored elsewhere
  119.         $template->setOwner([]);
  120.     }
  122.     /**
  123.      * @return array
  124.      */
  125.     public static function getSubscribedEvents()
  126.     {
  127.         return [
  128.             KernelEvents::CONTROLLER => ['onKernelController', -128],
  129.             KernelEvents::VIEW => 'onKernelView',
  130.         ];
  131.     }
  133.     public static function getSubscribedServices(): array
  134.     {
  135.         return ['twig' => '?'.Environment::class];
  136.     }
  138.     private function resolveDefaultParameters(Request $request, Template $template, $controller, $action)
  139.     {
  140.         $parameters = [];
  141.         $arguments = $template->getVars();
  143.         if (0 === \count($arguments)) {
  144.             $r = new \ReflectionObject($controller);
  146.             $arguments = [];
  147.             foreach ($r->getMethod($action)->getParameters() as $param) {
  148.                 $arguments[] = $param;
  149.             }
  150.         }
  152.         // fetch the arguments of @Template.vars or everything if desired
  153.         // and assign them to the designated template
  154.         foreach ($arguments as $argument) {
  155.             if ($argument instanceof \ReflectionParameter) {
  156.                 $parameters[$name = $argument->getName()] = !$request->attributes->has($name) && $argument->isDefaultValueAvailable() ? $argument->getDefaultValue() : $request->attributes->get($name);
  157.             } else {
  158.                 $parameters[$argument] = $request->attributes->get($argument);
  159.             }
  160.         }
  162.         return $parameters;
  163.     }
  164. }