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 Doctrine\Common\Annotations\Reader;
  15. use Doctrine\Persistence\Proxy;
  16. use FOS\RestBundle\Controller\Annotations\View as ViewAnnotation;
  17. use FOS\RestBundle\FOSRestBundle;
  18. use FOS\RestBundle\View\View;
  19. use FOS\RestBundle\View\ViewHandlerInterface;
  20. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  23. use Symfony\Component\HttpKernel\Event\ViewEvent;
  24. use Symfony\Component\HttpKernel\KernelEvents;
  26. /**
  27. * The ViewResponseListener class handles the kernel.view event and creates a {@see Response} for a {@see View} provided by the controller result.
  28. *
  29. * @author Lukas Kahwe Smith <[email protected]>
  30. *
  31. * @internal
  32. */
  33. class ViewResponseListener implements EventSubscriberInterface
  34. {
  35. /**
  36. * @var ViewHandlerInterface
  37. */
  38. private $viewHandler;
  40. private $forceView;
  42. /**
  43. * @var Reader|null
  44. */
  45. private $annotationReader;
  47. public function __construct(ViewHandlerInterface $viewHandler, bool $forceView, ?Reader $annotationReader = null)
  48. {
  49. $this->viewHandler = $viewHandler;
  50. $this->forceView = $forceView;
  51. $this->annotationReader = $annotationReader;
  52. }
  54. /**
  55. * Extracts configuration for a {@see ViewAnnotation} from the controller if present.
  56. */
  57. public function onKernelController(ControllerEvent $event)
  58. {
  59. $request = $event->getRequest();
  61. if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  62. return;
  63. }
  65. $controller = $event->getController();
  67. if (!\is_array($controller) && method_exists($controller, '__invoke')) {
  68. $controller = [$controller, '__invoke'];
  69. }
  71. if (!\is_array($controller)) {
  72. return;
  73. }
  75. $className = $this->getRealClass(\get_class($controller[0]));
  76. $object = new \ReflectionClass($className);
  77. $method = $object->getMethod($controller[1]);
  79. /** @var ViewAnnotation|null $classConfiguration */
  80. $classConfiguration = null;
  82. /** @var ViewAnnotation|null $methodConfiguration */
  83. $methodConfiguration = null;
  85. if (null !== $this->annotationReader) {
  86. $classConfiguration = $this->getViewConfiguration($this->annotationReader->getClassAnnotations($object));
  87. $methodConfiguration = $this->getViewConfiguration($this->annotationReader->getMethodAnnotations($method));
  88. }
  90. if (80000 <= \PHP_VERSION_ID) {
  91. if (null === $classConfiguration) {
  92. $classAttributes = array_map(
  93. function (\ReflectionAttribute $attribute) {
  94. return $attribute->newInstance();
  95. },
  96. $object->getAttributes(ViewAnnotation::class, \ReflectionAttribute::IS_INSTANCEOF)
  97. );
  99. $classConfiguration = $this->getViewConfiguration($classAttributes);
  100. }
  102. if (null === $methodConfiguration) {
  103. $methodAttributes = array_map(
  104. function (\ReflectionAttribute $attribute) {
  105. return $attribute->newInstance();
  106. },
  107. $method->getAttributes(ViewAnnotation::class, \ReflectionAttribute::IS_INSTANCEOF)
  108. );
  110. $methodConfiguration = $this->getViewConfiguration($methodAttributes);
  111. }
  112. }
  114. // An annotation/attribute on the method takes precedence over the class level
  115. if (null !== $methodConfiguration) {
  116. $request->attributes->set(FOSRestBundle::VIEW_ATTRIBUTE, $methodConfiguration);
  117. } elseif (null !== $classConfiguration) {
  118. $request->attributes->set(FOSRestBundle::VIEW_ATTRIBUTE, $classConfiguration);
  119. }
  120. }
  122. public function onKernelView(ViewEvent $event): void
  123. {
  124. $request = $event->getRequest();
  126. if (!$request->attributes->get(FOSRestBundle::ZONE_ATTRIBUTE, true)) {
  127. return;
  128. }
  130. /** @var ViewAnnotation|null $configuration */
  131. $configuration = $request->attributes->get(FOSRestBundle::VIEW_ATTRIBUTE);
  133. $view = $event->getControllerResult();
  134. if (!$view instanceof View) {
  135. if (!$configuration instanceof ViewAnnotation && !$this->forceView) {
  136. return;
  137. }
  139. $view = new View($view);
  140. }
  142. if ($configuration instanceof ViewAnnotation) {
  143. if (null !== $configuration->getStatusCode() && (null === $view->getStatusCode() || Response::HTTP_OK === $view->getStatusCode())) {
  144. $view->setStatusCode($configuration->getStatusCode());
  145. }
  147. $context = $view->getContext();
  148. if ($configuration->getSerializerGroups()) {
  149. if (null === $context->getGroups()) {
  150. $context->setGroups($configuration->getSerializerGroups());
  151. } else {
  152. $context->setGroups(array_merge($context->getGroups(), $configuration->getSerializerGroups()));
  153. }
  154. }
  155. if (true === $configuration->getSerializerEnableMaxDepthChecks()) {
  156. $context->enableMaxDepth();
  157. } elseif (false === $configuration->getSerializerEnableMaxDepthChecks()) {
  158. $context->disableMaxDepth();
  159. }
  160. }
  162. if (null === $view->getFormat()) {
  163. $view->setFormat($request->getRequestFormat());
  164. }
  166. $event->setResponse($this->viewHandler->handle($view, $request));
  167. }
  169. public static function getSubscribedEvents(): array
  170. {
  171. return [
  172. KernelEvents::CONTROLLER => 'onKernelController',
  173. KernelEvents::VIEW => ['onKernelView', 30],
  174. ];
  175. }
  177. /**
  178. * @param object[] $annotations
  179. */
  180. private function getViewConfiguration(array $annotations): ?ViewAnnotation
  181. {
  182. $viewAnnotation = null;
  184. foreach ($annotations as $annotation) {
  185. if (!$annotation instanceof ViewAnnotation) {
  186. continue;
  187. }
  189. if (null === $viewAnnotation) {
  190. $viewAnnotation = $annotation;
  191. } else {
  192. throw new \LogicException('Multiple "view" annotations are not allowed.');
  193. }
  194. }
  196. return $viewAnnotation;
  197. }
  199. private function getRealClass(string $class): string
  200. {
  201. if (class_exists(Proxy::class)) {
  202. if (false === $pos = strrpos($class, '\\'.Proxy::MARKER.'\\')) {
  203. return $class;
  204. }
  206. return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
  207. }
  209. return $class;
  210. }
  211. }