feat: use fromResourceTransformer in PersistProcessor

Author: mrossard

features/doctrine/transform_model.feature

@@ -2,22 +2,49 @@ Feature: Use an entity or document transformer to return the correct ressource
 
   @createSchema
   @!mongodb
-  Scenario: Get collection from entities
+  Scenario: Get transformed collection from entities
     Given there is a TransformedDummy for date '2025-01-01'
     When I send a "GET" request to "/transformed_dummy_entity_ressources"
     Then the response status code should be 200
     And the response should be in JSON
     And the JSON node "hydra:totalItems" should be equal to 1
 
   @!mongodb
-  Scenario: Get item from entity
+  Scenario: Get transform item from entity
     Given there is a TransformedDummy for date '2025-01-01'
     When I send a "GET" request to "/transformed_dummy_entity_ressources/1"
     Then the response status code should be 200
     And the response should be in JSON
     And the JSON node "year" should exist
     And the JSON node year should be equal to "2025"
 
+  @!mongodb
+  Scenario: Post new entity from transformed resource
+    Given I add "Content-type" header equal to "application/ld+json"
+    When I send a "POST" request to "/transformed_dummy_entity_ressources" with body:
+    """
+      {
+        "year" : 2020
+      }
+    """
+    Then the response status code should be 201
+    And the response should be in JSON
+    And the JSON node "year" should be equal to "2020"
+
+  @!mongodb
+  Scenario: Patch entity from transformed resource
+    Given there is a TransformedDummy for date '2025-01-01'
+    And I add "Content-type" header equal to "application/merge-patch+json"
+    When I send a "PATCH" request to "/transformed_dummy_entity_ressources/1" with body:
+    """
+      {
+        "year" : 2020
+      }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the JSON node "year" should be equal to "2020"
+
   @createSchema
   @mongodb
   Scenario: Get collection from documents

features/hydra/error.feature

@@ -16,7 +16,7 @@ Feature: Error handling
     And the header "Content-Type" should be equal to "application/problem+json; charset=utf-8"
     And the header "Link" should contain '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error"'
     And the JSON node "type" should exist
-    And the JSON node "title" should not exists
+    And the JSON node "title" should not exist
     And the JSON node "hydra:title" should be equal to "An error occurred"
     And the JSON node "detail" should exist
     And the JSON node "description" should not exist

src/Doctrine/Common/State/Options.php

@@ -18,8 +18,8 @@
 class Options implements OptionsInterface
 {
     /**
-     * @param mixed $handleLinks experimental callable, typed mixed as we may want a service name in the future
-     * @param mixed $toResourceTransformer experimental callable, typed mixed as we may want a service name in the future
+     * @param mixed $handleLinks             experimental callable, typed mixed as we may want a service name in the future
+     * @param mixed $toResourceTransformer   experimental callable, typed mixed as we may want a service name in the future
      * @param mixed $fromResourceTransformer experimental callable, typed mixed as we may want a service name in the future
      */
     public function __construct(

src/Doctrine/Common/State/PersistProcessor.php

@@ -19,15 +19,19 @@
 use ApiPlatform\State\ProcessorInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager as DoctrineObjectManager;
+use Psr\Container\ContainerInterface;
 
 final class PersistProcessor implements ProcessorInterface
 {
     use ClassInfoTrait;
     use LinksHandlerTrait;
     use ResourceTransformerLocatorTrait;
 
-    public function __construct(private readonly ManagerRegistry $managerRegistry)
+    public function __construct(private readonly ManagerRegistry $managerRegistry,
+        ?ContainerInterface $handleLinksLocator = null,
+        ?ContainerInterface $resourceTransformerLocator = null)
     {
+        $this->resourceTransformerLocator = $resourceTransformerLocator;
     }
 
     /**
@@ -39,6 +43,12 @@ public function __construct(private readonly ManagerRegistry $managerRegistry)
      */
     public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): mixed
     {
+        // if a transformer is defined, start with that
+        $data = match ($transformer = $this->getFromResourceTransformer($operation)) {
+            null => $data,
+            default => $transformer($data, $this->getManager($operation, $this->managerRegistry)),
+        };
+
         if (
             !\is_object($data)
             || !$manager = $this->managerRegistry->getManagerForClass($class = $this->getObjectClass($data))
@@ -105,7 +115,10 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
         $manager->flush();
         $manager->refresh($data);
 
-        return $data;
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
+            null => $data,
+            default => $transformer($data, $operation, $uriVariables, $context),
+        };
     }
 
     /**

src/Doctrine/Common/State/ResourceTransformerInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Common\State;
+
+use Doctrine\Persistence\ObjectManager;
+
+interface ResourceTransformerInterface
+{
+    /**
+     * @param object $entityOrDocument the doctrine entity or document to make a resource from
+     *
+     * @return object the resulting ApiResource
+     */
+    public function toResource(object $entityOrDocument): object;
+
+    /**
+     * @param object        $resource      the resource you want to persist
+     * @param ObjectManager $objectManager the object manager to handle this kind of resources
+     *
+     * @return object the existing or new entity or document
+     */
+    public function fromResource(object $resource, ObjectManager $objectManager): object;
+}

src/Doctrine/Common/State/ResourceTransformerLocatorTrait.php

@@ -14,6 +14,8 @@
 namespace ApiPlatform\Doctrine\Common\State;
 
 use ApiPlatform\Metadata\Operation;
+use Doctrine\Persistence\ManagerRegistry;
+use Doctrine\Persistence\ObjectManager;
 use Psr\Container\ContainerInterface;
 
 /**
@@ -58,4 +60,20 @@ protected function getFromResourceTransformer(Operation $operation): ?callable
 
         return null;
     }
+
+    protected function getManager(Operation $operation, ManagerRegistry $managerRegistry): ObjectManager
+    {
+        $options = $operation->getStateOptions();
+        $entityClass = match (true) {
+            $options instanceof \ApiPlatform\Doctrine\Orm\State\Options => $options->getEntityClass(),
+            $options instanceof \ApiPlatform\Doctrine\Odm\State\Options => $options->getDocumentClass(),
+            default => null,
+        };
+
+        if ($entityClass) {
+            return $managerRegistry->getManagerForClass($entityClass);
+        }
+
+        throw new \RuntimeException('This should not be called on an operation without StateOptions');
+    }
 }

src/Doctrine/Odm/State/CollectionProvider.php

@@ -14,7 +14,7 @@
 namespace ApiPlatform\Doctrine\Odm\State;
 
 use ApiPlatform\Doctrine\Common\State\LinksHandlerLocatorTrait;
-use ApiPlatform\Doctrine\Common\State\ModelTransformerLocatorTrait;
+use ApiPlatform\Doctrine\Common\State\ResourceTransformerLocatorTrait;
 use ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface;
 use ApiPlatform\Doctrine\Odm\Extension\AggregationResultCollectionExtensionInterface;
 use ApiPlatform\Metadata\Exception\RuntimeException;
@@ -34,17 +34,20 @@ final class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
     use StateOptionsTrait;
 
     /**
      * @param AggregationCollectionExtensionInterface[] $collectionExtensions
      */
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry, private readonly iterable $collectionExtensions = [], ?ContainerInterface $handleLinksLocator = null)
-    {
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry,
+        private readonly iterable $collectionExtensions = [],
+        ?ContainerInterface $handleLinksLocator = null,
+        ?ContainerInterface $resourceTransformerLocator = null,
+    ) {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $resourceTransformerLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -82,7 +85,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? $aggregationBuilder->hydrate($documentClass)->getAggregation($executeOptions)->getIterator();
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => array_map($transformer, iterator_to_array($result)),
         };

src/Doctrine/Odm/State/ItemProvider.php

@@ -14,7 +14,7 @@
 namespace ApiPlatform\Doctrine\Odm\State;
 
 use ApiPlatform\Doctrine\Common\State\LinksHandlerLocatorTrait;
-use ApiPlatform\Doctrine\Common\State\ModelTransformerLocatorTrait;
+use ApiPlatform\Doctrine\Common\State\ResourceTransformerLocatorTrait;
 use ApiPlatform\Doctrine\Odm\Extension\AggregationItemExtensionInterface;
 use ApiPlatform\Doctrine\Odm\Extension\AggregationResultItemExtensionInterface;
 use ApiPlatform\Metadata\Exception\RuntimeException;
@@ -37,17 +37,20 @@ final class ItemProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
+    use ResourceTransformerLocatorTrait;
     use StateOptionsTrait;
-    use ModelTransformerLocatorTrait;
 
     /**
      * @param AggregationItemExtensionInterface[] $itemExtensions
      */
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry, private readonly iterable $itemExtensions = [], ?ContainerInterface $handleLinksLocator = null)
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry,
+        private readonly iterable $itemExtensions = [],
+        ?ContainerInterface $handleLinksLocator = null,
+        ?ContainerInterface $resourceTransformerLocator = null)
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $resourceTransformerLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -89,7 +92,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? ($aggregationBuilder->hydrate($documentClass)->getAggregation($executeOptions)->getIterator()->current() ?: null);
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => (null !== $result) ? $transformer($result) : null,
         };

src/Doctrine/Odm/State/Options.php

@@ -19,15 +19,15 @@
 class Options extends CommonOptions implements OptionsInterface
 {
     /**
-     * @param mixed $handleLinks       experimental callable, typed mixed as we may want a service name in the future
+     * @param mixed $handleLinks           experimental callable, typed mixed as we may want a service name in the future
      * @param mixed $transformFromDocument experimental callable, typed mixed as we may want a service name in the future
      *
      * @see LinksHandlerInterface
      */
     public function __construct(
         protected ?string $documentClass = null,
-        mixed             $handleLinks = null,
-        mixed             $transformFromDocument = null,
+        mixed $handleLinks = null,
+        mixed $transformFromDocument = null,
     ) {
         parent::__construct(handleLinks: $handleLinks, toResourceTransformer: $transformFromDocument);
     }

src/Doctrine/Orm/State/CollectionProvider.php

@@ -14,7 +14,7 @@
 namespace ApiPlatform\Doctrine\Orm\State;
 
 use ApiPlatform\Doctrine\Common\State\LinksHandlerLocatorTrait;
-use ApiPlatform\Doctrine\Common\State\ModelTransformerLocatorTrait;
+use ApiPlatform\Doctrine\Common\State\ResourceTransformerLocatorTrait;
 use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
 use ApiPlatform\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
@@ -37,17 +37,21 @@ final class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
     use StateOptionsTrait;
 
     /**
      * @param QueryCollectionExtensionInterface[] $collectionExtensions
      */
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry, private readonly iterable $collectionExtensions = [], ?ContainerInterface $handleLinksLocator = null)
+    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
+        ManagerRegistry $managerRegistry,
+        private readonly iterable $collectionExtensions = [],
+        ?ContainerInterface $handleLinksLocator = null,
+        ?ContainerInterface $resourceTransformerLocator = null)
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $resourceTransformerLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -83,7 +87,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? $queryBuilder->getQuery()->getResult();
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => array_map($transformer, iterator_to_array($result)),
         };