Deprecate classes related to old commit order computation

doctrine · Jul 4, 2023 · bb21865 · bb21865
1 parent 606da92
commit bb21865
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 0 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,12 @@
 # Upgrade to 2.16
 
+## Deprecated `\Doctrine\ORM\Internal\CommitOrderCalculator` and related classes
+
+With changes made to the commit order computation, the internal classes
+`\Doctrine\ORM\Internal\CommitOrderCalculator`, `\Doctrine\ORM\Internal\CommitOrder\Edge`,
+`\Doctrine\ORM\Internal\CommitOrder\Vertex` and `\Doctrine\ORM\Internal\CommitOrder\VertexState`
+have been deprecated and will be removed in ORM 3.0.
+
 ## Deprecated returning post insert IDs from `EntityPersister::executeInserts()`
 
 Persisters implementing `\Doctrine\ORM\Persisters\Entity\EntityPersister` should no longer

diff --git a/lib/Doctrine/ORM/Internal/CommitOrder/Edge.php b/lib/Doctrine/ORM/Internal/CommitOrder/Edge.php
@@ -4,6 +4,8 @@
 
 namespace Doctrine\ORM\Internal\CommitOrder;
 
+use Doctrine\Deprecations\Deprecation;
+
 /** @internal */
 final class Edge
 {
@@ -27,6 +29,13 @@ final class Edge
 
     public function __construct(string $from, string $to, int $weight)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/orm',
+            'https://github.com/doctrine/orm/pull/10547',
+            'The %s class is deprecated and will be removed in ORM 3.0',
+            self::class
+        );
+
         $this->from   = $from;
         $this->to     = $to;
         $this->weight = $weight;

diff --git a/lib/Doctrine/ORM/Internal/CommitOrder/Vertex.php b/lib/Doctrine/ORM/Internal/CommitOrder/Vertex.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Internal\CommitOrder;
 
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\Mapping\ClassMetadata;
 
 /** @internal */
@@ -32,6 +33,13 @@ final class Vertex
 
     public function __construct(string $hash, ClassMetadata $value)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/orm',
+            'https://github.com/doctrine/orm/pull/10547',
+            'The %s class is deprecated and will be removed in ORM 3.0',
+            self::class
+        );
+
         $this->hash  = $hash;
         $this->value = $value;
     }

diff --git a/lib/Doctrine/ORM/Internal/CommitOrder/VertexState.php b/lib/Doctrine/ORM/Internal/CommitOrder/VertexState.php
@@ -4,6 +4,8 @@
 
 namespace Doctrine\ORM\Internal\CommitOrder;
 
+use Doctrine\Deprecations\Deprecation;
+
 /** @internal */
 final class VertexState
 {
@@ -13,5 +15,11 @@ final class VertexState
 
     private function __construct()
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/orm',
+            'https://github.com/doctrine/orm/pull/10547',
+            'The %s class is deprecated and will be removed in ORM 3.0',
+            self::class
+        );
     }
 }
diff --git a/lib/Doctrine/ORM/Internal/CommitOrderCalculator.php b/lib/Doctrine/ORM/Internal/CommitOrderCalculator.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Internal;
 
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\Internal\CommitOrder\Edge;
 use Doctrine\ORM\Internal\CommitOrder\Vertex;
 use Doctrine\ORM\Internal\CommitOrder\VertexState;
@@ -45,6 +46,16 @@ class CommitOrderCalculator
      */
     private $sortedNodeList = [];
 
+    public function __construct()
+    {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/orm',
+            'https://github.com/doctrine/orm/pull/10547',
+            'The %s class is deprecated and will be removed in ORM 3.0',
+            self::class
+        );
+    }
+
     /**
      * Checks for node (vertex) existence in graph.
      *