vendor/friendsofsymfony/rest-bundle/EventListener/ViewResponseListener.php line 41

  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 FOS\RestBundle\Controller\Annotations\View as ViewAnnotation;
  15. use FOS\RestBundle\FOSRestBundle;
  16. use FOS\RestBundle\View\View;
  17. use FOS\RestBundle\View\ViewHandlerInterface;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpKernel\Event\ViewEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  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.  * @internal
  29.  */
  30. class ViewResponseListener implements EventSubscriberInterface
  31. {
  32.     private $viewHandler;
  33.     private $forceView;
  35.     public function __construct(ViewHandlerInterface $viewHandler, bool $forceView)
  36.     {
  37.         $this->viewHandler = $viewHandler;
  38.         $this->forceView = $forceView;
  39.     }
  41.     public function onKernelView(ViewEvent $event): void
  42.     {
  43.         $request = $event->getRequest();
  45.         if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  46.             return;
  47.         }
  49.         $configuration = $request->attributes->get('_template');
  51.         $view = $event->getControllerResult();
  52.         if (!$view instanceof View) {
  53.             if (!$configuration instanceof ViewAnnotation && !$this->forceView) {
  54.                 return;
  55.             }
  57.             $view = new View($view);
  58.         }
  60.         if ($configuration instanceof ViewAnnotation) {
  61.             if (null !== $configuration->getStatusCode() && (null === $view->getStatusCode() || Response::HTTP_OK === $view->getStatusCode())) {
  62.                 $view->setStatusCode($configuration->getStatusCode());
  63.             }
  65.             $context = $view->getContext();
  66.             if ($configuration->getSerializerGroups()) {
  67.                 if (null === $context->getGroups()) {
  68.                     $context->setGroups($configuration->getSerializerGroups());
  69.                 } else {
  70.                     $context->setGroups(array_merge($context->getGroups(), $configuration->getSerializerGroups()));
  71.                 }
  72.             }
  73.             if (true === $configuration->getSerializerEnableMaxDepthChecks()) {
  74.                 $context->enableMaxDepth();
  75.             } elseif (false === $configuration->getSerializerEnableMaxDepthChecks()) {
  76.                 $context->disableMaxDepth();
  77.             }
  78.         }
  80.         if (null === $view->getFormat()) {
  81.             $view->setFormat($request->getRequestFormat());
  82.         }
  84.         $response = $this->viewHandler->handle($view, $request);
  86.         $event->setResponse($response);
  87.     }
  89.     public static function getSubscribedEvents(): array
  90.     {
  91.         // Must be executed before SensioFrameworkExtraBundle's listener
  92.         return [
  93.             KernelEvents::VIEW => ['onKernelView', 30],
  94.         ];
  95.     }
  96. }