Deprecate mapping relations with targetDocument and discriminatorMap (#2271)

* Deprecate mapping relations with targetDocument and discriminatorMap

* Fix invalid mapping in tests

* Apply suggestions from code review

Co-authored-by: Maciej Malarz <[email protected]>

Co-authored-by: Paweł Niedzielski <[email protected]>
Co-authored-by: Maciej Malarz <[email protected]>

Author: 3 people

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

@@ -1946,6 +1946,16 @@ public function mapField(array $mapping): array
             throw MappingException::repositoryMethodCanNotBeCombinedWithSkipLimitAndSort($this->name, $mapping['fieldName']);
         }
 
+        if (isset($mapping['targetDocument']) && isset($mapping['discriminatorMap'])) {
+            trigger_deprecation(
+                'doctrine/mongodb-odm',
+                '2.2',
+                'Mapping both "targetDocument" and "discriminatorMap" on field "%s" in class "%s" is deprecated. Only one of them can be used at a time',
+                $mapping['fieldName'],
+                $this->name
+            );
+        }
+
         if (isset($mapping['reference']) && $mapping['type'] === 'one') {
             $mapping['association'] = self::REFERENCE_ONE;
         }

tests/Doctrine/ODM/MongoDB/Tests/Functional/DocumentPersisterTest.php

@@ -771,10 +771,6 @@ class DocumentPersisterTestDocument
      * @ODM\EmbedOne(
      *     targetDocument=Doctrine\ODM\MongoDB\Tests\Functional\AbstractDocumentPersisterTestDocumentAssociation::class,
      *     discriminatorField="type",
-     *     discriminatorMap={
-     *         "reference"=Doctrine\ODM\MongoDB\Tests\Functional\DocumentPersisterTestDocumentReference::class,
-     *         "embed"=Doctrine\ODM\MongoDB\Tests\Functional\DocumentPersisterTestDocumentEmbed::class
-     *     },
      *     name="associationName"
      * )
      */
@@ -827,10 +823,6 @@ abstract class AbstractDocumentPersisterTestDocumentAssociation
      * @ODM\EmbedOne(
      *     targetDocument=Doctrine\ODM\MongoDB\Tests\Functional\AbstractDocumentPersisterTestDocumentAssociation::class,
      *     discriminatorField="type",
-     *     discriminatorMap={
-     *         "reference"=Doctrine\ODM\MongoDB\Tests\Functional\DocumentPersisterTestDocumentReference::class,
-     *         "embed"=Doctrine\ODM\MongoDB\Tests\Functional\DocumentPersisterTestDocumentEmbed::class
-     *     },
      *     name="associationName"
      * )
      */

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"=GH267SellerCompany::class, "buyer"=GH267BuyerCompany::class}, inversedBy="users") */
+    /** @ODM\ReferenceOne(name="company", targetDocument=GH267Company::class, inversedBy="users") */
     protected $company;
 
     public function __construct($name)

tests/Doctrine/ODM/MongoDB/Tests/Mapping/AbstractMappingDriverTest.php

@@ -134,10 +134,10 @@ public function testGetAssociationTargetClass($class)
     {
         $this->assertEquals(Address::class, $class->getAssociationTargetClass('address'));
         $this->assertEquals(Group::class, $class->getAssociationTargetClass('groups'));
-        $this->assertEquals(Phonenumber::class, $class->getAssociationTargetClass('phonenumbers'));
+        $this->assertNull($class->getAssociationTargetClass('phonenumbers'));
         $this->assertEquals(Phonenumber::class, $class->getAssociationTargetClass('morePhoneNumbers'));
         $this->assertEquals(Phonenumber::class, $class->getAssociationTargetClass('embeddedPhonenumber'));
-        $this->assertEquals(Phonenumber::class, $class->getAssociationTargetClass('otherPhonenumbers'));
+        $this->assertNull($class->getAssociationTargetClass('otherPhonenumbers'));
     }
 
     /**
@@ -625,7 +625,7 @@ class AbstractMappingDriverUser
     /** @ODM\ReferenceOne(targetDocument=Address::class, cascade={"remove"}) */
     public $address;
 
-    /** @ODM\ReferenceMany(targetDocument=Phonenumber::class, collectionClass=PhonenumberCollection::class, cascade={"persist"}, discriminatorField="discr", discriminatorMap={"home"=HomePhonenumber::class, "work"=WorkPhonenumber::class}, defaultDiscriminatorValue="home") */
+    /** @ODM\ReferenceMany(collectionClass=PhonenumberCollection::class, cascade={"persist"}, discriminatorField="discr", discriminatorMap={"home"=HomePhonenumber::class, "work"=WorkPhonenumber::class}, defaultDiscriminatorValue="home") */
     public $phonenumbers;
 
     /** @ODM\ReferenceMany(targetDocument=Group::class, cascade={"all"}) */
@@ -637,7 +637,7 @@ class AbstractMappingDriverUser
     /** @ODM\EmbedMany(targetDocument=Phonenumber::class, name="embedded_phone_number") */
     public $embeddedPhonenumber;
 
-    /** @ODM\EmbedMany(targetDocument=Phonenumber::class, discriminatorField="discr", discriminatorMap={"home"=HomePhonenumber::class, "work"=WorkPhonenumber::class}, defaultDiscriminatorValue="home") */
+    /** @ODM\EmbedMany(discriminatorField="discr", discriminatorMap={"home"=HomePhonenumber::class, "work"=WorkPhonenumber::class}, defaultDiscriminatorValue="home") */
     public $otherPhonenumbers;
 
     /** @ODM\Field(type="date") */

tests/Doctrine/ODM/MongoDB/Tests/Mapping/xml/Doctrine.ODM.MongoDB.Tests.Mapping.AbstractMappingDriverUser.dcm.xml

@@ -49,7 +49,7 @@
                 <remove />
             </cascade>
         </reference-one>
-        <reference-many target-document="Doctrine\ODM\MongoDB\Tests\Mapping\Phonenumber" collection-class="Doctrine\ODM\MongoDB\Tests\Mapping\PhonenumberCollection" field="phonenumbers">
+        <reference-many collection-class="Doctrine\ODM\MongoDB\Tests\Mapping\PhonenumberCollection" field="phonenumbers">
             <cascade>
                 <persist />
             </cascade>
@@ -69,7 +69,7 @@
         </reference-many>
         <embed-one target-document="Doctrine\ODM\MongoDB\Tests\Mapping\Phonenumber" field-name="embeddedPhonenumber" field="embedded_phone_number">
         </embed-one>
-        <embed-many target-document="Doctrine\ODM\MongoDB\Tests\Mapping\Phonenumber" collection-class="Doctrine\ODM\MongoDB\Tests\Mapping\PhonenumberCollection" field="otherPhonenumbers">
+        <embed-many collection-class="Doctrine\ODM\MongoDB\Tests\Mapping\PhonenumberCollection" field="otherPhonenumbers">
             <discriminator-field name="discr" />
             <discriminator-map>
                 <discriminator-mapping value="home" class="Doctrine\ODM\MongoDB\Tests\Mapping\HomePhonenumber" />