Export subscribers panel with directory filter

Author: tatevikg1

assets/vue/components/lists/ListSubscribersExportPanel.vue

@@ -163,7 +163,11 @@ const props = defineProps({
   listName: {
     type: String,
     default: ''
-  }
+  },
+  directoryFilter: {
+    type: String,
+    default: 'all'
+  },
 })
 
 const dateTypeOptions = [
@@ -254,6 +258,11 @@ const exportSubscribers = () => {
   if (props.listId) {
     params.set('list_id', String(props.listId))
   }
+
+  if (props.directoryFilter && props.directoryFilter !== 'all') {
+    params.set(props.directoryFilter, 'true')
+  }
+
   params.set('date_type', form.value.dateType)
 
   if (!usesAnyDate.value) {

assets/vue/components/subscribers/SubscriberDirectory.vue

@@ -84,7 +84,7 @@
     </div>
   </div>
 
-  <ListSubscribersExportPanel/>
+  <ListSubscribersExportPanel :directory-filter="currentFilter || 'all'"/>
 </template>
 
 <script setup>
@@ -306,21 +306,4 @@ const handleFileChange = async (event) => {
   }
 }
 
-const exportSubscribers = () => {
-  const params = new URLSearchParams()
-  if (currentFilter.value && currentFilter.value !== 'all') {
-    params.set(currentFilter.value, 'true')
-  }
-
-  if (searchQuery.value && isAllowedSearchColumn(searchColumn.value)) {
-    params.set('findColumn', searchColumn.value)
-    params.set('findValue', searchQuery.value)
-  }
-
-  if (pagination.value.total > 0) {
-    params.set('limit', pagination.value.total)
-  }
-
-  window.location.href = `/subscribers/export?${params.toString()}`
-}
 </script>

src/Controller/SubscribersController.php

@@ -4,12 +4,10 @@
 
 namespace PhpList\WebFrontend\Controller;
 
-use DateTimeImmutable;
 use PhpList\RestApiClient\Endpoint\SubscribersClient;
-use PhpList\RestApiClient\Entity\Subscriber;
-use PhpList\RestApiClient\Request\Subscriber\ExportSubscriberRequest;
 use PhpList\RestApiClient\Request\Subscriber\SubscribersFilterRequest;
-use PhpList\RestApiClient\Response\Subscribers\SubscriberCollection;
+use PhpList\WebFrontend\Service\SubscriberCollectionNormalizer;
+use PhpList\WebFrontend\Service\SubscriberExportRequestFactory;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -20,8 +18,11 @@
 #[Route('/subscribers', name: 'subscriber_')]
 class SubscribersController extends AbstractController
 {
-    public function __construct(private readonly SubscribersClient $subscribersClient)
-    {
+    public function __construct(
+        private readonly SubscribersClient $subscribersClient,
+        private readonly SubscriberCollectionNormalizer $subscriberCollectionNormalizer,
+        private readonly SubscriberExportRequestFactory $subscriberExportRequestFactory
+    ) {
     }
 
     /**
@@ -68,23 +69,13 @@ public function index(Request $request): JsonResponse|Response
             $prevId = $history[$index - 1];
         }
 
-        return $this->json($this->normalize($collection, $prevId, $afterId));
+        return $this->json($this->subscriberCollectionNormalizer->normalize($collection, $prevId, $afterId));
     }
 
-    /**
-     * @SuppressWarnings("CyclomaticComplexity")
-     * @SuppressWarnings("NPathComplexity")
-     */
     #[Route('/export', name: 'export', methods: ['GET'])]
     public function export(Request $request): Response
     {
-        $exportRequest = new ExportSubscriberRequest(
-            dateType: (string) $request->query->get('date_type', 'any'),
-            listId: $request->query->has('list_id') ? $request->query->getInt('list_id') : null,
-            dateFrom: $request->query->get('date_from') ?: null,
-            dateTo: $request->query->get('date_to') ?: null,
-            columns: array_values(array_filter($request->query->all('columns')))
-        );
+        $exportRequest = $this->subscriberExportRequestFactory->fromQuery($request->query);
 
         $upstreamResponse = $this->subscribersClient->exportSubscribers($exportRequest);
 
@@ -118,29 +109,4 @@ static function () use ($body): void {
 
         return $response;
     }
-
-    private function normalize(SubscriberCollection $collection, ?int $prevId, ?int $afterId): array
-    {
-        return [
-            'items' => array_map(static function (Subscriber $subscriber) {
-                return [
-                    'id' => $subscriber->id,
-                    'email' => $subscriber->email,
-                    'confirmed' => $subscriber->confirmed,
-                    'blacklisted' => $subscriber->blacklisted,
-                    'createdAt' => (new DateTimeImmutable($subscriber->createdAt))->format('Y-m-d H:i:s'),
-                    'uniqueId' => $subscriber->uniqueId,
-                    'listCount' => count($subscriber->subscribedLists),
-                ];
-            }, $collection->items ?? []),
-            'pagination' => [
-                'limit' => $collection->pagination->limit,
-                'afterId' => $collection->pagination->nextCursor,
-                'hasMore' => $collection->pagination->hasMore ,
-                'total' => $collection->pagination->total,
-                'prevId' => $prevId,
-                'isFirstPage' => $afterId === null,
-            ],
-        ];
-    }
 }

src/Service/SubscriberCollectionNormalizer.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\WebFrontend\Service;
+
+use DateTimeImmutable;
+use PhpList\RestApiClient\Entity\Subscriber;
+use PhpList\RestApiClient\Response\Subscribers\SubscriberCollection;
+
+class SubscriberCollectionNormalizer
+{
+    public function normalize(SubscriberCollection $collection, ?int $prevId, ?int $afterId): array
+    {
+        return [
+            'items' => array_map(static function (Subscriber $subscriber) {
+                return [
+                    'id' => $subscriber->id,
+                    'email' => $subscriber->email,
+                    'confirmed' => $subscriber->confirmed,
+                    'blacklisted' => $subscriber->blacklisted,
+                    'createdAt' => (new DateTimeImmutable($subscriber->createdAt))->format('Y-m-d H:i:s'),
+                    'uniqueId' => $subscriber->uniqueId,
+                    'listCount' => count($subscriber->subscribedLists),
+                ];
+            }, $collection->items ?? []),
+            'pagination' => [
+                'limit' => $collection->pagination->limit,
+                'afterId' => $collection->pagination->nextCursor,
+                'hasMore' => $collection->pagination->hasMore,
+                'total' => $collection->pagination->total,
+                'prevId' => $prevId,
+                'isFirstPage' => $afterId === null,
+            ],
+        ];
+    }
+}

src/Service/SubscriberExportRequestFactory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\WebFrontend\Service;
+
+use PhpList\RestApiClient\Request\Subscriber\ExportSubscriberRequest;
+use Symfony\Component\HttpFoundation\ParameterBag;
+
+class SubscriberExportRequestFactory
+{
+    public function fromQuery(ParameterBag $query): ExportSubscriberRequest
+    {
+        return new ExportSubscriberRequest(
+            dateType: (string) $query->get('date_type', 'any'),
+            listId: $query->has('list_id') ? $query->getInt('list_id') : null,
+            dateFrom: $query->get('date_from') ?: null,
+            dateTo: $query->get('date_to') ?: null,
+            columns: array_values(array_filter($query->all('columns'))),
+            isConfirmed: $query->has('confirmed') ? true :
+                ($query->has('unconfirmed') ? false : null),
+            isBlacklisted: $query->has('blacklisted') ? true :
+                ($query->has('non-blacklisted') ? false : null),
+        );
+    }
+}