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

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\Core\EventListener;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  18. use ApiPlatform\Core\Util\RequestAttributesExtractor;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpKernel\Event\ViewEvent;
  22. /**
  23.  * Builds the response object.
  24.  *
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. final class RespondListener
  28. {
  29.     public const METHOD_TO_CODE = [
  30.         'POST' => Response::HTTP_CREATED,
  31.         'DELETE' => Response::HTTP_NO_CONTENT,
  32.     ];
  34.     private $resourceMetadataFactory;
  36.     public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
  37.     {
  38.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  39.     }
  41.     /**
  42.      * Creates a Response to send to the client according to the requested format.
  43.      */
  44.     public function onKernelView(ViewEvent $event): void
  45.     {
  46.         $controllerResult = $event->getControllerResult();
  47.         $request = $event->getRequest();
  49.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  50.         if ($controllerResult instanceof Response && ($attributes['respond'] ?? false)) {
  51.             $event->setResponse($controllerResult);
  53.             return;
  54.         }
  55.         if ($controllerResult instanceof Response || !($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond'))) {
  56.             return;
  57.         }
  59.         $headers = [
  60.             'Content-Type' => sprintf('%s; charset=utf-8', $request->getMimeType($request->getRequestFormat())),
  61.             'Vary' => 'Accept',
  62.             'X-Content-Type-Options' => 'nosniff',
  63.             'X-Frame-Options' => 'deny',
  64.         ];
  66.         $status = null;
  67.         if ($this->resourceMetadataFactory && $attributes) {
  68.             $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  70.             if ($sunset = $resourceMetadata->getOperationAttribute($attributes, 'sunset', null, true)) {
  71.                 $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTime::RFC1123);
  72.             }
  74.             $headers = $this->addAcceptPatchHeader($headers, $attributes, $resourceMetadata);
  75.             $status = $resourceMetadata->getOperationAttribute($attributes, 'status');
  76.         }
  78.         $status = $status ?? self::METHOD_TO_CODE[$request->getMethod()] ?? Response::HTTP_OK;
  80.         if ($request->attributes->has('_api_write_item_iri')) {
  81.             $headers['Content-Location'] = $request->attributes->get('_api_write_item_iri');
  83.             if ((Response::HTTP_CREATED === $status || (300 <= $status && $status < 400)) && $request->isMethod('POST')) {
  84.                 $headers['Location'] = $request->attributes->get('_api_write_item_iri');
  85.             }
  86.         }
  88.         $event->setResponse(new Response(
  89.             $controllerResult,
  90.             $status,
  91.             $headers
  92.         ));
  93.     }
  95.     private function addAcceptPatchHeader(array $headers, array $attributes, ResourceMetadata $resourceMetadata): array
  96.     {
  97.         if (!isset($attributes['item_operation_name'])) {
  98.             return $headers;
  99.         }
  101.         $patchMimeTypes = [];
  102.         foreach ($resourceMetadata->getItemOperations() as $operation) {
  103.             if ('PATCH' !== ($operation['method'] ?? '') || !isset($operation['input_formats'])) {
  104.                 continue;
  105.             }
  107.             foreach ($operation['input_formats'] as $mimeTypes) {
  108.                 foreach ($mimeTypes as $mimeType) {
  109.                     $patchMimeTypes[] = $mimeType;
  110.                 }
  111.             }
  112.             $headers['Accept-Patch'] = implode(', ', $patchMimeTypes);
  114.             return $headers;
  115.         }
  117.         return $headers;
  118.     }
  119. }