ScheduledTaskSubscribersListingRepository.php
1 year ago
ScheduledTaskSubscribersRepository.php
1 year ago
ScheduledTasksRepository.php
1 year ago
SendingQueuesRepository.php
1 year ago
index.php
3 years ago
ScheduledTaskSubscribersListingRepository.php
135 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Newsletter\Sending; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\ScheduledTaskSubscriberEntity; |
| 9 | use MailPoet\Listing\ListingDefinition; |
| 10 | use MailPoet\Listing\ListingRepository; |
| 11 | use MailPoet\Util\Helpers; |
| 12 | use MailPoetVendor\Doctrine\ORM\QueryBuilder; |
| 13 | |
| 14 | class ScheduledTaskSubscribersListingRepository extends ListingRepository { |
| 15 | public function getGroups(ListingDefinition $definition): array { |
| 16 | $queryBuilder = clone $this->queryBuilder; |
| 17 | $this->applyFromClause($queryBuilder); |
| 18 | $this->applyParameters($queryBuilder, $definition->getParameters()); |
| 19 | |
| 20 | // total count |
| 21 | $countQueryBuilder = clone $queryBuilder; |
| 22 | $countQueryBuilder->select('COUNT(sts.subscriber) AS subscriberCount'); |
| 23 | $totalCount = intval($countQueryBuilder->getQuery()->getSingleScalarResult()); |
| 24 | |
| 25 | // Sent count |
| 26 | $sentCountQuery = clone $queryBuilder; |
| 27 | $sentCountQuery->select('COUNT(sts.subscriber) AS subscriberCount'); |
| 28 | $sentCountQuery->andWhere('sts.processed = :processedStatus'); |
| 29 | $sentCountQuery->andWhere('sts.failed = :failedStatus'); |
| 30 | $sentCountQuery->setParameter('processedStatus', ScheduledTaskSubscriberEntity::STATUS_PROCESSED); |
| 31 | $sentCountQuery->setParameter('failedStatus', ScheduledTaskSubscriberEntity::FAIL_STATUS_OK); |
| 32 | $sentCount = intval($sentCountQuery->getQuery()->getSingleScalarResult()); |
| 33 | |
| 34 | // Failed count |
| 35 | $failedCountQuery = clone $queryBuilder; |
| 36 | $failedCountQuery->select('COUNT(sts.subscriber) AS subscriberCount'); |
| 37 | $failedCountQuery->andWhere('sts.failed = :failedStatus'); |
| 38 | $failedCountQuery->setParameter('failedStatus', ScheduledTaskSubscriberEntity::FAIL_STATUS_FAILED); |
| 39 | $failedCount = intval($failedCountQuery->getQuery()->getSingleScalarResult()); |
| 40 | |
| 41 | // Unprocessed count |
| 42 | $unprocessedCountQuery = clone $queryBuilder; |
| 43 | $unprocessedCountQuery->select('COUNT(sts.subscriber) AS subscriberCount'); |
| 44 | $unprocessedCountQuery->andWhere('sts.processed = :processedStatus'); |
| 45 | $unprocessedCountQuery->setParameter('processedStatus', ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED); |
| 46 | $unprocessedCount = intval($unprocessedCountQuery->getQuery()->getSingleScalarResult()); |
| 47 | |
| 48 | return [ |
| 49 | [ |
| 50 | 'name' => 'all', |
| 51 | 'label' => __('All', 'mailpoet'), |
| 52 | 'count' => $totalCount, |
| 53 | ], |
| 54 | [ |
| 55 | 'name' => ScheduledTaskSubscriberEntity::SENDING_STATUS_SENT, |
| 56 | 'label' => __('Sent', 'mailpoet'), |
| 57 | 'count' => $sentCount, |
| 58 | ], |
| 59 | [ |
| 60 | 'name' => ScheduledTaskSubscriberEntity::SENDING_STATUS_FAILED, |
| 61 | 'label' => __('Failed', 'mailpoet'), |
| 62 | 'count' => $failedCount, |
| 63 | ], |
| 64 | [ |
| 65 | 'name' => ScheduledTaskSubscriberEntity::SENDING_STATUS_UNPROCESSED, |
| 66 | 'label' => __('Unprocessed', 'mailpoet'), |
| 67 | 'count' => $unprocessedCount, |
| 68 | ], |
| 69 | ]; |
| 70 | } |
| 71 | |
| 72 | protected function applySelectClause(QueryBuilder $queryBuilder) { |
| 73 | $queryBuilder->select("PARTIAL sts.{task,subscriber,processed,failed,error,createdAt,updatedAt}, PARTIAL s.{id, email, firstName, lastName}"); |
| 74 | } |
| 75 | |
| 76 | protected function applyFromClause(QueryBuilder $queryBuilder) { |
| 77 | $queryBuilder->from(ScheduledTaskSubscriberEntity::class, 'sts') |
| 78 | ->leftJoin('sts.subscriber', 's'); |
| 79 | } |
| 80 | |
| 81 | protected function applyGroup(QueryBuilder $queryBuilder, string $group) { |
| 82 | if ($group === ScheduledTaskSubscriberEntity::SENDING_STATUS_SENT) { |
| 83 | $queryBuilder->andWhere('sts.processed = :processedStatus'); |
| 84 | $queryBuilder->andWhere('sts.failed = :failedStatus'); |
| 85 | $queryBuilder->setParameter('processedStatus', ScheduledTaskSubscriberEntity::STATUS_PROCESSED); |
| 86 | $queryBuilder->setParameter('failedStatus', ScheduledTaskSubscriberEntity::FAIL_STATUS_OK); |
| 87 | } elseif ($group === ScheduledTaskSubscriberEntity::SENDING_STATUS_FAILED) { |
| 88 | $queryBuilder->andWhere('sts.failed = :failedStatus'); |
| 89 | $queryBuilder->setParameter('failedStatus', ScheduledTaskSubscriberEntity::FAIL_STATUS_FAILED); |
| 90 | } elseif ($group === ScheduledTaskSubscriberEntity::SENDING_STATUS_UNPROCESSED) { |
| 91 | $queryBuilder->andWhere('sts.processed = :processedStatus'); |
| 92 | $queryBuilder->setParameter('processedStatus', ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED); |
| 93 | } |
| 94 | } |
| 95 | |
| 96 | protected function applySorting(QueryBuilder $queryBuilder, string $sortBy, string $sortOrder) { |
| 97 | // ScheduledTaskSubscriber doesn't have id column so the default fallback value 'id' |
| 98 | // generated in MailPoet\Listing\Handler needs to be changed to something else |
| 99 | if ($sortBy === 'id') { |
| 100 | $sortBy = 'sts.subscriber'; |
| 101 | } elseif ($sortBy === 'subscriberId') { // Ordering by subscriberId is mapped to email for consistency with Subscriber listing |
| 102 | $sortBy = 's.email'; |
| 103 | } else { |
| 104 | $sortBy = "sts.{$sortBy}"; |
| 105 | } |
| 106 | $queryBuilder->addOrderBy($sortBy, $sortOrder); |
| 107 | } |
| 108 | |
| 109 | protected function applySearch(QueryBuilder $queryBuilder, string $search, array $parameters = []) { |
| 110 | $search = Helpers::escapeSearch($search); |
| 111 | $queryBuilder |
| 112 | ->andWhere('s.email LIKE :search or s.firstName LIKE :search or s.lastName LIKE :search') |
| 113 | ->setParameter('search', "%$search%"); |
| 114 | } |
| 115 | |
| 116 | protected function applyFilters(QueryBuilder $queryBuilder, array $filters) { |
| 117 | // the parent class requires this method, but scheduled task subscribers listing doesn't currently support this feature. |
| 118 | } |
| 119 | |
| 120 | protected function applyParameters(QueryBuilder $queryBuilder, array $parameters) { |
| 121 | if (isset($parameters['task_ids']) && !empty($parameters['task_ids'])) { |
| 122 | $queryBuilder->andWhere('sts.task IN (:taskIds)') |
| 123 | ->setParameter('taskIds', $parameters['task_ids']); |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | public function getCount(ListingDefinition $definition): int { |
| 128 | $queryBuilder = clone $this->queryBuilder; |
| 129 | $this->applyFromClause($queryBuilder); |
| 130 | $this->applyConstraints($queryBuilder, $definition); |
| 131 | $queryBuilder->select("COUNT(DISTINCT sts.subscriber)"); |
| 132 | return intval($queryBuilder->getQuery()->getSingleScalarResult()); |
| 133 | } |
| 134 | } |
| 135 |