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

Author: mrossard

src/Doctrine/Common/State/ModelTransformerLocatorTrait.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;
     }

src/Doctrine/Common/State/Options.php

@@ -24,6 +24,7 @@ final class PersistProcessor implements ProcessorInterface
 {
     use ClassInfoTrait;
     use LinksHandlerTrait;
+    use ResourceTransformerLocatorTrait;
 
     public function __construct(private readonly ManagerRegistry $managerRegistry)
     {

src/Doctrine/Common/State/PersistProcessor.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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;
+    }
+}

src/Doctrine/Common/State/ResourceTransformerLocatorTrait.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;
     }

src/Doctrine/Odm/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;
+    }
+
 }

src/Doctrine/Orm/State/Options.php

@@ -17,7 +17,6 @@
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Tests\Fixtures\TestBundle\Document\TransformedDummyDocument;
-use ApiPlatform\Tests\Fixtures\TestBundle\Entity\TransformedDummyEntity;
 
 #[ApiResource(
     operations : [
@@ -26,7 +25,7 @@
     ],
     stateOptions: new \ApiPlatform\Doctrine\Odm\State\Options(
         documentClass: TransformedDummyDocument::class,
-        transformDocument: [self::class, 'transformModel'],
+        transformFromDocument: [self::class, 'transformToResource'],
     )
 )]
 class TransformedDummyDocumentRessource
@@ -35,7 +34,7 @@ class TransformedDummyDocumentRessource
 
     public ?int $year = null;
 
-    public static function transformModel(TransformedDummyEntity|TransformedDummyDocument $model): self
+    public static function transformToResource(TransformedDummyDocument $model): self
     {
         $resource = new self();
         $resource->id = $model->getId();

tests/Fixtures/TestBundle/ApiResource/TransformedDummyDocumentRessource.php

@@ -17,7 +17,6 @@
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
-use ApiPlatform\Tests\Fixtures\TestBundle\Document\TransformedDummyDocument;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\TransformedDummyEntity;
 
 #[ApiResource(
@@ -27,7 +26,7 @@
     ],
     stateOptions: new Options(
         entityClass: TransformedDummyEntity::class,
-        transformEntity: [self::class, 'transformModel'],
+        transformFromEntity: [self::class, 'transformToResource'],
     )
 )]
 class TransformedDummyEntityRessource
@@ -36,7 +35,7 @@ class TransformedDummyEntityRessource
 
     public ?int $year = null;
 
-    public static function transformModel(TransformedDummyEntity|TransformedDummyDocument $model): self
+    public static function transformToResource(TransformedDummyEntity $model): self
     {
         $resource = new self();
         $resource->id = $model->getId();