vendor/api-platform/core/src/Symfony/EventListener/SerializeListener.php line 51

  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\Doctrine\Orm\State\Options;
  17. use ApiPlatform\Exception\RuntimeException;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Serializer\ResourceList;
  20. use ApiPlatform\Serializer\SerializerContextBuilderInterface;
  21. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  22. use ApiPlatform\Util\RequestAttributesExtractor;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\Event\ViewEvent;
  26. use Symfony\Component\Serializer\Encoder\EncoderInterface;
  27. use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
  28. use Symfony\Component\Serializer\SerializerInterface;
  29. use Symfony\Component\WebLink\GenericLinkProvider;
  30. use Symfony\Component\WebLink\Link;
  32. /**
  33.  * Serializes data.
  34.  *
  35.  * @author Kévin Dunglas <dunglas@gmail.com>
  36.  */
  37. final class SerializeListener
  38. {
  39.     use OperationRequestInitiatorTrait;
  41.     public const OPERATION_ATTRIBUTE_KEY = 'serialize';
  43.     public function __construct(private readonly SerializerInterface $serializer, private readonly SerializerContextBuilderInterface $serializerContextBuilder, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null)
  44.     {
  45.         $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
  46.     }
  48.     /**
  49.      * Serializes the data to the requested format.
  50.      */
  51.     public function onKernelView(ViewEvent $event): void
  52.     {
  53.         $controllerResult = $event->getControllerResult();
  54.         $request = $event->getRequest();
  56.         if ($controllerResult instanceof Response) {
  57.             return;
  58.         }
  60.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  62.         if (!($attributes['respond'] ?? $request->attributes->getBoolean('_api_respond', false))) {
  63.             return;
  64.         }
  66.         $operation = $this->initializeOperation($request);
  67.         if (!($operation?->canSerialize() ?? true)) {
  68.             return;
  69.         }
  71.         if (!$attributes) {
  72.             $this->serializeRawData($event, $request, $controllerResult);
  74.             return;
  75.         }
  77.         $context = $this->serializerContextBuilder->createFromRequest($request, true, $attributes);
  78.         if (isset($context['output']) && \array_key_exists('class', $context['output']) && null === $context['output']['class']) {
  79.             $event->setControllerResult(null);
  81.             return;
  82.         }
  84.         if ($included = $request->attributes->get('_api_included')) {
  85.             $context['api_included'] = $included;
  86.         }
  87.         $resources = new ResourceList();
  88.         $context['resources'] = &$resources;
  89.         $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'resources';
  91.         $resourcesToPush = new ResourceList();
  92.         $context['resources_to_push'] = &$resourcesToPush;
  93.         $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'resources_to_push';
  94.         if (($options = $operation?->getStateOptions()) && $options instanceof Options && $options->getEntityClass()) {
  95.             $context['force_resource_class'] = $operation->getClass();
  96.         }
  98.         $request->attributes->set('_api_normalization_context', $context);
  99.         $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $context));
  101.         $request->attributes->set('_resources', $request->attributes->get('_resources', []) + (array) $resources);
  102.         if (!\count($resourcesToPush)) {
  103.             return;
  104.         }
  106.         $linkProvider = $request->attributes->get('_links', new GenericLinkProvider());
  107.         foreach ($resourcesToPush as $resourceToPush) {
  108.             $linkProvider = $linkProvider->withLink((new Link('preload', $resourceToPush))->withAttribute('as', 'fetch'));
  109.         }
  110.         $request->attributes->set('_links', $linkProvider);
  111.     }
  113.     /**
  114.      * Tries to serialize data that are not API resources (e.g. the entrypoint or data returned by a custom controller).
  115.      *
  116.      * @throws RuntimeException
  117.      */
  118.     private function serializeRawData(ViewEvent $event, Request $request, $controllerResult): void
  119.     {
  120.         if (\is_object($controllerResult)) {
  121.             $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $request->attributes->get('_api_normalization_context', [])));
  123.             return;
  124.         }
  126.         if (!$this->serializer instanceof EncoderInterface) {
  127.             throw new RuntimeException(sprintf('The serializer must implement the "%s" interface.', EncoderInterface::class));
  128.         }
  130.         $event->setControllerResult($this->serializer->encode($controllerResult, $request->getRequestFormat()));
  131.     }
  132. }