Add: PaginatedFilter

Author: tatevikg1

src/Common/Service/Provider/PaginatedDataProvider.php

@@ -27,7 +27,7 @@ public function getPaginatedList(
         Request $request,
         NormalizerInterface $normalizer,
         string $className,
-        FilterRequestInterface $filter = null
+        FilterRequestInterface $filter
     ): array {
         $pagination = $this->paginationFactory->fromRequest($request);
 
@@ -37,11 +37,10 @@ public function getPaginatedList(
             throw new RuntimeException('Repository not found');
         }
 
-        $result = $repository->getFilteredAfterId(
-            lastId: $pagination->afterId,
-            limit: $pagination->limit,
-            filter: $filter,
-        );
+        $filter->setLimit($pagination->limit);
+        $filter->setLastId($pagination->afterId);
+
+        $result = $repository->getFilteredAfterId(filter: $filter);
 
         $normalizedItems = array_map(
             fn($item) => $normalizer->normalize($item, 'json'),
@@ -50,9 +49,9 @@ public function getPaginatedList(
 
         return $this->paginationNormalizer->normalize(
             new CursorPaginationResult(
-                $normalizedItems,
-                $result->getLimit(),
-                $result->getTotal(),
+                items: $normalizedItems,
+                limit: $result->getLimit(),
+                total: $result->getTotal(),
             )
         );
     }

src/Identity/Controller/AdminAttributeDefinitionController.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Identity\Model\AdminAttributeDefinition;
 use PhpList\Core\Domain\Identity\Service\Manager\AdminAttributeDefinitionManager;
 use PhpList\Core\Security\Authentication;
@@ -279,9 +280,10 @@ public function getPaginated(Request $request): JsonResponse
 
         return $this->json(
             $this->paginatedDataProvider->getPaginatedList(
-                $request,
-                $this->normalizer,
-                AdminAttributeDefinition::class,
+                request: $request,
+                normalizer: $this->normalizer,
+                className: AdminAttributeDefinition::class,
+                filter: new PaginatedFilter(),
             ),
             Response::HTTP_OK
         );

src/Identity/Controller/AdministratorController.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Identity\Model\Administrator;
 use PhpList\Core\Domain\Identity\Service\Manager\AdministratorManager;
 use PhpList\Core\Security\Authentication;
@@ -102,7 +103,12 @@ public function getAdministrators(Request $request): JsonResponse
         $this->requireAuthentication($request);
 
         return $this->json(
-            $this->paginatedProvider->getPaginatedList($request, $this->normalizer, Administrator::class),
+            $this->paginatedProvider->getPaginatedList(
+                request: $request,
+                normalizer: $this->normalizer,
+                className: Administrator::class,
+                filter: new PaginatedFilter(),
+            ),
             Response::HTTP_OK
         );
     }

src/Messaging/Controller/TemplateController.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Messaging\Model\Template;
 use PhpList\Core\Domain\Messaging\Service\Manager\TemplateManager;
 use PhpList\Core\Security\Authentication;
@@ -108,6 +109,7 @@ public function getTemplates(Request $request): JsonResponse
                 request: $request,
                 normalizer: $this->normalizer,
                 className: Template::class,
+                filter: new PaginatedFilter(),
             ),
             Response::HTTP_OK
         );

src/Subscription/Controller/SubscriberAttributeDefinitionController.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Subscription\Model\SubscriberAttributeDefinition;
 use PhpList\Core\Domain\Subscription\Repository\SubscriberAttributeDefinitionRepository;
 use PhpList\Core\Domain\Subscription\Service\Manager\AttributeDefinitionManager;
@@ -282,9 +283,10 @@ public function getPaginated(Request $request): JsonResponse
 
         return $this->json(
             $this->paginatedDataProvider->getPaginatedList(
-                $request,
-                $this->normalizer,
-                SubscriberAttributeDefinition::class,
+                request: $request,
+                normalizer: $this->normalizer,
+                className: SubscriberAttributeDefinition::class,
+                filter: new PaginatedFilter(),
             ),
             Response::HTTP_OK
         );

src/Subscription/Controller/SubscriberListController.php

@@ -6,6 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilter;
 use PhpList\Core\Domain\Subscription\Model\SubscriberList;
 use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberListManager;
 use PhpList\Core\Security\Authentication;
@@ -108,7 +109,12 @@ public function getLists(Request $request): JsonResponse
         $this->requireAuthentication($request);
 
         return $this->json(
-            $this->paginatedDataProvider->getPaginatedList($request, $this->normalizer, SubscriberList::class),
+            $this->paginatedDataProvider->getPaginatedList(
+                request: $request,
+                normalizer: $this->normalizer,
+                className: SubscriberList::class,
+                filter: new PaginatedFilter(),
+            ),
             Response::HTTP_OK
         );
     }

tests/Helpers/DummyPaginatableRepository.php

@@ -11,7 +11,7 @@
 
 class DummyPaginatableRepository extends EntityRepository implements PaginatableRepositoryInterface
 {
-    public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): PaginatedResult
+    public function getFilteredAfterId(FilterRequestInterface $filter): PaginatedResult
     {
         return new PaginatedResult(
             [

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\Filter\PaginatedFilter;
 use PhpList\RestBundle\Common\Dto\CursorPaginationResult;
 use PhpList\RestBundle\Common\Request\PaginationCursorRequest;
 use PhpList\RestBundle\Common\Serializer\CursorPaginationNormalizer;
@@ -53,7 +54,12 @@ public function testGetPaginatedListSuccess(): void
 
         $provider = new PaginatedDataProvider($paginationNormalizer, $paginationFactory, $entityManager);
 
-        $result = $provider->getPaginatedList($request, $normalizer, 'Some\\Entity\\Class');
+        $result = $provider->getPaginatedList(
+            request: $request,
+            normalizer: $normalizer,
+            className: 'Some\\Entity\\Class',
+            filter: new PaginatedFilter(),
+        );
 
         $this->assertIsArray($result);
         $this->assertArrayHasKey('items', $result);
@@ -80,6 +86,11 @@ public function testThrowsIfRepositoryIsNotPaginatable(): void
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage('Repository not found');
 
-        $provider->getPaginatedList($request, $normalizer, 'NonPaginatableClass');
+        $provider->getPaginatedList(
+            request: $request,
+            normalizer: $normalizer,
+            className: 'NonPaginatableClass',
+            filter: new PaginatedFilter(),
+        );
     }
 }