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

surecart / app / src / Rest / ProductsRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductsRestServiceProvider.php

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