bug #38628 [DoctrineBridge] indexBy could reference to association columns (juanmiguelbesada)

nicolas-grekas · nicolas-grekas · commit 6724ca799af2 · 2020-11-09T18:47:11.000+01:00
This PR was squashed before being merged into the 3.4 branch. Discussion ---------- [DoctrineBridge] indexBy could reference to association columns | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #37982  | License | MIT | Doc PR | -  This is my approach to solve #37982. It partials reverts @xabbuh PR #38604 This is my first Symfony contribution, so please, tell me if I need to do something more or something is wrong. Also, this bug affects 4.x and 5.x versions. I think merging in this branches is done automatically. If not, please tell me. Thanks you Commits ------- f9a0e00 failing test for issue 38861 4c36145 [DoctrineBridge] indexBy could reference to association columns
diff --git a/src/Symfony/Bridge/Doctrine/PropertyInfo/DoctrineExtractor.php b/src/Symfony/Bridge/Doctrine/PropertyInfo/DoctrineExtractor.php
@@ -110,10 +110,24 @@ public function getTypes($class, $property, array $context = [])
                 $associationMapping = $metadata->getAssociationMapping($property);
 
                 if (isset($associationMapping['indexBy'])) {
-                    $indexColumn = $associationMapping['indexBy'];
                     /** @var ClassMetadataInfo $subMetadata */
                     $subMetadata = $this->classMetadataFactory->getMetadataFor($associationMapping['targetEntity']);
-                    $typeOfField = $subMetadata->getTypeOfField($subMetadata->getFieldForColumn($indexColumn));
+
+                    // Check if indexBy value is a property
+                    $fieldName = $associationMapping['indexBy'];
+                    if (null === ($typeOfField = $subMetadata->getTypeOfField($fieldName))) {
+                        $fieldName = $subMetadata->getFieldForColumn($associationMapping['indexBy']);
+                        //Not a property, maybe a column name?
+                        if (null === ($typeOfField = $subMetadata->getTypeOfField($fieldName))) {
+                            //Maybe the column name is the association join column?
+                            $associationMapping = $subMetadata->getAssociationMapping($fieldName);
+
+                            /** @var ClassMetadataInfo $subMetadata */
+                            $indexProperty = $subMetadata->getSingleAssociationReferencedJoinColumnName($fieldName);
+                            $subMetadata = $this->classMetadataFactory->getMetadataFor($associationMapping['targetEntity']);
+                            $typeOfField = $subMetadata->getTypeOfField($indexProperty);
+                        }
+                    }
 
                     if (!$collectionKeyType = $this->getPhpType($typeOfField)) {
                         return null;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/DoctrineExtractorTest.php b/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/DoctrineExtractorTest.php
@@ -72,10 +72,13 @@ public function testGetProperties()
         $expected = array_merge($expected, [
             'foo',
             'bar',
+            'indexedRguid',
             'indexedBar',
             'indexedFoo',
+            'indexedBaz',
             'indexedByDt',
             'indexedByCustomType',
+            'indexedBuz',
         ]);
 
         $this->assertEquals(
@@ -151,6 +154,14 @@ public function typesProvider()
                 new Type(Type::BUILTIN_TYPE_INT),
                 new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\DoctrineRelation')
             )]],
+            ['indexedRguid', [new Type(
+                Type::BUILTIN_TYPE_OBJECT,
+                false,
+                'Doctrine\Common\Collections\Collection',
+                true,
+                new Type(Type::BUILTIN_TYPE_STRING),
+                new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\DoctrineRelation')
+            )]],
             ['indexedBar', [new Type(
                 Type::BUILTIN_TYPE_OBJECT,
                 false,
@@ -167,6 +178,14 @@ public function typesProvider()
                 new Type(Type::BUILTIN_TYPE_STRING),
                 new Type(Type::BUILTIN_TYPE_OBJECT, false, 'Symfony\Bridge\Doctrine\Tests\PropertyInfo\Fixtures\DoctrineRelation')
             )]],
+            ['indexedBaz', [new Type(
+                Type::BUILTIN_TYPE_OBJECT,
+                false,
+                Collection::class,
+                true,
+                new Type(Type::BUILTIN_TYPE_INT),
+                new Type(Type::BUILTIN_TYPE_OBJECT, false, DoctrineRelation::class)
+            )]],
             ['simpleArray', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_STRING))]],
             ['customFoo', null],
             ['notMapped', null],
@@ -179,6 +198,14 @@ public function typesProvider()
                 new Type(Type::BUILTIN_TYPE_OBJECT, false, DoctrineRelation::class)
             )]],
             ['indexedByCustomType', null],
+            ['indexedBuz', [new Type(
+                Type::BUILTIN_TYPE_OBJECT,
+                false,
+                Collection::class,
+                true,
+                new Type(Type::BUILTIN_TYPE_STRING),
+                new Type(Type::BUILTIN_TYPE_OBJECT, false, DoctrineRelation::class)
+            )]],
         ];
 
         if (class_exists(Types::class)) {
diff --git a/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/Fixtures/DoctrineDummy.php b/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/Fixtures/DoctrineDummy.php
@@ -41,6 +41,11 @@ class DoctrineDummy
      */
     public $bar;
 
+    /**
+     * @ManyToMany(targetEntity="DoctrineRelation", indexBy="rguid")
+     */
+    protected $indexedRguid;
+
     /**
      * @ManyToMany(targetEntity="DoctrineRelation", indexBy="rguid_column")
      */
@@ -51,6 +56,11 @@ class DoctrineDummy
      */
     protected $indexedFoo;
 
+    /**
+     * @OneToMany(targetEntity="DoctrineRelation", mappedBy="baz", indexBy="baz_id")
+     */
+    protected $indexedBaz;
+
     /**
      * @Column(type="guid")
      */
@@ -122,4 +132,9 @@ class DoctrineDummy
      * @OneToMany(targetEntity="DoctrineRelation", mappedBy="customType", indexBy="customType")
      */
     private $indexedByCustomType;
+
+    /**
+     * @OneToMany(targetEntity="DoctrineRelation", mappedBy="buzField", indexBy="buzField")
+     */
+    protected $indexedBuz;
 }
diff --git a/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/Fixtures/DoctrineRelation.php b/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/Fixtures/DoctrineRelation.php
@@ -40,6 +40,11 @@ class DoctrineRelation
      */
     protected $foo;
 
+    /**
+     * @ManyToOne(targetEntity="DoctrineDummy")
+     */
+    protected $baz;
+
     /**
      * @Column(type="datetime")
      */
@@ -49,4 +54,10 @@ class DoctrineRelation
      * @Column(type="foo")
      */
     private $customType;
+
+    /**
+     * @Column(type="guid", name="different_than_field")
+     * @ManyToOne(targetEntity="DoctrineDummy", inversedBy="indexedBuz")
+     */
+    protected $buzField;
 }
