ExportWCSettingsShipping.php — WooCommerce 10.9.4

woocommerce / src / Admin / Features / Blueprint / Exporters / ExportWCSettingsShipping.php

woocommerce / src / Admin / Features / Blueprint / Exporters Last commit date

ExportWCSettingsShipping.php

209 lines

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Automattic\WooCommerce\Admin\Features\Blueprint\Exporters;
6
7	use Automattic\WooCommerce\Blueprint\Steps\RunSql;
8	use Automattic\WooCommerce\Blueprint\Steps\SetSiteOptions;
9	use Automattic\WooCommerce\Blueprint\Util;
10
11	/**
12	* Class ExportWCSettingsShipping
13	*
14	* Exports WooCommerce settings on the Shipping page.
15	*
16	* @package Automattic\WooCommerce\Admin\Features\Blueprint\Exporters
17	*/
18	class ExportWCSettingsShipping extends ExportWCSettings {
19	/**
20	* Export WooCommerce shipping settings.
21	*
22	* @return array Array of RunSql\|SetSiteOptions instances.
23	*/
24	public function export(): array {
25	$shipping_settings = parent::export();
26
27	$steps = array_merge(
28	array( $shipping_settings ),
29	$this->get_steps_for_classes_and_terms(),
30	$this->get_steps_for_zones(),
31	$this->get_steps_for_locations(),
32	$this->get_steps_for_methods_and_options()
33	);
34
35	$steps[] = $this->get_step_for_local_pickup();
36	return $steps;
37	}
38
39	/**
40	* Retrieve term data based on provided classes.
41	*
42	* @param array $classes List of classes with term IDs.
43	* @return array Retrieved term data.
44	*/
45	protected function get_terms( array $classes ): array {
46	global $wpdb;
47
48	$term_ids = array_map( fn( $term ) => (int) $term['term_id'], $classes );
49	$term_ids = implode( ', ', $term_ids );
50
51	return ! empty( $term_ids ) ? $wpdb->get_results(
52	$wpdb->prepare(
53	"SELECT * FROM {$wpdb->prefix}terms WHERE term_id IN (%s)",
54	$term_ids
55	),
56	ARRAY_A
57	) : array();
58	}
59
60	/**
61	* Retrieve shipping classes and related terms.
62	*
63	* @return array Steps for shipping classes and terms.
64	*/
65	protected function get_steps_for_classes_and_terms(): array {
66	global $wpdb;
67
68	$classes = $wpdb->get_results(
69	"SELECT * FROM {$wpdb->prefix}term_taxonomy WHERE taxonomy = 'product_shipping_class'",
70	ARRAY_A
71	);
72
73	$classes_steps = array_map(
74	fn( $class_row ) => new RunSql( Util::array_to_insert_sql( $class_row, $wpdb->prefix . 'term_taxonomy', 'replace into' ) ),
75	$classes
76	);
77
78	$terms = array_map(
79	fn( $term ) => new RunSql( Util::array_to_insert_sql( $term, $wpdb->prefix . 'terms', 'replace into' ) ),
80	$this->get_terms( $classes )
81	);
82
83	return array_merge( $classes_steps, $terms );
84	}
85
86	/**
87	* Get the name of the step.
88	*
89	* @return string
90	*/
91	public function get_step_name(): string {
92	return RunSql::get_step_name();
93	}
94
95	/**
96	* Return label used in the frontend.
97	*
98	* @return string
99	*/
100	public function get_label(): string {
101	return __( 'Shipping', 'woocommerce' );
102	}
103
104	/**
105	* Return description used in the frontend.
106	*
107	* @return string
108	*/
109	public function get_description(): string {
110	return __( 'Includes all settings in WooCommerce \| Settings \| Shipping.', 'woocommerce' );
111	}
112
113	/**
114	* Get the alias.
115	*
116	* @return string
117	*/
118	public function get_alias(): string {
119	return 'setWCShipping';
120	}
121
122	/**
123	* Retrieve shipping zones from the database.
124	*
125	* @return array Steps for shipping zones.
126	*/
127	private function get_steps_for_zones(): array {
128	global $wpdb;
129
130	return array_map(
131	fn( $zone ) => new RunSql( Util::array_to_insert_sql( $zone, $wpdb->prefix . 'woocommerce_shipping_zones', 'replace into' ) ),
132	$wpdb->get_results( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zones", ARRAY_A )
133	);
134	}
135
136	/**
137	* Retrieve shipping zone locations.
138	*
139	* @return array Steps for shipping zone locations.
140	*/
141	private function get_steps_for_locations(): array {
142	global $wpdb;
143
144	return array_map(
145	fn( $location ) => new RunSql( Util::array_to_insert_sql( $location, $wpdb->prefix . 'woocommerce_shipping_zone_locations', 'replace into' ) ),
146	$wpdb->get_results( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zone_locations", ARRAY_A )
147	);
148	}
149
150	/**
151	* Retrieve shipping methods and options.
152	*
153	* @return array Steps for shipping methods and options.
154	*/
155	private function get_steps_for_methods_and_options(): array {
156	global $wpdb;
157
158	$methods = $wpdb->get_results( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zone_methods", ARRAY_A );
159	$method_options = $wpdb->get_results(
160	"SELECT * FROM {$wpdb->prefix}options WHERE option_name LIKE 'woocommerce_flat_rate_%_settings'
161	OR option_name LIKE 'woocommerce_free_shipping_%_settings'",
162	ARRAY_A
163	);
164
165	return array_merge(
166	array_map(
167	fn( $method ) => new RunSql( Util::array_to_insert_sql( $method, $wpdb->prefix . 'woocommerce_shipping_zone_methods', 'replace into' ) ),
168	$methods
169	),
170	array_map(
171	fn( $option ) => new RunSql( Util::array_to_insert_sql( $option, $wpdb->prefix . 'options', 'replace into' ) ),
172	$method_options
173	)
174	);
175	}
176
177	/**
178	* Retrieve local pickup settings.
179	*
180	* @return SetSiteOptions Local pickup settings step.
181	*/
182	private function get_step_for_local_pickup(): SetSiteOptions {
183	return new SetSiteOptions(
184	array(
185	'woocommerce_pickup_location_settings' => get_option( 'woocommerce_pickup_location_settings', array() ),
186	'pickup_location_pickup_locations' => get_option( 'pickup_location_pickup_locations', array() ),
187	)
188	);
189	}
190
191	/**
192	* Check if the current user has the required capabilities for this step.
193	*
194	* @return bool True if the user has the required capabilities. False otherwise.
195	*/
196	public function check_step_capabilities(): bool {
197	return current_user_can( 'manage_woocommerce' );
198	}
199
200	/**
201	* Get the page ID for the settings page.
202	*
203	* @return string
204	*/
205	public function get_page_id(): string {
206	return 'shipping';
207	}
208	}
209