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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the API Platform project.
  4.  *
  5.  * (c) Kévin Dunglas <dunglas@gmail.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. declare(strict_types=1);
  11. namespace ApiPlatform\Symfony\EventListener;
  12. use ApiPlatform\Api\IriConverterInterface;
  13. use ApiPlatform\Api\UrlGeneratorInterface;
  14. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  15. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  16. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  17. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  18. use ApiPlatform\Util\RequestAttributesExtractor;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpKernel\Event\ViewEvent;
  21. /**
  22.  * Builds the response object.
  23.  *
  24.  * @author Kévin Dunglas <dunglas@gmail.com>
  25.  */
  26. final class RespondListener
  27. {
  28.     use OperationRequestInitiatorTrait;
  29.     public const METHOD_TO_CODE = [
  30.         'POST' => Response::HTTP_CREATED,
  31.         'DELETE' => Response::HTTP_NO_CONTENT,
  32.     ];
  33.     private $resourceMetadataFactory;
  34.     private $iriConverter;
  35.     public function __construct($resourceMetadataFactory nullIriConverterInterface $iriConverter null)
  36.     {
  37.         if ($resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  38.             trigger_deprecation('api-platform/core''2.7'sprintf('Use "%s" instead of "%s".'ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  39.         }
  40.         if ($resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  41.             $this->resourceMetadataCollectionFactory $resourceMetadataFactory;
  42.         }
  43.         $this->resourceMetadataFactory $resourceMetadataFactory;
  44.         $this->iriConverter $iriConverter;
  45.     }
  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);
  54.         $attributes RequestAttributesExtractor::extractAttributes($request);
  55.         if ($controllerResult instanceof Response && ($attributes['respond'] ?? false)) {
  56.             $event->setResponse($controllerResult);
  57.             return;
  58.         }
  59.         if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond'))) {
  60.             return;
  61.         }
  62.         $headers = [
  63.             'Content-Type' => sprintf('%s; charset=utf-8'$request->getMimeType($request->getRequestFormat())),
  64.             'Vary' => 'Accept',
  65.             'X-Content-Type-Options' => 'nosniff',
  66.             'X-Frame-Options' => 'deny',
  67.         ];
  68.         $status $operation $operation->getStatus() : null;
  69.         // TODO: remove this in 3.x
  70.         if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface && $attributes) {
  71.             $resourceMetadata $this->resourceMetadataFactory->create($attributes['resource_class']);
  72.             if ($sunset $resourceMetadata->getOperationAttribute($attributes'sunset'nulltrue)) {
  73.                 $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
  74.             }
  75.             $headers $this->addAcceptPatchHeader($headers$attributes$resourceMetadata);
  76.             $status $resourceMetadata->getOperationAttribute($attributes'status');
  77.         } elseif ($operation) {
  78.             if ($sunset $operation->getSunset()) {
  79.                 $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
  80.             }
  81.             if ($acceptPatch $operation->getAcceptPatch()) {
  82.                 $headers['Accept-Patch'] = $acceptPatch;
  83.             }
  84.             if (
  85.                 $this->iriConverter &&
  86.                 ($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) &&
  87.                 !($operation->getExtraProperties()['is_legacy_subresource'] ?? false)
  88.                 && 301 === $operation->getStatus()
  89.             ) {
  90.                 $status 301;
  91.                 $headers['Location'] = $this->iriConverter->getIriFromResource($request->attributes->get('data'), UrlGeneratorInterface::ABS_PATH$operation);
  92.             }
  93.         }
  94.         $status $status ?? self::METHOD_TO_CODE[$request->getMethod()] ?? Response::HTTP_OK;
  95.         if ($request->attributes->has('_api_write_item_iri')) {
  96.             $headers['Content-Location'] = $request->attributes->get('_api_write_item_iri');
  97.             if ((Response::HTTP_CREATED === $status || (300 <= $status && $status 400)) && $request->isMethod('POST')) {
  98.                 $headers['Location'] = $request->attributes->get('_api_write_item_iri');
  99.             }
  100.         }
  101.         $event->setResponse(new Response(
  102.             $controllerResult,
  103.             $status,
  104.             $headers
  105.         ));
  106.     }
  107.     private function addAcceptPatchHeader(array $headers, array $attributesResourceMetadata $resourceMetadata): array
  108.     {
  109.         if (!isset($attributes['item_operation_name'])) {
  110.             return $headers;
  111.         }
  112.         $patchMimeTypes = [];
  113.         foreach ($resourceMetadata->getItemOperations() as $operation) {
  114.             if ('PATCH' !== ($operation['method'] ?? '') || !isset($operation['input_formats'])) {
  115.                 continue;
  116.             }
  117.             foreach ($operation['input_formats'] as $mimeTypes) {
  118.                 foreach ($mimeTypes as $mimeType) {
  119.                     $patchMimeTypes[] = $mimeType;
  120.                 }
  121.             }
  122.             $headers['Accept-Patch'] = implode(', '$patchMimeTypes);
  123.             return $headers;
  124.         }
  125.         return $headers;
  126.     }
  127. }
  128. class_alias(RespondListener::class, \ApiPlatform\Core\EventListener\RespondListener::class);