Updated persisting logic to throw exception of class is not listed in…

… discriminator map.
doctrine · Nov 9, 2018 · b577752 · b577752
1 parent dcbff78
commit b577752
Show file tree

Hide file tree

Showing 12 changed files with 150 additions and 156 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/DocumentManager.php b/lib/Doctrine/ODM/MongoDB/DocumentManager.php
@@ -734,27 +734,47 @@ public function createReference(object $document, array $referenceMapping)
          * class that is not defined in the discriminator map may only have a
          * discriminator field and no value, so default to the full class name.
          */
-        if (isset($class->discriminatorField)) {
-            $reference[$class->discriminatorField] = $class->discriminatorValue ?? $class->name;
+        $discriminatorField = null;
+        $discriminatorValue = null;
+        if (isset($referenceMapping['discriminatorField'])) {
+            $discriminatorField = $referenceMapping['discriminatorField'];
+            if (isset($referenceMapping['discriminatorMap'])) {
+                $pos = array_search($class->name, $referenceMapping['discriminatorMap']);
+                if ($pos !== false) {
+                    $discriminatorValue = $pos;
+                }
+            } else {
+                $discriminatorValue = $class->name;
+            }
+        } else {
+            $discriminatorField = $class->discriminatorField;
+            $discriminatorValue = $class->discriminatorValue;
         }
 
+        if (isset($discriminatorField)) {
+            if ($discriminatorValue === null) {
+                throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+            }
+            $reference[$discriminatorField] = $discriminatorValue;
+
         /* Add a discriminator value if the referenced document is not mapped
          * explicitly to a targetDocument class.
          */
-        if (! isset($referenceMapping['targetDocument'])) {
+        } elseif (! isset($referenceMapping['targetDocument'])) {
             $discriminatorField = $referenceMapping['discriminatorField'];
-            $discriminatorValue = isset($referenceMapping['discriminatorMap'])
-                ? array_search($class->name, $referenceMapping['discriminatorMap'])
-                : $class->name;
-
-            /* If the discriminator value was not found in the map, use the full
-             * class name. In the future, it may be preferable to throw an
-             * exception here (perhaps based on some strictness option).
-             *
-             * @see PersistenceBuilder::prepareEmbeddedDocumentValue()
-             */
-            if ($discriminatorValue === false) {
+
+            $discriminatorMap = null;
+            if (isset($referenceMapping['discriminatorMap'])) {
+                $discriminatorMap = $referenceMapping['discriminatorMap'];
+            }
+            if (! isset($discriminatorMap)) {
                 $discriminatorValue = $class->name;
+            } else {
+                $discriminatorValue = array_search($class->name, $discriminatorMap);
+
+                if ($discriminatorValue === false) {
+                    throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+                }
             }
 
             $reference[$discriminatorField] = $discriminatorValue;

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php b/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php
@@ -28,6 +28,7 @@
 use function count;
 use function get_class;
 use function in_array;
+use function interface_exists;
 use function is_array;
 use function is_string;
 use function is_subclass_of;
@@ -1902,6 +1903,28 @@ public function mapField(array $mapping) : array
             $mapping['discriminatorField'] = self::DEFAULT_DISCRIMINATOR_FIELD;
         }
 
+        if (isset($mapping['targetDocument']) && ! class_exists($mapping['targetDocument']) && ! interface_exists($mapping['targetDocument'])) {
+            $fullClassName = $this->reflClass->getNamespaceName() . '\\' . $mapping['targetDocument'];
+            if (! class_exists($fullClassName) && ! interface_exists($mapping['targetDocument'])) {
+                throw MappingException::nonExistingClass($mapping['targetDocument']);
+            }
+
+            $mapping['targetDocument'] = $fullClassName;
+        }
+
+        if (isset($mapping['discriminatorMap'])) {
+            foreach ($mapping['discriminatorMap'] as $value => $targetDocument) {
+                if (class_exists($targetDocument) || interface_exists($targetDocument)) {
+                    continue;
+                }
+                $fullClassName = $this->reflClass->getNamespaceName() . '\\' . $targetDocument;
+                if (! class_exists($fullClassName) && ! interface_exists($targetDocument)) {
+                    throw MappingException::nonExistingClass($fullClassName);
+                }
+                $mapping['discriminatorMap'][$value] = $fullClassName;
+            }
+        }
+
         if (isset($mapping['version'])) {
             $mapping['notSaved'] = true;
             $this->setVersionMapping($mapping);

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/MappingException.php b/lib/Doctrine/ODM/MongoDB/Mapping/MappingException.php
@@ -64,6 +64,11 @@ public static function invalidClassInDiscriminatorMap(string $className, string
         return new self(sprintf("Document class '%s' used in the discriminator map of class '%s' does not exist.", $className, $owningClass));
     }
 
+    public static function unlistedClassInDiscriminatorMap(string $className) : self
+    {
+        return new self(sprintf('Document class "%s" is unlisted in the discriminator map.', $className));
+    }
+
     public static function invalidDiscriminatorValue(string $value, string $owningClass) : self
     {
         return new self(sprintf("Discriminator value '%s' used in the declaration of class '%s' does not exist.", $value, $owningClass));

diff --git a/lib/Doctrine/ODM/MongoDB/Persisters/PersistenceBuilder.php b/lib/Doctrine/ODM/MongoDB/Persisters/PersistenceBuilder.php
@@ -6,6 +6,7 @@
 
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
+use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionInterface;
 use Doctrine\ODM\MongoDB\Types\Type;
 use Doctrine\ODM\MongoDB\UnitOfWork;
@@ -96,7 +97,13 @@ public function prepareInsertData($document)
 
         // add discriminator if the class has one
         if (isset($class->discriminatorField)) {
-            $insertData[$class->discriminatorField] = $class->discriminatorValue ?? $class->name;
+            if ($class->discriminatorValue === null) {
+                if (! empty($class->discriminatorMap)) {
+                    throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+                }
+                $class->discriminatorValue = $class->name;
+            }
+            $insertData[$class->discriminatorField] = $class->discriminatorValue;
         }
 
         return $insertData;
@@ -277,7 +284,13 @@ public function prepareUpsertData($document)
 
         // add discriminator if the class has one
         if (isset($class->discriminatorField)) {
-            $updateData['$set'][$class->discriminatorField] = $class->discriminatorValue ?? $class->name;
+            if ($class->discriminatorValue === null) {
+                if (! empty($class->discriminatorMap)) {
+                    throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+                }
+                $class->discriminatorValue = $class->name;
+            }
+            $updateData['$set'][$class->discriminatorField] = $class->discriminatorValue;
         }
 
         return $updateData;
@@ -377,19 +390,15 @@ public function prepareEmbeddedDocumentValue(array $embeddedMapping, $embeddedDo
         /* Add a discriminator value if the embedded document is not mapped
          * explicitly to a targetDocument class.
          */
-        if (! isset($embeddedMapping['targetDocument'])) {
+        if (! isset($embeddedMapping['targetDocument']) && isset($embeddedMapping['discriminatorField'])) {
             $discriminatorField = $embeddedMapping['discriminatorField'];
-            $discriminatorValue = isset($embeddedMapping['discriminatorMap'])
-                ? array_search($class->name, $embeddedMapping['discriminatorMap'])
-                : $class->name;
-
-            /* If the discriminator value was not found in the map, use the full
-             * class name. In the future, it may be preferable to throw an
-             * exception here (perhaps based on some strictness option).
-             *
-             * @see DocumentManager::createDBRef()
-             */
-            if ($discriminatorValue === false) {
+            if (! empty($embeddedMapping['discriminatorMap'])) {
+                $discriminatorValue = array_search($class->name, $embeddedMapping['discriminatorMap']);
+
+                if ($discriminatorValue === false) {
+                    throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+                }
+            } else {
                 $discriminatorValue = $class->name;
             }
 
@@ -401,7 +410,13 @@ public function prepareEmbeddedDocumentValue(array $embeddedMapping, $embeddedDo
          * discriminator field and no value, so default to the full class name.
          */
         if (isset($class->discriminatorField)) {
-            $embeddedDocumentValue[$class->discriminatorField] = $class->discriminatorValue ?? $class->name;
+            if ($class->discriminatorValue === null) {
+                if (! empty($class->discriminatorMap)) {
+                    throw MappingException::unlistedClassInDiscriminatorMap($class->name);
+                }
+                $class->discriminatorValue = $class->name;
+            }
+            $embeddedDocumentValue[$class->discriminatorField] =  $class->discriminatorValue;
         }
 
         // Ensure empty embedded documents are stored as BSON objects

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/EmbeddedTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/EmbeddedTest.php
@@ -596,7 +596,7 @@ public function testEmbeddedDocumentWithDifferentFieldNameAnnotation()
         $embedded     = new EmbeddedDocumentWithId();
         $embedded->id = (string) new ObjectId();
 
-        $firstEmbedded        = new EmbedDocumentWithAnotherEmbed();
+        $firstEmbedded        = new EmbeddedDocumentWithAnotherEmbedded();
         $firstEmbedded->embed = $embedded;
 
         $secondEmbedded = clone $firstEmbedded;
@@ -668,7 +668,7 @@ class ChangeEmbeddedWithNameAnnotationTest
 /**
  * @ODM\EmbeddedDocument
  */
-class EmbedDocumentWithAnotherEmbed
+class EmbeddedDocumentWithAnotherEmbedded
 {
     /** @ODM\EmbedOne(targetDocument=EmbeddedDocumentWithId::class, name="m_id") */
     public $embed;

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH267Test.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH267Test.php
@@ -67,7 +67,7 @@ class GH267User
     /** @ODM\Field(type="string") */
     protected $name;
 
-    /** @ODM\ReferenceOne(name="company", targetDocument=GH267Company::class, discriminatorMap={"seller"="SellerCompany", "buyer"="BuyerCompany"}, inversedBy="users") */
+    /** @ODM\ReferenceOne(name="company", targetDocument=GH267Company::class, discriminatorMap={"seller"="GH267SellerCompany", "buyer"="GH267BuyerCompany"}, inversedBy="users") */
     protected $company;
 
     public function __construct($name)