[ObjectMapper] embed collection transformer

symfony · soyuka · May 17, 2025 · May 19, 2025 · May 20, 2025 · May 19, 2025
commit 2da896ae63462004abb2b127774e78d7487a37b4
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,42 @@
+<?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\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;
+    }
+}
-Original file line number
+Diff line change
@@ -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;
       Comment on lines

    
      +54
     to 
      +57
    

  

  



  
    
        
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            GromNaN
  

      

      

      


        May 19, 2025


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I would make the classe names longer instead of using an alias. It's simpler to call the class by its name.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            soyuka
  

      

      

      


        May 19, 2025


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      its nitpicking as these are test fixtures I don't see the benefits
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
     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')]);
                   soyuka marked this conversation as resolved.
              

          
            Show resolved
            Hide resolved
        

                
  
            
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.
+        }
     }