CustomFieldsResponseBuilder.php
1 year ago
DynamicSegmentsResponseBuilder.php
3 months ago
FormsResponseBuilder.php
1 year ago
NewsletterTemplatesResponseBuilder.php
1 year ago
NewslettersResponseBuilder.php
1 month ago
ScheduledTaskSubscriberResponseBuilder.php
3 years ago
SegmentsResponseBuilder.php
3 months ago
SendingQueuesResponseBuilder.php
3 months ago
SubscribersResponseBuilder.php
2 days ago
index.php
3 years ago
SubscribersResponseBuilder.php
244 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\API\JSON\ResponseBuilders; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\CustomFields\CustomFieldsRepository; |
| 9 | use MailPoet\Entities\NewsletterEntity; |
| 10 | use MailPoet\Entities\SegmentEntity; |
| 11 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 12 | use MailPoet\Entities\SubscriberCustomFieldEntity; |
| 13 | use MailPoet\Entities\SubscriberEntity; |
| 14 | use MailPoet\Statistics\StatisticsUnsubscribesRepository; |
| 15 | use MailPoet\Statistics\UnsubscribeReasonTracker; |
| 16 | use MailPoet\Subscribers\Statistics\SubscriberStatisticsRepository; |
| 17 | use MailPoet\Subscribers\SubscriberCustomFieldRepository; |
| 18 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 19 | |
| 20 | class SubscribersResponseBuilder { |
| 21 | const DATE_FORMAT = 'Y-m-d H:i:s'; |
| 22 | |
| 23 | /** @var StatisticsUnsubscribesRepository */ |
| 24 | private $statisticsUnsubscribesRepository; |
| 25 | |
| 26 | /** @var CustomFieldsRepository */ |
| 27 | private $customFieldsRepository; |
| 28 | |
| 29 | /** @var SubscriberCustomFieldRepository */ |
| 30 | private $subscriberCustomFieldRepository; |
| 31 | |
| 32 | /** @var EntityManager */ |
| 33 | private $entityManager; |
| 34 | |
| 35 | /** @var UnsubscribeReasonTracker */ |
| 36 | private $unsubscribeReasonTracker; |
| 37 | |
| 38 | /** @var SubscriberStatisticsRepository */ |
| 39 | private $subscriberStatisticsRepository; |
| 40 | |
| 41 | public function __construct( |
| 42 | EntityManager $entityManager, |
| 43 | CustomFieldsRepository $customFieldsRepository, |
| 44 | SubscriberCustomFieldRepository $subscriberCustomFieldRepository, |
| 45 | StatisticsUnsubscribesRepository $statisticsUnsubscribesRepository, |
| 46 | UnsubscribeReasonTracker $unsubscribeReasonTracker, |
| 47 | SubscriberStatisticsRepository $subscriberStatisticsRepository |
| 48 | ) { |
| 49 | $this->statisticsUnsubscribesRepository = $statisticsUnsubscribesRepository; |
| 50 | $this->customFieldsRepository = $customFieldsRepository; |
| 51 | $this->subscriberCustomFieldRepository = $subscriberCustomFieldRepository; |
| 52 | $this->entityManager = $entityManager; |
| 53 | $this->unsubscribeReasonTracker = $unsubscribeReasonTracker; |
| 54 | $this->subscriberStatisticsRepository = $subscriberStatisticsRepository; |
| 55 | } |
| 56 | |
| 57 | public function buildForListing(array $subscribers): array { |
| 58 | $this->prefetchRelations($subscribers); |
| 59 | $engagementScoreTypes = $this->subscriberStatisticsRepository->getEngagementScoreTypes($subscribers); |
| 60 | $data = []; |
| 61 | foreach ($subscribers as $subscriber) { |
| 62 | $data[] = $this->buildListingItem( |
| 63 | $subscriber, |
| 64 | $engagementScoreTypes[(int)$subscriber->getId()] ?? SubscriberStatisticsRepository::ENGAGEMENT_SCORE_UNKNOWN |
| 65 | ); |
| 66 | } |
| 67 | return $data; |
| 68 | } |
| 69 | |
| 70 | private function buildListingItem(SubscriberEntity $subscriber, string $engagementScoreType): array { |
| 71 | return [ |
| 72 | 'id' => (string)$subscriber->getId(), // (string) for BC |
| 73 | 'email' => $subscriber->getEmail(), |
| 74 | 'first_name' => $subscriber->getFirstName(), |
| 75 | 'last_name' => $subscriber->getLastName(), |
| 76 | 'subscriptions' => $this->buildSubscriptions($subscriber), |
| 77 | 'status' => $subscriber->getStatus(), |
| 78 | 'count_confirmations' => $subscriber->getConfirmationsCount(), |
| 79 | 'wp_user_id' => $subscriber->getWpUserId(), |
| 80 | 'is_woocommerce_user' => $subscriber->getIsWoocommerceUser(), |
| 81 | 'created_at' => ($createdAt = $subscriber->getCreatedAt()) ? $createdAt->format(self::DATE_FORMAT) : null, |
| 82 | 'deleted_at' => ($deletedAt = $subscriber->getDeletedAt()) ? $deletedAt->format(self::DATE_FORMAT) : null, |
| 83 | 'last_subscribed_at' => ($lastSubscribedAt = $subscriber->getLastSubscribedAt()) ? $lastSubscribedAt->format(self::DATE_FORMAT) : null, |
| 84 | 'engagement_score' => $subscriber->getEngagementScore(), |
| 85 | 'engagement_score_type' => $engagementScoreType, |
| 86 | 'tags' => $this->buildTags($subscriber), |
| 87 | 'tracking_consent' => $subscriber->getTrackingConsent(), |
| 88 | ]; |
| 89 | } |
| 90 | |
| 91 | public function build(SubscriberEntity $subscriberEntity): array { |
| 92 | $data = [ |
| 93 | 'id' => (string)$subscriberEntity->getId(), |
| 94 | 'wp_user_id' => $subscriberEntity->getWpUserId(), |
| 95 | 'is_woocommerce_user' => $subscriberEntity->getIsWoocommerceUser(), |
| 96 | 'subscriptions' => $this->buildSubscriptions($subscriberEntity), |
| 97 | 'unsubscribes' => $this->buildUnsubscribes($subscriberEntity), |
| 98 | 'status' => $subscriberEntity->getStatus(), |
| 99 | 'last_name' => $subscriberEntity->getLastName(), |
| 100 | 'first_name' => $subscriberEntity->getFirstName(), |
| 101 | 'email' => $subscriberEntity->getEmail(), |
| 102 | 'created_at' => ($createdAt = $subscriberEntity->getCreatedAt()) ? $createdAt->format(self::DATE_FORMAT) : null, |
| 103 | 'updated_at' => ($updatedAt = $subscriberEntity->getUpdatedAt()) ? $updatedAt->format(self::DATE_FORMAT) : null, |
| 104 | 'deleted_at' => ($deletedAt = $subscriberEntity->getDeletedAt()) ? $deletedAt->format(self::DATE_FORMAT) : null, |
| 105 | 'subscribed_ip' => $subscriberEntity->getSubscribedIp(), |
| 106 | 'confirmed_ip' => $subscriberEntity->getConfirmedIp(), |
| 107 | 'confirmed_at' => ($confirmedAt = $subscriberEntity->getConfirmedAt()) ? $confirmedAt->format(self::DATE_FORMAT) : null, |
| 108 | 'last_subscribed_at' => ($lastSubscribedAt = $subscriberEntity->getLastSubscribedAt()) ? $lastSubscribedAt->format(self::DATE_FORMAT) : null, |
| 109 | 'unconfirmed_data' => $subscriberEntity->getUnconfirmedData(), |
| 110 | 'source' => $subscriberEntity->getSource(), |
| 111 | 'count_confirmations' => $subscriberEntity->getConfirmationsCount(), |
| 112 | 'unsubscribe_token' => $subscriberEntity->getUnsubscribeToken(), |
| 113 | 'link_token' => $subscriberEntity->getLinkToken(), |
| 114 | 'tags' => $this->buildTags($subscriberEntity), |
| 115 | 'timezone' => $subscriberEntity->getTimeZone(), |
| 116 | 'tracking_consent' => $subscriberEntity->getTrackingConsent(), |
| 117 | 'tracking_consent_updated_at' => ($trackingConsentUpdatedAt = $subscriberEntity->getTrackingConsentUpdatedAt()) |
| 118 | ? $trackingConsentUpdatedAt->format(self::DATE_FORMAT) : null, |
| 119 | 'tracking_consent_method' => $subscriberEntity->getTrackingConsentMethod(), |
| 120 | 'tracking_consent_copy' => $subscriberEntity->getTrackingConsentCopy(), |
| 121 | ]; |
| 122 | |
| 123 | return $this->buildCustomFields($subscriberEntity, $data); |
| 124 | } |
| 125 | |
| 126 | private function buildSubscriptions(SubscriberEntity $subscriberEntity): array { |
| 127 | $result = []; |
| 128 | foreach ($subscriberEntity->getSubscriberSegments() as $subscriberSegment) { |
| 129 | $segment = $subscriberSegment->getSegment(); |
| 130 | if ($segment instanceof SegmentEntity) { |
| 131 | $result[] = [ |
| 132 | 'id' => $subscriberSegment->getId(), |
| 133 | 'subscriber_id' => (string)$subscriberEntity->getId(), |
| 134 | 'created_at' => ($createdAt = $subscriberSegment->getCreatedAt()) ? $createdAt->format(self::DATE_FORMAT) : null, |
| 135 | 'segment_id' => (string)$segment->getId(), |
| 136 | 'status' => $subscriberSegment->getStatus(), |
| 137 | 'updated_at' => ($updatedAt = $subscriberSegment->getUpdatedAt()) ? $updatedAt->format(self::DATE_FORMAT) : null, |
| 138 | ]; |
| 139 | } |
| 140 | } |
| 141 | return $result; |
| 142 | } |
| 143 | |
| 144 | private function buildUnsubscribes(SubscriberEntity $subscriberEntity): array { |
| 145 | $unsubscribes = $this->statisticsUnsubscribesRepository->findBy([ |
| 146 | 'subscriber' => $subscriberEntity, |
| 147 | ], [ |
| 148 | 'createdAt' => 'desc', |
| 149 | ]); |
| 150 | $result = []; |
| 151 | $reasonLabels = $this->unsubscribeReasonTracker->getReasonLabels(); |
| 152 | foreach ($unsubscribes as $unsubscribe) { |
| 153 | $mapped = [ |
| 154 | 'source' => $unsubscribe->getSource(), |
| 155 | 'meta' => $unsubscribe->getMeta(), |
| 156 | 'createdAt' => $unsubscribe->getCreatedAt(), |
| 157 | 'reason' => $unsubscribe->getReason(), |
| 158 | 'reasonLabel' => $this->getUnsubscribeReasonLabel($unsubscribe->getReason(), $reasonLabels), |
| 159 | 'reasonText' => $unsubscribe->getReasonText(), |
| 160 | 'reasonSubmittedAt' => $unsubscribe->getReasonSubmittedAt(), |
| 161 | ]; |
| 162 | $newsletter = $unsubscribe->getNewsletter(); |
| 163 | if ($newsletter instanceof NewsletterEntity) { |
| 164 | $mapped['newsletterId'] = $newsletter->getId(); |
| 165 | $mapped['newsletterSubject'] = $newsletter->getSubject(); |
| 166 | } |
| 167 | $result[] = $mapped; |
| 168 | } |
| 169 | return $result; |
| 170 | } |
| 171 | |
| 172 | /** |
| 173 | * @param array<string, string> $reasonLabels |
| 174 | */ |
| 175 | private function getUnsubscribeReasonLabel(?string $reason, array $reasonLabels): ?string { |
| 176 | if ($reason === null) { |
| 177 | return null; |
| 178 | } |
| 179 | if ($reason === '' || $reason === StatisticsUnsubscribeEntity::REASON_UNSPECIFIED) { |
| 180 | return __('No reason provided', 'mailpoet'); |
| 181 | } |
| 182 | return $reasonLabels[$reason] ?? $reason; |
| 183 | } |
| 184 | |
| 185 | private function buildCustomFields(SubscriberEntity $subscriberEntity, array $data): array { |
| 186 | $customFields = $this->customFieldsRepository->findAllActive(); |
| 187 | |
| 188 | foreach ($customFields as $customField) { |
| 189 | $subscriberCustomField = $this->subscriberCustomFieldRepository->findOneBy( |
| 190 | ['subscriber' => $subscriberEntity, 'customField' => $customField] |
| 191 | ); |
| 192 | if ($subscriberCustomField instanceof SubscriberCustomFieldEntity) { |
| 193 | $data['cf_' . $customField->getId()] = $subscriberCustomField->getValue(); |
| 194 | } |
| 195 | } |
| 196 | return $data; |
| 197 | } |
| 198 | |
| 199 | private function buildTags(SubscriberEntity $subscriber): array { |
| 200 | $result = []; |
| 201 | foreach ($subscriber->getSubscriberTags() as $subscriberTag) { |
| 202 | $tag = $subscriberTag->getTag(); |
| 203 | if (!$tag) { |
| 204 | continue; |
| 205 | } |
| 206 | $result[] = [ |
| 207 | 'id' => $subscriberTag->getId(), |
| 208 | 'subscriber_id' => (string)$subscriber->getId(), |
| 209 | 'tag_id' => (string)$tag->getId(), |
| 210 | 'created_at' => ($createdAt = $subscriberTag->getCreatedAt()) ? $createdAt->format(self::DATE_FORMAT) : null, |
| 211 | 'updated_at' => ($updatedAt = $subscriberTag->getUpdatedAt()) ? $updatedAt->format(self::DATE_FORMAT) : null, |
| 212 | 'name' => $tag->getName(), |
| 213 | ]; |
| 214 | } |
| 215 | return $result; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * @param SubscriberEntity[] $subscribers |
| 220 | */ |
| 221 | private function prefetchRelations(array $subscribers): void { |
| 222 | // Prefetch subscriptions |
| 223 | $this->entityManager->createQueryBuilder() |
| 224 | ->select('PARTIAL s.{id}, ssg, sg') |
| 225 | ->from(SubscriberEntity::class, 's') |
| 226 | ->leftJoin('s.subscriberSegments', 'ssg') |
| 227 | ->leftJoin('ssg.segment', 'sg') |
| 228 | ->where('s.id IN (:subscribers)') |
| 229 | ->setParameter('subscribers', $subscribers) |
| 230 | ->getQuery() |
| 231 | ->getResult(); |
| 232 | // Prefetch tags |
| 233 | $this->entityManager->createQueryBuilder() |
| 234 | ->select('PARTIAL s.{id}, st, t') |
| 235 | ->from(SubscriberEntity::class, 's') |
| 236 | ->leftJoin('s.subscriberTags', 'st') |
| 237 | ->leftJoin('st.tag', 't') |
| 238 | ->where('s.id IN (:subscribers)') |
| 239 | ->setParameter('subscribers', $subscribers) |
| 240 | ->getQuery() |
| 241 | ->getResult(); |
| 242 | } |
| 243 | } |
| 244 |