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

Open in your IDE?
  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 Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  15. use Sensio\Bundle\FrameworkExtraBundle\Templating\TemplateGuesser;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\HttpFoundation\StreamedResponse;
  20. use Symfony\Component\HttpKernel\Event\KernelEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  22. use Twig\Environment;
  24. /**
  25.  * Handles the Template annotation for actions.
  26.  *
  27.  * Depends on pre-processing of the ControllerListener.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  */
  31. class TemplateListener implements EventSubscriberInterface
  32. {
  33.     private $templateGuesser;
  34.     private $twig;
  36.     public function __construct(TemplateGuesser $templateGuesser, Environment $twig = null)
  37.     {
  38.         $this->templateGuesser = $templateGuesser;
  39.         $this->twig = $twig;
  40.     }
  42.     /**
  43.      * Guesses the template name to render and its variables and adds them to
  44.      * the request object.
  45.      */
  46.     public function onKernelController(KernelEvent $event)
  47.     {
  48.         $request = $event->getRequest();
  49.         $template = $request->attributes->get('_template');
  51.         if (!$template instanceof Template) {
  52.             return;
  53.         }
  55.         $controller = $event->getController();
  56.         if (!\is_array($controller) && method_exists($controller, '__invoke')) {
  57.             $controller = [$controller, '__invoke'];
  58.         }
  59.         $template->setOwner($controller);
  61.         // when no template has been given, try to resolve it based on the controller
  62.         if (null === $template->getTemplate()) {
  63.             $template->setTemplate($this->templateGuesser->guessTemplateName($controller, $request));
  64.         }
  65.     }
  67.     /**
  68.      * Renders the template and initializes a new response object with the
  69.      * rendered template content.
  70.      */
  71.     public function onKernelView(KernelEvent $event)
  72.     {
  73.         /* @var Template $template */
  74.         $request = $event->getRequest();
  75.         $template = $request->attributes->get('_template');
  77.         if (!$template instanceof Template) {
  78.             return;
  79.         }
  81.         if (null === $this->twig) {
  82.             throw new \LogicException('You can not use the "@Template" annotation if the Twig Bundle is not available.');
  83.         }
  85.         $parameters = $event->getControllerResult();
  86.         $owner = $template->getOwner();
  87.         list($controller, $action) = $owner;
  89.         // when the annotation declares no default vars and the action returns
  90.         // null, all action method arguments are used as default vars
  91.         if (null === $parameters) {
  92.             $parameters = $this->resolveDefaultParameters($request, $template, $controller, $action);
  93.         }
  95.         // attempt to render the actual response
  96.         if ($template->isStreamable()) {
  97.             $callback = function () use ($template, $parameters) {
  98.                 $this->twig->display($template->getTemplate(), $parameters);
  99.             };
  101.             $event->setResponse(new StreamedResponse($callback));
  102.         } else {
  103.             $event->setResponse(new Response($this->twig->render($template->getTemplate(), $parameters)));
  104.         }
  106.         // make sure the owner (controller+dependencies) is not cached or stored elsewhere
  107.         $template->setOwner([]);
  108.     }
  110.     /**
  111.      * {@inheritdoc}
  112.      */
  113.     public static function getSubscribedEvents()
  114.     {
  115.         return [
  116.             KernelEvents::CONTROLLER => ['onKernelController', -128],
  117.             KernelEvents::VIEW => 'onKernelView',
  118.         ];
  119.     }
  121.     private function resolveDefaultParameters(Request $request, Template $template, $controller, $action)
  122.     {
  123.         $parameters = [];
  124.         $arguments = $template->getVars();
  126.         if (0 === \count($arguments)) {
  127.             $r = new \ReflectionObject($controller);
  129.             $arguments = [];
  130.             foreach ($r->getMethod($action)->getParameters() as $param) {
  131.                 $arguments[] = $param;
  132.             }
  133.         }
  135.         // fetch the arguments of @Template.vars or everything if desired
  136.         // and assign them to the designated template
  137.         foreach ($arguments as $argument) {
  138.             if ($argument instanceof \ReflectionParameter) {
  139.                 $parameters[$name = $argument->getName()] = !$request->attributes->has($name) && $argument->isDefaultValueAvailable() ? $argument->getDefaultValue() : $request->attributes->get($name);
  140.             } else {
  141.                 $parameters[$argument] = $request->attributes->get($argument);
  142.             }
  143.         }
  145.         return $parameters;
  146.     }
  147. }