MobileMessagingHandler.php at 11.1.0-rc.2 · WooCommerce

woocommerce / src / Internal / Orders / MobileMessagingHandler.php

MobileMessagingHandler.php

206 lines 5.5 KB

Raw Download Zip

1	<?php
2
3	namespace Automattic\WooCommerce\Internal\Orders;
4
5	use DateTime;
6	use Exception;
7	use WC_Order;
8	use WC_Tracker;
9
10	/**
11	* Prepares formatted mobile deep link navigation link for order mails.
12	*/
13	class MobileMessagingHandler {
14
15	private const OPEN_ORDER_INTERVAL_DAYS = 30;
16
17	/**
18	* Prepares mobile messaging with a deep link.
19	*
20	* @param WC_Order $order order that mobile message is created for.
21	* @param ?int $blog_id of blog to make a deep link for (will be null if Jetpack is not enabled).
22	* @param DateTime $now current DateTime.
23	* @param string $domain URL of the current site.
24	*
25	* @return ?string
26	*/
27	public static function prepare_mobile_message(
28	WC_Order $order,
29	?int $blog_id,
30	DateTime $now,
31	string $domain
32	): ?string {
33	try {
34	$last_mobile_used = self::get_closer_mobile_usage_date();
35
36	$used_app_in_last_month = null !== $last_mobile_used && $last_mobile_used->diff( $now )->days <= self::OPEN_ORDER_INTERVAL_DAYS;
37	$has_jetpack = null !== $blog_id;
38
39	if ( IppFunctions::is_store_in_person_payment_eligible() && IppFunctions::is_order_in_person_payment_eligible( $order ) ) {
40	return self::accept_payment_message( $blog_id, $domain );
41	} else {
42	if ( $used_app_in_last_month && $has_jetpack ) {
43	return self::manage_order_message( $blog_id, $order->get_id(), $domain );
44	} else {
45	return self::no_app_message( $blog_id, $domain );
46	}
47	}
48	} catch ( Exception $e ) {
49	return null;
50	}
51	}
52
53	/**
54	* Returns the closest date of last usage of any mobile app platform.
55	*
56	* @return ?DateTime
57	*/
58	private static function get_closer_mobile_usage_date(): ?DateTime {
59	$mobile_usage = WC_Tracker::get_woocommerce_mobile_usage();
60
61	if ( ! $mobile_usage ) {
62	return null;
63	}
64
65	$last_ios_used = self::get_last_used_or_null( 'ios', $mobile_usage );
66	$last_android_used = self::get_last_used_or_null( 'android', $mobile_usage );
67
68	return max( $last_android_used, $last_ios_used );
69	}
70
71	/**
72	* Returns last used date of specified mobile app platform.
73	*
74	* @param string $platform mobile platform to check.
75	* @param array $mobile_usage mobile apps usage data.
76	*
77	* @return ?DateTime last used date of specified mobile app
78	*/
79	private static function get_last_used_or_null(
80	string $platform, array $mobile_usage
81	): ?DateTime {
82	try {
83	if ( array_key_exists( $platform, $mobile_usage ) ) {
84	return new DateTime( $mobile_usage[ $platform ]['last_used'] );
85	} else {
86	return null;
87	}
88	} catch ( Exception $e ) {
89	return null;
90	}
91	}
92
93	/**
94	* Prepares message with a deep link to mobile payment.
95	*
96	* @param ?int $blog_id blog id to deep link to.
97	* @param string $domain URL of the current site.
98	*
99	* @return string formatted message
100	*/
101	private static function accept_payment_message( ?int $blog_id, $domain ): string {
102	$deep_link_url = add_query_arg(
103	array_merge(
104	array(
105	'blog_id' => absint( $blog_id ),
106	),
107	self::prepare_utm_parameters( 'deeplinks_payments', $blog_id, $domain )
108	),
109	'https://woocommerce.com/mobile/payments'
110	);
111
112	return sprintf(
113	/* translators: 1: opening link tag 2: closing link tag. */
114	esc_html__(
115	'%1$sCollect payments easily%2$s from your customers anywhere with our mobile app.',
116	'woocommerce'
117	),
118	'<a href="' . esc_url( $deep_link_url ) . '">',
119	'</a>'
120	);
121	}
122
123	/**
124	* Prepares message with a deep link to manage order details.
125	*
126	* @param int $blog_id blog id to deep link to.
127	* @param int $order_id order id to deep link to.
128	* @param string $domain URL of the current site.
129	*
130	* @return string formatted message
131	*/
132	private static function manage_order_message( int $blog_id, int $order_id, string $domain ): string {
133	$deep_link_url = add_query_arg(
134	array_merge(
135	array(
136	'blog_id' => absint( $blog_id ),
137	'order_id' => absint( $order_id ),
138	),
139	self::prepare_utm_parameters( 'deeplinks_orders_details', $blog_id, $domain )
140	),
141	'https://woocommerce.com/mobile/orders/details'
142	);
143
144	return sprintf(
145	/* translators: 1: opening link tag 2: closing link tag. */
146	esc_html__(
147	'%1$sManage the order%2$s with the app.',
148	'woocommerce'
149	),
150	'<a href="' . esc_url( $deep_link_url ) . '">',
151	'</a>'
152	);
153	}
154
155	/**
156	* Prepares message with a deep link to learn more about mobile app.
157	*
158	* @param ?int $blog_id blog id used for tracking.
159	* @param string $domain URL of the current site.
160	*
161	* @return string formatted message
162	*/
163	private static function no_app_message( ?int $blog_id, string $domain ): string {
164	$deep_link_url = add_query_arg(
165	array_merge(
166	array(
167	'blog_id' => absint( $blog_id ),
168	),
169	self::prepare_utm_parameters( 'deeplinks_promote_app', $blog_id, $domain )
170	),
171	'https://woocommerce.com/mobile'
172	);
173	return sprintf(
174	/* translators: 1: opening link tag 2: closing link tag. */
175	esc_html__(
176	'Process your orders on the go. %1$sGet the app%2$s.',
177	'woocommerce'
178	),
179	'<a href="' . esc_url( $deep_link_url ) . '">',
180	'</a>'
181	);
182	}
183
184	/**
185	* Prepares array of parameters used by WooCommerce.com for tracking.
186	*
187	* @param string $campaign name of the deep link campaign.
188	* @param int\|null $blog_id blog id of the current site.
189	* @param string $domain URL of the current site.
190	*
191	* @return array
192	*/
193	private static function prepare_utm_parameters(
194	string $campaign,
195	?int $blog_id,
196	string $domain
197	): array {
198	return array(
199	'utm_campaign' => $campaign,
200	'utm_medium' => 'email',
201	'utm_source' => $domain,
202	'utm_term' => absint( $blog_id ),
203	);
204	}
205	}
206