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

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