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

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

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

SubscriptionAutomationEmailPattern.php

251 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	* Subscription automation email pattern.
14	*/
15	class SubscriptionAutomationEmailPattern extends Pattern {
16	public const VARIANT_PURCHASE = 'purchase';
17	public const VARIANT_RENEWAL = 'renewal';
18	public const VARIANT_FAILED_RENEWAL = 'failed-renewal';
19	public const VARIANT_CHURNED = 'churned';
20	public const VARIANT_TRIAL_ENDED = 'trial-ended';
21	public const VARIANT_WIN_BACK = 'win-back';
22
23	protected $name = 'subscription-purchase-follow-up';
24	protected $block_types = ['core/post-content']; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
25	protected $template_types = ['email-template']; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
26	protected $categories = ['subscriptions'];
27	protected $post_types = [EmailEditor::MAILPOET_EMAIL_POST_TYPE]; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps
28
29	/** @var string */
30	private $variant;
31
32	public function __construct(
33	CdnAssetUrl $cdnAssetUrl,
34	string $variant
35	) {
36	parent::__construct($cdnAssetUrl);
37	$this->variant = $variant;
38
39	if ($variant === self::VARIANT_RENEWAL) {
40	$this->name = 'subscription-renewal-follow-up';
41	} elseif ($variant === self::VARIANT_FAILED_RENEWAL) {
42	$this->name = 'subscription-failed-renewal-follow-up';
43	} elseif ($variant === self::VARIANT_CHURNED) {
44	$this->name = 'subscription-churned-follow-up';
45	} elseif ($variant === self::VARIANT_TRIAL_ENDED) {
46	$this->name = 'subscription-trial-ended-follow-up';
47	} elseif ($variant === self::VARIANT_WIN_BACK) {
48	$this->name = 'subscription-win-back';
49	}
50	}
51
52	protected function get_content(): string { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
53	if ($this->variant === self::VARIANT_RENEWAL) {
54	return $this->buildContent(
55	__('Your subscription renewed', 'mailpoet'),
56	[
57	sprintf(
58	/* translators: %s: Subscriber first name personalization tag */
59	__('Hi %s, your subscription has renewed successfully. Thanks for staying with us.', 'mailpoet'),
60	$this->getSubscriberFirstNameTag()
61	),
62	sprintf(
63	/* translators: %s: WooCommerce subscription title personalization tag */
64	__('Your %s subscription is active for the new billing period, so there is nothing you need to do right now.', 'mailpoet'),
65	'<!--[mailpoet/woocommerce-subscription-title]-->'
66	),
67	__('We’ll keep working to make every renewal worth it. If you have questions, reply to this email and we’ll help.', 'mailpoet'),
68	],
69	__('Visit our site', 'mailpoet'),
70	__('Thanks for being with us,', 'mailpoet')
71	);
72	}
73
74	if ($this->variant === self::VARIANT_FAILED_RENEWAL) {
75	return $this->buildContent(
76	__('We couldn’t renew your subscription', 'mailpoet'),
77	[
78	sprintf(
79	/* translators: %s: Subscriber first name personalization tag */
80	__('Hi %s, we tried to renew your subscription but the payment did not go through.', 'mailpoet'),
81	$this->getSubscriberFirstNameTag()
82	),
83	sprintf(
84	/* translators: %s: WooCommerce subscription title personalization tag */
85	__('To keep %s active, please sign in to your account and update your payment details.', 'mailpoet'),
86	'<!--[mailpoet/woocommerce-subscription-title]-->'
87	),
88	__('If you already updated your details, you can ignore this message. If you need help, reply and we’ll take a look.', 'mailpoet'),
89	],
90	__('Visit our site', 'mailpoet'),
91	__('We’re here to help,', 'mailpoet')
92	);
93	}
94
95	if ($this->variant === self::VARIANT_CHURNED) {
96	return $this->buildContent(
97	__('We’d value your feedback', 'mailpoet'),
98	[
99	sprintf(
100	/* translators: %s: Subscriber first name personalization tag */
101	__('Hi %s, we noticed your subscription has ended. We’re sorry to see you go.', 'mailpoet'),
102	$this->getSubscriberFirstNameTag()
103	),
104	sprintf(
105	/* translators: %s: WooCommerce subscription title personalization tag */
106	__('If %s was not the right fit, we’d be grateful to know what would have made it better for you.', 'mailpoet'),
107	'<!--[mailpoet/woocommerce-subscription-title]-->'
108	),
109	__('You can reply directly to this email. Every note helps us improve the experience for future subscribers.', 'mailpoet'),
110	],
111	__('Visit our site', 'mailpoet'),
112	__('Thanks for your feedback,', 'mailpoet')
113	);
114	}
115
116	if ($this->variant === self::VARIANT_TRIAL_ENDED) {
117	return $this->buildContent(
118	__('Your trial has ended', 'mailpoet'),
119	[
120	sprintf(
121	/* translators: %s: Subscriber first name personalization tag */
122	__('Hi %s, thanks for trying us. We hope your trial gave you a useful look at what’s included.', 'mailpoet'),
123	$this->getSubscriberFirstNameTag()
124	),
125	sprintf(
126	/* translators: %s: WooCommerce subscription title personalization tag */
127	__('If %s helped you, you can keep the benefits going from your account on our site.', 'mailpoet'),
128	'<!--[mailpoet/woocommerce-subscription-title]-->'
129	),
130	__('Still deciding? Reply with any questions and we’ll help you choose the next step.', 'mailpoet'),
131	],
132	__('Visit our site', 'mailpoet'),
133	__('Thanks for trying us,', 'mailpoet')
134	);
135	}
136
137	if ($this->variant === self::VARIANT_WIN_BACK) {
138	return $this->buildContent(
139	__('See what’s new', 'mailpoet'),
140	[
141	sprintf(
142	/* translators: %s: Subscriber first name personalization tag */
143	__('Hi %s, it’s been a while since your subscription ended, and we’d love to welcome you back.', 'mailpoet'),
144	$this->getSubscriberFirstNameTag()
145	),
146	sprintf(
147	/* translators: %s: WooCommerce subscription title personalization tag */
148	__('We’ve been improving the experience around %s, with new reasons to give it another look.', 'mailpoet'),
149	'<!--[mailpoet/woocommerce-subscription-title]-->'
150	),
151	__('When you’re ready, visit our site to see what’s changed and start again.', 'mailpoet'),
152	],
153	__('Visit our site', 'mailpoet'),
154	__('Hope to see you again,', 'mailpoet')
155	);
156	}
157
158	return $this->buildContent(
159	__('Welcome to your subscription', 'mailpoet'),
160	[
161	sprintf(
162	/* translators: %s: Subscriber first name personalization tag */
163	__('Hi %s, thanks for subscribing. Your subscription is active, and we’re glad to have you with us.', 'mailpoet'),
164	$this->getSubscriberFirstNameTag()
165	),
166	sprintf(
167	/* translators: %s: WooCommerce subscription title personalization tag */
168	__('You’re subscribed to %s. We’ll send you useful updates, renewal reminders, and anything you need to get the most from it.', 'mailpoet'),
169	'<!--[mailpoet/woocommerce-subscription-title]-->'
170	),
171	__('You can review billing, renewals, and subscription details from your account on our site.', 'mailpoet'),
172	],
173	__('Visit our site', 'mailpoet'),
174	__('Thanks for joining us,', 'mailpoet')
175	);
176	}
177
178	protected function get_title(): string { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
179	if ($this->variant === self::VARIANT_RENEWAL) {
180	return __('Subscription Renewal Follow-up', 'mailpoet');
181	}
182
183	if ($this->variant === self::VARIANT_FAILED_RENEWAL) {
184	return __('Subscription Failed Renewal Follow-up', 'mailpoet');
185	}
186
187	if ($this->variant === self::VARIANT_CHURNED) {
188	return __('Subscription Churned Follow-up', 'mailpoet');
189	}
190
191	if ($this->variant === self::VARIANT_TRIAL_ENDED) {
192	return __('Subscription Trial Ended Follow-up', 'mailpoet');
193	}
194
195	if ($this->variant === self::VARIANT_WIN_BACK) {
196	return __('Subscription Win-back', 'mailpoet');
197	}
198
199	return __('Subscription Purchase Follow-up', 'mailpoet');
200	}
201
202	/**
203	* @param string[] $paragraphs
204	*/
205	private function buildContent(string $heading, array $paragraphs, string $buttonText, string $signoff): string {
206	$paragraphBlocks = '';
207	foreach ($paragraphs as $paragraph) {
208	$paragraphBlocks .= '
209	<!-- wp:paragraph {"style":{"typography":{"fontSize":"16px"},"spacing":{"padding":{"top":"0","bottom":"var:preset\|spacing\|30"}}}} -->
210	<p style="padding-top:0;padding-bottom:var(--wp--preset--spacing--30);font-size:16px">' . $paragraph . '</p>
211	<!-- /wp:paragraph -->';
212	}
213
214	return '
215	<!-- wp:group {"style":{"spacing":{"padding":{"right":"var:preset\|spacing\|40","left":"var:preset\|spacing\|40"}}},"layout":{"type":"constrained"}} -->
216	<div class="wp-block-group" style="padding-right:var(--wp--preset--spacing--40);padding-left:var(--wp--preset--spacing--40)">
217	<!-- wp:heading {"level":1} -->
218	<h1 class="wp-block-heading">' . $heading . '</h1>
219	<!-- /wp:heading -->
220
221	' . $paragraphBlocks . '
222
223	<!-- wp:buttons {"style":{"spacing":{"padding":{"bottom":"var:preset\|spacing\|30"}}},"layout":{"type":"flex","justifyContent":"left"}} -->
224	<div class="wp-block-buttons" style="padding-bottom:var(--wp--preset--spacing--30)">
225	<!-- 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"}}}} -->
226	<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>
227	<!-- /wp:button -->
228	</div>
229	<!-- /wp:buttons -->
230
231	<!-- wp:paragraph {"fontSize":"medium"} -->
232	<p class="has-medium-font-size">' . $signoff . '</p>
233	<!-- /wp:paragraph -->
234
235	<!-- wp:paragraph {"fontSize":"medium"} -->
236	<p class="has-medium-font-size">–<!--[woocommerce/site-title]--></p>
237	<!-- /wp:paragraph -->
238	</div>
239	<!-- /wp:group -->
240	';
241	}
242
243	private function getSubscriberFirstNameTag(): string {
244	return sprintf(
245	'<!--[mailpoet/subscriber-firstname default="%s"]-->',
246	/* translators: Default placeholder used when no subscriber name is available in "Hi %s" */
247	esc_attr(_x('there', 'subscriber name placeholder', 'mailpoet'))
248	);
249	}
250	}
251