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

mailpoet / lib / EmailEditor / Integrations / MailPoet / Patterns / Library / BookingAutomationEmailPattern.php

mailpoet / lib / EmailEditor / Integrations / MailPoet / Patterns / Library Last commit date

BookingAutomationEmailPattern.php

278 lines

1	<?php declare(strict_types = 1);
2
3	namespace MailPoet\EmailEditor\Integrations\MailPoet\Patterns\Library;
4
5	if (!defined('ABSPATH')) exit;
6
7
8	use MailPoet\EmailEditor\Integrations\MailPoet\EmailEditor;
9	use MailPoet\EmailEditor\Integrations\MailPoet\Patterns\Pattern;
10	use MailPoet\Util\CdnAssetUrl;
11
12	/**
13	* Booking automation email pattern.
14	*/
15	class BookingAutomationEmailPattern extends Pattern {
16	public const VARIANT_ABANDONED_SPOT = 'abandoned-spot';
17	public const VARIANT_NEW_BOOKING = 'new-booking';
18	public const VARIANT_PRE_VISIT_REMINDER = 'pre-visit-reminder';
19	public const VARIANT_PRE_VISIT_WHAT_TO_EXPECT = 'pre-visit-what-to-expect';
20	public const VARIANT_PRE_VISIT_TIPS = 'pre-visit-tips';
21	public const VARIANT_POST_VISIT_REVIEW = 'post-visit-review';
22	public const VARIANT_NEXT_BOOKING_NUDGE = 'next-booking-nudge';
23
24	protected $name = 'booking-abandoned-spot';
25	protected $block_types = ['core/post-content']; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
26	protected $template_types = ['email-template']; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
27	protected $categories = ['bookings'];
28	protected $post_types = [EmailEditor::MAILPOET_EMAIL_POST_TYPE]; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
29
30	/** @var string */
31	private $variant;
32
33	public function __construct(
34	CdnAssetUrl $cdnAssetUrl,
35	string $variant
36	) {
37	parent::__construct($cdnAssetUrl);
38	$this->variant = $variant;
39
40	if ($variant === self::VARIANT_NEW_BOOKING) {
41	$this->name = 'booking-new-booking-follow-up';
42	} elseif ($variant === self::VARIANT_PRE_VISIT_REMINDER) {
43	$this->name = 'booking-pre-visit-reminder';
44	} elseif ($variant === self::VARIANT_PRE_VISIT_WHAT_TO_EXPECT) {
45	$this->name = 'booking-pre-visit-what-to-expect';
46	} elseif ($variant === self::VARIANT_PRE_VISIT_TIPS) {
47	$this->name = 'booking-pre-visit-tips';
48	} elseif ($variant === self::VARIANT_POST_VISIT_REVIEW) {
49	$this->name = 'booking-post-visit-review';
50	} elseif ($variant === self::VARIANT_NEXT_BOOKING_NUDGE) {
51	$this->name = 'booking-next-booking-nudge';
52	}
53	}
54
55	protected function get_content(): string { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
56	if ($this->variant === self::VARIANT_NEW_BOOKING) {
57	return $this->buildContent(
58	__('Your booking is confirmed', 'mailpoet'),
59	[
60	sprintf(
61	/* translators: %s: Subscriber first name personalization tag */
62	__('Hi %s, your booking is confirmed. We’re looking forward to seeing you.', 'mailpoet'),
63	$this->getSubscriberFirstNameTag()
64	),
65	sprintf(
66	/* translators: %s: WooCommerce booking product name personalization tag */
67	__('You booked %s. Keep this email handy so the details are easy to find.', 'mailpoet'),
68	'<!--[mailpoet/woocommerce-booking-product-name]-->'
69	),
70	$this->getBookingDetailsCopy(),
71	__('If anything changes or you have questions before your visit, reply to this email and we’ll help.', 'mailpoet'),
72	],
73	__('Visit our site', 'mailpoet'),
74	__('See you soon,', 'mailpoet')
75	);
76	}
77
78	if ($this->variant === self::VARIANT_PRE_VISIT_REMINDER) {
79	return $this->buildContent(
80	__('Your booking is coming up', 'mailpoet'),
81	[
82	sprintf(
83	/* translators: %s: Subscriber first name personalization tag */
84	__('Hi %s, this is a friendly reminder about your upcoming booking.', 'mailpoet'),
85	$this->getSubscriberFirstNameTag()
86	),
87	$this->getBookingDetailsCopy(),
88	__('Please arrive a few minutes early so we can get everything started on time. Reply to this email if you need to make a change.', 'mailpoet'),
89	],
90	__('Visit our site', 'mailpoet'),
91	__('We’ll see you soon,', 'mailpoet')
92	);
93	}
94
95	if ($this->variant === self::VARIANT_PRE_VISIT_WHAT_TO_EXPECT) {
96	return $this->buildContent(
97	__('What to expect at your booking', 'mailpoet'),
98	[
99	sprintf(
100	/* translators: 1: Subscriber first name personalization tag, 2: WooCommerce booking product name personalization tag */
101	__('Hi %1$s, here are a few details for your upcoming %2$s booking.', 'mailpoet'),
102	$this->getSubscriberFirstNameTag(),
103	'<!--[mailpoet/woocommerce-booking-product-name]-->'
104	),
105	$this->getBookingDetailsCopy(),
106	__('Please arrive a few minutes early and bring anything you need for the visit. If you have questions, reply to this email before your appointment.', 'mailpoet'),
107	],
108	__('View our site', 'mailpoet'),
109	__('See you soon,', 'mailpoet')
110	);
111	}
112
113	if ($this->variant === self::VARIANT_PRE_VISIT_TIPS) {
114	return $this->buildContent(
115	__('Make the most of your booking', 'mailpoet'),
116	[
117	sprintf(
118	/* translators: 1: Subscriber first name personalization tag, 2: WooCommerce booking product name personalization tag */
119	__('Hi %1$s, your %2$s booking is coming up soon. A little preparation can help you get the most out of it.', 'mailpoet'),
120	$this->getSubscriberFirstNameTag(),
121	'<!--[mailpoet/woocommerce-booking-product-name]-->'
122	),
123	$this->getBookingDetailsCopy(),
124	__('Review the details, plan enough time before and after your visit, and reply to this email if there is anything we should know ahead of time.', 'mailpoet'),
125	],
126	__('Review details', 'mailpoet'),
127	__('We’ll see you soon,', 'mailpoet')
128	);
129	}
130
131	if ($this->variant === self::VARIANT_POST_VISIT_REVIEW) {
132	return $this->buildContent(
133	__('How was your booking?', 'mailpoet'),
134	[
135	sprintf(
136	/* translators: 1: Subscriber first name personalization tag, 2: WooCommerce booking product name personalization tag */
137	__('Hi %1$s, thanks for joining us for %2$s. We hope everything went smoothly.', 'mailpoet'),
138	$this->getSubscriberFirstNameTag(),
139	'<!--[mailpoet/woocommerce-booking-product-name]-->'
140	),
141	$this->getBookingDetailsCopy(),
142	__('Your feedback helps us improve future bookings. Send us a quick note or visit our site to leave feedback.', 'mailpoet'),
143	],
144	__('Leave feedback', 'mailpoet'),
145	__('Thank you,', 'mailpoet')
146	);
147	}
148
149	if ($this->variant === self::VARIANT_NEXT_BOOKING_NUDGE) {
150	return $this->buildContent(
151	__('Ready for your next booking?', 'mailpoet'),
152	[
153	sprintf(
154	/* translators: 1: Subscriber first name personalization tag, 2: WooCommerce booking product name personalization tag */
155	__('Hi %1$s, it’s been a little while since your %2$s booking, and we’d love to welcome you back.', 'mailpoet'),
156	$this->getSubscriberFirstNameTag(),
157	'<!--[mailpoet/woocommerce-booking-product-name]-->'
158	),
159	sprintf(
160	/* translators: %s: WooCommerce booking start date personalization tag */
161	__('Last time, you joined us on %s. We hope it was time well spent.', 'mailpoet'),
162	'<!--[mailpoet/woocommerce-booking-start-date]-->'
163	),
164	__('Whenever you’re ready for your next visit, we’ll be glad to have you. Just reply to this email if you’d like a hand picking a time.', 'mailpoet'),
165	],
166	__('Book again', 'mailpoet'),
167	__('Hope to see you soon,', 'mailpoet')
168	);
169	}
170
171	return $this->buildContent(
172	__('Your booking spot is waiting', 'mailpoet'),
173	[
174	sprintf(
175	/* translators: %s: Subscriber first name personalization tag */
176	__('Hi %s, it looks like you started a booking but did not finish reserving your spot.', 'mailpoet'),
177	$this->getSubscriberFirstNameTag()
178	),
179	sprintf(
180	/* translators: %s: WooCommerce booking product name personalization tag */
181	__('If you still want to book %s, come back and complete your reservation while availability is still open.', 'mailpoet'),
182	'<!--[mailpoet/woocommerce-booking-product-name]-->'
183	),
184	__('Booking availability can change quickly, so finishing sooner gives you the best chance of keeping the time you selected.', 'mailpoet'),
185	],
186	__('Return to our site', 'mailpoet'),
187	__('Hope to see you soon,', 'mailpoet')
188	);
189	}
190
191	protected function get_title(): string { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
192	if ($this->variant === self::VARIANT_NEW_BOOKING) {
193	return __('Booking Confirmation Follow-up', 'mailpoet');
194	}
195
196	if ($this->variant === self::VARIANT_PRE_VISIT_REMINDER) {
197	return __('Booking Pre-visit Reminder', 'mailpoet');
198	}
199
200	if ($this->variant === self::VARIANT_PRE_VISIT_WHAT_TO_EXPECT) {
201	return __('Booking Preparation', 'mailpoet');
202	}
203
204	if ($this->variant === self::VARIANT_PRE_VISIT_TIPS) {
205	return __('Booking Tips', 'mailpoet');
206	}
207
208	if ($this->variant === self::VARIANT_POST_VISIT_REVIEW) {
209	return __('Booking Review Request', 'mailpoet');
210	}
211
212	if ($this->variant === self::VARIANT_NEXT_BOOKING_NUDGE) {
213	return __('Next Booking Nudge', 'mailpoet');
214	}
215
216	return __('Abandoned Booking Reminder', 'mailpoet');
217	}
218
219	/**
220	* @param string[] $paragraphs
221	*/
222	private function buildContent(string $heading, array $paragraphs, string $buttonText, string $signoff): string {
223	$paragraphBlocks = '';
224	foreach ($paragraphs as $paragraph) {
225	$paragraphBlocks .= '
226	<!-- wp:paragraph {"style":{"typography":{"fontSize":"16px"},"spacing":{"padding":{"top":"0","bottom":"var:preset\|spacing\|30"}}}} -->
227	<p style="padding-top:0;padding-bottom:var(--wp--preset--spacing--30);font-size:16px">' . $paragraph . '</p>
228	<!-- /wp:paragraph -->';
229	}
230
231	return '
232	<!-- wp:group {"style":{"spacing":{"padding":{"right":"var:preset\|spacing\|40","left":"var:preset\|spacing\|40"}}},"layout":{"type":"constrained"}} -->
233	<div class="wp-block-group" style="padding-right:var(--wp--preset--spacing--40);padding-left:var(--wp--preset--spacing--40)">
234	<!-- wp:heading {"level":1} -->
235	<h1 class="wp-block-heading">' . $heading . '</h1>
236	<!-- /wp:heading -->
237
238	' . $paragraphBlocks . '
239
240	<!-- wp:buttons {"style":{"spacing":{"padding":{"bottom":"var:preset\|spacing\|30"}}},"layout":{"type":"flex","justifyContent":"left"}} -->
241	<div class="wp-block-buttons" style="padding-bottom:var(--wp--preset--spacing--30)">
242	<!-- wp:button {"style":{"typography":{"fontSize":"16px"},"spacing":{"padding":{"top":"var:preset\|spacing\|10","bottom":"var:preset\|spacing\|10","left":"var:preset\|spacing\|20","right":"var:preset\|spacing\|20"}}}} -->
243	<div class="wp-block-button"><a class="wp-block-button__link has-custom-font-size wp-element-button" style="padding-top:var(--wp--preset--spacing--10);padding-bottom:var(--wp--preset--spacing--10);padding-left:var(--wp--preset--spacing--20);padding-right:var(--wp--preset--spacing--20);font-size:16px" href="[mailpoet/site-homepage-url]">' . $buttonText . '</a></div>
244	<!-- /wp:button -->
245	</div>
246	<!-- /wp:buttons -->
247
248	<!-- wp:paragraph {"fontSize":"medium"} -->
249	<p class="has-medium-font-size">' . $signoff . '</p>
250	<!-- /wp:paragraph -->
251
252	<!-- wp:paragraph {"fontSize":"medium"} -->
253	<p class="has-medium-font-size">–<!--[woocommerce/site-title]--></p>
254	<!-- /wp:paragraph -->
255	</div>
256	<!-- /wp:group -->
257	';
258	}
259
260	private function getBookingDetailsCopy(): string {
261	return sprintf(
262	/* translators: 1: WooCommerce booking start date tag, 2: WooCommerce booking end date tag, 3: WooCommerce booking persons count tag */
263	__('Details: starts %1$s, ends %2$s, for %3$s person(s).', 'mailpoet'),
264	'<!--[mailpoet/woocommerce-booking-start-date]-->',
265	'<!--[mailpoet/woocommerce-booking-end-date]-->',
266	'<!--[mailpoet/woocommerce-booking-persons-count]-->'
267	);
268	}
269
270	private function getSubscriberFirstNameTag(): string {
271	return sprintf(
272	'<!--[mailpoet/subscriber-firstname default="%s"]-->',
273	/* translators: Default placeholder used when no subscriber name is available in "Hi %s" */
274	esc_attr(_x('there', 'subscriber name placeholder', 'mailpoet'))
275	);
276	}
277	}
278