BlocksRenderer.php — MailPoet – Newsletters, Email Marketing, and Automation 5.36.0

mailpoet / lib / Form / BlocksRenderer.php

mailpoet / lib / Form Last commit date

Block 1 month ago Listing 1 month ago RestApi 1 month ago Templates 3 weeks ago Util 3 weeks ago ApiDataSanitizer.php 1 month ago AssetsController.php 3 weeks ago BlockStylesRenderer.php 3 years ago BlockWrapperRenderer.php 3 years ago BlocksRenderer.php 1 day ago DisplayFormInWPContent.php 3 months ago FormHtmlSanitizer.php 1 month ago FormMessageController.php 4 years ago FormSaveController.php 1 year ago FormsRepository.php 1 year ago PreviewPage.php 3 months ago PreviewWidget.php 1 year ago Renderer.php 3 months ago Widget.php 3 months ago index.php 3 years ago

BlocksRenderer.php

226 lines

1	<?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing
2
3	namespace MailPoet\Form;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use MailPoet\Entities\FormEntity;
9	use MailPoet\Entities\SubscriberEntity;
10	use MailPoet\Form\Block\Checkbox;
11	use MailPoet\Form\Block\Close;
12	use MailPoet\Form\Block\Column;
13	use MailPoet\Form\Block\Columns;
14	use MailPoet\Form\Block\Date;
15	use MailPoet\Form\Block\Divider;
16	use MailPoet\Form\Block\Heading;
17	use MailPoet\Form\Block\Html;
18	use MailPoet\Form\Block\Image;
19	use MailPoet\Form\Block\Paragraph;
20	use MailPoet\Form\Block\Radio;
21	use MailPoet\Form\Block\Segment;
22	use MailPoet\Form\Block\Select;
23	use MailPoet\Form\Block\Submit;
24	use MailPoet\Form\Block\Text;
25	use MailPoet\Form\Block\Textarea;
26	use MailPoet\Subscribers\TrackingConsentCapture;
27	use MailPoet\Util\Security;
28
29	class BlocksRenderer {
30	/** @var Checkbox */
31	private $checkbox;
32
33	/** @var Close */
34	private $close;
35
36	/** @var Date */
37	private $date;
38
39	/** @var Divider */
40	private $divider;
41
42	/** @var Html */
43	private $html;
44
45	/** @var Image */
46	private $image;
47
48	/** @var Radio */
49	private $radio;
50
51	/** @var Segment */
52	private $segment;
53
54	/** @var Select */
55	private $select;
56
57	/** @var Submit */
58	private $submit;
59
60	/** @var Text */
61	private $text;
62
63	/** @var Textarea */
64	private $textarea;
65
66	/** @var Column */
67	private $column;
68
69	/** @var Columns */
70	private $columns;
71
72	/** @var Heading */
73	private $heading;
74
75	/** @var Paragraph */
76	private $paragraph;
77
78	/** @var TrackingConsentCapture */
79	private $trackingConsentCapture;
80
81	public function __construct(
82	Checkbox $checkbox,
83	Close $close,
84	Column $column,
85	Columns $columns,
86	Date $date,
87	Divider $divider,
88	Html $html,
89	Image $image,
90	Heading $heading,
91	Paragraph $paragraph,
92	Radio $radio,
93	Segment $segment,
94	Select $select,
95	Submit $submit,
96	Text $text,
97	Textarea $textarea,
98	TrackingConsentCapture $trackingConsentCapture
99	) {
100	$this->checkbox = $checkbox;
101	$this->close = $close;
102	$this->column = $column;
103	$this->columns = $columns;
104	$this->date = $date;
105	$this->divider = $divider;
106	$this->html = $html;
107	$this->image = $image;
108	$this->radio = $radio;
109	$this->segment = $segment;
110	$this->select = $select;
111	$this->submit = $submit;
112	$this->text = $text;
113	$this->textarea = $textarea;
114	$this->heading = $heading;
115	$this->paragraph = $paragraph;
116	$this->trackingConsentCapture = $trackingConsentCapture;
117	}
118
119	public function renderBlock(array $block, array $formSettings, ?int $formId): string {
120	$html = '';
121	// A tracking-consent checkbox is recipient-facing, so it only appears on
122	// sites that chose to ask. On a site that tracks everyone without asking,
123	// a block a merchant placed deliberately still renders nothing.
124	if (($block['id'] ?? null) === TrackingConsentCapture::FIELD_ID) {
125	if (!$this->trackingConsentCapture->isCaptureEnabled()) {
126	return $html;
127	}
128	$block = $this->withResolvedConsentCopy($block);
129	}
130	if ($formId) {
131	$formSettings['id'] = $formId;
132	}
133	// This is used to properly show validation message when
134	// the same form is rendered on a page multiple times
135	$block['validation_id'] = Security::generateRandomString();
136	switch ($block['type']) {
137	case FormEntity::HTML_BLOCK_TYPE:
138	$html .= $this->html->render($block, $formSettings);
139	break;
140
141	case FormEntity::HEADING_BLOCK_TYPE:
142	$html .= $this->heading->render($block);
143	break;
144
145	case FormEntity::IMAGE_BLOCK_TYPE:
146	$html .= $this->image->render($block);
147	break;
148
149	case FormEntity::PARAGRAPH_BLOCK_TYPE:
150	$html .= $this->paragraph->render($block);
151	break;
152
153	case FormEntity::DIVIDER_BLOCK_TYPE:
154	$html .= $this->divider->render($block);
155	break;
156
157	case FormEntity::CHECKBOX_BLOCK_TYPE:
158	$html .= $this->checkbox->render($block, $formSettings, $formId);
159	break;
160
161	case FormEntity::RADIO_BLOCK_TYPE:
162	$html .= $this->radio->render($block, $formSettings, $formId);
163	break;
164
165	case FormEntity::SEGMENT_SELECTION_BLOCK_TYPE:
166	$html .= $this->segment->render($block, $formSettings, $formId);
167	break;
168
169	case FormEntity::DATE_BLOCK_TYPE:
170	$html .= $this->date->render($block, $formSettings, $formId);
171	break;
172
173	case FormEntity::SELECT_BLOCK_TYPE:
174	$html .= $this->select->render($block, $formSettings, $formId);
175	break;
176
177	case FormEntity::TEXT_BLOCK_TYPE:
178	$html .= $this->text->render($block, $formSettings, $formId);
179	break;
180
181	case FormEntity::TEXTAREA_BLOCK_TYPE:
182	$html .= $this->textarea->render($block, $formSettings, $formId);
183	break;
184
185	case FormEntity::SUBMIT_BLOCK_TYPE:
186	$html .= $this->submit->render($block, $formSettings);
187	break;
188
189	case FormEntity::CLOSE_BLOCK_TYPE:
190	$html .= $this->close->render($block, $formSettings);
191	break;
192	}
193	return $html;
194	}
195
196	/**
197	* Replaces the consent block's stored wording with the wording that will
198	* actually be recorded as proof. The subscriber must see exactly the sentence
199	* we file against their consent, so the blank fallback and the
200	* mailpoet_tracking_consent_copy filter have to reach the rendered label too,
201	* not only SubscriberSubscribeController's record of it.
202	*/
203	private function withResolvedConsentCopy(array $block): array {
204	$stored = $block['params']['values'][0]['value'] ?? null;
205	$block['params']['values'][0]['value'] = $this->trackingConsentCapture->getCopy(
206	SubscriberEntity::TRACKING_CONSENT_METHOD_FORM,
207	is_string($stored) ? $stored : null
208	);
209	return $block;
210	}
211
212	public function renderContainerBlock(array $block, string $content) {
213	$html = '';
214	switch ($block['type']) {
215	case FormEntity::COLUMNS_BLOCK_TYPE:
216	$html .= $this->columns->render($block, $content);
217	break;
218
219	case FormEntity::COLUMN_BLOCK_TYPE:
220	$html .= $this->column->render($block, $content);
221	break;
222	}
223	return $html;
224	}
225	}
226