fix(state): object mapper flag

soyuka · soyuka · commit 3909f96a7349 · 2025-11-17T15:01:02.000+01:00
diff --git a/src/Metadata/ApiResource.php b/src/Metadata/ApiResource.php
@@ -969,8 +969,9 @@ public function __construct(
         array|Parameters|null $parameters = null,
         protected ?bool $strictQueryParameterValidation = null,
         protected ?bool $hideHydraOperation = null,
-        ?bool $jsonStream = null,
+        protected ?bool $jsonStream = null,
         protected array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             shortName: $shortName,
@@ -1016,7 +1017,8 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
 
         /* @var Operations<HttpOperation> $operations> */
diff --git a/src/Metadata/Delete.php b/src/Metadata/Delete.php
@@ -101,6 +101,7 @@ public function __construct(
         protected ?bool $hideHydraOperation = null,
         ?bool $jsonStream = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             method: 'DELETE',
@@ -183,6 +184,7 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             stateOptions: $stateOptions,
+            map: $map
         );
     }
 }
diff --git a/src/Metadata/Error.php b/src/Metadata/Error.php
@@ -95,6 +95,7 @@ public function __construct(
         ?OptionsInterface $stateOptions = null,
         ?bool $hideHydraOperation = null,
         ?bool $jsonStream = null,
+        ?bool $map = null,
         array $extraProperties = [],
     ) {
         parent::__construct(
@@ -171,6 +172,7 @@ class: $class,
             stateOptions: $stateOptions,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
+            map: $map,
             extraProperties: $extraProperties,
         );
     }
diff --git a/src/Metadata/Get.php b/src/Metadata/Get.php
@@ -101,6 +101,7 @@ public function __construct(
         protected ?bool $hideHydraOperation = null,
         ?bool $jsonStream = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             uriTemplate: $uriTemplate,
@@ -182,6 +183,7 @@ class: $class,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
             extraProperties: $extraProperties,
+            map: $map
         );
     }
 }
