Add: SubscriberFilter options

Author: tatevikg1

src/Domain/Subscription/Model/Filter/SubscriberFilter.php

@@ -7,6 +7,7 @@
 use DateTimeImmutable;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 
+/** @SuppressWarnings("ExcessiveParameterList") */
 class SubscriberFilter implements FilterRequestInterface
 {
     private ?int $listId;
@@ -16,7 +17,13 @@ class SubscriberFilter implements FilterRequestInterface
     private ?DateTimeImmutable $createdDateTo;
     private ?DateTimeImmutable $updatedDateFrom;
     private ?DateTimeImmutable $updatedDateTo;
+    private ?bool $isConfirmed;
+    private ?bool $isBlacklisted;
     private array $columns;
+    private ?string $sortBy;
+    private ?string $sortDirection;
+    private ?string $findColumn;
+    private ?string $findValue;
 
     public function __construct(
         ?int $listId = null,
@@ -26,7 +33,13 @@ public function __construct(
         ?DateTimeImmutable $createdDateTo = null,
         ?DateTimeImmutable $updatedDateFrom = null,
         ?DateTimeImmutable $updatedDateTo = null,
+        ?bool $isConfirmed = null,
+        ?bool $isBlacklisted = null,
         array $columns = [],
+        ?string $sortBy = null,
+        ?string $sortDirection = null,
+        ?string $findColumn = null,
+        ?string $findValue = null,
     ) {
         $this->listId = $listId;
         $this->subscribedDateFrom = $subscribedDateFrom;
@@ -35,7 +48,13 @@ public function __construct(
         $this->createdDateTo = $createdDateTo;
         $this->updatedDateFrom = $updatedDateFrom;
         $this->updatedDateTo = $updatedDateTo;
+        $this->isConfirmed = $isConfirmed;
+        $this->isBlacklisted = $isBlacklisted;
         $this->columns = $columns;
+        $this->sortBy = $sortBy;
+        $this->sortDirection = $sortDirection;
+        $this->findColumn = $findColumn;
+        $this->findValue = $findValue;
     }
 
     public function getListId(): ?int
@@ -73,8 +92,38 @@ public function getUpdatedDateTo(): ?DateTimeImmutable
         return $this->updatedDateTo;
     }
 
+    public function getIsConfirmed(): ?bool
+    {
+        return $this->isConfirmed;
+    }
+
+    public function getIsBlacklisted(): ?bool
+    {
+        return $this->isBlacklisted;
+    }
+
     public function getColumns(): array
     {
         return $this->columns;
     }
+
+    public function getSortBy(): ?string
+    {
+        return $this->sortBy;
+    }
+
+    public function getSortDirection(): ?string
+    {
+        return $this->sortDirection;
+    }
+
+    public function getFindColumn(): ?string
+    {
+        return $this->findColumn;
+    }
+
+    public function getFindValue(): ?string
+    {
+        return $this->findValue;
+    }
 }

src/Domain/Subscription/Repository/SubscriberRepository.php

@@ -4,6 +4,7 @@
 
 namespace PhpList\Core\Domain\Subscription\Repository;
 
+use Doctrine\ORM\QueryBuilder;
 use InvalidArgumentException;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
@@ -73,6 +74,8 @@ public function getSubscribersBySubscribedListId(int $listId): array
     /**
      * @return Subscriber[]
      * @throws InvalidArgumentException
+     * @SuppressWarnings("CyclomaticComplexity")
+     * @SuppressWarnings("NPathComplexity")
      */
     public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): array
     {
@@ -96,29 +99,51 @@ public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterf
                     ->setParameter('subscribedAtTo', $filter->getSubscribedDateTo());
             }
         }
+
+        $this->applyTimeFilter($filter, $queryBuilder);
+
+        if ($filter->getIsConfirmed() !== null) {
+            $queryBuilder->andWhere('subscriber.isConfirmed = :isConfirmed')
+                ->setParameter('isConfirmed', $filter->getIsConfirmed());
+        }
+        if ($filter->getIsBlacklisted() !== null) {
+            $queryBuilder->andWhere('subscriber.isBlacklisted = :isBlacklisted')
+                ->setParameter('isBlacklisted', $filter->getIsBlacklisted());
+        }
+        if ($filter->getSortBy() !== null) {
+            $queryBuilder->orderBy('subscriber.' . $filter->getSortBy(), $filter->getSortDirection() ?? 'ASC');
+        }
+        if ($filter->getFindColumn() && $filter->getFindValue()) {
+            $queryBuilder->andWhere('subscriber.' . $filter->getFindColumn() . ' LIKE :search')
+                ->setParameter('search', '%' . $filter->getFindValue() . '%');
+        }
+
+        return $queryBuilder->andWhere('subscriber.id > :lastId')
+            ->setParameter('lastId', $lastId)
+            ->orderBy('subscriber.id', 'ASC')
+            ->setMaxResults($limit)
+            ->getQuery()
+            ->getResult();
+    }
+
+    private function applyTimeFilter(SubscriberFilter $filter, QueryBuilder $queryBuilder): void
+    {
         if ($filter->getCreatedDateFrom() !== null) {
-            $queryBuilder->where('subscriber.createdAt > :createdAtFrom')
+            $queryBuilder->andWhere('subscriber.createdAt > :createdAtFrom')
                 ->setParameter('createdAtFrom', $filter->getCreatedDateFrom());
         }
         if ($filter->getCreatedDateTo() !== null) {
-            $queryBuilder->where('subscriber.createdAt < :createdAtTo')
+            $queryBuilder->andWhere('subscriber.createdAt < :createdAtTo')
                 ->setParameter('createdAtTo', $filter->getCreatedDateTo());
         }
         if ($filter->getUpdatedDateFrom() !== null) {
-            $queryBuilder->where('subscriber.updatedAt > :updatedAtFrom')
+            $queryBuilder->andWhere('subscriber.updatedAt > :updatedAtFrom')
                 ->setParameter('updatedAtFrom', $filter->getUpdatedDateFrom());
         }
         if ($filter->getUpdatedDateTo() !== null) {
-            $queryBuilder->where('subscriber.updatedAt < :updatedAtTo')
+            $queryBuilder->andWhere('subscriber.updatedAt < :updatedAtTo')
                 ->setParameter('updatedAtTo', $filter->getUpdatedDateTo());
         }
-
-        return $queryBuilder->andWhere('subscriber.id > :lastId')
-            ->setParameter('lastId', $lastId)
-            ->orderBy('subscriber.id', 'ASC')
-            ->setMaxResults($limit)
-            ->getQuery()
-            ->getResult();
     }
 
     public function findSubscriberWithSubscriptions(int $id): ?Subscriber