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

surecart / app / src / Rest / VariantsRestServiceProvider.php

surecart / app / src / Rest Last commit date

VariantsRestServiceProvider.php

176 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\VariantsController;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Service provider for Variant Rest Requests
10	*/
11	class VariantsRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'variants';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = VariantsController::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	* Methods allowed for the model.
35	*
36	* @var array
37	*/
38	protected $methods = [ 'index', 'find', 'edit', 'create', 'delete' ];
39
40	/**
41	* Get our sample schema for post.
42	*
43	* @return array The sample schema for a post
44	*/
45	public function get_item_schema() {
46	if ( $this->schema ) {
47	// Since WordPress 5.3, the schema can be cached in the $schema property.
48	return $this->schema;
49	}
50
51	$this->schema = [
52	// This tells the spec of JSON Schema we are using which is draft 4.
53	'$schema' => 'http://json-schema.org/draft-04/schema#',
54	// The title property marks the identity of the resource.
55	'title' => $this->endpoint,
56	'type' => 'object',
57	// In JSON Schema you can specify object properties in the properties attribute.
58	'properties' => [
59	'id' => [
60	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
61	'type' => 'string',
62	'context' => [ 'view', 'edit', 'embed' ],
63	'readonly' => true,
64	],
65	'available_stock' => [
66	'description' => esc_html__( 'The available stock for the variant.', 'surecart' ),
67	'type' => 'integer',
68	'context' => [ 'edit' ],
69	],
70	'held_stock' => [
71	'description' => esc_html__( 'The held stock for the variant.', 'surecart' ),
72	'type' => 'integer',
73	'context' => [ 'edit' ],
74	],
75	'stock' => [
76	'description' => esc_html__( 'The stock for the variant.', 'surecart' ),
77	'type' => 'integer',
78	'context' => [ 'edit' ],
79	],
80	'sku' => [
81	'description' => esc_html__( 'The variant SKU.', 'surecart' ),
82	'type' => 'string',
83	'context' => [ 'edit' ],
84	],
85	'metadata' => [
86	'description' => esc_html__( 'Set of key-value pairs for custom data.', 'surecart' ),
87	'type' => 'object',
88	'context' => [ 'edit' ],
89	],
90	'dimensions' => [
91	'description' => esc_html__( 'The variant shipping dimensions.', 'surecart' ),
92	'type' => 'object',
93	'context' => [ 'edit' ],
94	],
95	'weight' => [
96	'description' => esc_html__( 'The variant shipping weight.', 'surecart' ),
97	'type' => 'number',
98	'context' => [ 'edit' ],
99	],
100	'weight_unit' => [
101	'description' => esc_html__( 'The variant shipping weight unit.', 'surecart' ),
102	'type' => 'string',
103	'context' => [ 'edit' ],
104	],
105	],
106	];
107
108	return $this->schema;
109	}
110
111
112	/**
113	* Anyone can get a specfic variant.
114	*
115	* @param \WP_REST_Request $request Full details about the request .
116	* @return true \| \WP_Error true if the request has access to create items, WP_Error object otherwise .
117	*/
118	public function get_item_permissions_check( $request ) {
119	$check = $this->forbidEditContextWithout( $request, 'edit_sc_prices' );
120	if ( is_wp_error( $check ) ) {
121	return $check;
122	}
123
124	return true;
125	}
126
127	/**
128	* Who can list variants
129	*
130	* @param \WP_REST_Request $request Full details about the request .
131	* @return true \| \WP_Error true if the request has access to create items, WP_Error object otherwise .
132	*/
133	public function get_items_permissions_check( $request ) {
134	$check = $this->forbidEditContextWithout( $request, 'edit_sc_prices' );
135	if ( is_wp_error( $check ) ) {
136	return $check;
137	}
138
139	if ( $request ['archived'] ) {
140	return current_user_can( 'edit_sc_prices' );
141	}
142
143	return true;
144	}
145
146	/**
147	* Who can create variants
148	*
149	* @param \WP_REST_Request $request Full details about the request .
150	* @return true \| \WP_Error true if the request has access to create items, WP_Error object otherwise .
151	*/
152	public function create_item_permissions_check( $request ) {
153	return current_user_can( 'publish_sc_prices' );
154	}
155
156	/**
157	* Who can edit variants
158	*
159	* @param \WP_REST_Request $request Full details about the request .
160	* @return true \| \WP_Error true if the request has access to create items, WP_Error object otherwise .
161	*/
162	public function update_item_permissions_check( $request ) {
163	return current_user_can( 'edit_sc_prices' );
164	}
165
166	/**
167	* Who can delete variants
168	*
169	* @param \WP_REST_Request $request Full details about the request .
170	* @return true \| \WP_Error true if the request has access to create items, WP_Error object otherwise .
171	*/
172	public function delete_item_permissions_check( $request ) {
173	return current_user_can( 'delete_sc_prices' );
174	}
175	}
176