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

  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;
  17. use ApiPlatform\Api\UrlGeneratorInterface;
  18. use ApiPlatform\Metadata\HttpOperation;
  19. use ApiPlatform\Metadata\Put;
  20. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  21. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  22. use ApiPlatform\Util\RequestAttributesExtractor;
  23. use Symfony\Component\HttpFoundation\Response;
  24. use Symfony\Component\HttpKernel\Event\ViewEvent;
  26. /**
  27.  * Builds the response object.
  28.  *
  29.  * @author Kévin Dunglas <dunglas@gmail.com>
  30.  */
  31. final class RespondListener
  32. {
  33.     use OperationRequestInitiatorTrait;
  35.     public const METHOD_TO_CODE = [
  36.         'POST' => Response::HTTP_CREATED,
  37.         'DELETE' => Response::HTTP_NO_CONTENT,
  38.     ];
  40.     public function __construct(
  41.         ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null,
  42.         private readonly ?IriConverterInterface $iriConverter = null,
  43.     ) {
  44.         $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  45.     }
  47.     /**
  48.      * Creates a Response to send to the client according to the requested format.
  49.      */
  50.     public function onKernelView(ViewEvent $event): void
  51.     {
  52.         $controllerResult = $event->getControllerResult();
  53.         $request = $event->getRequest();
  54.         $operation = $this->initializeOperation($request);
  56.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  58.         if ($controllerResult instanceof Response && ($attributes['respond'] ?? false)) {
  59.             $event->setResponse($controllerResult);
  61.             return;
  62.         }
  64.         if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond'))) {
  65.             return;
  66.         }
  68.         $headers = [
  69.             'Content-Type' => sprintf('%s; charset=utf-8', $request->getMimeType($request->getRequestFormat())),
  70.             'Vary' => 'Accept',
  71.             'X-Content-Type-Options' => 'nosniff',
  72.             'X-Frame-Options' => 'deny',
  73.         ];
  75.         $status = $operation?->getStatus();
  77.         if ($sunset = $operation?->getSunset()) {
  78.             $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
  79.         }
  81.         if ($acceptPatch = $operation?->getAcceptPatch()) {
  82.             $headers['Accept-Patch'] = $acceptPatch;
  83.         }
  85.         $method = $request->getMethod();
  86.         if (
  87.             $this->iriConverter &&
  88.             $operation &&
  89.             ($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false)
  90.             && 301 === $operation->getStatus()
  91.         ) {
  92.             $status = 301;
  93.             $headers['Location'] = $this->iriConverter->getIriFromResource($request->attributes->get('data'), UrlGeneratorInterface::ABS_PATH, $operation);
  94.         } elseif (HttpOperation::METHOD_PUT === $method && !($attributes['previous_data'] ?? null) && null === $status && ($operation instanceof Put && ($operation->getAllowCreate() ?? false))) {
  95.             $status = Response::HTTP_CREATED;
  96.         }
  98.         $status ??= self::METHOD_TO_CODE[$request->getMethod()] ?? Response::HTTP_OK;
  100.         if ($request->attributes->has('_api_write_item_iri')) {
  101.             $headers['Content-Location'] = $request->attributes->get('_api_write_item_iri');
  103.             if ((Response::HTTP_CREATED === $status || (300 <= $status && $status < 400)) && HttpOperation::METHOD_POST === $method) {
  104.                 $headers['Location'] = $request->attributes->get('_api_write_item_iri');
  105.             }
  106.         }
  108.         $event->setResponse(new Response(
  109.             $controllerResult,
  110.             $status,
  111.             $headers
  112.         ));
  113.     }
  114. }