ProductsRestServiceProvider.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 3.2.1

surecart / app / src / Rest / ProductsRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductsRestServiceProvider.php

278 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\ProductsController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class ProductsRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'products';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = ProductsController::class;
25
26	/**
27	* Register Additional REST Routes
28	*
29	* @return void
30	*/
31	public function registerRoutes() {
32	register_rest_route(
33	"$this->name/v$this->version",
34	$this->endpoint . '/(?P<id>\S+)/sync/',
35	[
36	[
37	'methods' => \WP_REST_Server::EDITABLE,
38	'callback' => $this->callback( $this->controller, 'sync' ),
39	'permission_callback' => [ $this, 'update_item_permissions_check' ],
40	],
41	// Register our schema callback.
42	'schema' => [ $this, 'get_item_schema' ],
43	]
44	);
45	register_rest_route(
46	"$this->name/v$this->version",
47	$this->endpoint . '/sync_all',
48	[
49	[
50	'methods' => \WP_REST_Server::EDITABLE,
51	'callback' => $this->callback( $this->controller, 'syncAll' ),
52	'permission_callback' => [ $this, 'update_item_permissions_check' ],
53	],
54	// Register our schema callback.
55	'schema' => [ $this, 'get_item_schema' ],
56	]
57	);
58	}
59
60	/**
61	* Get our sample schema for a post.
62	*
63	* @return array The sample schema for a post
64	*/
65	public function get_item_schema() {
66	if ( $this->schema ) {
67	// Since WordPress 5.3, the schema can be cached in the $schema property.
68	return $this->schema;
69	}
70
71	$this->schema = [
72	// This tells the spec of JSON Schema we are using which is draft 4.
73	'$schema' => 'http://json-schema.org/draft-04/schema#',
74	// The title property marks the identity of the resource.
75	'title' => $this->endpoint,
76	'type' => 'object',
77	// In JSON Schema you can specify object properties in the properties attribute.
78	'properties' => [
79	'id' => [
80	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
81	'type' => 'string',
82	'context' => [ 'view', 'edit', 'embed' ],
83	'readonly' => true,
84	],
85	'file_upload_ids' => [
86	'description' => esc_html__( 'Files attached to the product.', 'surecart' ),
87	'context' => [ 'edit' ],
88	'type' => 'array',
89	'items' => [
90	'type' => 'string',
91	],
92	],
93	'metadata' => [
94	'description' => esc_html__( 'Stored product metadata', 'surecart' ),
95	'type' => 'object',
96	'properties' => [
97	'wp_created_by' => [
98	'type' => 'integer',
99	'context' => [ 'edit' ],
100	'readonly' => true,
101	],
102	],
103	],
104	'metrics' => [
105	'description' => esc_html__( 'Top level metrics for the product.', 'surecart' ),
106	'readonly' => true,
107	'type' => 'object',
108	'properties' => [
109	'currency' => [
110	'type' => 'string',
111	],
112	'max_price_amount' => [
113	'type' => 'integer',
114	],
115	'min_price_amount' => [
116	'type' => 'integer',
117	],
118	'prices_count' => [
119	'type' => 'integer',
120	],
121	],
122	'context' => [ 'edit' ],
123	],
124	],
125	];
126
127	return $this->schema;
128	}
129
130	/**
131	* Get the collection params.
132	*
133	* @return array
134	*/
135	public function get_collection_params() {
136	return [
137	'archived' => [
138	'description' => esc_html__( 'Whether to get archived products or not.', 'surecart' ),
139	'type' => 'boolean',
140	],
141	'recurring' => [
142	'description' => esc_html__( 'Only return products that are recurring or not recurring (one time).', 'surecart' ),
143	'type' => 'boolean',
144	],
145	'query' => [
146	'description' => __( 'The query to be used for full text search of this collection.', 'surecart' ),
147	'type' => 'string',
148	],
149	'ids' => [
150	'description' => __( 'Ensure result set excludes specific IDs.', 'surecart' ),
151	'type' => 'array',
152	'items' => [
153	'type' => 'string',
154	],
155	'default' => [],
156	],
157	'product_group_ids' => [
158	'description' => __( 'Only return objects that belong to the given product groups.', 'surecart' ),
159	'type' => 'array',
160	'items' => [
161	'type' => 'string',
162	],
163	'default' => [],
164	],
165	'product_collection_ids' => [
166	'description' => __( 'Only return objects that belong to the given product collections.', 'surecart' ),
167	'type' => 'array',
168	'items' => [
169	'type' => 'string',
170	],
171	'default' => [],
172	],
173	'page' => [
174	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
175	'type' => 'integer',
176	],
177	'per_page' => [
178	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
179	'type' => 'integer',
180	],
181	];
182	}
183
184	/**
185	* Anyone can get a specific product.
186	*
187	* @param \WP_REST_Request $request Full details about the request.
188	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
189	*/
190	public function get_item_permissions_check( $request ) {
191	if ( 'edit' === $request['context'] && ! current_user_can( 'edit_sc_products' ) ) {
192	return new \WP_Error(
193	'rest_forbidden_context',
194	__( 'Sorry, you are not allowed to edit products.', 'surecart' ),
195	array( 'status' => rest_authorization_required_code() )
196	);
197	}
198
199	return true;
200	}
201
202	/**
203	* Who can list products?
204	*
205	* @param \WP_REST_Request $request Full details about the request.
206	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
207	*/
208	public function get_items_permissions_check( $request ) {
209	if ( 'edit' === $request['context'] && ! current_user_can( 'edit_sc_products' ) ) {
210	return new \WP_Error(
211	'rest_forbidden_context',
212	__( 'Sorry, you are not allowed to edit products.', 'surecart' ),
213	array( 'status' => rest_authorization_required_code() )
214	);
215	}
216
217	if ( $request['archived'] ) {
218	return current_user_can( 'edit_sc_products' );
219	}
220
221	return true;
222	}
223
224	/**
225	* Create model.
226	*
227	* @param \WP_REST_Request $request Full details about the request.
228	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
229	*/
230	public function create_item_permissions_check( $request ) {
231	$request['context'] = 'edit';
232	return current_user_can( 'publish_sc_products' );
233	}
234
235	/**
236	* Update model.
237	*
238	* @param \WP_REST_Request $request Full details about the request.
239	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
240	*/
241	public function update_item_permissions_check( $request ) {
242	$request['context'] = 'edit';
243	return current_user_can( 'edit_sc_products' );
244	}
245
246	/**
247	* Delete model.
248	*
249	* @param \WP_REST_Request $request Full details about the request.
250	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
251	*/
252	public function delete_item_permissions_check( $request ) {
253	$request['context'] = 'edit';
254	return current_user_can( 'delete_sc_products' );
255	}
256
257	/**
258	* If we are editing, let's make sure the data comes back directly.
259	*
260	* @param \SureCart\Models\Product $model Product model.
261	* @param string $context The context of the request.
262	*
263	* @return array The filtered response.
264	*/
265	public function filter_response_by_context( $model, $context ) {
266	$response = parent::filter_response_by_context( $model, $context );
267
268	if ( 'edit' === $context && is_array( $response ) && ! empty( $response['id'] ) ) {
269	// Process the variants, it's in a data column, so we need to pull it out.
270	$response['variants'] = ! empty( $response['variants']['data'] ) ? $response['variants']['data'] : [];
271	// Process the variant_options, it's in a data column, so we need to pull it out.
272	$response['variant_options'] = ! empty( $response['variant_options']['data'] ) ? $response['variant_options']['data'] : [];
273	}
274
275	return $response;
276	}
277	}
278