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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony framework.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Symfony\Component\DependencyInjection\ContainerInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  17. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpFoundation\StreamedResponse;
  21. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  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.     /**
  33.      * @var ContainerInterface
  34.      */
  35.     protected $container;
  37.     /**
  38.      * Constructor.
  39.      *
  40.      * @param ContainerInterface $container The service container instance
  41.      */
  42.     public function __construct(ContainerInterface $container)
  43.     {
  44.         $this->container = $container;
  45.     }
  47.     /**
  48.      * Guesses the template name to render and its variables and adds them to
  49.      * the request object.
  50.      *
  51.      * @param FilterControllerEvent $event A FilterControllerEvent instance
  52.      */
  53.     public function onKernelController(FilterControllerEvent $event)
  54.     {
  55.         $request = $event->getRequest();
  56.         $template = $request->attributes->get('_template');
  58.         if (!$template instanceof Template) {
  59.             return;
  60.         }
  62.         $template->setOwner($controller = $event->getController());
  64.         // when no template has been given, try to resolve it based on the controller
  65.         if (null === $template->getTemplate()) {
  66.             $guesser = $this->container->get('sensio_framework_extra.view.guesser');
  67.             $template->setTemplate($guesser->guessTemplateName($controller, $request, $template->getEngine()));
  68.         }
  69.     }
  71.     /**
  72.      * Renders the template and initializes a new response object with the
  73.      * rendered template content.
  74.      *
  75.      * @param GetResponseForControllerResultEvent $event
  76.      */
  77.     public function onKernelView(GetResponseForControllerResultEvent $event)
  78.     {
  79.         /* @var Template $template */
  80.         $request = $event->getRequest();
  81.         $template = $request->attributes->get('_template');
  83.         if (!$template instanceof Template) {
  84.             return;
  85.         }
  87.         $parameters = $event->getControllerResult();
  88.         $owner = $template->getOwner();
  89.         list($controller, $action) = $owner;
  91.         // when the annotation declares no default vars and the action returns
  92.         // null, all action method arguments are used as default vars
  93.         if (null === $parameters) {
  94.             $parameters = $this->resolveDefaultParameters($request, $template, $controller, $action);
  95.         }
  97.         // attempt to render the actual response
  98.         $templating = $this->container->get('templating');
  100.         if ($template->isStreamable()) {
  101.             $callback = function () use ($templating, $template, $parameters) {
  102.                 return $templating->stream($template->getTemplate(), $parameters);
  103.             };
  105.             $event->setResponse(new StreamedResponse($callback));
  106.         } else {
  107.             $event->setResponse($templating->renderResponse($template->getTemplate(), $parameters));
  108.         }
  110.         // make sure the owner (controller+dependencies) is not cached or stored elsewhere
  111.         $template->setOwner(array());
  112.     }
  114.     public static function getSubscribedEvents()
  115.     {
  116.         return array(
  117.             KernelEvents::CONTROLLER => array('onKernelController', -128),
  118.             KernelEvents::VIEW => 'onKernelView',
  119.         );
  120.     }
  122.     /**
  123.      * @param Request  $request
  124.      * @param Template $template
  125.      * @param object   $controller
  126.      * @param string   $action
  127.      *
  128.      * @return array
  129.      */
  130.     private function resolveDefaultParameters(Request $request, Template $template, $controller, $action)
  131.     {
  132.         $parameters = array();
  133.         $arguments = $template->getVars();
  135.         if (0 === count($arguments)) {
  136.             $r = new \ReflectionObject($controller);
  138.             $arguments = array();
  139.             foreach ($r->getMethod($action)->getParameters() as $param) {
  140.                 $arguments[] = $param;
  141.             }
  142.         }
  144.         // fetch the arguments of @Template.vars or everything if desired
  145.         // and assign them to the designated template
  146.         foreach ($arguments as $argument) {
  147.             if ($argument instanceof \ReflectionParameter) {
  148.                 $parameters[$name = $argument->getName()] = !$request->attributes->has($name) && $argument->isDefaultValueAvailable() ? $argument->getDefaultValue() : $request->attributes->get($name);
  149.             } else {
  150.                 $parameters[$argument] = $request->attributes->get($argument);
  151.             }
  152.         }
  154.         return $parameters;
  155.     }
  156. }