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

mailpoet / lib / Entities / SegmentEntity.php

mailpoet / lib / Entities Last commit date

SegmentEntity.php

300 lines

1	<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
2
3	namespace MailPoet\Entities;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use MailPoet\Doctrine\EntityTraits\AutoincrementedIdTrait;
9	use MailPoet\Doctrine\EntityTraits\CreatedAtTrait;
10	use MailPoet\Doctrine\EntityTraits\DeletedAtTrait;
11	use MailPoet\Doctrine\EntityTraits\UpdatedAtTrait;
12	use MailPoetVendor\Doctrine\Common\Collections\ArrayCollection;
13	use MailPoetVendor\Doctrine\ORM\Mapping as ORM;
14	use MailPoetVendor\Symfony\Component\Validator\Constraints as Assert;
15
16	/**
17	* @ORM\Entity()
18	* @ORM\Table(name="segments")
19	*/
20	class SegmentEntity {
21	use AutoincrementedIdTrait;
22	use CreatedAtTrait;
23	use UpdatedAtTrait;
24	use DeletedAtTrait;
25
26	const TYPE_WP_USERS = 'wp_users';
27	const TYPE_WC_USERS = 'woocommerce_users';
28	const TYPE_WC_MEMBERSHIPS = 'woocommerce_memberships';
29	const TYPE_DEFAULT = 'default';
30	const TYPE_DYNAMIC = 'dynamic';
31	const TYPE_WITHOUT_LIST = 'without-list';
32
33	const NON_WOO_RELATED_TYPES = [
34	self::TYPE_WP_USERS,
35	self::TYPE_DEFAULT,
36	self::TYPE_DYNAMIC,
37	self::TYPE_WITHOUT_LIST,
38	];
39
40	const SEGMENT_ENABLED = 'active';
41	const SEGMENT_DISABLED = 'disabled';
42
43	/**
44	* @ORM\Column(type="string")
45	* @Assert\NotBlank()
46	* @var string
47	*/
48	private $name;
49
50	/**
51	* @ORM\Column(type="string")
52	* @var string
53	*/
54	private $type;
55
56	/**
57	* @ORM\Column(type="string")
58	* @var string
59	*/
60	private $description;
61
62	/**
63	* @ORM\Column(type="text", nullable=true)
64	* @var string\|null
65	*/
66	private $publicDescription = '';
67
68	/**
69	* @ORM\OneToMany(targetEntity="MailPoet\Entities\DynamicSegmentFilterEntity", mappedBy="segment")
70	* @var ArrayCollection<int, DynamicSegmentFilterEntity>
71	*/
72	private $dynamicFilters;
73
74	/**
75	* @ORM\Column(type="float", nullable=true)
76	* @var float\|null
77	*/
78	private $averageEngagementScore;
79
80	/**
81	* @ORM\Column(type="datetimetz", nullable=true)
82	* @var \DateTimeInterface\|null
83	*/
84	private $averageEngagementScoreUpdatedAt;
85
86	/**
87	* @ORM\Column(type="boolean")
88	* @var bool
89	*/
90	private $displayInManageSubscriptionPage = false;
91
92	/**
93	* @ORM\Column(type="integer", nullable=true)
94	* @var int\|null
95	*/
96	private $confirmationEmailId;
97
98	/**
99	* @ORM\Column(type="integer", nullable=true)
100	* @var int\|null
101	*/
102	private $confirmationPageId;
103
104	public function __construct(
105	string $name,
106	string $type,
107	string $description
108	) {
109	$this->name = $name;
110	$this->type = $type;
111	$this->description = $description;
112	$this->publicDescription = '';
113	$this->dynamicFilters = new ArrayCollection();
114	}
115
116	public function __clone() {
117	// reset ID
118	$this->id = null;
119	$this->dynamicFilters = new ArrayCollection();
120	}
121
122	/**
123	* @return string
124	*/
125	public function getName() {
126	return $this->name;
127	}
128
129	/**
130	* @param string $name
131	*/
132	public function setName($name) {
133	$this->name = $name;
134	}
135
136	/**
137	* @return string
138	*/
139	public function getType() {
140	return $this->type;
141	}
142
143	/**
144	* @param string $type
145	*/
146	public function setType($type) {
147	$this->type = $type;
148	}
149
150	/**
151	* @return string
152	*/
153	public function getDescription() {
154	return $this->description;
155	}
156
157	/**
158	* @param string $description
159	*/
160	public function setDescription($description) {
161	$this->description = $description;
162	}
163
164	public function getPublicDescription(): string {
165	return $this->publicDescription ?? '';
166	}
167
168	public function setPublicDescription(string $publicDescription): void {
169	$this->publicDescription = $publicDescription;
170	}
171
172	/**
173	* @return ArrayCollection<int, DynamicSegmentFilterEntity>
174	*/
175	public function getDynamicFilters() {
176	return $this->dynamicFilters;
177	}
178
179	public function addDynamicFilter(DynamicSegmentFilterEntity $dynamicSegmentFilterEntity) {
180	$this->dynamicFilters->add($dynamicSegmentFilterEntity);
181	}
182
183	public function isStatic(): bool {
184	return in_array($this->getType(), [self::TYPE_DEFAULT, self::TYPE_WP_USERS, self::TYPE_WC_USERS, self::TYPE_WC_MEMBERSHIPS], true);
185	}
186
187	public function getAverageEngagementScore(): ?float {
188	return $this->averageEngagementScore;
189	}
190
191	public function setAverageEngagementScore(?float $averageEngagementScore): void {
192	$this->averageEngagementScore = $averageEngagementScore;
193	}
194
195	public function getAverageEngagementScoreUpdatedAt(): ?\DateTimeInterface {
196	return $this->averageEngagementScoreUpdatedAt;
197	}
198
199	public function setAverageEngagementScoreUpdatedAt(?\DateTimeInterface $averageEngagementScoreUpdatedAt): void {
200	$this->averageEngagementScoreUpdatedAt = $averageEngagementScoreUpdatedAt;
201	}
202
203	public function getDisplayInManageSubscriptionPage(): bool {
204	return $this->displayInManageSubscriptionPage;
205	}
206
207	public function setDisplayInManageSubscriptionPage(bool $state): void {
208	$this->displayInManageSubscriptionPage = $state;
209	}
210
211	public function getConfirmationEmailId(): ?int {
212	return $this->confirmationEmailId;
213	}
214
215	public function setConfirmationEmailId(?int $confirmationEmailId): void {
216	$this->confirmationEmailId = $confirmationEmailId;
217	}
218
219	public function getConfirmationPageId(): ?int {
220	return $this->confirmationPageId;
221	}
222
223	public function setConfirmationPageId(?int $confirmationPageId): void {
224	$this->confirmationPageId = $confirmationPageId;
225	}
226
227	/**
228	* Returns connect operand from the first filter, when doesn't exist, then returns a default value.
229	*
230	* For segments with multiple filter groups this is the outer connector between the groups
231	* (and/or). For legacy single-group segments it carries the within-group operator
232	* (and/or/none).
233	*
234	* @return string
235	*/
236	public function getFiltersConnectOperator(): string {
237	$firstFilter = $this->getDynamicFilters()->first();
238	$filterData = $firstFilter ? $firstFilter->getFilterData() : null;
239	if (!$firstFilter \|\| !$filterData) {
240	return DynamicSegmentFilterData::CONNECT_TYPE_AND;
241	}
242	$connect = $filterData->getParam('connect');
243	return is_string($connect) && $connect !== '' ? $connect : DynamicSegmentFilterData::CONNECT_TYPE_AND;
244	}
245
246	/**
247	* Returns dynamic filters grouped by their group_id.
248	*
249	* Legacy filters (no group_id) collapse into a single group whose operator is the
250	* legacy filters_connect value. Saved groups carry their own group_operator.
251	*
252	* @return array<int, array{operator: string, filters: DynamicSegmentFilterEntity[]}>
253	*/
254	public function getFilterGroups(): array {
255	$filters = $this->getDynamicFilters()->toArray();
256	if (!$filters) {
257	return [];
258	}
259
260	$hasGroupData = false;
261	foreach ($filters as $filter) {
262	$data = $filter->getFilterData();
263	if ($data && $data->getParam('group_id') !== null) {
264	$hasGroupData = true;
265	break;
266	}
267	}
268
269	if (!$hasGroupData) {
270	return [[
271	'operator' => $this->getFiltersConnectOperator(),
272	'filters' => array_values($filters),
273	]];
274	}
275
276	$groups = [];
277	$legacyGroupKey = 0;
278	foreach ($filters as $filter) {
279	$data = $filter->getFilterData();
280	if (!$data) {
281	continue;
282	}
283	$groupId = $data->getParam('group_id');
284	$hasNumericGroupId = is_int($groupId) \|\| is_numeric($groupId);
285	$groupKey = $hasNumericGroupId ? (int)$groupId : $legacyGroupKey;
286	if (!isset($groups[$groupKey])) {
287	$operator = $hasNumericGroupId ? $data->getParam('group_operator') : $this->getFiltersConnectOperator();
288	$groups[$groupKey] = [
289	'operator' => is_string($operator) && $operator !== '' ? $operator : DynamicSegmentFilterData::CONNECT_TYPE_AND,
290	'filters' => [],
291	];
292	}
293	$groups[$groupKey]['filters'][] = $filter;
294	}
295
296	ksort($groups);
297	return array_values($groups);
298	}
299	}
300