Ref: FilterRequestInterface

Author: tatevikg1

src/Domain/Analytics/Service/AnalyticsService.php

@@ -9,6 +9,7 @@
 use PhpList\Core\Domain\Analytics\Repository\UserMessageViewRepository;
 use PhpList\Core\Domain\Analytics\Service\Manager\LinkTrackManager;
 use PhpList\Core\Domain\Analytics\Service\Manager\UserMessageViewManager;
+use PhpList\Core\Domain\Messaging\Model\Filter\MessageFilter;
 use PhpList\Core\Domain\Messaging\Repository\MessageRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageBounceRepository;
 use PhpList\Core\Domain\Messaging\Repository\UserMessageForwardRepository;
@@ -48,7 +49,9 @@ public function __construct(
      */
     public function getCampaignStatistics(int $limit = 50, int $lastId = 0): array
     {
-        $messages = $this->messageRepository->getFilteredAfterId($lastId, $limit)->getItems();
+        $messages = $this->messageRepository
+            ->getFilteredAfterId((new MessageFilter())->setLastId($lastId)->setLimit($limit))
+            ->getItems();
 
         $campaignStats = [];
         foreach ($messages as $message) {
@@ -105,7 +108,8 @@ public function getCampaignStatistics(int $limit = 50, int $lastId = 0): array
      */
     public function getViewOpensStatistics(int $limit = 50, int $lastId = 0): array
     {
-        $messagesResult = $this->messageRepository->getFilteredAfterId($lastId, $limit);
+        $messagesResult = $this->messageRepository
+            ->getFilteredAfterId((new MessageFilter())->setLastId($lastId)->setLimit($limit));
 
         $viewStats = [];
         foreach ($messagesResult->getItems() as $message) {
@@ -445,7 +449,9 @@ public function getCampaignPerformance(): array
      */
     public function getRecentCampaigns(int $limit = 5): array
     {
-        $messages = $this->messageRepository->getFilteredAfterId(0, $limit)->getItems();
+        $messages = $this->messageRepository
+            ->getFilteredAfterId((new MessageFilter())->setLastId(0)->setLimit($limit))
+            ->getItems();
         $recentCampaigns = [];
         foreach ($messages as $message) {
             $views = $this->userMessageViewManager->countViewsByMessageId($message->getId());

src/Domain/Common/Model/Filter/FilterRequestInterface.php

@@ -6,5 +6,8 @@
 
 interface FilterRequestInterface
 {
-
+    public function getLastId(): int;
+    public function getLimit(): int;
+    public function setLastId(int $lastId): self;
+    public function setLimit(int $limit): self;
 }

src/Domain/Common/Model/Filter/PaginatedFilterTrait.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Common\Model\Filter;
+
+trait PaginatedFilterTrait
+{
+    private int $lastId = 0;
+    private int $limit = 50;
+
+    public function setLastId(int $lastId): self
+    {
+        $this->lastId = $lastId;
+
+        return $this;
+    }
+
+    public function getLastId(): int
+    {
+        return $this->lastId;
+    }
+
+    public function setLimit(int $limit): self
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    public function getLimit(): int
+    {
+        return $this->limit;
+    }
+}

src/Domain/Common/Repository/CursorPaginationTrait.php

@@ -4,7 +4,6 @@
 
 namespace PhpList\Core\Domain\Common\Repository;
 
-use BadMethodCallException;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 use PhpList\Core\Domain\Common\Model\PaginatedResult;
 
@@ -40,20 +39,8 @@ public function getAfterId(int $lastId, int $limit): PaginatedResult
         );
     }
 
-    /**
-     * Get filtered + paginated messages for a given owner and status.
-     *
-     * @throws BadMethodCallException
-     * */
-    public function getFilteredAfterId(
-        int $lastId,
-        int $limit,
-        ?FilterRequestInterface $filter = null
-    ): PaginatedResult {
-        if ($filter === null) {
-            return $this->getAfterId($lastId, $limit);
-        }
-
-        throw new BadMethodCallException('getFilteredAfterId method not implemented');
+    public function getFilteredAfterId(FilterRequestInterface $filter): PaginatedResult
+    {
+        return $this->getAfterId($filter->getLastId(), $filter->getLimit());
     }
 }

src/Domain/Common/Repository/Interfaces/PaginatableRepositoryInterface.php

@@ -9,9 +9,5 @@
 
 interface PaginatableRepositoryInterface
 {
-    public function getFilteredAfterId(
-        int $lastId,
-        int $limit,
-        ?FilterRequestInterface $filter = null
-    ): PaginatedResult;
+    public function getFilteredAfterId(FilterRequestInterface $filter): PaginatedResult;
 }

src/Domain/Configuration/Model/Filter/EventLogFilter.php

@@ -6,14 +6,21 @@
 
 use DateTimeInterface;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilterTrait;
 
 class EventLogFilter implements FilterRequestInterface
 {
+    use PaginatedFilterTrait;
+
     public function __construct(
         private readonly ?string $page = null,
         private readonly ?DateTimeInterface $dateFrom = null,
         private readonly ?DateTimeInterface $dateTo = null,
+        int $lastId = 0,
+        int $limit = 50,
     ) {
+        $this->setLastId($lastId);
+        $this->setLimit($limit);
     }
 
     public function getPage(): ?string

src/Domain/Configuration/Repository/EventLogRepository.php

@@ -21,17 +21,12 @@ class EventLogRepository extends AbstractRepository implements PaginatableReposi
      * @return PaginatedResult<EventLog>
      * @throws InvalidArgumentException
      */
-    public function getFilteredAfterId(
-        int $lastId,
-        int $limit,
-        ?FilterRequestInterface $filter = null
-    ): PaginatedResult {
+    public function getFilteredAfterId(FilterRequestInterface $filter): PaginatedResult
+    {
+        $lastId = $filter->getLastId();
+        $limit = $filter->getLimit();
         $queryBuilder = $this->createQueryBuilder('e');
 
-        if ($filter === null) {
-            return $queryBuilder->getQuery()->getResult();
-        }
-
         if (!$filter instanceof EventLogFilter) {
             throw new InvalidArgumentException('Expected EventLogFilter.');
         }

src/Domain/Configuration/Service/Manager/EventLogManager.php

@@ -43,9 +43,9 @@ public function get(
         ?DateTimeInterface $dateFrom = null,
         ?DateTimeInterface $dateTo = null
     ): array {
-        $filter = new EventLogFilter($page, $dateFrom, $dateTo);
+        $filter = new EventLogFilter($page, $dateFrom, $dateTo, $lastId, $limit);
 
-        return $this->repository->getFilteredAfterId($lastId, $limit, $filter)->getItems();
+        return $this->repository->getFilteredAfterId($filter)->getItems();
     }
 
     public function delete(EventLog $log): void

src/Domain/Identity/Model/Filter/AdminAttributeValueFilter.php

@@ -5,9 +5,12 @@
 namespace PhpList\Core\Domain\Identity\Model\Filter;
 
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
+use PhpList\Core\Domain\Common\Model\Filter\PaginatedFilterTrait;
 
 class AdminAttributeValueFilter implements FilterRequestInterface
 {
+    use PaginatedFilterTrait;
+
     private ?int $adminId = null;
 
     public function setAdminId(?int $adminId): self

src/Domain/Identity/Repository/AdminAttributeValueRepository.php

@@ -32,11 +32,10 @@ public function findOneByAdminIdAndAttributeId(int $adminId, int $definitionId):
      * @return PaginatedResult<SubscriberAttributeValue>
      * @throws InvalidArgumentException
      */
-    public function getFilteredAfterId(
-        int $lastId,
-        int $limit,
-        ?FilterRequestInterface $filter = null
-    ): PaginatedResult {
+    public function getFilteredAfterId(FilterRequestInterface $filter): PaginatedResult
+    {
+        $lastId = $filter->getLastId();
+        $limit = $filter->getLimit();
         if (!$filter instanceof AdminAttributeValueFilter) {
             throw new InvalidArgumentException('Expected AdminAttributeValueFilter.');
         }