feat: add a second hook for resource to entity or document transforma…

…tion
api-platform · Jan 20, 2025 · 9f4cb1a · 9f4cb1a
1 parent 3b26b70
commit 9f4cb1a
Show file tree

Hide file tree

Showing 12 changed files with 132 additions and 84 deletions.
diff --git a/src/Doctrine/Common/State/ModelTransformerLocatorTrait.php b/src/Doctrine/Common/State/ModelTransformerLocatorTrait.php
diff --git a/src/Doctrine/Common/State/Options.php b/src/Doctrine/Common/State/Options.php
@@ -19,10 +19,13 @@ 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 $fromResourceTransformer experimental callable, typed mixed as we may want a service name in the future
      */
     public function __construct(
         protected mixed $handleLinks = null,
-        protected mixed $transformModel = null,
+        protected mixed $toResourceTransformer = null,
+        protected mixed $fromResourceTransformer = null,
     ) {
     }
 
@@ -39,15 +42,28 @@ public function withHandleLinks(mixed $handleLinks): self
         return $self;
     }
 
-    public function getTransformModel(): mixed
+    public function getToResourceTransformer(): mixed
     {
-        return $this->transformModel;
+        return $this->toResourceTransformer;
     }
 
-    public function withTransformModel(mixed $transformModel): self
+    public function withToResourceTransformer(mixed $toResourceTransformer): self
     {
         $self = clone $this;
-        $self->transformModel = $transformModel;
+        $self->toResourceTransformer = $toResourceTransformer;
+
+        return $self;
+    }
+
+    public function getFromResourceTransformer(): mixed
+    {
+        return $this->fromResourceTransformer;
+    }
+
+    public function withFromResourceTransformer(mixed $fromResourceTransformer): self
+    {
+        $self = clone $this;
+        $self->fromResourceTransformer = $fromResourceTransformer;
 
         return $self;
     }

