SubscriberConfirmationEmailEndpoint.php
2 months ago
SubscribersBulkActionEndpoint.php
4 days ago
SubscribersListingEndpoint.php
2 weeks ago
index.php
2 months ago
SubscribersListingEndpoint.php
104 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Subscribers\RestApi\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\JSON\ResponseBuilders\SubscribersResponseBuilder; |
| 9 | use MailPoet\API\REST\AbstractListingEndpoint; |
| 10 | use MailPoet\Config\AccessControl; |
| 11 | use MailPoet\Entities\SubscriberEntity; |
| 12 | use MailPoet\Listing\Handler as ListingHandler; |
| 13 | use MailPoet\Listing\ListingDefinition; |
| 14 | use MailPoet\Listing\ListingRepository; |
| 15 | use MailPoet\Subscribers\SubscriberListingRepository; |
| 16 | use MailPoet\WP\Functions as WPFunctions; |
| 17 | |
| 18 | class SubscribersListingEndpoint extends AbstractListingEndpoint { |
| 19 | /** @var SubscriberListingRepository */ |
| 20 | private $subscriberListingRepository; |
| 21 | |
| 22 | /** @var SubscribersResponseBuilder */ |
| 23 | private $subscribersResponseBuilder; |
| 24 | |
| 25 | public function __construct( |
| 26 | ListingHandler $listingHandler, |
| 27 | SubscriberListingRepository $subscriberListingRepository, |
| 28 | SubscribersResponseBuilder $subscribersResponseBuilder |
| 29 | ) { |
| 30 | parent::__construct($listingHandler); |
| 31 | $this->subscriberListingRepository = $subscriberListingRepository; |
| 32 | $this->subscribersResponseBuilder = $subscribersResponseBuilder; |
| 33 | } |
| 34 | |
| 35 | public function checkPermissions(): bool { |
| 36 | return WPFunctions::get()->currentUserCan(AccessControl::PERMISSION_MANAGE_SUBSCRIBERS); |
| 37 | } |
| 38 | |
| 39 | protected function getListingRepository(): ListingRepository { |
| 40 | return $this->subscriberListingRepository; |
| 41 | } |
| 42 | |
| 43 | protected function getCountAndGroups(ListingRepository $repository, ListingDefinition $definition): array { |
| 44 | if (!$repository instanceof SubscriberListingRepository) { |
| 45 | return parent::getCountAndGroups($repository, $definition); |
| 46 | } |
| 47 | return $repository->getCountAndGroups($definition); |
| 48 | } |
| 49 | |
| 50 | protected function buildItems(array $rows, ListingDefinition $definition): array { |
| 51 | $subscribers = $this->subscribersResponseBuilder->buildForListing($rows); |
| 52 | // Mirror the legacy endpoint: when filtering by a specific segment, surface |
| 53 | // the per-segment unsubscribe status as the visible status so the UI shows |
| 54 | // "unsubscribed from this list" rather than the global subscriber status. |
| 55 | $segmentFilter = $this->extractSegmentFilter($definition); |
| 56 | if ($segmentFilter !== null) { |
| 57 | foreach ($subscribers as $key => $subscriber) { |
| 58 | if ($this->isUnsubscribedFromSegment($subscriber, $segmentFilter)) { |
| 59 | $subscribers[$key]['status'] = SubscriberEntity::STATUS_UNSUBSCRIBED; |
| 60 | } |
| 61 | } |
| 62 | } |
| 63 | return $subscribers; |
| 64 | } |
| 65 | |
| 66 | protected function getDefaultSortBy(): string { |
| 67 | return 'created_at'; |
| 68 | } |
| 69 | |
| 70 | protected function getDefaultSortOrder(): string { |
| 71 | return 'desc'; |
| 72 | } |
| 73 | |
| 74 | protected function getDefaultGroup(): ?string { |
| 75 | return 'all'; |
| 76 | } |
| 77 | |
| 78 | private function extractSegmentFilter(ListingDefinition $definition): ?string { |
| 79 | $filters = $definition->getFilters(); |
| 80 | if (!isset($filters['segment']) || !is_scalar($filters['segment'])) { |
| 81 | return null; |
| 82 | } |
| 83 | $segment = (string)$filters['segment']; |
| 84 | return $segment !== '' ? $segment : null; |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * @param array<string, mixed> $subscriber |
| 89 | */ |
| 90 | private function isUnsubscribedFromSegment(array $subscriber, string $segmentId): bool { |
| 91 | if (!isset($subscriber['subscriptions']) || !is_array($subscriber['subscriptions'])) { |
| 92 | return false; |
| 93 | } |
| 94 | foreach ($subscriber['subscriptions'] as $segment) { |
| 95 | if (!is_array($segment)) continue; |
| 96 | if (!isset($segment['segment_id']) || !is_scalar($segment['segment_id'])) continue; |
| 97 | if ((string)$segment['segment_id'] !== $segmentId) continue; |
| 98 | $status = $segment['status'] ?? null; |
| 99 | return is_scalar($status) && (string)$status === SubscriberEntity::STATUS_UNSUBSCRIBED; |
| 100 | } |
| 101 | return false; |
| 102 | } |
| 103 | } |
| 104 |