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

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