Postpone deprecation of string representation of order

In downstream packages that representation is recommended in places where type hints do not allow using an enum yet, which means we would have to modify the public API of downstream packages to allow it. Let us postpone the deprecation until we figure what exactly needs to be done.
doctrine · Feb 27, 2024 · 8fb3eae · 8fb3eae
1 parent c13b813
commit 8fb3eae
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 53 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -6,22 +6,6 @@ awareness about deprecated code.
 - Use of our low-overhead runtime deprecation API, details:
   https://github.com/doctrine/deprecations/
 
-# Upgrade to 2.2
-
-## Deprecated string representation of sort order
-
-Criteria orderings direction is now represented by the
-`Doctrine\Common\Collection\Order` enum.
-
-As a consequence:
-
-- `Criteria::ASC` and `Criteria::DESC` are deprecated in favor of
-  `Order::Ascending` and `Order::Descending`, respectively.
-- `Criteria::getOrderings()` is deprecated in favor of `Criteria::orderings()`,
-  which returns `array<string, Order>`.
-- `Criteria::orderBy()` accepts `array<string, string|Order>`, but passing
-  anything other than `array<string, Order>` is deprecated.
-
 # Upgrade to 2.0
 
 ## BC breaking changes

diff --git a/src/Criteria.php b/src/Criteria.php
@@ -19,10 +19,7 @@
  */
 class Criteria
 {
-    /** @deprecated use Order::Ascending instead */
-    final public const ASC = 'ASC';
-
-    /** @deprecated use Order::Descending instead */
+    final public const ASC  = 'ASC';
     final public const DESC = 'DESC';
 
     private static ExpressionBuilder|null $expressionBuilder = null;
@@ -154,20 +151,10 @@ public function getWhereExpression()
     /**
      * Gets the current orderings of this Criteria.
      *
-     * @deprecated use orderings() instead
-     *
      * @return array<string, string>
      */
     public function getOrderings()
     {
-        Deprecation::trigger(
-            'doctrine/collections',
-            'https://github.com/doctrine/collections/pull/389',
-            'Calling %s() is deprecated. Use %s::orderings() instead.',
-            __METHOD__,
-            self::class,
-        );
-
         return array_map(
             static fn (Order $ordering): string => $ordering->value,
             $this->orderings,
@@ -204,19 +191,6 @@ static function (string|Order $ordering): Order {
                     return $ordering;
                 }
 
-                static $triggered = false;
-
-                if (! $triggered) {
-                    Deprecation::trigger(
-                        'doctrine/collections',
-                        'https://github.com/doctrine/collections/pull/389',
-                        'Passing non-Order enum values to %s() is deprecated. Pass Order enum values instead.',
-                        __METHOD__,
-                    );
-                }
-
-                $triggered = true;
-
                 return strtoupper($ordering) === Order::Ascending->value ? Order::Ascending : Order::Descending;
             },
             $orderings,

diff --git a/tests/CriteriaTest.php b/tests/CriteriaTest.php
@@ -134,29 +134,31 @@ public function testExpr(): void
         self::assertInstanceOf(ExpressionBuilder::class, Criteria::expr());
     }
 
-    public function testPassingNonOrderEnumToOrderByIsDeprecated(): void
+    public function testPassingNonOrderEnumToOrderByStillWorks(): void
     {
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/collections/pull/389');
         $criteria = Criteria::create()->orderBy(['foo' => 'ASC']);
+
+        self::assertEquals(['foo' => Order::Ascending], $criteria->orderings());
     }
 
-    public function testConstructingCriteriaWithNonOrderEnumIsDeprecated(): void
+    public function testConstructingCriteriaWithNonOrderEnumStillWorks(): void
     {
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/collections/pull/389');
         $criteria = new Criteria(null, ['foo' => 'ASC']);
+
+        self::assertEquals(['foo' => Order::Ascending], $criteria->orderings());
     }
 
-    public function testUsingOrderEnumIsTheRightWay(): void
+    public function testUsingOrderEnumInConstructorWorks(): void
     {
-        $this->expectNoDeprecationWithIdentifier('https://github.com/doctrine/collections/pull/389');
         Criteria::create()->orderBy(['foo' => Order::Ascending]);
-        new Criteria(null, ['foo' => Order::Ascending]);
+        $criteria = new Criteria(null, ['foo' => Order::Ascending]);
+
+        self::assertSame(['foo' => Order::Ascending], $criteria->orderings());
     }
 
-    public function testCallingGetOrderingsIsDeprecated(): void
+    public function testCallingGetOrderingsStillReturnsAnArrayOfString(): void
     {
         $criteria = Criteria::create()->orderBy(['foo' => Order::Ascending]);
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/collections/pull/389');
-        $criteria->getOrderings();
+        self::assertSame(['foo' => 'ASC'], $criteria->getOrderings());
     }
 }