* rename prop $orderByDesc and its get/setter to $isOrderByDesc @ BaseQuery

* rename param `$orderByDesc` to `$isOrderByDesc` @ `App\Tests\PostsQuery\PostsTreeTest::testReOrderNestedPosts()`, `PostsTree::reOrderNestedPosts()` & `setSortingKeyForSortablePost()`

* rename param `$orderByDesc` to `$isOrderByDesc` @ `setResult()`
* rename var `$results` to `$result` @ `getQueryResult()`
@ `QueryResult`
@ `App\PostsQuery`
@ be

Author: n0099

be/src/PostsQuery/BaseQuery.php

@@ -6,7 +6,7 @@
 {
     private string $orderByField;
 
-    private bool $orderByDesc;
+    private bool $isOrderByDesc;
 
     public function __construct(
         public QueryResult $queryResult,
@@ -28,12 +28,12 @@ protected function setOrderByField(string $value): self
 
     public function isOrderByDesc(): bool
     {
-        return $this->orderByDesc;
+        return $this->isOrderByDesc;
     }
 
-    protected function setOrderByDesc(bool $value): self
+    protected function setIsOrderByDesc(bool $value): self
     {
-        $this->orderByDesc = $value;
+        $this->isOrderByDesc = $value;
         return $this;
     }
 }

be/src/PostsQuery/PostsTree.php

@@ -127,24 +127,24 @@ public function nestPostsWithParent(): Collection
     public function reOrderNestedPosts(
         Collection $nestedPosts,
         string $orderByField,
-        bool $orderByDesc,
+        bool $isOrderByDesc,
     ): Collection {
         $sortBySortingKey = static fn(Collection $posts): Collection => $posts
-            ->sortBy(fn(SortablePost $post) => $post->getSortingKey(), descending: $orderByDesc)
+            ->sortBy(fn(SortablePost $post) => $post->getSortingKey(), descending: $isOrderByDesc)
             ->values(); // reset keys
         $getOrderByProp = 'get' . ucfirst($orderByField);
         return $sortBySortingKey($nestedPosts->map(
-            function (Thread $thread) use ($getOrderByProp, $orderByDesc, $sortBySortingKey): Thread {
+            function (Thread $thread) use ($getOrderByProp, $isOrderByDesc, $sortBySortingKey): Thread {
                 $thread->setReplies($sortBySortingKey($thread->getReplies()->map(
-                    function (Reply $reply) use ($getOrderByProp, $orderByDesc): Reply {
+                    function (Reply $reply) use ($getOrderByProp, $isOrderByDesc): Reply {
                         $reply->setSubReplies($reply->getSubReplies()->sortBy(
                             fn(SubReply $subReplies) => $subReplies->{$getOrderByProp}(),
-                            descending: $orderByDesc,
+                            descending: $isOrderByDesc,
                         )->values()); // reset keys
-                        return $this->setSortingKeyForSortablePost($reply, $reply->getSubReplies(), $getOrderByProp, $orderByDesc);
+                        return $this->setSortingKeyForSortablePost($reply, $reply->getSubReplies(), $getOrderByProp, $isOrderByDesc);
                     },
                 )));
-                $this->setSortingKeyForSortablePost($thread, $thread->getReplies(), $getOrderByProp, $orderByDesc);
+                $this->setSortingKeyForSortablePost($thread, $thread->getReplies(), $getOrderByProp, $isOrderByDesc);
                 return $thread;
             },
         ));
@@ -160,7 +160,7 @@ private function setSortingKeyForSortablePost(
         SortablePost $currentPost,
         Collection $subPosts,
         string $getOrderByProp,
-        bool $orderByDesc,
+        bool $isOrderByDesc,
     ): SortablePost {
         // use the topmost value between sorting key or value of orderBy field within its sub-posts
         /* @var ?(T is Thread ? Reply : (T is Reply ? SubReply : never)) $firstSubPost */
@@ -185,7 +185,7 @@ private function setSortingKeyForSortablePost(
 
         // Collection->filter() will remove falsy values like null
         $currentAndSubPostSortingKeys = $currentAndSubPostSortingKeys->filter()->sort();
-        $currentPost->setSortingKey($orderByDesc
+        $currentPost->setSortingKey($isOrderByDesc
             ? $currentAndSubPostSortingKeys->last()
             : $currentAndSubPostSortingKeys->first());
 

be/src/PostsQuery/Query.php

@@ -41,7 +41,7 @@ public function query(QueryParams $params, ?string $cursor): void
 
         $orderByParam = $params->pick('orderBy')[0];
         $this->setOrderByField($orderByParam->value === 'default' ? 'postedAt' : $orderByParam->value)
-            ->setOrderByDesc($orderByParam->value === 'default'
+            ->setIsOrderByDesc($orderByParam->value === 'default'
                 ? $queryByPostIDParamsName->isEmpty()
                 : $orderByParam->getSub('direction') === 'DESC');
 

be/src/PostsQuery/QueryResult.php

@@ -65,13 +65,13 @@ public function getQueryResult(QueryBuilder $queryBuilder, int $limit): array
             Helper::abortAPIIf(40006, $plansCost > $planCostLimit);
         }
 
-        $results = collect($query->getResult());
-        if ($results->count() === $maxResults) {
-            $results->pop();
+        $result = collect($query->getResult());
+        if ($result->count() === $maxResults) {
+            $result->pop();
             $hasMorePages = true;
         }
         return [
-            'result' => $results,
+            'result' => $result,
             'hasMorePages' => $hasMorePages ?? false,
             'query' => $rawSQL,
             'queryPlan' => $explainJSON
@@ -83,7 +83,7 @@ public function setResult(
         Collection $queries,
         ?string $cursorParamValue,
         string $orderByField,
-        bool $orderByDesc,
+        bool $isOrderByDesc,
         Collection $queryByPostIDParamsName,
     ): void {
         $this->stopwatch->start('setResult');
@@ -95,8 +95,8 @@ public function setResult(
             $queries = $queries->intersectByKeys($cursorsKeyByPostType);
         }
 
-        $queries->each(function (QueryBuilder $qb, string $postType) use ($orderByDesc, $orderByField, $cursorsKeyByPostType) {
-            $qb->addOrderBy("t.$orderByField", $orderByDesc === true ? 'DESC' : 'ASC')
+        $queries->each(function (QueryBuilder $qb, string $postType) use ($isOrderByDesc, $orderByField, $cursorsKeyByPostType) {
+            $qb->addOrderBy("t.$orderByField", $isOrderByDesc === true ? 'DESC' : 'ASC')
                 // cursor paginator requires values of orderBy column are unique
                 // if not it should fall back to other unique field (here is the post ID primary key)
                 // https://use-the-index-luke.com/no-offset
@@ -110,7 +110,7 @@ public function setResult(
                 return;
             }
             $comparisons = $cursors->keys()->map(
-                fn(string $fieldName): Comparison => $orderByDesc
+                fn(string $fieldName): Comparison => $isOrderByDesc
                     ? $qb->expr()->lt("t.$fieldName", ":cursor_$fieldName")
                     : $qb->expr()->gt("t.$fieldName", ":cursor_$fieldName"),
             );

be/tests/PostsQuery/PostsTreeTest.php

@@ -24,9 +24,9 @@ protected function setUp(): void
     }
 
     #[DataProvider('provideReOrderNestedPostsData')]
-    public function testReOrderNestedPosts(Collection $input, bool $orderByDesc, Collection $expected): void
+    public function testReOrderNestedPosts(Collection $input, bool $isOrderByDesc, Collection $expected): void
     {
-        self::assertEquals($expected, $this->sut->reOrderNestedPosts($input, 'postedAt', $orderByDesc));
+        self::assertEquals($expected, $this->sut->reOrderNestedPosts($input, 'postedAt', $isOrderByDesc));
     }
 
     public static function provideReOrderNestedPostsData(): array