[Tree] [NestedSet] [ClosureTree] Allow sorting children by a ManyToOne relation (#2493)

Author: pmishev

CHANGELOG.md

@@ -19,6 +19,9 @@ a release.
 
 ## [Unreleased]
 
+### Fixed
+- Tree: Allow sorting children by a ManyToOne relation (#2492)
+
 ## [3.8.0] - 2022-07-17
 ### Added
 - Sluggable: Add support for `DateTimeImmutable` fields

src/Tree/Entity/Repository/ClosureTreeRepository.php

@@ -152,15 +152,15 @@ public function childrenQueryBuilder($node = null, $direct = false, $sortByField
         if ($sortByField) {
             if (is_array($sortByField)) {
                 foreach ($sortByField as $key => $field) {
-                    $fieldDirection = strtolower(is_array($direction) ? ($direction[$key] ?? 'asc') : $direction);
-                    if ($meta->hasField($field) && in_array($fieldDirection, ['asc', 'desc'], true)) {
+                    $fieldDirection = is_array($direction) ? ($direction[$key] ?? 'asc') : $direction;
+                    if (($meta->hasField($field) || $meta->isSingleValuedAssociation($field)) && in_array(strtolower($fieldDirection), ['asc', 'desc'], true)) {
                         $qb->addOrderBy('node.'.$field, $fieldDirection);
                     } else {
                         throw new InvalidArgumentException(sprintf('Invalid sort options specified: field - %s, direction - %s', $field, $fieldDirection));
                     }
                 }
             } else {
-                if ($meta->hasField($sortByField) && in_array(strtolower($direction), ['asc', 'desc'], true)) {
+                if (($meta->hasField($sortByField) || $meta->isSingleValuedAssociation($sortByField)) && in_array(strtolower($direction), ['asc', 'desc'], true)) {
                     $qb->orderBy('node.'.$sortByField, $direction);
                 } else {
                     throw new InvalidArgumentException(sprintf('Invalid sort options specified: field - %s, direction - %s', $sortByField, $direction));

src/Tree/Entity/Repository/NestedTreeRepository.php

@@ -248,15 +248,15 @@ public function childrenQueryBuilder($node = null, $direct = false, $sortByField
             $qb->orderBy('node.'.$config['left'], 'ASC');
         } elseif (is_array($sortByField)) {
             foreach ($sortByField as $key => $field) {
-                $fieldDirection = strtolower(is_array($direction) ? ($direction[$key] ?? 'asc') : $direction);
-                if ($meta->hasField($field) && in_array($fieldDirection, ['asc', 'desc'], true)) {
+                $fieldDirection = is_array($direction) ? ($direction[$key] ?? 'asc') : $direction;
+                if (($meta->hasField($field) || $meta->isSingleValuedAssociation($field)) && in_array(strtolower($fieldDirection), ['asc', 'desc'], true)) {
                     $qb->addOrderBy('node.'.$field, $fieldDirection);
                 } else {
                     throw new InvalidArgumentException(sprintf('Invalid sort options specified: field - %s, direction - %s', $field, $fieldDirection));
                 }
             }
         } else {
-            if ($meta->hasField($sortByField) && in_array(strtolower($direction), ['asc', 'desc'], true)) {
+            if (($meta->hasField($sortByField) || $meta->isSingleValuedAssociation($sortByField)) && in_array(strtolower($direction), ['asc', 'desc'], true)) {
                 $qb->orderBy('node.'.$sortByField, $direction);
             } else {
                 throw new InvalidArgumentException(sprintf('Invalid sort options specified: field - %s, direction - %s', $sortByField, $direction));

tests/Gedmo/Tree/ClosureTreeRepositoryTest.php

@@ -165,6 +165,21 @@ public function testChildren(): void
         static::assertSame('Oranges', $children[3]->getTitle());
         static::assertSame('Strawberries', $children[4]->getTitle());
 
+        // test sorting by single-valued association field
+        $children = $repo->children($fruits, false, 'parent');
+        static::assertCount(4, $children);
+        static::assertSame('Oranges', $children[0]->getTitle());
+        static::assertSame('Lemons', $children[1]->getTitle());
+        static::assertSame('Berries', $children[2]->getTitle());
+        static::assertSame('Strawberries', $children[3]->getTitle());
+
+        $children = $repo->children($fruits, false, ['parent'], ['ASC']);
+        static::assertCount(4, $children);
+        static::assertSame('Oranges', $children[0]->getTitle());
+        static::assertSame('Lemons', $children[1]->getTitle());
+        static::assertSame('Berries', $children[2]->getTitle());
+        static::assertSame('Strawberries', $children[3]->getTitle());
+
         // direct root nodes
         $children = $repo->children(null, true, 'title');
         static::assertCount(2, $children);

tests/Gedmo/Tree/RepositoryTest.php

@@ -121,6 +121,25 @@ public function testBasicFunctions(): void
         static::assertSame('Carrots', $children[2]->getTitle());
         static::assertSame('Potatoes', $children[3]->getTitle());
 
+        // test sorting by single-valued association field
+        $children = $this->em->getRepository(self::CATEGORY)
+            ->children($food, false, 'parentId');
+
+        static::assertCount(4, $children);
+        static::assertSame('Fruits', $children[0]->getTitle());
+        static::assertSame('Vegitables', $children[1]->getTitle());
+        static::assertSame('Carrots', $children[2]->getTitle());
+        static::assertSame('Potatoes', $children[3]->getTitle());
+
+        $children = $this->em->getRepository(self::CATEGORY)
+            ->children($food, false, ['parentId'], ['ASC']);
+
+        static::assertCount(4, $children);
+        static::assertSame('Fruits', $children[0]->getTitle());
+        static::assertSame('Vegitables', $children[1]->getTitle());
+        static::assertSame('Carrots', $children[2]->getTitle());
+        static::assertSame('Potatoes', $children[3]->getTitle());
+
         // path
 
         $path = $this->em->getRepository(self::CATEGORY)