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

surecart / app / src / Rest / BumpRestServiceProvider.php

surecart / app / src / Rest Last commit date

BumpRestServiceProvider.php

235 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\BumpsController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class BumpRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'bumps';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = BumpsController::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', 'create', 'find', 'edit', 'delete' ];
39
40
41	/**
42	* Get our sample schema for a post.
43	*
44	* @return array The sample schema for a post
45	*/
46	public function get_item_schema() {
47	if ( $this->schema ) {
48	// Since WordPress 5.3, the schema can be cached in the $schema property.
49	return $this->schema;
50	}
51
52	$this->schema = [
53	// This tells the spec of JSON Schema we are using which is draft 4.
54	'$schema' => 'http://json-schema.org/draft-04/schema#',
55	// The title property marks the identity of the resource.
56	'title' => $this->endpoint,
57	'type' => 'object',
58	// In JSON Schema you can specify object properties in the properties attribute.
59	'properties' => [
60	'id' => [
61	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
62	'type' => 'string',
63	'context' => [ 'view', 'edit', 'embed' ],
64	'readonly' => true,
65	],
66	'object' => [
67	'description' => esc_html__( 'Type of object (bump)', 'surecart' ),
68	'type' => 'string',
69	'context' => [ 'view', 'edit' ],
70	'readonly' => true,
71	],
72	'created_at' => [
73	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
74	'type' => 'integer',
75	'context' => [ 'edit' ],
76	'readonly' => true,
77	],
78	'updated_at' => [
79	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
80	'type' => 'integer',
81	'context' => [ 'edit' ],
82	'readonly' => true,
83	],
84	'archived' => [
85	'description' => esc_html__( 'Whether the bump is archived.', 'surecart' ),
86	'type' => 'boolean',
87	'context' => [ 'edit' ],
88	],
89	'archived_at' => [
90	'description' => esc_html__( 'Archived at timestamp.', 'surecart' ),
91	'type' => 'integer',
92	'context' => [ 'edit' ],
93	],
94	'amount_off' => [
95	'description' => esc_html__( 'Amount (in the currency of the price) that will be taken off line items associated with this bump.', 'surecart' ),
96	'type' => 'integer',
97	'context' => [ 'edit' ],
98	],
99	'enabled' => [
100	'description' => esc_html__( 'Whether or not this bump is currently enabled and being shown to customers.', 'surecart' ),
101	'type' => 'boolean',
102	'context' => [ 'view', 'edit', 'embed' ],
103	],
104	'auto_apply' => [
105	'description' => esc_html__( 'Whether this bump is automatically applied when its conditions match.', 'surecart' ),
106	'type' => 'boolean',
107	'context' => [ 'edit' ],
108	],
109	'filters' => [
110	'description' => esc_html__( 'The conditions that will filter this bump to be recommeneded. Accepted keys are price_ids, product_ids, and product_group_ids with array values.', 'surecart' ),
111	'type' => 'string',
112	'context' => [ 'edit' ],
113	],
114	'filter_price_ids' => [
115	'description' => esc_html__( 'The price ids that filter this bump.', 'surecart' ),
116	'type' => 'array',
117	'context' => [ 'edit' ],
118	],
119	'filter_product_ids' => [
120	'description' => esc_html__( 'The product ids that filter this bump.', 'surecart' ),
121	'type' => 'array',
122	'context' => [ 'edit' ],
123	],
124	'filter_product_group_ids' => [
125	'description' => esc_html__( 'The product group ids that filter this bump.', 'surecart' ),
126	'type' => 'array',
127	'context' => [ 'edit' ],
128	],
129	'filter_match_type' => [
130	'description' => esc_html__( 'How the filter conditions are matched – can be one of all, any, or none.', 'surecart' ),
131	'type' => 'string',
132	'context' => [ 'edit' ],
133	],
134	'name' => [
135	'description' => esc_html__( 'This is shown to the customer on invoices and line items.', 'surecart' ),
136	'type' => 'string',
137	'context' => [ 'view', 'edit', 'embed' ],
138	],
139	'percent_off' => [
140	'description' => esc_html__( 'Percent that will be taken off line items associated with this bump.', 'surecart' ),
141	'type' => 'integer',
142	'context' => [ 'edit' ],
143	],
144	'priority' => [
145	'description' => esc_html__( 'The priority of this bump in relation to other bumps. Must be in the range of 1 - 5.', 'surecart' ),
146	'type' => 'integer',
147	'context' => [ 'edit' ],
148	],
149	'price' => [
150	'description' => esc_html__( 'The UUID of the price.', 'surecart' ),
151	'type' => 'string',
152	'context' => [ 'view', 'edit', 'embed' ],
153	],
154	'metadata' => [
155	'description' => esc_html__( 'Set of key-value pairs for custom data.', 'surecart' ),
156	'type' => 'object',
157	'context' => [ 'edit' ],
158	'properties' => [
159	'description' => [
160	'description' => esc_html__( 'Offer description.', 'surecart' ),
161	'type' => 'string',
162	'sanitize_callback' => 'wp_kses_post',
163	],
164	],
165	],
166	],
167	];
168
169	return $this->schema;
170	}
171
172	/**
173	* Anyone can get a specific price.
174	*
175	* @param \WP_REST_Request $request Full details about the request.
176	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
177	*/
178	public function get_item_permissions_check( $request ) {
179	$check = $this->forbidEditContextWithout( $request, 'edit_sc_prices' );
180	if ( is_wp_error( $check ) ) {
181	return $check;
182	}
183
184	return true;
185	}
186
187	/**
188	* Who can list prices
189	*
190	* @param \WP_REST_Request $request Full details about the request.
191	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
192	*/
193	public function get_items_permissions_check( $request ) {
194	$check = $this->forbidEditContextWithout( $request, 'edit_sc_prices' );
195	if ( is_wp_error( $check ) ) {
196	return $check;
197	}
198
199	if ( ! $request['enabled'] ) {
200	return current_user_can( 'edit_sc_prices' );
201	}
202	return true;
203	}
204
205	/**
206	* Create model.
207	*
208	* @param \WP_REST_Request $request Full details about the request.
209	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
210	*/
211	public function create_item_permissions_check( $request ) {
212	return current_user_can( 'publish_sc_prices' );
213	}
214
215	/**
216	* Update model.
217	*
218	* @param \WP_REST_Request $request Full details about the request.
219	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
220	*/
221	public function update_item_permissions_check( $request ) {
222	return current_user_can( 'edit_sc_prices' );
223	}
224
225	/**
226	* Delete model.
227	*
228	* @param \WP_REST_Request $request Full details about the request.
229	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
230	*/
231	public function delete_item_permissions_check( $request ) {
232	return current_user_can( 'delete_sc_prices' );
233	}
234	}
235