-
Notifications
You must be signed in to change notification settings - Fork 21
/
AttributeMappingRulesController.php
282 lines (249 loc) · 8.78 KB
/
AttributeMappingRulesController.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<?php
declare( strict_types=1 );
namespace Automattic\WooCommerce\GoogleListingsAndAds\API\Site\Controllers\AttributeMapping;
use Automattic\WooCommerce\GoogleListingsAndAds\API\Site\Controllers\BaseOptionsController;
use Automattic\WooCommerce\GoogleListingsAndAds\API\TransportMethods;
use Automattic\WooCommerce\GoogleListingsAndAds\DB\Query\AttributeMappingRulesQuery;
use Automattic\WooCommerce\GoogleListingsAndAds\Product\AttributeMapping\AttributeMappingHelper;
use Automattic\WooCommerce\GoogleListingsAndAds\Proxies\RESTServer;
use WP_Error;
use WP_REST_Request as Request;
use WP_REST_Response as Response;
use Exception;
defined( 'ABSPATH' ) || exit;
/**
* Class for handling API requests for getting source and destination data for Attribute Mapping
*
* @package Automattic\WooCommerce\GoogleListingsAndAds\API\Site\Controllers\AttributeMapping
*/
class AttributeMappingRulesController extends BaseOptionsController {
/**
* @var AttributeMappingRulesQuery
*/
private AttributeMappingRulesQuery $attribute_mapping_rules_query;
/**
* @var AttributeMappingHelper
*/
private AttributeMappingHelper $attribute_mapping_helper;
/**
* AttributeMappingController constructor.
*
* @param RESTServer $server
* @param AttributeMappingHelper $attribute_mapping_helper
* @param AttributeMappingRulesQuery $attribute_mapping_rules_query
*/
public function __construct( RESTServer $server, AttributeMappingHelper $attribute_mapping_helper, AttributeMappingRulesQuery $attribute_mapping_rules_query ) {
parent::__construct( $server );
$this->attribute_mapping_helper = $attribute_mapping_helper;
$this->attribute_mapping_rules_query = $attribute_mapping_rules_query;
}
/**
* Register rest routes with WordPress.
*/
public function register_routes(): void {
$this->register_route(
'mc/mapping/rules',
[
[
'methods' => TransportMethods::READABLE,
'callback' => $this->get_rule_callback(),
'permission_callback' => $this->get_permission_callback(),
'args' => $this->get_collection_params(),
],
[
'methods' => TransportMethods::CREATABLE,
'callback' => $this->create_rule_callback(),
'permission_callback' => $this->get_permission_callback(),
'args' => $this->get_schema_properties(),
],
'schema' => $this->get_api_response_schema_callback(),
],
);
$this->register_route(
'mc/mapping/rules/(?P<id>[\d]+)',
[
[
'methods' => TransportMethods::EDITABLE,
'callback' => $this->update_rule_callback(),
'permission_callback' => $this->get_permission_callback(),
'args' => $this->get_schema_properties(),
],
[
'methods' => TransportMethods::DELETABLE,
'callback' => $this->delete_rule_callback(),
'permission_callback' => $this->get_permission_callback(),
],
'schema' => $this->get_api_response_schema_callback(),
],
);
}
/**
* Callback function for getting the Attribute Mapping rules from DB
*
* @return callable
*/
protected function get_rule_callback(): callable {
return function ( Request $request ) {
try {
$page = $request->get_param( 'page' );
$per_page = $request->get_param( 'per_page' );
$this->attribute_mapping_rules_query->set_limit( $per_page );
$this->attribute_mapping_rules_query->set_offset( $per_page * ( $page - 1 ) );
$rules = $this->attribute_mapping_rules_query->get_results();
$total_rules = $this->attribute_mapping_rules_query->get_count();
$response_data = [];
foreach ( $rules as $rule ) {
$item_data = $this->prepare_item_for_response( $rule, $request );
$response_data[] = $this->prepare_response_for_collection( $item_data );
}
return new Response(
$response_data,
200,
[
'X-WP-Total' => $total_rules,
'X-WP-TotalPages' => ceil( $total_rules / $per_page ),
]
);
} catch ( Exception $e ) {
return $this->response_from_exception( $e );
}
};
}
/**
* Callback function for saving an Attribute Mapping rule in DB
*
* @return callable
*/
protected function create_rule_callback(): callable {
return function ( Request $request ) {
try {
if ( ! $this->attribute_mapping_rules_query->insert( $this->prepare_item_for_database( $request ) ) ) {
return $this->response_from_exception( new Exception( 'Unable to create the new rule.' ) );
}
$response = $this->prepare_item_for_response( $this->attribute_mapping_rules_query->get_rule( $this->attribute_mapping_rules_query->last_insert_id() ), $request );
do_action( 'woocommerce_gla_mapping_rules_change' );
return $response;
} catch ( Exception $e ) {
return $this->response_from_exception( $e );
}
};
}
/**
* Callback function for saving an Attribute Mapping rule in DB
*
* @return callable
*/
protected function update_rule_callback(): callable {
return function ( Request $request ) {
try {
$rule_id = $request->get_url_params()['id'];
if ( ! $this->attribute_mapping_rules_query->update( $this->prepare_item_for_database( $request ), [ 'id' => $rule_id ] ) ) {
return $this->response_from_exception( new Exception( 'Unable to update the new rule.' ) );
}
$response = $this->prepare_item_for_response( $this->attribute_mapping_rules_query->get_rule( $rule_id ), $request );
do_action( 'woocommerce_gla_mapping_rules_change' );
return $response;
} catch ( Exception $e ) {
return $this->response_from_exception( $e );
}
};
}
/**
* Callback function for deleting an Attribute Mapping rule in DB
*
* @return callable
*/
protected function delete_rule_callback(): callable {
return function ( Request $request ) {
try {
$rule_id = $request->get_url_params()['id'];
if ( ! $this->attribute_mapping_rules_query->delete( 'id', $rule_id ) ) {
return $this->response_from_exception( new Exception( 'Unable to delete the rule' ) );
}
do_action( 'woocommerce_gla_mapping_rules_change' );
return [
'id' => $rule_id,
];
} catch ( Exception $e ) {
return $this->response_from_exception( $e );
}
};
}
/**
* Get the item schema properties for the controller.
*
* @return array The Schema properties
*/
protected function get_schema_properties(): array {
return [
'id' => [
'description' => __( 'The Id for the rule.', 'google-listings-and-ads' ),
'type' => 'integer',
'validate_callback' => 'rest_validate_request_arg',
'readonly' => true,
],
'attribute' => [
'description' => __( 'The attribute value for the rule.', 'google-listings-and-ads' ),
'type' => 'string',
'validate_callback' => 'rest_validate_request_arg',
'required' => true,
'enum' => array_column( $this->attribute_mapping_helper->get_attributes(), 'id' ),
],
'source' => [
'description' => __( 'The source value for the rule.', 'google-listings-and-ads' ),
'type' => 'string',
'validate_callback' => 'rest_validate_request_arg',
'required' => true,
],
'category_condition_type' => [
'description' => __( 'The category condition type to apply for this rule.', 'google-listings-and-ads' ),
'type' => 'string',
'validate_callback' => 'rest_validate_request_arg',
'required' => true,
'enum' => $this->attribute_mapping_helper->get_category_condition_types(),
],
'categories' => [
'description' => __( 'List of category IDs, separated by commas.', 'google-listings-and-ads' ),
'type' => 'string',
'required' => false,
'validate_callback' => function ( $param ) {
return $this->validate_categories_param( $param );
},
],
];
}
/**
* Get the item schema name for the controller.
*
* Used for building the API response schema.
*
* @return string
*/
protected function get_schema_title(): string {
return 'attribute_mapping_rules';
}
/**
* @param string $categories Categories to validate
* @return bool|WP_Error True if it's validated
*
* @throw Exception when invalid categories are provided
*/
public function validate_categories_param( string $categories ) {
if ( $categories === '' ) {
return true;
}
$categories_array = explode( ',', $categories );
foreach ( $categories_array as $category ) {
if ( ! is_numeric( $category ) ) {
return new WP_Error(
'woocommerce_gla_attribute_mapping_invalid_categories_schema',
'categories should be a string of category IDs separated by commas.',
[
'categories' => $categories,
]
);
}
}
return true;
}
}