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

surecart / app / src / Rest / CustomerRestServiceProvider.php

surecart / app / src / Rest Last commit date

CustomerRestServiceProvider.php

261 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\CustomerController;
6	use SureCart\Models\User;
7	use SureCart\Rest\RestServiceInterface;
8
9	/**
10	* Service provider for Price Rest Requests
11	*/
12	class CustomerRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
13	/**
14	* Endpoint.
15	*
16	* @var string
17	*/
18	protected $endpoint = 'customers';
19
20	/**
21	* Rest Controller
22	*
23	* @var string
24	*/
25	protected $controller = CustomerController::class;
26
27	/**
28	* Get our sample schema for a post.
29	*
30	* @return array The sample schema for a post
31	*/
32	public function get_item_schema() {
33	if ( $this->schema ) {
34	// Since WordPress 5.3, the schema can be cached in the $schema property.
35	return $this->schema;
36	}
37
38	$this->schema = [
39	// This tells the spec of JSON Schema we are using which is draft 4.
40	'$schema' => 'http://json-schema.org/draft-04/schema#',
41	// The title property marks the identity of the resource.
42	'title' => $this->endpoint,
43	'type' => 'object',
44	// In JSON Schema you can specify object properties in the properties attribute.
45	'properties' => [
46	'id' => [
47	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
48	'type' => 'string',
49	'context' => [ 'view', 'edit', 'embed' ],
50	'readonly' => true,
51	],
52	],
53	];
54
55	return $this->schema;
56	}
57
58	/**
59	* Get our sample schema for a post.
60	*
61	* @return array The sample schema for a post
62	*/
63	public function sync_schema() {
64	if ( ! empty( $this->schema ) ) {
65	// Since WordPress 5.3, the schema can be cached in the $schema property.
66	return $this->schema;
67	}
68
69	$this->schema = [
70	// This tells the spec of JSON Schema we are using which is draft 4.
71	'$schema' => 'http://json-schema.org/draft-04/schema#',
72	// The title property marks the identity of the resource.
73	'title' => $this->endpoint,
74	'type' => 'object',
75	// In JSON Schema you can specify object properties in the properties attribute.
76	'properties' => [
77	'create_user' => [
78	'description' => esc_html__( 'Create the WordPress user.', 'surecart' ),
79	'type' => 'boolean',
80	'context' => [ 'view', 'edit', 'embed' ],
81	'default' => true,
82	],
83	'run_actions' => [
84	'description' => esc_html__( 'Run any purchase syncing actions.', 'surecart' ),
85	'type' => 'boolean',
86	'context' => [ 'view', 'edit', 'embed' ],
87	'default' => true,
88	],
89	'dry_run' => [
90	'description' => esc_html__( 'Dry run the sync.', 'surecart' ),
91	'type' => 'boolean',
92	'context' => [ 'view', 'edit', 'embed' ],
93	'default' => false,
94	],
95	],
96	];
97
98	return $this->schema;
99	}
100
101	/**
102	* Register REST Routes
103	*
104	* @return void
105	*/
106	public function registerRoutes() {
107	register_rest_route(
108	"$this->name/v$this->version",
109	$this->endpoint . '/me',
110	[
111	[
112	'methods' => \WP_REST_Server::READABLE,
113	'callback' => $this->callback( $this->controller, 'me' ),
114	'permission_callback' => [ $this, 'me_permissions_check' ],
115	'args' => [
116	'mode' => [
117	'type' => 'string',
118	'enum' => [ 'live', 'test' ],
119	'default' => 'live',
120	'sanitize_callback' => 'sanitize_text_field',
121	],
122	],
123	],
124	'schema' => [ $this, 'get_item_schema' ],
125	]
126	);
127
128	register_rest_route(
129	"$this->name/v$this->version",
130	$this->endpoint . '/(?P<id>\S+)/connect/(?P<user_id>\S+)',
131	[
132	[
133	'methods' => \WP_REST_Server::EDITABLE,
134	'callback' => $this->callback( $this->controller, 'connect' ),
135	'permission_callback' => [ $this, 'connect_permissions_check' ],
136	],
137	// Register our schema callback.
138	'schema' => [ $this, 'get_item_schema' ],
139	]
140	);
141
142	// sync with SureCart.
143	register_rest_route(
144	"$this->name/v$this->version",
145	$this->endpoint . '/sync',
146	[
147	[
148	'methods' => \WP_REST_Server::EDITABLE,
149	'callback' => $this->callback( $this->controller, 'sync' ),
150	'permission_callback' => [ $this, 'sync_permissions_check' ],
151	],
152	// Register our schema callback.
153	'schema' => [ $this, 'sync_schema' ],
154	]
155	);
156
157	register_rest_route(
158	"$this->name/v$this->version",
159	$this->endpoint . '/(?P<id>\S+)/expose/(?P<media_id>\S+)',
160	[
161	[
162	'methods' => \WP_REST_Server::READABLE,
163	'callback' => $this->callback( $this->controller, 'exposeMedia' ),
164	'permission_callback' => [ $this, 'get_item_permissions_check' ],
165	],
166	// Register our schema callback.
167	'schema' => [ $this, 'get_item_schema' ],
168	]
169	);
170	}
171
172	/**
173	* Only logged-in users can fetch their own customer record.
174	*
175	* @param \WP_REST_Request $request Full details about the request.
176	* @return true\|\WP_Error
177	*/
178	public function me_permissions_check( $request ) {
179	if ( ! is_user_logged_in() ) {
180	return new \WP_Error(
181	'rest_not_logged_in',
182	__( 'You must be logged in to access your customer record.', 'surecart' ),
183	[ 'status' => 401 ]
184	);
185	}
186	return true;
187	}
188
189	/**
190	* A WordPress user can read their own customer record.
191	*
192	* @param \WP_REST_Request $request Full details about the request.
193	* @return boolean
194	*/
195	public function connect_permissions_check( $request ) {
196	return current_user_can( 'edit_sc_customers' );
197	}
198
199	/**
200	* A WordPress user can read their own customer record.
201	*
202	* @param \WP_REST_Request $request Full details about the request.
203	* @return boolean
204	*/
205	public function sync_permissions_check( $request ) {
206	return current_user_can( 'edit_sc_customers' );
207	}
208
209
210	/**
211	* A WordPress user can read their own customer record.
212	*
213	* @param \WP_REST_Request $request Full details about the request.
214	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
215	*/
216	public function get_item_permissions_check( $request ) {
217	return current_user_can( 'read_sc_customer', $request->get_params() );
218	}
219
220	/**
221	* Read permissions.
222	*
223	* @param \WP_REST_Request $request Full details about the request.
224	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
225	*/
226	public function get_items_permissions_check( $request ) {
227	return current_user_can( 'read_sc_customers' );
228	}
229
230
231	/**
232	* Create permissions.
233	*
234	* @param \WP_REST_Request $request Full details about the request.
235	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
236	*/
237	public function create_item_permissions_check( $request ) {
238	return current_user_can( 'publish_sc_customers' );
239	}
240
241	/**
242	* Update permissions.
243	*
244	* @param \WP_REST_Request $request Full details about the request.
245	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
246	*/
247	public function update_item_permissions_check( $request ) {
248	return current_user_can( 'edit_sc_customer', $request['id'], $request->get_params() );
249	}
250
251	/**
252	* Nobody can delete.
253	*
254	* @param \WP_REST_Request $request Full details about the request.
255	* @return false
256	*/
257	public function delete_item_permissions_check( $request ) {
258	return current_user_can( 'delete_sc_customers' );
259	}
260	}
261