ExportWCSettingsShipping.php — WooCommerce 11.1.0

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

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

ExportWCSettingsShipping.php

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