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

surecart / app / src / Rest / ProductCollectionsRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductCollectionsRestServiceProvider.php

190 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\ProductCollectionsController;
7
8	/**
9	* Service provider for Product Collection Rest Requests
10	*/
11	class ProductCollectionsRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'product_collections';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = ProductCollectionsController::class;
25
26	/**
27	* Filter index list items by schema context.
28	*
29	* @var boolean
30	*/
31	protected $filters_list_items = true;
32
33	/**
34	* Get our sample schema for a post.
35	*
36	* @return array The sample schema for a post
37	*/
38	public function get_item_schema() {
39	if ( $this->schema ) {
40	// Since WordPress 5.3, the schema can be cached in the $schema property.
41	return $this->schema;
42	}
43
44	$this->schema = [
45	// This tells the spec of JSON Schema we are using which is draft 4.
46	'$schema' => 'http://json-schema.org/draft-04/schema#',
47	// The title property marks the identity of the resource.
48	'title' => $this->endpoint,
49	'type' => 'object',
50	// In JSON Schema you can specify object properties in the properties attribute.
51	'properties' => [
52	'id' => [
53	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
54	'type' => 'string',
55	'context' => array( 'view', 'edit', 'embed' ),
56	'readonly' => true,
57	],
58	'metadata' => [
59	'description' => esc_html__( 'Set of key-value pairs for custom data.', 'surecart' ),
60	'type' => 'object',
61	'context' => [ 'edit' ],
62	],
63	'archived_at' => [
64	'description' => esc_html__( 'Archived at timestamp.', 'surecart' ),
65	'type' => 'integer',
66	'context' => [ 'edit' ],
67	],
68	],
69	];
70
71	return $this->schema;
72	}
73
74	/**
75	* You can get a specific product collection if you have the id.
76	*
77	* @param \WP_REST_Request $request Full details about the request.
78	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
79	*/
80	public function get_item_permissions_check( $request ) {
81	$check = $this->forbidEditContextWithout( $request, 'edit_sc_products' );
82	if ( is_wp_error( $check ) ) {
83	return $check;
84	}
85
86	return true;
87	}
88
89	/**
90	* Get the collection params.
91	*
92	* Plugins can extend this list via the
93	* `surecart/product_collections/rest_args` filter.
94	*
95	* @return array
96	*/
97	public function get_collection_params() {
98	$args = [
99	'query' => [
100	'description' => __( 'The query to be used for full text search of this collection.', 'surecart' ),
101	'type' => 'string',
102	],
103	'sort' => [
104	'description' => __( 'Sort directive in the form `field:direction`, e.g. `created_at:desc`.', 'surecart' ),
105	'type' => 'string',
106	],
107	'expand' => [
108	'description' => __( 'Relations to expand on each returned collection.', 'surecart' ),
109	'type' => 'array',
110	'items' => [ 'type' => 'string' ],
111	'default' => [],
112	],
113	'ids' => [
114	'description' => __( 'Filter the result set to specific IDs.', 'surecart' ),
115	'type' => 'array',
116	'items' => [ 'type' => 'string' ],
117	'default' => [],
118	],
119	'product_ids' => [
120	'description' => __( 'Only return collections that contain the given products.', 'surecart' ),
121	'type' => 'array',
122	'items' => [ 'type' => 'string' ],
123	'default' => [],
124	],
125	'page' => [
126	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
127	'type' => 'integer',
128	],
129	'per_page' => [
130	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
131	'type' => 'integer',
132	],
133	];
134
135	/**
136	* Filter the product_collections REST collection params.
137	*
138	* @param array $args Args keyed by param name.
139	* @return array
140	*/
141	return apply_filters( 'surecart/product_collections/rest_args', $args );
142	}
143
144	/**
145	* You can get the product collection for edit context with permission
146	* and for view context make it public.
147	*
148	* @param \WP_REST_Request $request Full details about the request.
149	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
150	*/
151	public function get_items_permissions_check( $request ) {
152	$check = $this->forbidEditContextWithout( $request, 'edit_sc_products' );
153	if ( is_wp_error( $check ) ) {
154	return $check;
155	}
156
157	return true;
158	}
159
160	/**
161	* Create model.
162	*
163	* @param \WP_REST_Request $request Full details about the request.
164	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
165	*/
166	public function create_item_permissions_check( $request ) {
167	return current_user_can( 'edit_sc_products' );
168	}
169
170	/**
171	* Update model.
172	*
173	* @param \WP_REST_Request $request Full details about the request.
174	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
175	*/
176	public function update_item_permissions_check( $request ) {
177	return current_user_can( 'edit_sc_products' );
178	}
179
180	/**
181	* Delete model.
182	*
183	* @param \WP_REST_Request $request Full details about the request.
184	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
185	*/
186	public function delete_item_permissions_check( $request ) {
187	return current_user_can( 'edit_sc_products' );
188	}
189	}
190