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

surecart / app / src / Rest / PriceRestServiceProvider.php

surecart / app / src / Rest Last commit date

PriceRestServiceProvider.php

179 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\PricesController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class PriceRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12
13	/**
14	* Endpoint.
15	*
16	* @var string
17	*/
18	protected $endpoint = 'prices';
19
20	/**
21	* Rest Controller
22	*
23	* @var string
24	*/
25	protected $controller = PricesController::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+)/duplicate',
36	[
37	'methods' => \WP_REST_Server::CREATABLE,
38	'callback' => $this->callback( $this->controller, 'duplicate' ),
39	'permission_callback' => [ $this, 'create_item_permissions_check' ],
40	]
41	);
42	}
43
44	/**
45	* Get our sample schema for a post.
46	*
47	* @return array The sample schema for a post
48	*/
49	public function get_item_schema() {
50	if ( $this->schema ) {
51	// Since WordPress 5.3, the schema can be cached in the $schema property.
52	return $this->schema;
53	}
54
55	$this->schema = [
56	// This tells the spec of JSON Schema we are using which is draft 4.
57	'$schema' => 'http://json-schema.org/draft-04/schema#',
58	// The title property marks the identity of the resource.
59	'title' => $this->endpoint,
60	'type' => 'object',
61	// In JSON Schema you can specify object properties in the properties attribute.
62	'properties' => [
63	'id' => [
64	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
65	'type' => 'string',
66	'context' => array( 'view', 'edit', 'embed' ),
67	'readonly' => true,
68	],
69	'content' => array(
70	'description' => esc_html__( 'The content for the object.', 'surecart' ),
71	'type' => 'string',
72	),
73	],
74	];
75
76	return $this->schema;
77	}
78
79	/**
80	* Get the collection params.
81	*
82	* @return array
83	*/
84	public function get_collection_params() {
85	return [
86	'archived' => [
87	'description' => esc_html__( 'Whether to get archived products or not.', 'surecart' ),
88	'type' => 'boolean',
89	],
90	'ad_hoc' => [
91	'description' => esc_html__( 'Only return prices that allow ad hoc amounts or not.', 'surecart' ),
92	'type' => 'boolean',
93	],
94	'query' => [
95	'description' => __( 'The query to be used for full text search of this collection.', 'surecart' ),
96	'type' => 'string',
97	],
98	'ids' => [
99	'description' => __( 'Ensure result set excludes specific IDs.', 'surecart' ),
100	'type' => 'array',
101	'items' => [
102	'type' => 'string',
103	],
104	'default' => [],
105	],
106	'product_ids' => [
107	'description' => __( 'Only return objects that belong to the given products.', 'surecart' ),
108	'type' => 'array',
109	'items' => [
110	'type' => 'string',
111	],
112	'default' => [],
113	],
114	'page' => [
115	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
116	'type' => 'integer',
117	],
118	'per_page' => [
119	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
120	'type' => 'integer',
121	],
122	];
123	}
124
125	/**
126	* Anyone can get a specific price.
127	*
128	* @param \WP_REST_Request $request Full details about the request.
129	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
130	*/
131	public function get_item_permissions_check( $request ) {
132	return true;
133	}
134
135	/**
136	* Who can list prices
137	*
138	* @param \WP_REST_Request $request Full details about the request.
139	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
140	*/
141	public function get_items_permissions_check( $request ) {
142	if ( $request['archived'] ) {
143	return current_user_can( 'edit_sc_prices' );
144	}
145
146	return true;
147	}
148
149	/**
150	* Create model.
151	*
152	* @param \WP_REST_Request $request Full details about the request.
153	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
154	*/
155	public function create_item_permissions_check( $request ) {
156	return current_user_can( 'publish_sc_prices' );
157	}
158
159	/**
160	* Update model.
161	*
162	* @param \WP_REST_Request $request Full details about the request.
163	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
164	*/
165	public function update_item_permissions_check( $request ) {
166	return current_user_can( 'edit_sc_prices' );
167	}
168
169	/**
170	* Delete model.
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 delete_item_permissions_check( $request ) {
176	return current_user_can( 'delete_sc_prices' );
177	}
178	}
179