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

surecart / app / src / Rest / ReviewsRestServiceProvider.php

surecart / app / src / Rest Last commit date

ReviewsRestServiceProvider.php

257 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\ReviewsController;
7
8	/**
9	* Service provider for Review Rest Requests
10	*/
11	class ReviewsRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'reviews';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = ReviewsController::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+)/publish/',
35	[
36	[
37	'methods' => \WP_REST_Server::EDITABLE,
38	'callback' => $this->callback( $this->controller, 'publish' ),
39	'permission_callback' => [ $this, 'update_item_permissions_check' ],
40	],
41	// Register our schema callback.
42	'schema' => [ $this, 'get_item_schema' ],
43	]
44	);
45
46	register_rest_route(
47	"$this->name/v$this->version",
48	$this->endpoint . '/(?P<id>\S+)/unpublish/',
49	[
50	[
51	'methods' => \WP_REST_Server::EDITABLE,
52	'callback' => $this->callback( $this->controller, 'unpublish' ),
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	'object' => [
87	'description' => esc_html__( 'Type of object.', 'surecart' ),
88	'type' => 'string',
89	'context' => [ 'view', 'edit', 'embed' ],
90	'readonly' => true,
91	],
92	'body' => [
93	'description' => esc_html__( 'Review body content.', 'surecart' ),
94	'type' => 'string',
95	'context' => [ 'view', 'edit' ],
96	],
97	'status' => [
98	'description' => esc_html__( 'Review status.', 'surecart' ),
99	'type' => 'string',
100	'enum' => [ 'published', 'in_review', 'unpublished' ],
101	'context' => [ 'view', 'edit' ],
102	],
103	'title' => [
104	'description' => esc_html__( 'Review title.', 'surecart' ),
105	'type' => 'string',
106	'context' => [ 'view', 'edit' ],
107	],
108	'stars' => [
109	'description' => esc_html__( 'Review rating in stars (1-5).', 'surecart' ),
110	'type' => 'integer',
111	'minimum' => 1,
112	'maximum' => 5,
113	'context' => [ 'view', 'edit' ],
114	],
115	'verified' => [
116	'description' => esc_html__( 'Whether the review is verified.', 'surecart' ),
117	'type' => 'boolean',
118	'context' => [ 'view', 'edit' ],
119	'readonly' => true,
120	],
121	'customer' => [
122	'description' => esc_html__( 'The customer who wrote the review.', 'surecart' ),
123	'type' => 'string',
124	'context' => [ 'view', 'edit' ],
125	],
126	'product' => [
127	'description' => esc_html__( 'The product being reviewed.', 'surecart' ),
128	'type' => 'string',
129	'context' => [ 'view', 'edit' ],
130	],
131	'purchase' => [
132	'description' => esc_html__( 'The purchase associated with this review.', 'surecart' ),
133	'type' => [ 'string', 'null' ],
134	'context' => [ 'view', 'edit' ],
135	],
136	],
137	];
138
139	return $this->schema;
140	}
141
142	/**
143	* Get the collection params.
144	*
145	* @return array
146	*/
147	public function get_collection_params() {
148	return [
149	'status' => [
150	'description' => esc_html__( 'Filter by review status.', 'surecart' ),
151	'type' => 'array',
152	'items' => [
153	'type' => 'string',
154	'enum' => [ 'published', 'in_review', 'unpublished' ],
155	],
156	'default' => [],
157	],
158	'product_ids' => [
159	'description' => esc_html__( 'Only return reviews for the given products.', 'surecart' ),
160	'type' => 'array',
161	'items' => [
162	'type' => 'string',
163	],
164	'default' => [],
165	],
166	'stars' => [
167	'description' => esc_html__( 'Filter by star rating (1-5).', 'surecart' ),
168	'type' => 'array',
169	'items' => [
170	'type' => 'string',
171	'enum' => [ '1', '2', '3', '4', '5' ],
172	],
173	'default' => [],
174	],
175	'customer_ids' => [
176	'description' => esc_html__( 'Only return reviews from the given customers.', 'surecart' ),
177	'type' => 'array',
178	'items' => [
179	'type' => 'string',
180	],
181	'default' => [],
182	],
183	'verified' => [
184	'description' => esc_html__( 'Only return verified or unverified reviews.', 'surecart' ),
185	'type' => 'boolean',
186	],
187	'query' => [
188	'description' => esc_html__( 'The query to be used for full text search of this collection.', 'surecart' ),
189	'type' => 'string',
190	],
191	'page' => [
192	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
193	'type' => 'integer',
194	],
195	'per_page' => [
196	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
197	'type' => 'integer',
198	],
199	];
200	}
201
202	/**
203	* Who can list reviews?
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	return current_user_can( 'read_sc_reviews' );
210	}
211
212	/**
213	* Who can get a specific review?
214	*
215	* @param \WP_REST_Request $request Full details about the request.
216	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
217	*/
218	public function get_item_permissions_check( $request ) {
219	return current_user_can( 'read_sc_reviews' );
220	}
221
222	/**
223	* Create review.
224	*
225	* @param \WP_REST_Request $request Full details about the request.
226	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
227	*/
228	public function create_item_permissions_check( $request ) {
229	// If customer, product, or purchase are passed, user must have edit_sc_reviews permission.
230	if ( ! empty( $request->get_param( 'customer' ) ) \|\| ! empty( $request->get_param( 'purchase' ) ) ) {
231	return current_user_can( 'edit_sc_reviews' );
232	}
233
234	return is_user_logged_in();
235	}
236
237	/**
238	* Update review.
239	*
240	* @param \WP_REST_Request $request Full details about the request.
241	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
242	*/
243	public function update_item_permissions_check( $request ) {
244	return current_user_can( 'edit_sc_reviews' );
245	}
246
247	/**
248	* Delete review.
249	*
250	* @param \WP_REST_Request $request Full details about the request.
251	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
252	*/
253	public function delete_item_permissions_check( $request ) {
254	return current_user_can( 'delete_sc_reviews' );
255	}
256	}
257