Added runtime deprecation to UnitOfWork::commit() and clear() (#9327)

Author: derrabus

lib/Doctrine/ORM/UnitOfWork.php

@@ -340,6 +340,15 @@ public function __construct(EntityManagerInterface $em)
      */
     public function commit($entity = null)
     {
+        if ($entity !== null) {
+            Deprecation::triggerIfCalledFromOutside(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/issues/8459',
+                'Calling %s() with any arguments to commit specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
+                __METHOD__
+            );
+        }
+
         $connection = $this->em->getConnection();
 
         if ($connection instanceof PrimaryReadReplicaConnection) {
@@ -2554,6 +2563,13 @@ public function clear($entityName = null)
             $this->eagerLoadingEntities           =
             $this->orphanRemovals                 = [];
         } else {
+            Deprecation::triggerIfCalledFromOutside(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/issues/8460',
+                'Calling %s() with any arguments to clear specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
+                __METHOD__
+            );
+
             $this->clearIdentityMapForEntityName($entityName);
             $this->clearEntityInsertionsForEntityName($entityName);
         }

tests/Doctrine/Tests/ORM/UnitOfWorkTest.php

@@ -7,6 +7,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\EventManager;
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\EntityNotFoundException;
 use Doctrine\ORM\Events;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -50,6 +51,8 @@
  */
 class UnitOfWorkTest extends OrmTestCase
 {
+    use VerifyDeprecations;
+
     /**
      * SUT
      *
@@ -226,6 +229,9 @@ public function testChangeTrackingNotifyIndividualCommit(): void
 
         $this->_unitOfWork->persist($entity);
         $this->_unitOfWork->persist($entity2);
+
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/issues/8459');
+
         $this->_unitOfWork->commit($entity);
         $this->_unitOfWork->commit();
 
@@ -393,6 +399,8 @@ public function testPersistedEntityAndClearManager(): void
         $this->_unitOfWork->persist($entity2);
         self::assertTrue($this->_unitOfWork->isInIdentityMap($entity2));
 
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/issues/8460');
+
         $this->_unitOfWork->clear(Country::class);
         self::assertTrue($this->_unitOfWork->isInIdentityMap($entity1));
         self::assertFalse($this->_unitOfWork->isInIdentityMap($entity2));
@@ -414,6 +422,8 @@ public function testEntityChangeSetIsNotClearedAfterFlushOnSingleEntity(): void
         $this->_unitOfWork->persist($entity1);
         $this->_unitOfWork->persist($entity2);
 
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/issues/8459');
+
         $this->_unitOfWork->commit($entity1);
         self::assertEmpty($this->_unitOfWork->getEntityChangeSet($entity1));
         self::assertCount(1, $this->_unitOfWork->getEntityChangeSet($entity2));
@@ -436,6 +446,8 @@ public function testEntityChangeSetIsNotClearedAfterFlushOnArrayOfEntities(): vo
         $this->_unitOfWork->persist($entity2);
         $this->_unitOfWork->persist($entity3);
 
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/issues/8459');
+
         $this->_unitOfWork->commit([$entity1, $entity3]);
 
         self::assertEmpty($this->_unitOfWork->getEntityChangeSet($entity1));