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

  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\Core\Api\OperationType;
  17. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  18. use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
  19. use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
  20. use ApiPlatform\Exception\RuntimeException;
  21. use ApiPlatform\Metadata\CollectionOperationInterface;
  22. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  23. use ApiPlatform\Util\RequestAttributesExtractor;
  24. use Symfony\Component\HttpFoundation\Request;
  25. use Symfony\Component\Serializer\Encoder\CsvEncoder;
  27. /**
  28.  * @author Kévin Dunglas <dunglas@gmail.com>
  29.  */
  30. final class SerializerContextBuilder implements SerializerContextBuilderInterface
  31. {
  32.     private $resourceMetadataFactory;
  34.     public function __construct($resourceMetadataFactory)
  35.     {
  36.         $this->resourceMetadataFactory = $resourceMetadataFactory;
  38.         if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  39.             trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
  40.         }
  41.     }
  43.     public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
  44.     {
  45.         if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
  46.             throw new RuntimeException('Request attributes are not valid.');
  47.         }
  49.         // TODO remove call to getContentType() when requiring symfony/http-foundation ≥ 6.2
  50.         $contentTypeFormat = method_exists($request, 'getContentTypeFormat')
  51.             ? $request->getContentTypeFormat()
  52.             : $request->getContentType();
  54.         // TODO: 3.0 change the condition to remove the ResourceMetadataFactorym only used to skip null values
  55.         if (
  56.             $this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface
  57.             && (isset($attributes['operation_name']) || isset($attributes['operation']))
  58.         ) {
  59.             $operation = $attributes['operation'] ?? $this->resourceMetadataFactory->create($attributes['resource_class'])->getOperation($attributes['operation_name']);
  60.             $context = $normalization ? ($operation->getNormalizationContext() ?? []) : ($operation->getDenormalizationContext() ?? []);
  61.             $context['operation_name'] = $operation->getName();
  62.             $context['operation'] = $operation;
  63.             $context['resource_class'] = $attributes['resource_class'];
  64.             // TODO: 3.0 becomes true by default
  65.             $context['skip_null_values'] = $context['skip_null_values'] ?? $this->shouldSkipNullValues($attributes['resource_class'], $context['operation_name']);
  66.             // TODO: remove in 3.0, operation type will not exist anymore
  67.             $context['operation_type'] = $operation instanceof CollectionOperationInterface ? OperationType::COLLECTION : OperationType::ITEM;
  68.             $context['iri_only'] = $context['iri_only'] ?? false;
  69.             $context['request_uri'] = $request->getRequestUri();
  70.             $context['uri'] = $request->getUri();
  71.             $context['input'] = $operation->getInput();
  72.             $context['output'] = $operation->getOutput();
  74.             // Special case as this is usually handled by our OperationContextTrait, here we want to force the IRI in the response
  75.             if (!$operation instanceof CollectionOperationInterface && method_exists($operation, 'getItemUriTemplate') && $operation->getItemUriTemplate()) {
  76.                 $context['item_uri_template'] = $operation->getItemUriTemplate();
  77.             }
  79.             $context['types'] = $operation->getTypes();
  80.             $context['uri_variables'] = [];
  82.             foreach (array_keys($operation->getUriVariables() ?? []) as $parameterName) {
  83.                 $context['uri_variables'][$parameterName] = $request->attributes->get($parameterName);
  84.             }
  86.             if (!$normalization) {
  87.                 if (!isset($context['api_allow_update'])) {
  88.                     $context['api_allow_update'] = \in_array($method = $request->getMethod(), ['PUT', 'PATCH'], true);
  90.                     if ($context['api_allow_update'] && 'PATCH' === $method) {
  91.                         $context['deep_object_to_populate'] = $context['deep_object_to_populate'] ?? true;
  92.                     }
  93.                 }
  95.                 if ('csv' === $contentTypeFormat) {
  96.                     $context[CsvEncoder::AS_COLLECTION_KEY] = false;
  97.                 }
  98.             }
  100.             return $context;
  101.         }
  103.         /** @var ResourceMetadata $resourceMetadata */
  104.         $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
  105.         $key = $normalization ? 'normalization_context' : 'denormalization_context';
  106.         if (isset($attributes['collection_operation_name'])) {
  107.             $operationKey = 'collection_operation_name';
  108.             $operationType = OperationType::COLLECTION;
  109.         } elseif (isset($attributes['item_operation_name'])) {
  110.             $operationKey = 'item_operation_name';
  111.             $operationType = OperationType::ITEM;
  112.         } else {
  113.             $operationKey = 'subresource_operation_name';
  114.             $operationType = OperationType::SUBRESOURCE;
  115.         }
  117.         $context = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], $key, [], true);
  118.         $context['operation_type'] = $operationType;
  119.         $context[$operationKey] = $attributes[$operationKey];
  120.         $context['iri_only'] = $resourceMetadata->getAttribute('normalization_context')['iri_only'] ?? false;
  121.         $context['input'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'input', null, true);
  122.         $context['output'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'output', null, true);
  124.         if (!$normalization) {
  125.             if (!isset($context['api_allow_update'])) {
  126.                 $context['api_allow_update'] = \in_array($method = $request->getMethod(), ['PUT', 'PATCH'], true);
  128.                 if ($context['api_allow_update'] && 'PATCH' === $method) {
  129.                     $context['deep_object_to_populate'] = $context['deep_object_to_populate'] ?? true;
  130.                 }
  131.             }
  133.             if ('csv' === $contentTypeFormat) {
  134.                 $context[CsvEncoder::AS_COLLECTION_KEY] = false;
  135.             }
  136.         }
  138.         $context['resource_class'] = $attributes['resource_class'];
  139.         $context['request_uri'] = $request->getRequestUri();
  140.         $context['uri'] = $request->getUri();
  142.         if (isset($attributes['subresource_context'])) {
  143.             $context['subresource_identifiers'] = [];
  145.             foreach ($attributes['subresource_context']['identifiers'] as $parameterName => [$resourceClass]) {
  146.                 if (!isset($context['subresource_resources'][$resourceClass])) {
  147.                     $context['subresource_resources'][$resourceClass] = [];
  148.                 }
  150.                 $context['subresource_identifiers'][$parameterName] = $context['subresource_resources'][$resourceClass][$parameterName] = $request->attributes->get($parameterName);
  151.             }
  152.         }
  154.         if (isset($attributes['subresource_property'])) {
  155.             $context['subresource_property'] = $attributes['subresource_property'];
  156.             $context['subresource_resource_class'] = $attributes['subresource_resource_class'] ?? null;
  157.         }
  159.         unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);
  161.         if (isset($context['skip_null_values'])) {
  162.             return $context;
  163.         }
  165.         // TODO: We should always use `skip_null_values` but changing this would be a BC break, for now use it only when `merge-patch+json` is activated on a Resource
  166.         if (!$this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
  167.             foreach ($resourceMetadata->getItemOperations() as $operation) {
  168.                 if ('PATCH' === ($operation['method'] ?? '') && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {
  169.                     $context['skip_null_values'] = true;
  171.                     break;
  172.                 }
  173.             }
  174.         } else {
  175.             $context['skip_null_values'] = $this->shouldSkipNullValues($attributes['resource_class'], $attributes['operation_name']);
  176.         }
  178.         return $context;
  179.     }
  181.     /**
  182.      * TODO: remove in 3.0, this will have no impact and skip_null_values will be default, no more resourceMetadataFactory call in this class.
  183.      */
  184.     private function shouldSkipNullValues(string $class, string $operationName): bool
  185.     {
  186.         if (!$this->resourceMetadataFactory) {
  187.             return false;
  188.         }
  190.         $collection = $this->resourceMetadataFactory->create($class);
  191.         foreach ($collection as $metadata) {
  192.             foreach ($metadata->getOperations() as $operation) {
  193.                 if ('PATCH' === ($operation->getMethod() ?? '') && \in_array('application/merge-patch+json', $operation->getInputFormats()['json'] ?? [], true)) {
  194.                     return true;
  195.                 }
  196.             }
  197.         }
  199.         return false;
  200.     }
  201. }
  203. class_alias(SerializerContextBuilder::class, \ApiPlatform\Core\Serializer\SerializerContextBuilder::class);