vendor/friendsofsymfony/rest-bundle/FOS/RestBundle/EventListener/ViewResponseListener.php line 36

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\RestBundle\EventListener;
  14. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  15. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  16. use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
  17. use Sensio\Bundle\FrameworkExtraBundle\EventListener\TemplateListener;
  18. use JMS\Serializer\SerializationContext;
  19. use FOS\RestBundle\View\View;
  20. use FOS\RestBundle\Util\Codes;
  21. use FOS\RestBundle\View\ViewHandlerInterface;
  23. /**
  24.  * The ViewResponseListener class handles the View core event as well as the "@extra:Template" annotation.
  25.  *
  26.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  27.  */
  28. class ViewResponseListener extends TemplateListener
  29. {
  30.     /**
  31.      * Guesses the template name to render and its variables and adds them to
  32.      * the request object.
  33.      *
  34.      * @param FilterControllerEvent $event
  35.      */
  36.     public function onKernelController(FilterControllerEvent $event)
  37.     {
  38.         $request = $event->getRequest();
  40.         if ($configuration = $request->attributes->get('_view')) {
  41.             $request->attributes->set('_template', $configuration);
  42.         }
  44.         parent::onKernelController($event);
  45.     }
  47.     /**
  48.      * Renders the parameters and template and initializes a new response object with the
  49.      * rendered content.
  50.      *
  51.      * @param GetResponseForControllerResultEvent $event
  52.      */
  53.     public function onKernelView(GetResponseForControllerResultEvent $event)
  54.     {
  55.         $request = $event->getRequest();
  56.         /** @var \FOS\RestBundle\Controller\Annotations\View $configuration */
  57.         $configuration = $request->attributes->get('_view');
  59.         $view = $event->getControllerResult();
  60.         $customViewDefined = true;
  61.         if (!$view instanceof View) {
  62.             if (!$configuration && !$this->container->getParameter('fos_rest.view_response_listener.force_view')) {
  63.                 return parent::onKernelView($event);
  64.             }
  66.             $view = new View($view);
  67.             $customViewDefined = false;
  68.         }
  70.         if ($configuration) {
  71.             if ($configuration->getTemplateVar()) {
  72.                 $view->setTemplateVar($configuration->getTemplateVar());
  73.             }
  74.             if ($configuration->getStatusCode() && (null === $view->getStatusCode() || Codes::HTTP_OK === $view->getStatusCode())) {
  75.                 $view->setStatusCode($configuration->getStatusCode());
  76.             }
  77.             if ($configuration->getSerializerGroups() && !$customViewDefined) {
  78.                 $context = $view->getSerializationContext() ?: new SerializationContext();
  79.                 $context->setGroups($configuration->getSerializerGroups());
  80.                 $view->setSerializationContext($context);
  81.             }
  82.             if ($configuration->getSerializerEnableMaxDepthChecks()) {
  83.                 $context = $view->getSerializationContext() ?: new SerializationContext();
  84.                 $context->enableMaxDepthChecks();
  85.                 $view->setSerializationContext($context);
  86.             }
  87.             $populateDefaultVars = $configuration->isPopulateDefaultVars();
  88.         } else {
  89.             $populateDefaultVars = true;
  90.         }
  92.         if (null === $view->getFormat()) {
  93.             $view->setFormat($request->getRequestFormat());
  94.         }
  96.         $vars = $request->attributes->get('_template_vars');
  97.         if (!$vars && $populateDefaultVars) {
  98.             $vars = $request->attributes->get('_template_default_vars');
  99.         }
  101.         /** @var ViewHandlerInterface $viewHandler */
  102.         $viewHandler = $this->container->get('fos_rest.view_handler');
  104.         if ($viewHandler->isFormatTemplating($view->getFormat())) {
  105.             if (!empty($vars)) {
  106.                 $parameters = (array) $viewHandler->prepareTemplateParameters($view);
  108.                 foreach ($vars as $var) {
  109.                     if (!array_key_exists($var, $parameters)) {
  110.                         $parameters[$var] = $request->attributes->get($var);
  111.                     }
  112.                 }
  113.                 $view->setData($parameters);
  114.             }
  116.             $template = $request->attributes->get('_template');
  117.             if ($template && !$view->getTemplate()) {
  118.                 if ($template instanceof TemplateReference) {
  119.                     $template->set('format', null);
  120.                 }
  122.                 $view->setTemplate($template);
  123.             }
  124.         }
  126.         $response = $viewHandler->handle($view, $request);
  128.         $event->setResponse($response);
  129.     }
  130. }