API.php
3 months ago
APIException.php
3 months ago
CustomFields.php
2 months ago
Segments.php
2 months ago
Subscribers.php
2 months ago
Tags.php
3 months ago
index.php
3 years ago
Segments.php
213 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\API\MP\v1; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\SegmentEntity; |
| 9 | use MailPoet\Form\FormsRepository; |
| 10 | use MailPoet\Newsletter\Segment\NewsletterSegmentRepository; |
| 11 | use MailPoet\Segments\SegmentsRepository; |
| 12 | |
| 13 | class Segments { |
| 14 | private const DATE_FORMAT = 'Y-m-d H:i:s'; |
| 15 | |
| 16 | /** @var NewsletterSegmentRepository */ |
| 17 | private $newsletterSegmentRepository; |
| 18 | |
| 19 | /** @var FormsRepository */ |
| 20 | private $formsRepository; |
| 21 | |
| 22 | /** @var SegmentsRepository */ |
| 23 | private $segmentsRepository; |
| 24 | |
| 25 | public function __construct ( |
| 26 | NewsletterSegmentRepository $newsletterSegmentRepository, |
| 27 | FormsRepository $formsRepository, |
| 28 | SegmentsRepository $segmentsRepository |
| 29 | ) { |
| 30 | $this->newsletterSegmentRepository = $newsletterSegmentRepository; |
| 31 | $this->formsRepository = $formsRepository; |
| 32 | $this->segmentsRepository = $segmentsRepository; |
| 33 | } |
| 34 | |
| 35 | public function getAll(): array { |
| 36 | $segments = $this->segmentsRepository->findBy(['type' => SegmentEntity::TYPE_DEFAULT], ['id' => 'asc']); |
| 37 | $result = []; |
| 38 | foreach ($segments as $segment) { |
| 39 | $result[] = $this->buildItem($segment); |
| 40 | } |
| 41 | return $result; |
| 42 | } |
| 43 | |
| 44 | public function addList(array $data): array { |
| 45 | $this->validateSegmentName($data); |
| 46 | |
| 47 | try { |
| 48 | $name = isset($data['name']) ? sanitize_text_field($data['name']) : ''; |
| 49 | $description = isset($data['description']) ? sanitize_textarea_field($data['description']) : ''; |
| 50 | $segment = $this->segmentsRepository->createOrUpdate($name, $description); |
| 51 | } catch (\Exception $e) { |
| 52 | throw new APIException( |
| 53 | __('The list couldn’t be created in the database', 'mailpoet'), |
| 54 | APIException::FAILED_TO_SAVE_LIST |
| 55 | ); |
| 56 | } |
| 57 | |
| 58 | return $this->buildItem($segment); |
| 59 | } |
| 60 | |
| 61 | public function updateList(array $data): array { |
| 62 | // firstly validation on list id |
| 63 | $this->validateSegmentId((string)($data['id'] ?? '')); |
| 64 | |
| 65 | // secondly validation on list name |
| 66 | $this->validateSegmentName($data); |
| 67 | |
| 68 | // update is supported only for default segment type |
| 69 | $this->validateSegmentType((string)$data['id']); |
| 70 | |
| 71 | $name = isset($data['name']) ? sanitize_text_field($data['name']) : ''; |
| 72 | $description = isset($data['description']) ? sanitize_textarea_field($data['description']) : ''; |
| 73 | |
| 74 | try { |
| 75 | $segment = $this->segmentsRepository->createOrUpdate( |
| 76 | $name, |
| 77 | $description, |
| 78 | SegmentEntity::TYPE_DEFAULT, |
| 79 | [], |
| 80 | (int)$data['id'] |
| 81 | ); |
| 82 | } catch (\Exception $e) { |
| 83 | throw new APIException( |
| 84 | __('The list couldn’t be updated in the database', 'mailpoet'), |
| 85 | APIException::FAILED_TO_UPDATE_LIST |
| 86 | ); |
| 87 | } |
| 88 | |
| 89 | return $this->buildItem($segment); |
| 90 | } |
| 91 | |
| 92 | public function deleteList(string $listId): bool { |
| 93 | $this->validateSegmentId($listId); |
| 94 | |
| 95 | // delete is supported only for default segment type |
| 96 | $this->validateSegmentType($listId); |
| 97 | |
| 98 | $activelyUsedNewslettersSubjects = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments([$listId]); |
| 99 | if (isset($activelyUsedNewslettersSubjects[$listId])) { |
| 100 | throw new APIException( |
| 101 | str_replace( |
| 102 | '%1$s', |
| 103 | "'" . join("', '", $activelyUsedNewslettersSubjects[$listId]) . "'", |
| 104 | // translators: %1$s is a comma-separated list of emails for which the segment is used. |
| 105 | _x('List cannot be deleted because it’s used for %1$s email', 'Alert shown when trying to delete segment, which is assigned to any automatic emails.', 'mailpoet') |
| 106 | ), |
| 107 | APIException::LIST_USED_IN_EMAIL |
| 108 | ); |
| 109 | } |
| 110 | |
| 111 | $activelyUsedFormNames = $this->formsRepository->getNamesOfFormsForSegments(); |
| 112 | if (isset($activelyUsedFormNames[$listId])) { |
| 113 | throw new APIException( |
| 114 | str_replace( |
| 115 | '%1$s', |
| 116 | "'" . join("', '", $activelyUsedFormNames[$listId]) . "'", |
| 117 | // translators: %1$s is a comma-separated list of forms for which the segment is used. |
| 118 | _nx( |
| 119 | 'List cannot be deleted because it’s used for %1$s form', |
| 120 | 'List cannot be deleted because it’s used for %1$s forms', |
| 121 | count($activelyUsedFormNames[$listId]), |
| 122 | 'Alert shown when trying to delete segment, when it is assigned to a form.', |
| 123 | 'mailpoet' |
| 124 | ) |
| 125 | ), |
| 126 | APIException::LIST_USED_IN_FORM |
| 127 | ); |
| 128 | } |
| 129 | |
| 130 | try { |
| 131 | $this->segmentsRepository->bulkDelete([$listId]); |
| 132 | return true; |
| 133 | } catch (\Exception $e) { |
| 134 | throw new APIException( |
| 135 | __('The list couldn’t be deleted from the database', 'mailpoet'), |
| 136 | APIException::FAILED_TO_DELETE_LIST |
| 137 | ); |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | private function validateSegmentId(string $segmentId): void { |
| 142 | if (empty($segmentId)) { |
| 143 | throw new APIException( |
| 144 | __('List id is required.', 'mailpoet'), |
| 145 | APIException::LIST_ID_REQUIRED |
| 146 | ); |
| 147 | } |
| 148 | |
| 149 | if (!$this->segmentsRepository->findOneById($segmentId)) { |
| 150 | throw new APIException( |
| 151 | __('The list does not exist.', 'mailpoet'), |
| 152 | APIException::LIST_NOT_EXISTS |
| 153 | ); |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Throws an exception when the segment's name is invalid. |
| 159 | * Validates against the sanitized name so whitespace-only inputs that |
| 160 | * collapse to empty after sanitize_text_field() are rejected up front |
| 161 | * instead of being silently saved as an empty list name. |
| 162 | * @return void |
| 163 | */ |
| 164 | private function validateSegmentName(array $data): void { |
| 165 | $name = isset($data['name']) && is_string($data['name']) ? sanitize_text_field($data['name']) : ''; |
| 166 | if ($name === '') { |
| 167 | throw new APIException( |
| 168 | __('List name is required.', 'mailpoet'), |
| 169 | APIException::LIST_NAME_REQUIRED |
| 170 | ); |
| 171 | } |
| 172 | |
| 173 | $segmentId = isset($data['id']) ? (int)$data['id'] : null; |
| 174 | if (!$this->segmentsRepository->isNameUnique($name, $segmentId)) { |
| 175 | throw new APIException( |
| 176 | __('This list already exists.', 'mailpoet'), |
| 177 | APIException::LIST_EXISTS |
| 178 | ); |
| 179 | } |
| 180 | } |
| 181 | |
| 182 | private function validateSegmentType(string $segmentId): void { |
| 183 | $segment = $this->segmentsRepository->findOneById($segmentId); |
| 184 | if ($segment && $segment->getType() !== SegmentEntity::TYPE_DEFAULT) { |
| 185 | throw new APIException( |
| 186 | str_replace( |
| 187 | '%1$s', |
| 188 | "'" . $segment->getType() . "'", |
| 189 | // translators: %1$s is an invalid segment type. |
| 190 | __('List of the type %1$s is not supported for this action.', 'mailpoet') |
| 191 | ), |
| 192 | APIException::LIST_TYPE_IS_NOT_SUPPORTED |
| 193 | ); |
| 194 | } |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * @param SegmentEntity $segment |
| 199 | * @return array |
| 200 | */ |
| 201 | private function buildItem(SegmentEntity $segment): array { |
| 202 | return [ |
| 203 | 'id' => (string)$segment->getId(), // (string) for BC |
| 204 | 'name' => $segment->getName(), |
| 205 | 'type' => $segment->getType(), |
| 206 | 'description' => $segment->getDescription(), |
| 207 | 'created_at' => ($createdAt = $segment->getCreatedAt()) ? $createdAt->format(self::DATE_FORMAT) : null, |
| 208 | 'updated_at' => ($updatedAt = $segment->getUpdatedAt()) ? $updatedAt->format(self::DATE_FORMAT) : null, |
| 209 | 'deleted_at' => ($deletedAt = $segment->getDeletedAt()) ? $deletedAt->format(self::DATE_FORMAT) : null, |
| 210 | ]; |
| 211 | } |
| 212 | } |
| 213 |