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

surecart / app / src / Rest / ProductsRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductsRestServiceProvider.php

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