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

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