FormEntity.php — MailPoet – Newsletters, Email Marketing, and Automation 5.33.1

mailpoet / lib / Entities / FormEntity.php

mailpoet / lib / Entities Last commit date

FormEntity.php

222 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\ORM\Mapping as ORM;
13
14	/**
15	* @ORM\Entity()
16	* @ORM\Table(name="forms")
17	*/
18	class FormEntity {
19	use AutoincrementedIdTrait;
20	use CreatedAtTrait;
21	use UpdatedAtTrait;
22	use DeletedAtTrait;
23
24	const DISPLAY_TYPE_BELOW_POST = 'below_posts';
25	const DISPLAY_TYPE_FIXED_BAR = 'fixed_bar';
26	const DISPLAY_TYPE_POPUP = 'popup';
27	const DISPLAY_TYPE_SLIDE_IN = 'slide_in';
28	const DISPLAY_TYPE_OTHERS = 'others';
29
30	const STATUS_ENABLED = 'enabled';
31	const STATUS_DISABLED = 'disabled';
32
33	const HTML_BLOCK_TYPE = 'html';
34	const HEADING_BLOCK_TYPE = 'heading';
35	const IMAGE_BLOCK_TYPE = 'image';
36	const PARAGRAPH_BLOCK_TYPE = 'paragraph';
37	const DIVIDER_BLOCK_TYPE = 'divider';
38	const CHECKBOX_BLOCK_TYPE = 'checkbox';
39	const RADIO_BLOCK_TYPE = 'radio';
40	const SEGMENT_SELECTION_BLOCK_TYPE = 'segment';
41	const DATE_BLOCK_TYPE = 'date';
42	const SELECT_BLOCK_TYPE = 'select';
43	const TEXT_BLOCK_TYPE = 'text';
44	const TEXTAREA_BLOCK_TYPE = 'textarea';
45	const SUBMIT_BLOCK_TYPE = 'submit';
46	const COLUMNS_BLOCK_TYPE = 'columns';
47	const COLUMN_BLOCK_TYPE = 'column';
48
49	public const FORM_DISPLAY_TYPES = [
50	self::DISPLAY_TYPE_BELOW_POST,
51	self::DISPLAY_TYPE_FIXED_BAR,
52	self::DISPLAY_TYPE_POPUP,
53	self::DISPLAY_TYPE_SLIDE_IN,
54	self::DISPLAY_TYPE_OTHERS,
55	];
56
57	public const FORM_FIELD_TYPES = [
58	self::CHECKBOX_BLOCK_TYPE,
59	self::RADIO_BLOCK_TYPE,
60	self::SEGMENT_SELECTION_BLOCK_TYPE,
61	self::DATE_BLOCK_TYPE,
62	self::SELECT_BLOCK_TYPE,
63	self::TEXT_BLOCK_TYPE,
64	self::TEXTAREA_BLOCK_TYPE,
65	];
66
67	/**
68	* @ORM\Column(type="string")
69	* @var string
70	*/
71	private $name;
72
73	/**
74	* @ORM\Column(type="serialized_array")
75	* @var array\|null
76	*/
77	private $body;
78
79	/**
80	* @ORM\Column(type="string")
81	* @var string
82	*/
83	private $status;
84
85	/**
86	* @ORM\Column(type="serialized_array")
87	* @var array\|null
88	*/
89	private $settings;
90
91	/**
92	* @ORM\Column(type="string", nullable=true)
93	* @var string\|null
94	*/
95	private $styles;
96
97	public function __construct(
98	$name
99	) {
100	$this->name = $name;
101	$this->status = self::STATUS_ENABLED;
102	}
103
104	/**
105	* @return string
106	*/
107	public function getName() {
108	return $this->name;
109	}
110
111	/**
112	* @return array\|null
113	*/
114	public function getBody() {
115	return $this->body;
116	}
117
118	/**
119	* @return array\|null
120	*/
121	public function getSettings() {
122	return $this->settings;
123	}
124
125	/**
126	* @return string\|null
127	*/
128	public function getStyles() {
129	return $this->styles;
130	}
131
132	/**
133	* @param string $name
134	*/
135	public function setName($name) {
136	$this->name = $name;
137	}
138
139	/**
140	* @param array\|null $body
141	*/
142	public function setBody($body) {
143	$this->body = $body;
144	}
145
146	/**
147	* @param array\|null $settings
148	*/
149	public function setSettings($settings) {
150	$this->settings = $settings;
151	}
152
153	/**
154	* @param string\|null $styles
155	*/
156	public function setStyles($styles) {
157	$this->styles = $styles;
158	}
159
160	/**
161	* @param string $status
162	*/
163	public function setStatus(string $status) {
164	$this->status = $status;
165	}
166
167	/**
168	* @return string
169	*/
170	public function getStatus(): string {
171	return $this->status;
172	}
173
174	public function toArray(): array {
175	return [
176	'id' => $this->getId(),
177	'name' => $this->getName(),
178	'body' => $this->getBody(),
179	'settings' => $this->getSettings(),
180	'styles' => $this->getStyles(),
181	'status' => $this->getStatus(),
182	'created_at' => $this->getCreatedAt(),
183	'updated_at' => $this->getUpdatedAt(),
184	'deleted_at' => $this->getDeletedAt(),
185	];
186	}
187
188	public function getBlocksByTypes(array $types, ?array $blocks = null): array {
189	$found = [];
190	if ($blocks === null) {
191	$blocks = $this->getBody() ?? [];
192	}
193	foreach ($blocks as $block) {
194	if (isset($block['type']) && in_array($block['type'], $types, true)) {
195	$found[] = $block;
196	}
197	if (isset($block['body']) && is_array($block['body']) && !empty($block['body'])) {
198	$found = array_merge($found, $this->getBlocksByTypes($types, $block['body']));
199	}
200	}
201	return $found;
202	}
203
204	public function getSegmentBlocksSegmentIds(): array {
205	$listSelectionBlocks = $this->getBlocksByTypes([FormEntity::SEGMENT_SELECTION_BLOCK_TYPE]);
206	$listSelection = [];
207	foreach ($listSelectionBlocks as $listSelectionBlock) {
208	$listSelection = array_unique(
209	array_merge(
210	$listSelection,
211	array_column($listSelectionBlock['params']['values'] ?? [], 'id')
212	)
213	);
214	}
215	return $listSelection;
216	}
217
218	public function getSettingsSegmentIds(): array {
219	return $this->settings['segments'] ?? [];
220	}
221	}
222