CustomFieldsResponseBuilder.php
11 months ago
DynamicSegmentsResponseBuilder.php
2 months ago
FormsResponseBuilder.php
11 months ago
NewsletterTemplatesResponseBuilder.php
11 months ago
NewslettersResponseBuilder.php
3 weeks ago
ScheduledTaskSubscriberResponseBuilder.php
3 years ago
SegmentsResponseBuilder.php
2 months ago
SendingQueuesResponseBuilder.php
2 months ago
SubscribersResponseBuilder.php
2 weeks ago
index.php
3 years ago
DynamicSegmentsResponseBuilder.php
115 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\Entities\DynamicSegmentFilterData; |
| 9 | use MailPoet\Entities\SegmentEntity; |
| 10 | use MailPoet\Entities\SubscriberEntity; |
| 11 | use MailPoet\Segments\SegmentDependencyValidator; |
| 12 | use MailPoet\Subscribers\SubscribersCountsController; |
| 13 | use MailPoet\WP\Functions; |
| 14 | |
| 15 | class DynamicSegmentsResponseBuilder { |
| 16 | const DATE_FORMAT = 'Y-m-d H:i:s'; |
| 17 | |
| 18 | /** @var SegmentsResponseBuilder */ |
| 19 | private $segmentsResponseBuilder; |
| 20 | |
| 21 | /** @var Functions */ |
| 22 | private $wp; |
| 23 | |
| 24 | /** @var SegmentDependencyValidator */ |
| 25 | private $segmentDependencyValidator; |
| 26 | |
| 27 | /** @var SubscribersCountsController */ |
| 28 | private $subscribersCountsController; |
| 29 | |
| 30 | public function __construct( |
| 31 | Functions $wp, |
| 32 | SegmentsResponseBuilder $segmentsResponseBuilder, |
| 33 | SegmentDependencyValidator $segmentDependencyValidator, |
| 34 | SubscribersCountsController $subscribersCountsController |
| 35 | ) { |
| 36 | $this->segmentsResponseBuilder = $segmentsResponseBuilder; |
| 37 | $this->wp = $wp; |
| 38 | $this->segmentDependencyValidator = $segmentDependencyValidator; |
| 39 | $this->subscribersCountsController = $subscribersCountsController; |
| 40 | } |
| 41 | |
| 42 | public function build(SegmentEntity $segmentEntity) { |
| 43 | $data = $this->segmentsResponseBuilder->build($segmentEntity); |
| 44 | $data = $this->addMissingPluginProperties($segmentEntity, $data); |
| 45 | $dynamicFilters = $segmentEntity->getDynamicFilters(); |
| 46 | $filters = []; |
| 47 | foreach ($dynamicFilters as $dynamicFilter) { |
| 48 | $filter = $dynamicFilter->getFilterData()->getData(); |
| 49 | $filter['id'] = $dynamicFilter->getId(); |
| 50 | $filter['segmentType'] = $dynamicFilter->getFilterData()->getFilterType(); // We need to add filterType with key segmentType due to BC |
| 51 | $filter['action'] = $dynamicFilter->getFilterData()->getAction(); |
| 52 | if (isset($filter['country_code']) && !is_array($filter['country_code'])) { |
| 53 | // Convert to multiple values filter |
| 54 | $filter['country_code'] = [$filter['country_code']]; |
| 55 | } |
| 56 | if (isset($filter['wordpressRole']) && !is_array($filter['wordpressRole'])) { |
| 57 | // new filters are always array, they support multiple values, the old didn't convert old filters to new format |
| 58 | $filter['wordpressRole'] = [$filter['wordpressRole']]; |
| 59 | } |
| 60 | if (($filter['segmentType'] === DynamicSegmentFilterData::TYPE_EMAIL) && isset($filter['newsletter_id'])) { |
| 61 | $filter['newsletter_id'] = intval($filter['newsletter_id']); |
| 62 | } |
| 63 | $filters[] = $filter; |
| 64 | } |
| 65 | $data['filters'] = $filters; |
| 66 | return $data; |
| 67 | } |
| 68 | |
| 69 | public function buildForListing(array $segments): array { |
| 70 | $data = []; |
| 71 | foreach ($segments as $segment) { |
| 72 | $data[] = $this->buildListingItem($segment); |
| 73 | } |
| 74 | return $data; |
| 75 | } |
| 76 | |
| 77 | private function addMissingPluginProperties(SegmentEntity $segment, array $data): array { |
| 78 | $missingPlugins = $this->segmentDependencyValidator->getMissingPluginsBySegment($segment); |
| 79 | if ($missingPlugins) { |
| 80 | $missingPlugin = reset($missingPlugins); |
| 81 | $data['is_plugin_missing'] = true; |
| 82 | |
| 83 | $missingPluginMessage = $this->segmentDependencyValidator->getCustomErrorMessage($missingPlugin); |
| 84 | |
| 85 | if ($missingPluginMessage) { |
| 86 | $data['missing_plugin_message'] = $missingPluginMessage; |
| 87 | } else { |
| 88 | $data['missing_plugin_message']['message'] = |
| 89 | sprintf( |
| 90 | // translators: %s is the name of the missing plugin. |
| 91 | __('Activate the %s plugin to see the number of subscribers and enable the editing of this segment.', 'mailpoet'), |
| 92 | $missingPlugin |
| 93 | ); |
| 94 | } |
| 95 | } else { |
| 96 | $data['is_plugin_missing'] = false; |
| 97 | $data['missing_plugin_message'] = null; |
| 98 | } |
| 99 | return $data; |
| 100 | } |
| 101 | |
| 102 | private function buildListingItem(SegmentEntity $segment): array { |
| 103 | $data = $this->segmentsResponseBuilder->build($segment); |
| 104 | $data = $this->addMissingPluginProperties($segment, $data); |
| 105 | $data['subscribers_url'] = $this->wp->adminUrl( |
| 106 | 'admin.php?page=mailpoet-subscribers#/filter[segment=' . $segment->getId() . ']' |
| 107 | ); |
| 108 | |
| 109 | $segmentStatisticsCount = $this->subscribersCountsController->getSegmentStatisticsCount($segment); |
| 110 | $data['count_all'] = $segmentStatisticsCount['all']; |
| 111 | $data['count_subscribed'] = $segmentStatisticsCount[SubscriberEntity::STATUS_SUBSCRIBED]; |
| 112 | return $data; |
| 113 | } |
| 114 | } |
| 115 |