Init.php — WooCommerce 10.9.4

woocommerce / src / Admin / Features / MarketingRecommendations / Init.php

woocommerce / src / Admin / Features / MarketingRecommendations Last commit date

DefaultMarketingRecommendations.php 3 months ago Init.php 1 year ago MarketingRecommendationsDataSourcePoller.php 1 year ago MiscRecommendationsDataSourcePoller.php 1 year ago

Init.php

258 lines

1	<?php
2
3	namespace Automattic\WooCommerce\Admin\Features\MarketingRecommendations;
4
5	use Automattic\WooCommerce\Admin\RemoteSpecs\RemoteSpecsEngine;
6
7	defined( 'ABSPATH' ) \|\| exit;
8
9	/**
10	* Marketing Recommendations engine.
11	* This goes through the specs and gets marketing recommendations.
12	*/
13	class Init extends RemoteSpecsEngine {
14	/**
15	* Slug of the category specifying marketing extensions on the WooCommerce.com store.
16	*
17	* @var string
18	*/
19	const MARKETING_EXTENSION_CATEGORY_SLUG = 'marketing';
20
21	/**
22	* Slug of the subcategory specifying marketing channels on the WooCommerce.com store.
23	*
24	* @var string
25	*/
26	const MARKETING_CHANNEL_SUBCATEGORY_SLUG = 'sales-channels';
27
28	/**
29	* Constructor.
30	*/
31	public function __construct() {
32	add_action( 'woocommerce_updated', array( __CLASS__, 'delete_specs_transient' ) );
33	}
34
35	/**
36	* Delete the specs transient.
37	*/
38	public static function delete_specs_transient() {
39	MarketingRecommendationsDataSourcePoller::get_instance()->delete_specs_transient();
40	MiscRecommendationsDataSourcePoller::get_instance()->delete_specs_transient();
41	}
42
43	/**
44	* Get specs or fetch remotely if they don't exist.
45	*/
46	public static function get_specs() {
47	if ( 'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) ) {
48	return DefaultMarketingRecommendations::get_all();
49	}
50	$specs = MarketingRecommendationsDataSourcePoller::get_instance()->get_specs_from_data_sources();
51
52	// Fetch specs if they don't yet exist.
53	if ( ! is_array( $specs ) \|\| 0 === count( $specs ) ) {
54	return DefaultMarketingRecommendations::get_all();
55	}
56
57	return $specs;
58	}
59
60	/**
61	* Get misc recommendations specs or fetch remotely if they don't exist.
62	*
63	* @since 9.5.0
64	*/
65	public static function get_misc_recommendations_specs() {
66	if ( 'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) ) {
67	return array();
68	}
69	$specs = MiscRecommendationsDataSourcePoller::get_instance()->get_specs_from_data_sources();
70
71	// Return empty specs if they don't yet exist.
72	if ( ! is_array( $specs ) ) {
73	return array();
74	}
75
76	return $specs;
77	}
78
79	/**
80	* Process specs.
81	*
82	* @param array\|null $specs Marketing recommendations spec array.
83	* @return array
84	*/
85	protected static function evaluate_specs( ?array $specs = null ) {
86	$suggestions = array();
87	$errors = array();
88
89	foreach ( $specs as $spec ) {
90	try {
91	$suggestions[] = self::object_to_array( $spec );
92	} catch ( \Throwable $e ) {
93	$errors[] = $e;
94	}
95	}
96
97	return array(
98	'suggestions' => $suggestions,
99	'errors' => $errors,
100	);
101	}
102
103	/**
104	* Load recommended plugins from WooCommerce.com
105	*
106	* @return array
107	*/
108	public static function get_recommended_plugins(): array {
109	$specs = self::get_specs();
110	$results = self::evaluate_specs( $specs );
111
112	$specs_to_return = $results['suggestions'];
113	$specs_to_save = null;
114
115	if ( empty( $specs_to_return ) ) {
116	// When suggestions is empty, replace it with defaults and save for 3 hours.
117	$specs_to_save = DefaultMarketingRecommendations::get_all();
118	$specs_to_return = self::evaluate_specs( $specs_to_save )['suggestions'];
119	} elseif ( count( $results['errors'] ) > 0 ) {
120	// When suggestions is not empty but has errors, save it for 3 hours.
121	$specs_to_save = $specs;
122	}
123
124	if ( $specs_to_save ) {
125	MarketingRecommendationsDataSourcePoller::get_instance()->set_specs_transient( $specs_to_save, 3 * HOUR_IN_SECONDS );
126	}
127	$errors = $results['errors'];
128	if ( ! empty( $errors ) ) {
129	self::log_errors( $errors );
130	}
131
132	return $specs_to_return;
133	}
134
135	/**
136	* Return only the recommended marketing channels from WooCommerce.com.
137	*
138	* @return array
139	*/
140	public static function get_recommended_marketing_channels(): array {
141	return array_filter(
142	self::get_recommended_plugins(),
143	function ( array $plugin_data ) {
144	return self::is_marketing_channel_plugin( $plugin_data );
145	}
146	);
147	}
148
149	/**
150	* Return all recommended marketing extensions EXCEPT the marketing channels from WooCommerce.com.
151	*
152	* @return array
153	*/
154	public static function get_recommended_marketing_extensions_excluding_channels(): array {
155	return array_filter(
156	self::get_recommended_plugins(),
157	function ( array $plugin_data ) {
158	return self::is_marketing_plugin( $plugin_data ) && ! self::is_marketing_channel_plugin( $plugin_data );
159	}
160	);
161	}
162
163	/**
164	* Load misc recommendations from WooCommerce.com
165	*
166	* @since 9.5.0
167	* @return array
168	*/
169	public static function get_misc_recommendations(): array {
170	$specs = self::get_misc_recommendations_specs();
171	$results = self::evaluate_specs( $specs );
172
173	$specs_to_return = $results['suggestions'];
174	$specs_to_save = null;
175
176	if ( empty( $specs_to_return ) ) {
177	// When misc_recommendations is empty, replace it with defaults and save for 3 hours.
178	$specs_to_save = array();
179	} elseif ( count( $results['errors'] ) > 0 ) {
180	// When misc_recommendations is not empty but has errors, save it for 3 hours.
181	$specs_to_save = $specs;
182	}
183
184	if ( $specs_to_save ) {
185	MiscRecommendationsDataSourcePoller::get_instance()->set_specs_transient( $specs_to_save, 3 * HOUR_IN_SECONDS );
186	}
187	$errors = $results['errors'];
188	if ( ! empty( $errors ) ) {
189	self::log_errors( $errors );
190	}
191
192	return $specs_to_return;
193	}
194
195	/**
196	* Returns whether a plugin is a marketing extension.
197	*
198	* @param array $plugin_data The plugin properties returned by the API.
199	*
200	* @return bool
201	*/
202	protected static function is_marketing_plugin( array $plugin_data ): bool {
203	$categories = $plugin_data['categories'] ?? array();
204
205	return in_array( self::MARKETING_EXTENSION_CATEGORY_SLUG, $categories, true );
206	}
207
208	/**
209	* Returns whether a plugin is a marketing channel.
210	*
211	* @param array $plugin_data The plugin properties returned by the API.
212	*
213	* @return bool
214	*/
215	protected static function is_marketing_channel_plugin( array $plugin_data ): bool {
216	if ( ! self::is_marketing_plugin( $plugin_data ) ) {
217	return false;
218	}
219
220	$subcategories = $plugin_data['subcategories'] ?? array();
221	foreach ( $subcategories as $subcategory ) {
222	if ( isset( $subcategory['slug'] ) && self::MARKETING_CHANNEL_SUBCATEGORY_SLUG === $subcategory['slug'] ) {
223	return true;
224	}
225	}
226
227	return false;
228	}
229
230	/**
231	* Convert an object to an array.
232	* This is used to convert the specs to an array so that they can be returned by the API.
233	*
234	* @param mixed $obj Object to convert.
235	* @param array &$visited Reference to an array keeping track of all seen objects to detect circular references.
236	* @return array
237	*/
238	public static function object_to_array( $obj, &$visited = array() ) {
239	if ( is_object( $obj ) ) {
240	if ( in_array( $obj, $visited, true ) ) {
241	// Circular reference detected.
242	return null;
243	}
244	$visited[] = $obj;
245	$obj = (array) $obj;
246	}
247	if ( is_array( $obj ) ) {
248	$new = array();
249	foreach ( $obj as $key => $val ) {
250	$new[ $key ] = self::object_to_array( $val, $visited );
251	}
252	} else {
253	$new = $obj;
254	}
255	return $new;
256	}
257	}
258