vendor/api-platform/core/src/Serializer/SerializerContextBuilder.php line 41

  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\Serializer;
  16. use ApiPlatform\Doctrine\Orm\State\Options;
  17. use ApiPlatform\Metadata\CollectionOperationInterface;
  18. use ApiPlatform\Metadata\Error as ErrorOperation;
  19. use ApiPlatform\Metadata\Exception\RuntimeException;
  20. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  21. use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
  22. use Symfony\Component\HttpFoundation\Request;
  23. use Symfony\Component\Serializer\Encoder\CsvEncoder;
  24. use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
  25. use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
  27. /**
  28.  * {@inheritdoc}
  29.  *
  30.  * @author Kévin Dunglas <dunglas@gmail.com>
  31.  */
  32. final class SerializerContextBuilder implements SerializerContextBuilderInterface
  33. {
  34.     public function __construct(private readonly ?ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, private readonly bool $debug = false)
  35.     {
  36.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      */
  41.     public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
  42.     {
  43.         if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
  44.             throw new RuntimeException('Request attributes are not valid.');
  45.         }
  47.         if (!($operation = $attributes['operation'] ?? null)) {
  48.             if (!$this->resourceMetadataFactory) {
  49.                 throw new RuntimeException('No operation');
  50.             }
  52.             $operation = $this->resourceMetadataFactory->create($attributes['resource_class'])->getOperation($attributes['operation_name'] ?? null);
  53.         }
  55.         $context = $normalization ? ($operation->getNormalizationContext() ?? []) : ($operation->getDenormalizationContext() ?? []);
  56.         $context['operation_name'] = $operation->getName();
  57.         $context['operation'] = $operation;
  58.         $context['resource_class'] = $attributes['resource_class'];
  59.         $context['skip_null_values'] ??= true;
  60.         $context['iri_only'] ??= false;
  61.         $context['request_uri'] = $request->getRequestUri();
  62.         $context['uri'] = $request->getUri();
  63.         $context['input'] = $operation->getInput();
  64.         $context['output'] = $operation->getOutput();
  66.         // Special case as this is usually handled by our OperationContextTrait, here we want to force the IRI in the response
  67.         if (!$operation instanceof CollectionOperationInterface && method_exists($operation, 'getItemUriTemplate') && $operation->getItemUriTemplate()) {
  68.             $context['item_uri_template'] = $operation->getItemUriTemplate();
  69.         }
  71.         if ($types = $operation->getTypes()) {
  72.             $context['types'] = $types;
  73.         }
  75.         // TODO: remove this as uri variables are available in the SerializerProcessor but correctly parsed
  76.         if ($operation->getUriVariables()) {
  77.             $context['uri_variables'] = [];
  79.             foreach (array_keys($operation->getUriVariables()) as $parameterName) {
  80.                 $context['uri_variables'][$parameterName] = $request->attributes->get($parameterName);
  81.             }
  82.         }
  84.         if (($options = $operation?->getStateOptions()) && $options instanceof Options && $options->getEntityClass()) {
  85.             $context['force_resource_class'] = $operation->getClass();
  86.         }
  88.         if ($this->debug && isset($context['groups']) && $operation instanceof ErrorOperation) {
  89.             if (!\is_array($context['groups'])) {
  90.                 $context['groups'] = (array) $context['groups'];
  91.             }
  93.             $context['groups'][] = 'trace';
  94.         }
  96.         if (!$normalization) {
  97.             if (!isset($context['api_allow_update'])) {
  98.                 $context['api_allow_update'] = \in_array($method = $request->getMethod(), ['PUT', 'PATCH'], true);
  100.                 if ($context['api_allow_update'] && 'PATCH' === $method) {
  101.                     $context['deep_object_to_populate'] ??= true;
  102.                 }
  103.             }
  105.             if ('csv' === (method_exists(Request::class, 'getContentTypeFormat') ? $request->getContentTypeFormat() : $request->getContentType())) {
  106.                 $context[CsvEncoder::AS_COLLECTION_KEY] = false;
  107.             }
  108.         }
  109.         if ($operation->getCollectDenormalizationErrors() ?? false) {
  110.             $context[DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS] = true;
  111.         }
  113.         // to keep the cache computation smaller, we have "operation_name" and "iri" anyways
  114.         $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'root_operation';
  115.         $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'operation';
  117.         // JSON API see JsonApiProvider
  118.         if ($included = $request->attributes->get('_api_included')) {
  119.             $context['api_included'] = $included;
  120.         }
  122.         return $context;
  123.     }
  124. }