diff --git a/src/Metadata/GetCollection.php b/src/Metadata/GetCollection.php
@@ -102,6 +102,7 @@ public function __construct(
         ?bool $jsonStream = null,
         array $extraProperties = [],
         private ?string $itemUriTemplate = null,
+        ?bool $map = null,
     ) {
         parent::__construct(
             uriTemplate: $uriTemplate,
@@ -183,6 +184,7 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             stateOptions: $stateOptions,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/GraphQl/Operation.php b/src/Metadata/GraphQl/Operation.php
@@ -92,6 +92,7 @@ public function __construct(
         mixed $rules = null,
         ?string $policy = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             shortName: $shortName,
@@ -141,7 +142,8 @@ class: $class,
             queryParameterValidationEnabled: $queryParameterValidationEnabled,
             rules: $rules,
             policy: $policy,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/GraphQl/Query.php b/src/Metadata/GraphQl/Query.php
@@ -77,6 +77,7 @@ public function __construct(
         array $extraProperties = [],
 
         protected ?bool $nested = null,
+        ?bool $map = null,
     ) {
         parent::__construct(
             resolver: $resolver,
@@ -132,7 +133,8 @@ class: $class,
             queryParameterValidationEnabled: $queryParameterValidationEnabled,
             policy: $policy,
             rules: $rules,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/GraphQl/Subscription.php b/src/Metadata/GraphQl/Subscription.php
@@ -75,6 +75,7 @@ public function __construct(
         mixed $rules = null,
         ?string $policy = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             resolver: $resolver,
@@ -131,6 +132,7 @@ class: $class,
             policy: $policy,
             rules: $rules,
             extraProperties: $extraProperties,
+            map: $map
         );
     }
 }
diff --git a/src/Metadata/HttpOperation.php b/src/Metadata/HttpOperation.php
@@ -221,6 +221,7 @@ public function __construct(
         ?bool $queryParameterValidationEnabled = null,
         ?bool $jsonStream = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         $this->formats = (null === $formats || \is_array($formats)) ? $formats : [$formats];
         $this->inputFormats = (null === $inputFormats || \is_array($inputFormats)) ? $inputFormats : [$inputFormats];
@@ -279,7 +280,8 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/Metadata.php b/src/Metadata/Metadata.php
@@ -81,6 +81,7 @@ public function __construct(
         protected ?bool $strictQueryParameterValidation = null,
         protected ?bool $hideHydraOperation = null,
         protected ?bool $jsonStream = null,
+        protected ?bool $map = null,
         protected array $extraProperties = [],
     ) {
         if (\is_array($parameters) && $parameters) {
@@ -90,6 +91,19 @@ public function __construct(
         $this->parameters = $parameters;
     }
 
+    public function canMap(): ?bool
+    {
+        return $this->map;
+    }
+
+    public function withMap(bool $map): static
+    {
+        $self = clone $this;
+        $self->map = $map;
+
+        return $self;
+    }
+
     public function getShortName(): ?string
     {
         return $this->shortName;
diff --git a/src/Metadata/NotExposed.php b/src/Metadata/NotExposed.php
@@ -107,6 +107,7 @@ public function __construct(
         $processor = null,
         array $extraProperties = [],
         ?OptionsInterface $stateOptions = null,
+        ?bool $map = null,
     ) {
         parent::__construct(
             method: $method,
@@ -182,6 +183,7 @@ class: $class,
             processor: $processor,
             stateOptions: $stateOptions,
             extraProperties: $extraProperties,
+            map: $map
         );
     }
 }
diff --git a/src/Metadata/Operation.php b/src/Metadata/Operation.php
@@ -814,6 +814,7 @@ public function __construct(
         protected ?bool $hideHydraOperation = null,
         protected ?bool $jsonStream = null,
         protected array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             shortName: $shortName,
@@ -861,6 +862,7 @@ class: $class,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
             extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/Patch.php b/src/Metadata/Patch.php
@@ -101,6 +101,7 @@ public function __construct(
         ?bool $hideHydraOperation = null,
         ?bool $jsonStream = null,
         array $extraProperties = [],
+        ?bool $map = null,
     ) {
         parent::__construct(
             method: 'PATCH',
@@ -182,7 +183,8 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 }
diff --git a/src/Metadata/Post.php b/src/Metadata/Post.php
@@ -102,6 +102,7 @@ public function __construct(
         private ?string $itemUriTemplate = null,
         ?bool $strictQueryParameterValidation = null,
         ?bool $hideHydraOperation = null,
+        ?bool $map = null,
     ) {
         parent::__construct(
             method: 'POST',
@@ -183,7 +184,8 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/Put.php b/src/Metadata/Put.php
@@ -102,6 +102,7 @@ public function __construct(
         ?bool $strictQueryParameterValidation = null,
         ?bool $hideHydraOperation = null,
         private ?bool $allowCreate = null,
+        ?bool $map = null,
     ) {
         parent::__construct(
             method: 'PUT',
@@ -183,7 +184,8 @@ class: $class,
             strictQueryParameterValidation: $strictQueryParameterValidation,
             hideHydraOperation: $hideHydraOperation,
             jsonStream: $jsonStream,
-            extraProperties: $extraProperties
+            extraProperties: $extraProperties,
+            map: $map
         );
     }
 
diff --git a/src/Metadata/Resource/Factory/ObjectMapperMetadataCollectionFactory.php b/src/Metadata/Resource/Factory/ObjectMapperMetadataCollectionFactory.php
@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Metadata\Resource\Factory;
+
+use ApiPlatform\Metadata\Odm\Options as OdmOptions;
+use ApiPlatform\Metadata\Options;
+use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
+use Symfony\Component\ObjectMapper\Metadata\ObjectMapperMetadataFactoryInterface;
+
+class ObjectMapperMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
+{
+    public function __construct(
+        private readonly ResourceMetadataCollectionFactoryInterface $decorated,
+        private readonly ObjectMapperMetadataFactoryInterface $objectMapperMetadata
+    ) {
+    }
+
+    public function create(string $resourceClass): ResourceMetadataCollection
+    {
+        $resourceMetadataCollection = $this->decorated->create($resourceClass);
+
+        foreach ($resourceMetadataCollection as $key => $resourceMetadata) {
+            $operations = $resourceMetadata->getOperations();
+
+            if ($operations) {
+                foreach ($operations as $operationKey => $operation) {
+                    if (null !== $operation->canMap()) {
+                        continue;
+                    }
+
+                    $entityClass = null;
+                    if (($options = $operation->getStateOptions()) && $options instanceof Options && $options->getEntityClass()) {
+                        $entityClass = $options->getEntityClass();
+                    }
+
+                    if (($options = $operation->getStateOptions()) && $options instanceof OdmOptions && $options->getDocumentClass()) {
+                        $entityClass = $options->getDocumentClass();
+                    }
+
+                    $class = $operation->getInput()['class'] ?? $operation->getClass();
+
+                    // Look for Mapping metadata
+                    if ($this->canBeMapped($class) || ($entityClass && $this->canBeMapped($entityClass))) {
+                        $operations->add($operationKey, $operation->withMap(true));
+                    }
+                }
+
+                $resourceMetadata = $resourceMetadata->withOperations($operations);
+            }
+
+            $resourceMetadataCollection[$key] = $resourceMetadata;
+        }
+
+        return $resourceMetadataCollection;
+    }
+
+    private function canBeMapped(string $class): bool
+    {
+        try {
+            $r = new \ReflectionClass($class);
+            if (!$r->isInstantiable() || !$this->objectMapperMetadata->create($r->newInstanceWithoutConstructor(), null, ['_api_check_can_be_mapped' => true])) {
+                return false;
+            }
+        } catch (\ReflectionException $e) {
+            return false;
+        }
+
+        return true;
+    }
+}
diff --git a/src/State/Processor/ObjectMapperProcessor.php b/src/State/Processor/ObjectMapperProcessor.php
@@ -47,28 +47,26 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
             || !$operation->canWrite()
             || null === $data
             || !is_a($data, $class, true)
+            || !$operation->canMap()
         ) {
             return $this->decorated->process($data, $operation, $uriVariables, $context);
         }
 
-        if ($this->objectMapperMetadata) {
-            if (!$this->objectMapperMetadata->create($data)) {
-                return $this->decorated->process($data, $operation, $uriVariables, $context);
-            }
-        } elseif (!(new \ReflectionClass($operation->getClass()))->getAttributes(Map::class)) {
-            return $this->decorated->process($data, $operation, $uriVariables, $context);
-        }
-
-        // return the Resource representation of the persisted entity
-        return $this->objectMapper->map(
-            // persist the entity
-            $this->decorated->process(
+        $request = $context['request'] ?? null;
+        $persisted = $this->decorated->process(
                 // maps the Resource to an Entity
                 $this->objectMapper->map($data),
                 $operation,
                 $uriVariables,
                 $context,
-            ),
+            );
+
+        $request?->attributes->set('persisted_data', $persisted);
+
+        // return the Resource representation of the persisted entity
+        return $this->objectMapper->map(
+            // persist the entity
+            $persisted,
             $operation->getClass()
         );
     }
diff --git a/src/State/Provider/ObjectMapperProvider.php b/src/State/Provider/ObjectMapperProvider.php
diff --git a/src/Symfony/Bundle/Resources/config/state/object_mapper.php b/src/Symfony/Bundle/Resources/config/state/object_mapper.php
diff --git a/tests/Fixtures/TestBundle/ApiResource/MappedResourceNoMap.php b/tests/Fixtures/TestBundle/ApiResource/MappedResourceNoMap.php
diff --git a/tests/Fixtures/TestBundle/Entity/MappedEntityNoMap.php b/tests/Fixtures/TestBundle/Entity/MappedEntityNoMap.php
diff --git a/tests/Functional/MappingTest.php b/tests/Functional/MappingTest.php
