ConfirmationEmailTemplate
1 month ago
ImportExport
2 weeks ago
RestApi
3 days ago
Statistics
1 month ago
BulkActionController.php
3 days ago
BulkActionException.php
1 month ago
BulkConfirmationEmailResender.php
2 months ago
ConfirmationEmailCustomizer.php
2 months ago
ConfirmationEmailMailer.php
2 months ago
ConfirmationEmailResolver.php
2 months ago
EngagementDataBackfiller.php
2 months ago
InactiveSubscribersController.php
4 days ago
LinkTokens.php
2 months ago
NewSubscriberNotificationMailer.php
2 months ago
RequiredCustomFieldValidator.php
2 months ago
SegmentsCountRecalculator.php
2 weeks ago
Source.php
2 months ago
SubscriberActions.php
2 months ago
SubscriberCustomFieldRepository.php
3 years ago
SubscriberIPsRepository.php
2 years ago
SubscriberLimitNotificationEvaluator.php
2 months ago
SubscriberLimitNotificationMailer.php
2 months ago
SubscriberLimitNotificationScheduler.php
2 months ago
SubscriberListingRepository.php
2 weeks ago
SubscriberPersonalDataEraser.php
2 months ago
SubscriberSaveController.php
3 days ago
SubscriberSegmentRepository.php
2 weeks ago
SubscriberSubscribeController.php
2 weeks ago
SubscriberTagRepository.php
4 years ago
SubscribersCountsController.php
2 weeks ago
SubscribersEmailCountsController.php
2 weeks ago
SubscribersRepository.php
3 days ago
TrackingConsentController.php
4 days ago
index.php
3 years ago
SubscriberSegmentRepository.php
232 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Subscribers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Doctrine\Repository; |
| 9 | use MailPoet\Entities\SegmentEntity; |
| 10 | use MailPoet\Entities\SubscriberEntity; |
| 11 | use MailPoet\Entities\SubscriberSegmentEntity; |
| 12 | use MailPoet\WP\Functions as WPFunctions; |
| 13 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 14 | use MailPoetVendor\Doctrine\ORM\Query\Expr\Join; |
| 15 | |
| 16 | /** |
| 17 | * @extends Repository<SubscriberSegmentEntity> |
| 18 | */ |
| 19 | class SubscriberSegmentRepository extends Repository { |
| 20 | /** @var WPFunctions */ |
| 21 | private $wp; |
| 22 | |
| 23 | /** @var SegmentsCountRecalculator */ |
| 24 | private $segmentsCountRecalculator; |
| 25 | |
| 26 | public function __construct( |
| 27 | EntityManager $entityManager, |
| 28 | WPFunctions $wp, |
| 29 | SegmentsCountRecalculator $segmentsCountRecalculator |
| 30 | ) { |
| 31 | parent::__construct($entityManager); |
| 32 | $this->wp = $wp; |
| 33 | $this->segmentsCountRecalculator = $segmentsCountRecalculator; |
| 34 | } |
| 35 | |
| 36 | protected function getEntityClassName() { |
| 37 | return SubscriberSegmentEntity::class; |
| 38 | } |
| 39 | |
| 40 | public function getNonDefaultSubscribedSegments(int $subscriberId): array { |
| 41 | $qb = $this->entityManager->createQueryBuilder(); |
| 42 | return $qb->select('ss') |
| 43 | ->from(SubscriberSegmentEntity::class, 'ss') |
| 44 | ->join('ss.segment', 'seg', Join::WITH, 'seg.type != :typeDefault') |
| 45 | ->where('ss.subscriber = :subscriberId') |
| 46 | ->andWhere('ss.status = :subscribed') |
| 47 | ->setParameter('subscriberId', $subscriberId) |
| 48 | ->setParameter('subscribed', SubscriberEntity::STATUS_SUBSCRIBED) |
| 49 | ->setParameter('typeDefault', SegmentEntity::TYPE_DEFAULT) |
| 50 | ->getQuery() |
| 51 | ->getResult(); |
| 52 | } |
| 53 | |
| 54 | public function deleteAllBySubscriber(SubscriberEntity $subscriber): void { |
| 55 | $this->entityManager->createQueryBuilder() |
| 56 | ->delete(SubscriberSegmentEntity::class, 'ss') |
| 57 | ->where('ss.subscriber = :subscriber') |
| 58 | ->setParameter('subscriber', $subscriber) |
| 59 | ->getQuery() |
| 60 | ->execute(); |
| 61 | $this->segmentsCountRecalculator->recalculateForSubscribers([(int)$subscriber->getId()]); |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * @param SegmentEntity[] $segments |
| 66 | */ |
| 67 | public function unsubscribeFromSegments(SubscriberEntity $subscriber, array $segments = []): void { |
| 68 | $subscriber->setConfirmationsCount(0); |
| 69 | |
| 70 | if (!empty($segments)) { |
| 71 | // unsubscribe from segments |
| 72 | foreach ($segments as $segment) { |
| 73 | // do not remove subscriptions to the WP Users segment |
| 74 | if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) { |
| 75 | continue; |
| 76 | } |
| 77 | |
| 78 | // Defer the recompute: there is a single recalculateForSubscribers() |
| 79 | // call for this subscriber at the end of the method. |
| 80 | $this->createOrUpdate($subscriber, $segment, SubscriberEntity::STATUS_UNSUBSCRIBED, false, true); |
| 81 | } |
| 82 | $this->entityManager->flush(); |
| 83 | } else { |
| 84 | $subscriberSegmentsToUnsubscribe = array_values(array_filter( |
| 85 | $subscriber->getSubscriberSegments()->toArray(), |
| 86 | function (SubscriberSegmentEntity $subscriberSegment): bool { |
| 87 | $segment = $subscriberSegment->getSegment(); |
| 88 | return $subscriberSegment->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED |
| 89 | && $segment instanceof SegmentEntity |
| 90 | && $segment->getType() !== SegmentEntity::TYPE_WP_USERS; |
| 91 | } |
| 92 | )); |
| 93 | $subscriberSegmentTable = $this->entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName(); |
| 94 | $segmentTable = $this->entityManager->getClassMetadata(SegmentEntity::class)->getTableName(); |
| 95 | $this->entityManager->getConnection()->executeStatement(" |
| 96 | UPDATE $subscriberSegmentTable ss |
| 97 | JOIN $segmentTable s ON s.`id` = ss.`segment_id` AND ss.`subscriber_id` = :subscriberId |
| 98 | SET ss.`status` = :status |
| 99 | WHERE s.`type` != :typeWordPress |
| 100 | ", [ |
| 101 | 'subscriberId' => $subscriber->getId(), |
| 102 | 'status' => SubscriberEntity::STATUS_UNSUBSCRIBED, |
| 103 | 'typeWordPress' => SegmentEntity::TYPE_WP_USERS, |
| 104 | ]); |
| 105 | // Refresh SubscriberSegments status |
| 106 | foreach ($subscriber->getSubscriberSegments() as $subscriberSegment) { |
| 107 | $this->entityManager->refresh($subscriberSegment); |
| 108 | } |
| 109 | foreach ($subscriberSegmentsToUnsubscribe as $subscriberSegment) { |
| 110 | $this->wp->doAction('mailpoet_segment_unsubscribed', $subscriberSegment); |
| 111 | } |
| 112 | } |
| 113 | $this->segmentsCountRecalculator->recalculateForSubscribers([(int)$subscriber->getId()]); |
| 114 | } |
| 115 | |
| 116 | public function resetSubscriptions(SubscriberEntity $subscriber, array $segments): void { |
| 117 | // Already existing subscriptions are stored in $existingSegments. Their IDs in $existingSegmentIds. |
| 118 | $existingSegments = array_values(array_filter(array_map( |
| 119 | function(SubscriberSegmentEntity $subscriberSegmentEntity): ?SegmentEntity { |
| 120 | return $subscriberSegmentEntity->getSegment(); |
| 121 | }, |
| 122 | $this->findBy(['subscriber' => $subscriber, 'status' => SubscriberEntity::STATUS_SUBSCRIBED]) |
| 123 | ))); |
| 124 | $existingSegmentIds = array_map( |
| 125 | function(SegmentEntity $segment): int { |
| 126 | return $segment->getId() ?? 0; |
| 127 | }, |
| 128 | $existingSegments |
| 129 | ); |
| 130 | |
| 131 | // $segmentIds are the IDs of the segments we want the user to be subscribed to. |
| 132 | $segmentIds = array_map( |
| 133 | function(SegmentEntity $segment): int { |
| 134 | return $segment->getId() ?? 0; |
| 135 | }, |
| 136 | $segments |
| 137 | ); |
| 138 | |
| 139 | // $unsubscribedSegments are the segment IDs to which we need to unsubscribe. |
| 140 | $unsubscribedSegments = array_diff($existingSegmentIds, $segmentIds); |
| 141 | |
| 142 | // $newlySubscribedSegments are the segment IDs to which we need to newly subscribe. |
| 143 | $newlySubscribedSegments = array_diff($segmentIds, $existingSegmentIds); |
| 144 | if (!$newlySubscribedSegments && !$unsubscribedSegments) { |
| 145 | return; |
| 146 | } |
| 147 | |
| 148 | // The segments we need to unsubscribe. |
| 149 | $unsubscribe = array_filter( |
| 150 | $existingSegments, |
| 151 | function(SegmentEntity $segment) use ($unsubscribedSegments): bool { |
| 152 | return in_array($segment->getId(), $unsubscribedSegments); |
| 153 | } |
| 154 | ); |
| 155 | |
| 156 | // The segments we need to newly subscribe. |
| 157 | $subscribe = array_filter( |
| 158 | $segments, |
| 159 | function(SegmentEntity $segment) use ($newlySubscribedSegments): bool { |
| 160 | return in_array($segment->getId(), $newlySubscribedSegments); |
| 161 | } |
| 162 | ); |
| 163 | if ($unsubscribe) { |
| 164 | $this->unsubscribeFromSegments($subscriber, $unsubscribe); |
| 165 | } |
| 166 | if ($subscribe) { |
| 167 | $this->subscribeToSegments($subscriber, $subscribe); |
| 168 | } |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * @param SegmentEntity[] $segments |
| 173 | */ |
| 174 | public function subscribeToSegments(SubscriberEntity $subscriber, array $segments, bool $skipHooks = false): void { |
| 175 | foreach ($segments as $segment) { |
| 176 | // Defer the per-segment recompute: subscribing to N segments only changes |
| 177 | // this one subscriber's count, so recompute it once after the loop. |
| 178 | $this->createOrUpdate($subscriber, $segment, SubscriberEntity::STATUS_SUBSCRIBED, $skipHooks, true); |
| 179 | } |
| 180 | $this->segmentsCountRecalculator->recalculateForSubscribers([(int)$subscriber->getId()]); |
| 181 | } |
| 182 | |
| 183 | public function createOrUpdate( |
| 184 | SubscriberEntity $subscriber, |
| 185 | SegmentEntity $segment, |
| 186 | string $status, |
| 187 | bool $skipHooks = false, |
| 188 | bool $skipSegmentsCountRecalculation = false |
| 189 | ): SubscriberSegmentEntity { |
| 190 | $subscriberSegment = $this->findOneBy(['segment' => $segment, 'subscriber' => $subscriber]); |
| 191 | |
| 192 | $oldStatus = null; |
| 193 | if ($subscriberSegment instanceof SubscriberSegmentEntity) { |
| 194 | $oldStatus = $subscriberSegment->getStatus(); |
| 195 | $subscriberSegment->setStatus($status); |
| 196 | } else { |
| 197 | $subscriberSegment = new SubscriberSegmentEntity($segment, $subscriber, $status); |
| 198 | $subscriber->getSubscriberSegments()->add($subscriberSegment); |
| 199 | $this->entityManager->persist($subscriberSegment); |
| 200 | } |
| 201 | $this->entityManager->flush(); |
| 202 | |
| 203 | // fire subscribed hook for new subscriptions |
| 204 | if ( |
| 205 | !$skipHooks |
| 206 | && $subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED |
| 207 | && $subscriberSegment->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED |
| 208 | && $oldStatus !== SubscriberEntity::STATUS_SUBSCRIBED |
| 209 | ) { |
| 210 | $this->wp->doAction('mailpoet_segment_subscribed', $subscriberSegment); |
| 211 | } |
| 212 | if ( |
| 213 | !$skipHooks |
| 214 | && $oldStatus === SubscriberEntity::STATUS_SUBSCRIBED |
| 215 | && $subscriberSegment->getStatus() === SubscriberEntity::STATUS_UNSUBSCRIBED |
| 216 | ) { |
| 217 | $this->wp->doAction('mailpoet_segment_unsubscribed', $subscriberSegment); |
| 218 | } |
| 219 | |
| 220 | // segments_count only counts 'subscribed' memberships, so it can only change |
| 221 | // when the status crosses the subscribed boundary. A transition between two |
| 222 | // non-subscribed statuses (e.g. unconfirmed -> bounced) leaves it untouched. |
| 223 | $crossesSubscribedBoundary = $oldStatus !== $status |
| 224 | && ($oldStatus === SubscriberEntity::STATUS_SUBSCRIBED || $status === SubscriberEntity::STATUS_SUBSCRIBED); |
| 225 | if ($crossesSubscribedBoundary && !$skipSegmentsCountRecalculation) { |
| 226 | $this->segmentsCountRecalculator->recalculateForSubscribers([(int)$subscriber->getId()]); |
| 227 | } |
| 228 | |
| 229 | return $subscriberSegment; |
| 230 | } |
| 231 | } |
| 232 |