Merge pull request #2271 from antograssiot/queryJoinParser-cleanup

Deprecate dead code in QueryJoinParser and remove internal usage

Author: dunglas

src/Bridge/Doctrine/Orm/Util/QueryChecker.php

@@ -95,7 +95,7 @@ public static function hasOrderByOnToManyJoin(QueryBuilder $queryBuilder, Manage
 
         $orderByAliases = [];
         foreach ($orderByParts as $orderBy) {
-            $parts = QueryJoinParser::getOrderByParts($orderBy);
+            $parts = $orderBy->getParts();
 
             foreach ($parts as $part) {
                 $pos = strpos($part, '.');
@@ -111,12 +111,12 @@ public static function hasOrderByOnToManyJoin(QueryBuilder $queryBuilder, Manage
 
         foreach ($joinParts as $joins) {
             foreach ($joins as $join) {
-                $alias = QueryJoinParser::getJoinAlias($join);
+                $alias = $join->getAlias();
 
                 if (!isset($orderByAliases[$alias])) {
                     continue;
                 }
-                $relationship = QueryJoinParser::getJoinRelationship($join);
+                $relationship = $join->getJoin();
 
                 if (false !== strpos($relationship, '.')) {
                     /*

src/Bridge/Doctrine/Orm/Util/QueryJoinParser.php

@@ -48,8 +48,8 @@ public static function getClassMetadataFromJoinAlias(string $alias, QueryBuilder
             $aliasMap[$rootAlias] = 'root';
 
             foreach ($joins as $join) {
-                $alias = self::getJoinAlias($join);
-                $relationship = self::getJoinRelationship($join);
+                $alias = $join->getAlias();
+                $relationship = $join->getJoin();
 
                 $pos = strpos($relationship, '.');
 
@@ -100,6 +100,8 @@ public static function getClassMetadataFromJoinAlias(string $alias, QueryBuilder
      */
     public static function getJoinRelationship(Join $join): string
     {
+        @trigger_error(sprintf('The use of "%s::getJoinRelationship()" is deprecated since 2.3 and will be removed in 3.0. Use "%s::getJoin()" directly instead.', __CLASS__, Join::class), E_USER_DEPRECATED);
+
         return $join->getJoin();
     }
 
@@ -108,17 +110,20 @@ public static function getJoinRelationship(Join $join): string
      */
     public static function getJoinAlias(Join $join): string
     {
+        @trigger_error(sprintf('The use of "%s::getJoinAlias()" is deprecated since 2.3 and will be removed in 3.0. Use "%s::getAlias()" directly instead.', __CLASS__, Join::class), E_USER_DEPRECATED);
+
         return $join->getAlias();
     }
 
     /**
      * Gets the parts from an OrderBy expression.
      *
-     *
      * @return string[]
      */
     public static function getOrderByParts(OrderBy $orderBy): array
     {
+        @trigger_error(sprintf('The use of "%s::getOrderByParts()" is deprecated since 2.3 and will be removed in 3.0. Use "%s::getParts()" directly instead.', __CLASS__, OrderBy::class), E_USER_DEPRECATED);
+
         return $orderBy->getParts();
     }
 }

tests/Bridge/Doctrine/Orm/Util/QueryJoinParserTest.php

@@ -43,30 +43,50 @@ public function testGetClassMetadataFromJoinAlias()
         $this->assertEquals($metadata, $classMetadata->reveal());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The use of "ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryJoinParser::getJoinRelationship()" is deprecated since 2.3 and will be removed in 3.0. Use "Doctrine\ORM\Query\Expr\Join::getJoin()" directly instead.
+     */
     public function testGetJoinRelationshipWithJoin()
     {
         $join = new Join('INNER_JOIN', 'a_1.relatedDummy', 'a_1', null, 'a_1.name = r.name');
         $this->assertEquals('a_1.relatedDummy', QueryJoinParser::getJoinRelationship($join));
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The use of "ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryJoinParser::getJoinRelationship()" is deprecated since 2.3 and will be removed in 3.0. Use "Doctrine\ORM\Query\Expr\Join::getJoin()" directly instead.
+     */
     public function testGetJoinRelationshipWithClassJoin()
     {
         $join = new Join('INNER_JOIN', RelatedDummy::class, 'a_1', null, 'a_1.name = r.name');
         $this->assertEquals(RelatedDummy::class, QueryJoinParser::getJoinRelationship($join));
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The use of "ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryJoinParser::getJoinAlias()" is deprecated since 2.3 and will be removed in 3.0. Use "Doctrine\ORM\Query\Expr\Join::getAlias()" directly instead.
+     */
     public function testGetJoinAliasWithJoin()
     {
         $join = new Join('INNER_JOIN', 'relatedDummy', 'a_1', null, 'a_1.name = r.name');
         $this->assertEquals('a_1', QueryJoinParser::getJoinAlias($join));
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The use of "ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryJoinParser::getJoinAlias()" is deprecated since 2.3 and will be removed in 3.0. Use "Doctrine\ORM\Query\Expr\Join::getAlias()" directly instead.
+     */
     public function testGetJoinAliasWithClassJoin()
     {
         $join = new Join('LEFT_JOIN', RelatedDummy::class, 'a_1', null, 'a_1.name = r.name');
         $this->assertEquals('a_1', QueryJoinParser::getJoinAlias($join));
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The use of "ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryJoinParser::getOrderByParts()" is deprecated since 2.3 and will be removed in 3.0. Use "Doctrine\ORM\Query\Expr\OrderBy::getParts()" directly instead.
+     */
     public function testGetOrderByPartsWithOrderBy()
     {
         $orderBy = new OrderBy('name', 'asc');