vendor/api-platform/core/src/Symfony/EventListener/RespondListener.php line 51

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Symfony\EventListener;
  16. use ApiPlatform\Api\IriConverterInterface as LegacyIriConverterInterface;
  17. use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
  18. use ApiPlatform\Metadata\IriConverterInterface;
  19. use ApiPlatform\Metadata\Put;
  20. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  21. use ApiPlatform\Metadata\UrlGeneratorInterface;
  22. use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
  23. use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\Event\ViewEvent;
  27. /**
  28.  * Builds the response object.
  29.  *
  30.  * @author Kévin Dunglas <dunglas@gmail.com>
  31.  */
  32. final class RespondListener
  33. {
  34.     use OperationRequestInitiatorTrait;
  36.     public const METHOD_TO_CODE = [
  37.         'POST' => Response::HTTP_CREATED,
  38.         'DELETE' => Response::HTTP_NO_CONTENT,
  39.     ];
  41.     public function __construct(
  42.         ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null,
  43.         private readonly IriConverterInterface|LegacyIriConverterInterface|null $iriConverter = null,
  44.     ) {
  45.         $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  46.     }
  48.     /**
  49.      * Creates a Response to send to the client according to the requested format.
  50.      */
  51.     public function onKernelView(ViewEvent $event): void
  52.     {
  53.         $request = $event->getRequest();
  54.         $controllerResult = $event->getControllerResult();
  55.         $operation = $this->initializeOperation($request);
  57.         if ('api_platform.symfony.main_controller' === $operation?->getController() || $request->attributes->get('_api_platform_disable_listeners')) {
  58.             return;
  59.         }
  61.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  63.         if ($controllerResult instanceof Response && ($attributes['respond'] ?? false)) {
  64.             $event->setResponse($controllerResult);
  66.             return;
  67.         }
  69.         if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond'))) {
  70.             return;
  71.         }
  73.         $headers = [
  74.             'Content-Type' => sprintf('%s; charset=utf-8', $request->getMimeType($request->getRequestFormat())),
  75.             'Vary' => 'Accept',
  76.             'X-Content-Type-Options' => 'nosniff',
  77.             'X-Frame-Options' => 'deny',
  78.         ];
  80.         $status = $operation?->getStatus();
  82.         if ($sunset = $operation?->getSunset()) {
  83.             $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
  84.         }
  86.         if ($acceptPatch = $operation?->getAcceptPatch()) {
  87.             $headers['Accept-Patch'] = $acceptPatch;
  88.         }
  90.         $method = $request->getMethod();
  91.         if (
  92.             $this->iriConverter
  93.             && $operation
  94.             && ($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false)
  95.             && 301 === $operation->getStatus()
  96.         ) {
  97.             $status = 301;
  98.             $headers['Location'] = $this->iriConverter->getIriFromResource($request->attributes->get('data'), UrlGeneratorInterface::ABS_PATH, $operation);
  99.         } elseif ('PUT' === $method && !($attributes['previous_data'] ?? null) && null === $status && ($operation instanceof Put && ($operation->getAllowCreate() ?? false))) {
  100.             $status = Response::HTTP_CREATED;
  101.         }
  103.         $status ??= self::METHOD_TO_CODE[$request->getMethod()] ?? Response::HTTP_OK;
  105.         if ($request->attributes->has('_api_write_item_iri')) {
  106.             $headers['Content-Location'] = $request->attributes->get('_api_write_item_iri');
  108.             if ((Response::HTTP_CREATED === $status || (300 <= $status && $status < 400)) && 'POST' === $method) {
  109.                 $headers['Location'] = $request->attributes->get('_api_write_item_iri');
  110.             }
  111.         }
  113.         if (($exception = $request->attributes->get('data')) instanceof HttpExceptionInterface) {
  114.             $headers = array_merge($headers, $exception->getHeaders());
  115.         }
  117.         $event->setResponse(new Response(
  118.             $controllerResult,
  119.             $status,
  120.             $headers
  121.         ));
  122.     }
  123. }