symfony · makomweb · May 31, 2025 · Jun 22, 2025 · soyuka · Jul 15, 2025
diff --git a/src/Symfony/Component/ObjectMapper/CHANGELOG.md b/src/Symfony/Component/ObjectMapper/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.4
+---
+
+ * Map a collection of source objects via `MapMultiple::yieldMappedObjects()`
+
 7.3
 ---
 

diff --git a/src/Symfony/Component/ObjectMapper/Exception/MapMultipleAggregateException.php b/src/Symfony/Component/ObjectMapper/Exception/MapMultipleAggregateException.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ObjectMapper\Exception;
+
+/**
+ * @experimental
+ *
+ * @author Martin Komischke <martin.komischke@gmail.com>
+ */
+final class MapMultipleAggregateException extends RuntimeException
+{
+    /**
+     * @param array<\Throwable> $innerExceptions The collection of inner exceptions reveals which discrete mapping has failed.
+     */
+    public function __construct(string $message, public readonly array $innerExceptions)
-    public function __construct(string $message, public readonly array $innerExceptions)
+    public function __construct(string $message, public readonly array $exceptions)
-    public function __construct(string $message, public readonly array $innerExceptions)
+    public function __construct(string $message, public readonly array $exceptions)
+    {
+        parent::__construct($message);
+    }
+}
diff --git a/src/Symfony/Component/ObjectMapper/MapMultiple.php b/src/Symfony/Component/ObjectMapper/MapMultiple.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ObjectMapper;
+
+use Symfony\Component\ObjectMapper\Exception\MapMultipleAggregateException;
+
+/**
+ * Map multiple objects using the ObjectMapperInterface
+ *
+ * @experimental
+ *
+ * @author Martin Komischke <martin.komischke@gmail.com>
+ */
+final class MapMultiple implements MapMultipleInterface
-final class MapMultiple implements MapMultipleInterface
+final class CollectionMapper implements CollectionMapperInterface
-final class MapMultiple implements MapMultipleInterface
+final class CollectionMapper implements CollectionMapperInterface
+{
+    public function __construct(private ObjectMapperInterface $mapper)
+    {
+    }
+
+    public function yieldMappedObjects(array $sourceCollection, ?string $target = null): \Generator
+    {
+        $exceptions = [];
+
+        foreach ($sourceCollection as $sourceObject) {
+            try {
+                yield $this->mapper->map($sourceObject, $target);
+            } catch (\Throwable $ex) {
+                $exceptions[] = $ex;
+            }
+        }
+
+        if ($exceptions) {
+            throw new MapMultipleAggregateException('Mapping source collection has failed.', $exceptions);
+        }
+    }
+}
diff --git a/src/Symfony/Component/ObjectMapper/MapMultipleInterface.php b/src/Symfony/Component/ObjectMapper/MapMultipleInterface.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ObjectMapper;
+
+use Symfony\Component\ObjectMapper\Exception\MapMultipleAggregateException;
+
+/**
+ * Map multiple objects using the ObjectMapper
+ *
+ * @experimental
+ *
+ * @author Martin Komischke <martin.komischke@gmail.com>
+ */
+interface MapMultipleInterface
+{
+    /**
+     * @template T of object
+     * 
+     * @param array<T> $sourceCollection The array of objects to map from
+     * @return \Generator<int, object, mixed, void> yields a target object for each source object
+     *
+     * @throws MapMultipleAggregateException      When mapping at least one of the source objects has failed.
+     */
+    public function yieldMappedObjects(array $sourceCollection, string|null $target = null): \Generator;
+}
diff --git a/src/Symfony/Component/ObjectMapper/Tests/MapMultipleTest.php b/src/Symfony/Component/ObjectMapper/Tests/MapMultipleTest.php
@@ -0,0 +1,83 @@
+<?php
+
+namespace Symfony\Component\ObjectMapper\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\ObjectMapper\Exception\MapMultipleAggregateException;
+use Symfony\Component\ObjectMapper\MapMultiple;
+use Symfony\Component\ObjectMapper\ObjectMapper;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\C;
+use Symfony\Component\ObjectMapper\Tests\Fixtures\D;
+
+final class MapMultipleTest extends TestCase
+{
+    public function testMappingSucceeds()
+    {
+        $source = [
+            new C(
+                foo: 'foo1',
+                bar: 'bar1'
+            ),
+            new C(
+                foo: 'foo2',
+                bar: 'bar2'
+            ),
+        ];
+
+        $mapper = new MapMultiple(new ObjectMapper());
+
+        $target = iterator_to_array($mapper->yieldMappedObjects($source, D::class));
+
+        self::assertIsArray($target);
+        self::assertCount(2, $target);
+
+        self::assertInstanceOf(D::class, $target[0]);
+        /** @var D $firstTarget */
+        $firstTarget = $target[0];
+        self::assertSame('foo1', $firstTarget->baz);
+        self::assertSame('bar1', $firstTarget->bat);
+
+        self::assertInstanceOf(D::class, $target[1]);
+        /** @var D $secondTarget */
+        $secondTarget = $target[1];
+        self::assertSame('foo2', $secondTarget->baz);
+        self::assertSame('bar2', $secondTarget->bat);
+    }
+
+    public function testMappingSecondSourceObjectThrows()
+    {
+        $sourceCollection = [
+            new class('value1', 'value2') {
+                public function __construct(
+                    public string $baz,
+                    public string $bat
+                ) {
+                }
+            },
+            new class(/* Nothing to map */) {}
+        ];
+
+        $mapper = new MapMultiple(new ObjectMapper());
+
+        $targetCollection = [];
+
+        try {
+            foreach ($mapper->yieldMappedObjects($sourceCollection, D::class) as $targetObject) {
+                $targetCollection[] = $targetObject;
+            }
+
+            self::fail('Mapping second object should have thrown!');
+        } catch (MapMultipleAggregateException $ex) {
+            self::assertSame('Mapping source collection has failed.', $ex->getMessage());
+            self::assertCount(1, $ex->innerExceptions);
+            self::assertSame('Undefined property: class@anonymous::$baz', $ex->innerExceptions[0]->getMessage());
+        }
+
+        self::assertCount(1, $targetCollection, 'Mapping first object should have passed!');
+        self::assertInstanceOf(D::class, $targetCollection[0]);
+        /** @var D $firstTarget */
+        $firstTarget = $targetCollection[0];
+        self::assertSame('value1', $firstTarget->baz);
+        self::assertSame('value2', $firstTarget->bat);
+    }
+}