Subscriber filter in get subscribers endpoint

Author: tatevikg1

src/Subscription/Controller/SubscriberController.php

@@ -7,14 +7,14 @@
 use Doctrine\ORM\EntityManagerInterface;
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Identity\Model\PrivilegeFlag;
-use PhpList\Core\Domain\Subscription\Model\Filter\SubscriberFilter;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
 use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberManager;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Common\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Subscription\Request\CreateSubscriberRequest;
+use PhpList\RestBundle\Subscription\Request\SubscribersFilterRequest;
 use PhpList\RestBundle\Subscription\Request\UpdateSubscriberRequest;
 use PhpList\RestBundle\Subscription\Serializer\SubscriberNormalizer;
 use PhpList\RestBundle\Subscription\Service\SubscriberHistoryService;
@@ -104,14 +104,17 @@ public function getSubscribers(Request $request): JsonResponse
     {
         $this->requireAuthentication($request);
 
+        /** @var SubscribersFilterRequest $subscriberRequest */
+        $subscriberRequest = $this->validator->validate($request, SubscribersFilterRequest::class);
+
         return $this->json(
-            $this->paginatedDataProvider->getPaginatedList(
-                $request,
-                $this->subscriberNormalizer,
-                Subscriber::class,
-                new SubscriberFilter(),
+            data: $this->paginatedDataProvider->getPaginatedList(
+                request: $request,
+                normalizer: $this->subscriberNormalizer,
+                className: Subscriber::class,
+                filter: $subscriberRequest->getDto(),
             ),
-            Response::HTTP_OK
+            status: Response::HTTP_OK
         );
     }
 

src/Subscription/Request/SubscribersFilterRequest.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Request;
+
+use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Subscription\Model\Filter\SubscriberFilter;
+use PhpList\RestBundle\Common\Request\RequestInterface;
+use Symfony\Component\Validator\Constraints as Assert;
+
+#[OA\Schema(
+    schema: 'SubscribersFilterRequest',
+    properties: [
+        new OA\Property(
+            property: 'is_confirmed',
+            description: 'Filter by confirmed status',
+            type: 'boolean',
+            nullable: true
+        ),
+        new OA\Property(
+            property: 'is_blacklisted',
+            description: 'Filter by blacklisted status',
+            type: 'boolean',
+            nullable: true
+        ),
+        new OA\Property(
+            property: 'sort_by',
+            description: 'Column to sort by',
+            type: 'string',
+            nullable: true
+        ),
+        new OA\Property(
+            property: 'sort_direction',
+            description: 'Sort direction',
+            type: 'string',
+            enum: ['asc', 'desc'],
+            nullable: true
+        ),
+        new OA\Property(
+            property: 'find_column',
+            description: 'Column to search in (requires find_value)',
+            type: 'string',
+            nullable: true
+        ),
+        new OA\Property(
+            property: 'find_value',
+            description: 'Value to search for (requires find_column)',
+            type: 'string',
+            nullable: true
+        ),
+    ],
+    type: 'object'
+)]
+class SubscribersFilterRequest implements RequestInterface
+{
+    #[Assert\Type(type: 'boolean')]
+    public ?bool $isConfirmed = null;
+
+    #[Assert\Type(type: 'boolean')]
+    public ?bool $isBlacklisted = null;
+
+    #[Assert\Type(type: 'string')]
+    public ?string $sortBy = null;
+
+    #[Assert\Choice(choices: ['asc', 'desc'])]
+    public ?string $sortDirection = null;
+
+    #[Assert\Type(type: 'string')]
+    public ?string $findColumn = null;
+
+    #[Assert\Type(type: 'string')]
+    public ?string $findValue = null;
+
+    public function getDto(): SubscriberFilter
+    {
+        $findColumn = $this->findColumn;
+        $findValue = $this->findValue;
+        if (($findColumn === null) xor ($findValue === null)) {
+            $findColumn = null;
+            $findValue = null;
+        }
+
+        return new SubscriberFilter(
+            isConfirmed: $this->isConfirmed,
+            isBlacklisted: $this->isBlacklisted,
+            sortBy: $this->sortBy,
+            sortDirection: $this->sortDirection,
+            findColumn: $findColumn,
+            findValue: $findValue,
+        );
+    }
+}