SubscriberCustomFieldsFactory.php — MailPoet – Newsletters, Email Marketing, and Automation 5.34.2

mailpoet / lib / Automation / Integrations / MailPoet / Fields / SubscriberCustomFieldsFactory.php

mailpoet / lib / Automation / Integrations / MailPoet / Fields Last commit date

NewsletterLinkFieldsFactory.php 2 years ago SubscriberAutomationFieldsFactory.php 1 year ago SubscriberCustomFieldsFactory.php 2 months ago SubscriberFieldsFactory.php 2 months ago SubscriberStatisticFieldsFactory.php 2 years ago index.php 3 years ago

SubscriberCustomFieldsFactory.php

173 lines

1	<?php declare(strict_types = 1);
2
3	namespace MailPoet\Automation\Integrations\MailPoet\Fields;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use DateTimeImmutable;
9	use MailPoet\Automation\Engine\Data\Field;
10	use MailPoet\Automation\Engine\Exceptions\InvalidStateException;
11	use MailPoet\Automation\Engine\WordPress;
12	use MailPoet\Automation\Integrations\MailPoet\Payloads\SubscriberPayload;
13	use MailPoet\CustomFields\CustomFieldsRepository;
14	use MailPoet\Entities\CustomFieldEntity;
15	use MailPoet\Entities\SubscriberCustomFieldEntity;
16	use MailPoet\Util\DateConverter;
17
18	class SubscriberCustomFieldsFactory {
19	/** @var CustomFieldsRepository */
20	private $customFieldsRepository;
21
22	/** @var WordPress */
23	private $wordPress;
24
25	public function __construct(
26	CustomFieldsRepository $customFieldsRepository,
27	WordPress $wordPress
28	) {
29	$this->customFieldsRepository = $customFieldsRepository;
30	$this->wordPress = $wordPress;
31	}
32
33	/** @return Field[] */
34	public function getFields(): array {
35	return array_map(function (CustomFieldEntity $customField) {
36	return $this->getField($customField);
37	}, $this->customFieldsRepository->findAllActive());
38	}
39
40	private function getField(CustomFieldEntity $customField): Field {
41	switch ($customField->getType()) {
42	case CustomFieldEntity::TYPE_TEXT:
43	case CustomFieldEntity::TYPE_TEXTAREA:
44	$validate = $customField->getParams()['validate'] ?? null;
45	return $validate === 'number'
46	? $this->createNumberField($customField)
47	: $this->createStringField($customField);
48	case CustomFieldEntity::TYPE_CHECKBOX:
49	return $this->createBooleanField($customField);
50	case CustomFieldEntity::TYPE_RADIO:
51	case CustomFieldEntity::TYPE_SELECT:
52	return $this->createEnumField($customField);
53	case CustomFieldEntity::TYPE_DATE:
54	$type = $customField->getParams()['date_type'] ?? null;
55	if ($type === 'year_month_day' \|\| $type === 'year_month') {
56	return $this->createDateTimeField($customField);
57	} elseif ($type === 'year') {
58	return $this->createYearField($customField);
59	} elseif ($type === 'month') {
60	return $this->createMonthField($customField);
61	} elseif ($type === 'day') {
62	return $this->createDayField($customField);
63	} else {
64	throw new InvalidStateException(sprintf('Unknown date type "%s"', $type));
65	}
66	default:
67	throw new InvalidStateException(sprintf('Unknown custom field type "%s"', $customField->getType()));
68	}
69	}
70
71	private function createStringField(CustomFieldEntity $customField): Field {
72	$factory = function (SubscriberPayload $payload) use ($customField) {
73	return $this->getCustomFieldValue($payload, $customField);
74	};
75	return $this->createField($customField, Field::TYPE_STRING, $factory);
76	}
77
78	private function createNumberField(CustomFieldEntity $customField): Field {
79	$factory = function (SubscriberPayload $payload) use ($customField) {
80	$value = $this->getCustomFieldValue($payload, $customField);
81	return is_numeric($value) ? (float)$value : null;
82	};
83	return $this->createField($customField, Field::TYPE_NUMBER, $factory);
84	}
85
86	private function createBooleanField(CustomFieldEntity $customField): Field {
87	$factory = function (SubscriberPayload $payload) use ($customField) {
88	$value = $this->getCustomFieldValue($payload, $customField);
89	return $value === null ? null : (bool)$value;
90	};
91	return $this->createField($customField, Field::TYPE_BOOLEAN, $factory);
92	}
93
94	private function createEnumField(CustomFieldEntity $customField): Field {
95	$factory = function (SubscriberPayload $payload) use ($customField) {
96	$value = $this->getCustomFieldValue($payload, $customField);
97	return $value === null ? null : $value;
98	};
99	return $this->createField($customField, Field::TYPE_ENUM, $factory, [
100	'options' => array_map(function (array $value) {
101	return ['id' => $value['value'], 'name' => $value['value']];
102	}, $customField->getParams()['values'] ?? []),
103	]);
104	}
105
106	private function createDateTimeField(CustomFieldEntity $customField): Field {
107	$factory = function (SubscriberPayload $payload) use ($customField) {
108	return $this->getDateTimeValue($customField, $this->getCustomFieldValue($payload, $customField) ?? '');
109	};
110	return $this->createField($customField, Field::TYPE_DATETIME, $factory);
111	}
112
113	private function createYearField(CustomFieldEntity $customField): Field {
114	$factory = function (SubscriberPayload $payload) use ($customField) {
115	$value = $this->getDateTimeValue($customField, $this->getCustomFieldValue($payload, $customField) ?? '');
116	return $value ? (int)$value->format('Y') : null;
117	};
118	return $this->createField($customField, Field::TYPE_INTEGER, $factory);
119	}
120
121	private function createMonthField(CustomFieldEntity $customField): Field {
122	$factory = function (SubscriberPayload $payload) use ($customField) {
123	$value = $this->getDateTimeValue($customField, $this->getCustomFieldValue($payload, $customField) ?? '');
124	return $value ? (int)$value->format('n') : null;
125	};
126	return $this->createField($customField, Field::TYPE_ENUM, $factory, [
127	'options' => array_map(function (int $value) {
128	return ['id' => $value, 'name' => $this->wordPress->getWpLocale()->get_month($value)];
129	}, range(1, 12)),
130	]);
131	}
132
133	private function createDayField(CustomFieldEntity $customField): Field {
134	$factory = function (SubscriberPayload $payload) use ($customField) {
135	$value = $this->getDateTimeValue($customField, $this->getCustomFieldValue($payload, $customField) ?? '');
136	return $value ? (int)$value->format('j') : null;
137	};
138	return $this->createField($customField, Field::TYPE_ENUM, $factory, [
139	'options' => array_map(function (int $value) {
140	return ['id' => $value, 'name' => "$value"];
141	}, range(1, 31)),
142	]);
143	}
144
145	private function getCustomFieldValue(SubscriberPayload $payload, CustomFieldEntity $customField): ?string {
146	$subscriberCustomField = $payload->getSubscriber()->getSubscriberCustomFields()->filter(
147	function (?SubscriberCustomFieldEntity $subscriberCustomField = null) use ($customField) {
148	return $subscriberCustomField && $subscriberCustomField->getCustomField() === $customField;
149	}
150	)->first() ?: null;
151	return $subscriberCustomField ? $subscriberCustomField->getValue() : null;
152	}
153
154	private function createField(CustomFieldEntity $customField, string $type, callable $factory, array $args = []): Field {
155	$key = 'mailpoet:subscriber:custom-field:' . $customField->getName();
156	$name = sprintf(
157	// translators: %s is the name of the custom field
158	__('Custom field: %s', 'mailpoet'),
159	$customField->getParams()['label'] ?? $customField->getName()
160	);
161	return new Field($key, $type, $name, $factory, $args);
162	}
163
164	private function getDateTimeValue(CustomFieldEntity $customField, ?string $value): ?DateTimeImmutable {
165	$dateFormat = $customField->getParams()['date_format'] ?? null;
166	if (!$dateFormat \|\| !$value) {
167	return null;
168	}
169	$dateString = (new DateConverter())->convertDateToDatetime($value, $dateFormat) ?: null;
170	return $dateString ? new DateTimeImmutable($dateString, $this->wordPress->wpTimezone()) : null;
171	}
172	}
173