Track
5 days ago
GATracking.php
6 months ago
StatisticsBouncesRepository.php
3 years ago
StatisticsClicksRepository.php
2 years ago
StatisticsFormsRepository.php
3 years ago
StatisticsNewslettersRepository.php
1 year ago
StatisticsOpensRepository.php
4 days ago
StatisticsUnsubscribesRepository.php
2 months ago
StatisticsWooCommercePurchasesRepository.php
1 year ago
UnsubscribeReasonTracker.php
2 months ago
UserAgentsRepository.php
1 year ago
index.php
3 years ago
UnsubscribeReasonTracker.php
109 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Statistics; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\NewsletterEntity; |
| 9 | use MailPoet\Entities\SendingQueueEntity; |
| 10 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 11 | use MailPoet\Entities\SubscriberEntity; |
| 12 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 13 | use MailPoet\WP\Functions as WPFunctions; |
| 14 | |
| 15 | class UnsubscribeReasonTracker { |
| 16 | const MAX_REASON_TEXT_LENGTH = 500; |
| 17 | |
| 18 | /** @var SendingQueuesRepository */ |
| 19 | private $sendingQueuesRepository; |
| 20 | |
| 21 | /** @var StatisticsUnsubscribesRepository */ |
| 22 | private $statisticsUnsubscribesRepository; |
| 23 | |
| 24 | /** @var WPFunctions */ |
| 25 | private $wp; |
| 26 | |
| 27 | public function __construct( |
| 28 | SendingQueuesRepository $sendingQueuesRepository, |
| 29 | StatisticsUnsubscribesRepository $statisticsUnsubscribesRepository, |
| 30 | WPFunctions $wp |
| 31 | ) { |
| 32 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 33 | $this->statisticsUnsubscribesRepository = $statisticsUnsubscribesRepository; |
| 34 | $this->wp = $wp; |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * @return array<string, string> |
| 39 | */ |
| 40 | public function getReasonLabels(): array { |
| 41 | return [ |
| 42 | StatisticsUnsubscribeEntity::REASON_NO_LONGER_INTERESTED => __('I no longer want to receive these emails', 'mailpoet'), |
| 43 | StatisticsUnsubscribeEntity::REASON_DID_NOT_SIGN_UP => __('I never signed up for this mailing list', 'mailpoet'), |
| 44 | StatisticsUnsubscribeEntity::REASON_INAPPROPRIATE_CONTENT => __('The emails are inappropriate', 'mailpoet'), |
| 45 | StatisticsUnsubscribeEntity::REASON_SPAM => __('The emails are spam and should be reported', 'mailpoet'), |
| 46 | StatisticsUnsubscribeEntity::REASON_OTHER => __('Other', 'mailpoet'), |
| 47 | ]; |
| 48 | } |
| 49 | |
| 50 | public function isValidReason(string $reason): bool { |
| 51 | return in_array($reason, StatisticsUnsubscribeEntity::REASONS, true); |
| 52 | } |
| 53 | |
| 54 | public function findTargetUnsubscribe(SubscriberEntity $subscriber, ?int $queueId): ?StatisticsUnsubscribeEntity { |
| 55 | if ($queueId !== null) { |
| 56 | $queue = $this->sendingQueuesRepository->findOneById($queueId); |
| 57 | if (!$queue instanceof SendingQueueEntity) { |
| 58 | return null; |
| 59 | } |
| 60 | $newsletter = $queue->getNewsletter(); |
| 61 | if (!$newsletter instanceof NewsletterEntity) { |
| 62 | return null; |
| 63 | } |
| 64 | return $this->statisticsUnsubscribesRepository->findOneBySubscriberAndQueue($subscriber, $queue, $newsletter); |
| 65 | } |
| 66 | |
| 67 | return $this->statisticsUnsubscribesRepository->findLatestForSubscriber($subscriber); |
| 68 | } |
| 69 | |
| 70 | public function saveReason( |
| 71 | SubscriberEntity $subscriber, |
| 72 | ?int $queueId, |
| 73 | string $reason, |
| 74 | ?string $reasonText, |
| 75 | bool $allowOtherText |
| 76 | ): ?StatisticsUnsubscribeEntity { |
| 77 | if (!$this->isValidReason($reason)) { |
| 78 | return null; |
| 79 | } |
| 80 | |
| 81 | $unsubscribe = $this->findTargetUnsubscribe($subscriber, $queueId); |
| 82 | if (!$unsubscribe instanceof StatisticsUnsubscribeEntity) { |
| 83 | return null; |
| 84 | } |
| 85 | |
| 86 | $unsubscribe->setReasonData($reason, $this->prepareReasonText($reason, $reasonText, $allowOtherText)); |
| 87 | $this->statisticsUnsubscribesRepository->persist($unsubscribe); |
| 88 | $this->statisticsUnsubscribesRepository->flush(); |
| 89 | |
| 90 | return $unsubscribe; |
| 91 | } |
| 92 | |
| 93 | private function prepareReasonText(string $reason, ?string $reasonText, bool $allowOtherText): ?string { |
| 94 | if (!$allowOtherText || $reason !== StatisticsUnsubscribeEntity::REASON_OTHER || $reasonText === null) { |
| 95 | return null; |
| 96 | } |
| 97 | |
| 98 | $reasonText = $this->wp->wpStripAllTags($reasonText, true); |
| 99 | $reasonText = trim($reasonText); |
| 100 | if ($reasonText === '') { |
| 101 | return null; |
| 102 | } |
| 103 | |
| 104 | return function_exists('mb_substr') |
| 105 | ? mb_substr($reasonText, 0, self::MAX_REASON_TEXT_LENGTH) |
| 106 | : substr($reasonText, 0, self::MAX_REASON_TEXT_LENGTH); |
| 107 | } |
| 108 | } |
| 109 |