diff --git a/src/Doctrine/Common/State/PersistProcessor.php b/src/Doctrine/Common/State/PersistProcessor.php
@@ -24,6 +24,7 @@ final class PersistProcessor implements ProcessorInterface
 {
     use ClassInfoTrait;
     use LinksHandlerTrait;
+    use ResourceTransformerLocatorTrait;
 
     public function __construct(private readonly ManagerRegistry $managerRegistry)
     {

diff --git a/src/Doctrine/Common/State/ResourceTransformerLocatorTrait.php b/src/Doctrine/Common/State/ResourceTransformerLocatorTrait.php
@@ -0,0 +1,61 @@
+<?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 ApiPlatform\Metadata\Operation;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Maybe merge this and LinksHandlerLocatorTrait into a OptionsHooksLocatorTrait or something similar?
+ */
+trait ResourceTransformerLocatorTrait
+{
+    private ?ContainerInterface $resourceTransformerLocator;
+
+    protected function getToResourceTransformer(Operation $operation): ?callable
+    {
+        if (!($options = $operation->getStateOptions()) || !$options instanceof Options) {
+            return null;
+        }
+
+        $transformer = $options->getToResourceTransformer();
+        if (\is_callable($transformer)) {
+            return $transformer;
+        }
+
+        if ($this->resourceTransformerLocator && \is_string($transformer) && $this->resourceTransformerLocator->has($transformer)) {
+            return [$this->resourceTransformerLocator->get($transformer), 'toResource'];
+        }
+
+        return null;
+    }
+
+    protected function getFromResourceTransformer(Operation $operation): ?callable
+    {
+        if (!($options = $operation->getStateOptions()) || !$options instanceof Options) {
+            return null;
+        }
+
+        $transformer = $options->getFromResourceTransformer();
+        if (\is_callable($transformer)) {
+            return $transformer;
+        }
+
+        if ($this->resourceTransformerLocator && \is_string($transformer) && $this->resourceTransformerLocator->has($transformer)) {
+            return [$this->resourceTransformerLocator->get($transformer), 'fromResource'];
+        }
+
+        return null;
+    }
+}
diff --git a/src/Doctrine/Odm/State/CollectionProvider.php b/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;
@@ -33,7 +33,7 @@ final class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
 
     /**
      * @param AggregationCollectionExtensionInterface[] $collectionExtensions
@@ -42,7 +42,7 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $handleLinksLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -83,7 +83,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? $aggregationBuilder->hydrate($documentClass)->execute($executeOptions);
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => array_map($transformer, iterator_to_array($result)),
         };

diff --git a/src/Doctrine/Odm/State/ItemProvider.php b/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;
@@ -36,7 +36,7 @@ final class ItemProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
 
     /**
      * @param AggregationItemExtensionInterface[] $itemExtensions
@@ -45,7 +45,7 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $handleLinksLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -90,7 +90,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? ($aggregationBuilder->hydrate($documentClass)->execute($executeOptions)->current() ?: null);
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => (null !== $result) ? $transformer($result) : null,
         };

diff --git a/src/Doctrine/Odm/State/Options.php b/src/Doctrine/Odm/State/Options.php
@@ -20,16 +20,16 @@ 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 $transformDocument 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 $transformDocument = null,
+        mixed             $handleLinks = null,
+        mixed             $transformFromDocument = null,
     ) {
-        parent::__construct(handleLinks: $handleLinks, transformModel: $transformDocument);
+        parent::__construct(handleLinks: $handleLinks, toResourceTransformer: $transformFromDocument);
     }
 
     public function getDocumentClass(): ?string
@@ -47,13 +47,13 @@ public function withDocumentClass(?string $documentClass): self
 
     public function getTransformDocument(): mixed
     {
-        return $this->getTransformModel();
+        return $this->getToResourceTransformer();
     }
 
     public function withTransformDocument(mixed $transformDocument): self
     {
         $self = clone $this;
-        $self->transformModel = $transformDocument;
+        $self->toResourceTransformer = $transformDocument;
 
         return $self;
     }

diff --git a/src/Doctrine/Orm/State/CollectionProvider.php b/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;
@@ -36,7 +36,7 @@ final class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
 
     /**
      * @param QueryCollectionExtensionInterface[] $collectionExtensions
@@ -45,7 +45,7 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $handleLinksLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -84,7 +84,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)),
         };

diff --git a/src/Doctrine/Orm/State/ItemProvider.php b/src/Doctrine/Orm/State/ItemProvider.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\QueryItemExtensionInterface;
 use ApiPlatform\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
@@ -36,7 +36,7 @@ final class ItemProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
     use LinksHandlerTrait;
-    use ModelTransformerLocatorTrait;
+    use ResourceTransformerLocatorTrait;
 
     /**
      * @param QueryItemExtensionInterface[] $itemExtensions
@@ -45,7 +45,7 @@ public function __construct(ResourceMetadataCollectionFactoryInterface $resource
     {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->handleLinksLocator = $handleLinksLocator;
-        $this->transformEntityLocator = $handleLinksLocator;
+        $this->resourceTransformerLocator = $handleLinksLocator;
         $this->managerRegistry = $managerRegistry;
     }
 
@@ -90,7 +90,7 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         $result = $result ?? $queryBuilder->getQuery()->getOneOrNullResult();
 
-        return match ($transformer = $this->getEntityTransformer($operation)) {
+        return match ($transformer = $this->getToResourceTransformer($operation)) {
             null => $result,
             default => $transformer($result),
         };

diff --git a/src/Doctrine/Orm/State/Options.php b/src/Doctrine/Orm/State/Options.php
@@ -20,16 +20,17 @@ class Options extends CommonOptions implements OptionsInterface
 {
     /**
      * @param string|callable $handleLinks     experimental callable, typed mixed as we may want a service name in the future
-     * @param string|callable $transformEntity experimental callable, typed mixed as we may want a service name in the future
+     * @param string|callable $transformFromEntity experimental callable, typed mixed as we may want a service name in the future
      *
      * @see LinksHandlerInterface
      */
     public function __construct(
         protected ?string $entityClass = null,
-        mixed $handleLinks = null,
-        mixed $transformEntity = null,
+        mixed             $handleLinks = null,
+        mixed             $transformFromEntity = null,
+        mixed             $transformToEntity = null,
     ) {
-        parent::__construct(handleLinks: $handleLinks, transformModel: $transformEntity);
+        parent::__construct(handleLinks: $handleLinks, toResourceTransformer: $transformFromEntity, fromResourceTransformer: $transformToEntity);
     }
 
     public function getEntityClass(): ?string
@@ -45,16 +46,30 @@ public function withEntityClass(?string $entityClass): self
         return $self;
     }
 
-    public function getTransformDocument(): mixed
+    public function getTransformFromEntity(): mixed
     {
-        return $this->getTransformModel();
+        return $this->getToResourceTransformer();
     }
 
-    public function withTransformDocument(mixed $transformEntity): self
+    public function withTransformFromEntity(mixed $transformFromEntity): self
     {
         $self = clone $this;
-        $self->transformModel = $transformEntity;
+        $self->toResourceTransformer = $transformFromEntity;
 
         return $self;
     }
+
+    public function getTransformToEntity(): mixed
+    {
+        return $this->getFromResourceTransformer();
+    }
+
+    public function withTransformToEntity(mixed $transformToEntity): self
+    {
+        $self = clone $this;
+        $self->fromResourceTransformer = $transformToEntity;
+
+        return $self;
+    }
+
 }