PaginatedResult

Author: tatevikg1

src/Common/Dto/CursorPaginationResult.php

@@ -7,9 +7,24 @@
 class CursorPaginationResult
 {
     public function __construct(
-        public readonly array $items,
-        public readonly int $limit,
-        public readonly int $total,
+        private readonly array $items,
+        private readonly int $limit,
+        private readonly int $total,
     ) {
     }
+
+    public function getItems(): array
+    {
+        return $this->items;
+    }
+
+    public function getLimit(): int
+    {
+        return $this->limit;
+    }
+
+    public function getTotal(): int
+    {
+        return $this->total;
+    }
 }

src/Common/Serializer/CursorPaginationNormalizer.php

@@ -15,9 +15,9 @@ class CursorPaginationNormalizer implements NormalizerInterface
      */
     public function normalize($object, string $format = null, array $context = []): array
     {
-        $items = $object->items;
-        $limit = $object->limit;
-        $total = $object->total;
+        $items = $object->getItems();
+        $limit = $object->getLimit();
+        $total = $object->getTotal();
         $hasNext = !empty($items) && isset($items[array_key_last($items)]['id']);
 
         return [

src/Common/Service/Provider/PaginatedDataProvider.php

@@ -37,20 +37,23 @@ public function getPaginatedList(
             throw new RuntimeException('Repository not found');
         }
 
-        $items = $repository->getFilteredAfterId(
+        $result = $repository->getFilteredAfterId(
             lastId: $pagination->afterId,
             limit: $pagination->limit,
             filter: $filter,
         );
-        $total = $repository->count();
 
         $normalizedItems = array_map(
             fn($item) => $normalizer->normalize($item, 'json'),
-            $items
+            $result->getItems()
         );
 
         return $this->paginationNormalizer->normalize(
-            new CursorPaginationResult($normalizedItems, $pagination->limit, $total)
+            new CursorPaginationResult(
+                $normalizedItems,
+                $result->getLimit(),
+                $result->getTotal(),
+            )
         );
     }
 }

tests/Helpers/DummyPaginatableRepository.php

@@ -6,20 +6,21 @@
 
 use Doctrine\ORM\EntityRepository;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
+use PhpList\Core\Domain\Common\Model\PaginatedResult;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
 
 class DummyPaginatableRepository extends EntityRepository implements PaginatableRepositoryInterface
 {
-    public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): array
+    public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): PaginatedResult
     {
-        return [
-            (object)['id' => 1, 'name' => 'Item 1'],
-            (object)['id' => 2, 'name' => 'Item 2'],
-        ];
-    }
-
-    public function count(array $criteria = []): int
-    {
-        return 10;
+        return new PaginatedResult(
+            [
+                (object)['id' => 1, 'name' => 'Item 1'],
+                (object)['id' => 2, 'name' => 'Item 2'],
+            ],
+            2,
+            10,
+            2,
+        );
     }
 }

tests/Integration/Subscription/Controller/SubscriberListControllerTest.php

@@ -313,7 +313,7 @@ public function testGetListMembersWithCurrentSessionKeyForExistingListWithSubscr
                     ],
                 ],
                 'pagination' => [
-                    'total' => 3,
+                    'total' => 2,
                     'limit' => 25,
                     'has_more' => false,
                     'next_cursor' => 2,

tests/Unit/Common/Service/Provider/PaginatedDataProviderTest.php

@@ -5,6 +5,7 @@
 namespace PhpList\RestBundle\Tests\Unit\Common\Service\Provider;
 
 use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Common\Model\PaginatedResult;
 use PhpList\RestBundle\Common\Dto\CursorPaginationResult;
 use PhpList\RestBundle\Common\Request\PaginationCursorRequest;
 use PhpList\RestBundle\Common\Serializer\CursorPaginationNormalizer;
@@ -37,14 +38,16 @@ public function testGetPaginatedListSuccess(): void
         $repository->expects($this->once())
             ->method('getFilteredAfterId')
             ->with(0, 2)
-            ->willReturn([
-                (object)['id' => 1, 'name' => 'Item 1'],
-                (object)['id' => 2, 'name' => 'Item 2'],
-            ]);
-
-        $repository->expects($this->once())
-            ->method('count')
-            ->willReturn(10);
+            ->willReturn(
+                new PaginatedResult([
+                        (object)['id' => 1, 'name' => 'Item 1'],
+                        (object)['id' => 2, 'name' => 'Item 2'],
+                    ],
+                    2,
+                    10,
+                    2,
+                )
+            );
 
         $entityManager->method('getRepository')
             ->willReturn($repository);