vendor/api-platform/core/src/Symfony/EventListener/DeserializeListener.php line 48

  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\FormatMatcher;
  17. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  18. use ApiPlatform\Serializer\SerializerContextBuilderInterface;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\HttpKernel\Event\RequestEvent;
  23. use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
  24. use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
  25. use Symfony\Component\Serializer\SerializerInterface;
  27. /**
  28.  * Updates the entity retrieved by the data provider with data contained in the request body.
  29.  *
  30.  * @author Kévin Dunglas <dunglas@gmail.com>
  31.  */
  32. final class DeserializeListener
  33. {
  34.     use OperationRequestInitiatorTrait;
  36.     public const OPERATION_ATTRIBUTE_KEY = 'deserialize';
  38.     public function __construct(private readonly SerializerInterface $serializer, private readonly SerializerContextBuilderInterface $serializerContextBuilder, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null)
  39.     {
  40.         $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  41.     }
  43.     /**
  44.      * Deserializes the data sent in the requested format.
  45.      *
  46.      * @throws UnsupportedMediaTypeHttpException
  47.      */
  48.     public function onKernelRequest(RequestEvent $event): void
  49.     {
  50.         $request = $event->getRequest();
  51.         $method = $request->getMethod();
  53.         if (
  54.             'DELETE' === $method
  55.             || $request->isMethodSafe()
  56.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  57.             || !$attributes['receive']
  58.         ) {
  59.             return;
  60.         }
  62.         $operation = $this->initializeOperation($request);
  64.         if (!($operation?->canDeserialize() ?? true)) {
  65.             return;
  66.         }
  68.         $context = $this->serializerContextBuilder->createFromRequest($request, false, $attributes);
  70.         $format = $this->getFormat($request, $operation?->getInputFormats() ?? []);
  71.         $data = $request->attributes->get('data');
  72.         if (null !== $data) {
  73.             $context[AbstractNormalizer::OBJECT_TO_POPULATE] = $data;
  74.         }
  76.         $request->attributes->set(
  77.             'data',
  78.             $this->serializer->deserialize($request->getContent(), $context['resource_class'], $format, $context)
  79.         );
  80.     }
  82.     /**
  83.      * Extracts the format from the Content-Type header and check that it is supported.
  84.      *
  85.      * @throws UnsupportedMediaTypeHttpException
  86.      */
  87.     private function getFormat(Request $request, array $formats): string
  88.     {
  89.         /** @var ?string $contentType */
  90.         $contentType = $request->headers->get('CONTENT_TYPE');
  91.         if (null === $contentType) {
  92.             throw new UnsupportedMediaTypeHttpException('The "Content-Type" header must exist.');
  93.         }
  95.         $formatMatcher = new FormatMatcher($formats);
  96.         $format = $formatMatcher->getFormat($contentType);
  97.         if (null === $format) {
  98.             $supportedMimeTypes = [];
  99.             foreach ($formats as $mimeTypes) {
  100.                 foreach ($mimeTypes as $mimeType) {
  101.                     $supportedMimeTypes[] = $mimeType;
  102.                 }
  103.             }
  105.             throw new UnsupportedMediaTypeHttpException(sprintf('The content-type "%s" is not supported. Supported MIME types are "%s".', $contentType, implode('", "', $supportedMimeTypes)));
  106.         }
  108.         return $format;
  109.     }
  110. }