[ObjectMapper] embed collection transformer

soyuka · soyuka · commit 36eef03f73b6 · 2025-05-19T10:48:38.000+02:00
diff --git a/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/A.php b/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/A.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection;
+
+use Symfony\Component\ObjectMapper\Attribute\Map;
+use Symfony\Component\ObjectMapper\Transform\MapCollection;
+
+class A
+{
+    #[Map(transform: new MapCollection())]
+    /** @var C[] */
+    public array $foo;
+}
diff --git a/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/B.php b/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/B.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection;
+
+class B
+{
+    /** @var D[] */
+    public array $foo;
+}
diff --git a/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/C.php b/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/C.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection;
+
+use Symfony\Component\ObjectMapper\Attribute\Map;
+
+#[Map(target: D::class)]
+class C
+{
+    public function __construct(
+        #[Map(target: 'baz')]
+        public string $bar
+    ) {}
+}
diff --git a/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/D.php b/src/Symfony/Component/ObjectMapper/Tests/Fixtures/TransformCollection/D.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection;
+
+class D
+{
+    public function __construct(
+        public string $baz
+    ) {}
+}
diff --git a/src/Symfony/Component/ObjectMapper/Tests/ObjectMapperTest.php b/src/Symfony/Component/ObjectMapper/Tests/ObjectMapperTest.php
@@ -51,6 +51,10 @@
 use Symfony\Component\ObjectMapper\Tests\Fixtures\ServiceLocator\B as ServiceLocatorB;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\ServiceLocator\ConditionCallable;
 use Symfony\Component\ObjectMapper\Tests\Fixtures\ServiceLocator\TransformCallable;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection\A as TransformCollectionA;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection\B as TransformCollectionB;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection\C as TransformCollectionC;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\TransformCollection\D as TransformCollectionD;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 
 final class ObjectMapperTest extends TestCase
@@ -291,4 +295,15 @@ public function testMultipleTargetMapProperty()
         $this->assertEquals($c->foo, 'donotmap');
         $this->assertEquals($c->doesNotExistInTargetB, 'foo');
     }
+
+    public function testTransformCollection()
+    {
+        $u = new TransformCollectionA();
+        $u->foo = [new TransformCollectionC('a'), new TransformCollectionC('b')];
+        $mapper = new ObjectMapper();
+
+        $transformed = $mapper->map($u, TransformCollectionB::class);
+
+        $this->assertEquals($transformed->foo, [new TransformCollectionD('a'), new TransformCollectionD('b')]);
+    }
 }
diff --git a/src/Symfony/Component/ObjectMapper/Transform/MapCollection.php b/src/Symfony/Component/ObjectMapper/Transform/MapCollection.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Transform;
+
+use Symfony\Component\ObjectMapper\Exception\MappingException;
+use Symfony\Component\ObjectMapper\ObjectMapper;
+use Symfony\Component\ObjectMapper\ObjectMapperInterface;
+use Symfony\Component\ObjectMapper\TransformCallableInterface;
+
+/**
+ * @template T of object
+ *
+ * @implements TransformCallableInterface<object, T>
+ */
+class MapCollection implements TransformCallableInterface
+{
+    public function __construct(private ?ObjectMapperInterface $objectMapper = new ObjectMapper())
+    {
+    }
+
+    public function __invoke(mixed $value, object $source, ?object $target): mixed
+    {
+        if (!is_iterable($value)) {
+            throw new MappingException(sprintf('The MapCollection transform expects an iterable, "%s" given.', get_debug_type($value)));
+        }
+
+        foreach ($value as &$v) {
+            $v = $this->objectMapper->map($v);
+        }
+
+        return $value;
+    }
+}
