Prevents incorrect table aliases to be generated

When a defined subclass has a case typo, the query builder will be lost and will generate exotic table alias. This commit fixes the issue at the root by prohibiting case typo in discriminator map. See doctrine#8112 for the consequence of such typo.
gquemener · Apr 24, 2020 · cad84ac · cad84ac
1 parent 73ec483
commit cad84ac
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 0 deletions.
diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php b/lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
@@ -2816,6 +2816,11 @@ public function addDiscriminatorMapClass($name, $className)
             throw MappingException::invalidClassInDiscriminatorMap($className, $this->name);
         }
 
+        $refl = new ReflectionClass($className);
+        if ($refl->name !== $className) {
+            throw MappingException::invalidClassInDiscriminatorMap($className, $this->name);
+        }
+
         if (is_subclass_of($className, $this->name) && ! in_array($className, $this->subClasses)) {
             $this->subClasses[] = $className;
         }

diff --git a/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php b/tests/Doctrine/Tests/ORM/Mapping/AbstractMappingDriverTest.php
@@ -1079,6 +1079,14 @@ public function testDiscriminatorColumnDefaultName()
         $this->assertEquals('dtype', $class->discriminatorColumn['name']);
     }
 
+    /**
+     * @expectedException \Doctrine\ORM\Mapping\MappingException
+     * @expectedExceptionMessage Entity class 'Doctrine\Tests\ORM\Mapping\cube' used in the discriminator map of class 'Doctrine\Tests\ORM\Mapping\Shape' does not exist.
+     */
+    public function testInvalidSubClassCase()
+    {
+        $this->createClassMetadata(Shape::class);
+    }
 }
 
 /**
@@ -1344,6 +1352,47 @@ public static function loadMetadata(ClassMetadataInfo $metadata)
     }
 }
 
+/**
+ * @Entity
+ * @InheritanceType("SINGLE_TABLE")
+ * @DiscriminatorMap({"cube" = cube::class})
+ * @DiscriminatorColumn(name="discr", length=32, type="string")
+ */
+abstract class Shape
+{
+    /** @Id @Column(type="string") @GeneratedValue(strategy="AUTO") */
+    public $id;
+
+    public static function loadMetadata(ClassMetadataInfo $metadata)
+    {
+        $metadata->setInheritanceType(ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE);
+        $metadata->setDiscriminatorColumn([
+            'name' => 'discr',
+            'type' => 'string',
+            'length' => 32,
+        ]);
+        $metadata->setDiscriminatorMap([
+            'cube' => cube::class,
+        ]);
+        $metadata->mapField([
+            'fieldName' => 'id',
+            'type' => 'string',
+            'length' => NULL,
+            'precision' => 0,
+            'scale' => 0,
+            'nullable' => false,
+            'unique' => false,
+            'id' => true,
+            'columnName' => 'id',
+        ]);
+        $metadata->setIdGeneratorType(ClassMetadataInfo::GENERATOR_TYPE_AUTO);
+    }
+}
+
+/** @Entity */
+class Cube extends Shape
+{
+}
 
 /**
  * @Entity

diff --git a/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Shape.php b/tests/Doctrine/Tests/ORM/Mapping/php/Doctrine.Tests.ORM.Mapping.Shape.php
@@ -0,0 +1,27 @@
+<?php
+
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\Tests\ORM\Mapping\cube;
+
+/* @var $metadata ClassMetadataInfo */
+$metadata->setInheritanceType(ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE);
+$metadata->setDiscriminatorColumn([
+   'name' => 'discr',
+   'type' => 'string',
+   'length' => 32,
+]);
+$metadata->setDiscriminatorMap([
+   'cube' => cube::class,
+]);
+$metadata->mapField([
+   'fieldName' => 'id',
+   'type' => 'string',
+   'length' => NULL,
+   'precision' => 0,
+   'scale' => 0,
+   'nullable' => false,
+   'unique' => false,
+   'id' => true,
+   'columnName' => 'id',
+]);
+$metadata->setIdGeneratorType(ClassMetadataInfo::GENERATOR_TYPE_AUTO);
diff --git a/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Shape.dcm.xml b/tests/Doctrine/Tests/ORM/Mapping/xml/Doctrine.Tests.ORM.Mapping.Shape.dcm.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                          https://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
+    <entity name="Doctrine\Tests\ORM\Mapping\Shape" inheritance-type="SINGLE_TABLE">
+        <discriminator-column name="discr" type="string" length="32" />
+        <discriminator-map>
+            <discriminator-mapping value="cube" class="Doctrine\Tests\ORM\Mapping\cube" />
+        </discriminator-map>
+        <id name="id" type="integer" column="id">
+            <generator strategy="AUTO" />
+        </id>
+    </entity>
+</doctrine-mapping>
diff --git a/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Shape.dcm.yml b/tests/Doctrine/Tests/ORM/Mapping/yaml/Doctrine.Tests.ORM.Mapping.Shape.dcm.yml
@@ -0,0 +1,14 @@
+Doctrine\Tests\ORM\Mapping\Shape:
+  type: entity
+  inheritanceType: SINGLE_TABLE
+  discriminatorMap:
+    cube: Doctrine\Tests\ORM\Mapping\cube
+  discriminatorColumn:
+    type: string
+    name: discr
+    length: 32
+  id:
+    id:
+      type: integer
+      generator:
+        strategy: AUTO