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

surecart / app / src / Rest / SubscriptionRestServiceProvider.php

surecart / app / src / Rest Last commit date

SubscriptionRestServiceProvider.php

254 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\SubscriptionsController;
7	/**
8	* Service provider for Price Rest Requests
9	*/
10	class SubscriptionRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
11	/**
12	* Endpoint.
13	*
14	* @var string
15	*/
16	protected $endpoint = 'subscriptions';
17
18	/**
19	* Rest Controller
20	*
21	* @var string
22	*/
23	protected $controller = SubscriptionsController::class;
24
25	/**
26	* Methods allowed for the model.
27	*
28	* @var array
29	*/
30	protected $methods = [ 'index', 'find', 'edit' ];
31
32	/**
33	* Register REST Routes
34	*
35	* @return void
36	*/
37	public function registerRoutes() {
38	register_rest_route(
39	"$this->name/v$this->version",
40	$this->endpoint . '/(?P<id>\S+)/cancel/',
41	[
42	[
43	'methods' => \WP_REST_Server::EDITABLE,
44	'callback' => $this->callback( $this->controller, 'cancel' ),
45	'permission_callback' => [ $this, 'cancel_permissions_check' ],
46	],
47	// Register our schema callback.
48	'schema' => [ $this, 'get_item_schema' ],
49	]
50	);
51
52	register_rest_route(
53	"$this->name/v$this->version",
54	$this->endpoint . '/(?P<id>\S+)/complete/',
55	[
56	[
57	'methods' => \WP_REST_Server::EDITABLE,
58	'callback' => $this->callback( $this->controller, 'complete' ),
59	'permission_callback' => [ $this, 'complete_permissions_check' ],
60	],
61	// Register our schema callback.
62	'schema' => [ $this, 'get_item_schema' ],
63	]
64	);
65
66	register_rest_route(
67	"$this->name/v$this->version",
68	$this->endpoint . '/(?P<id>\S+)/restore/',
69	[
70	[
71	'methods' => \WP_REST_Server::EDITABLE,
72	'callback' => $this->callback( $this->controller, 'restore' ),
73	'permission_callback' => [ $this, 'restore_permissions_check' ],
74	],
75	// Register our schema callback.
76	'schema' => [ $this, 'get_item_schema' ],
77	]
78	);
79
80	register_rest_route(
81	"$this->name/v$this->version",
82	$this->endpoint . '/(?P<id>\S+)/renew/',
83	[
84	[
85	'methods' => \WP_REST_Server::EDITABLE,
86	'callback' => $this->callback( $this->controller, 'renew' ),
87	'permission_callback' => [ $this, 'update_item_permissions_check' ],
88	],
89	// Register our schema callback.
90	'schema' => [ $this, 'get_item_schema' ],
91	]
92	);
93
94	register_rest_route(
95	"$this->name/v$this->version",
96	$this->endpoint . '/(?P<id>\S+)/preserve/',
97	[
98	[
99	'methods' => \WP_REST_Server::EDITABLE,
100	'callback' => $this->callback( $this->controller, 'preserve' ),
101	'permission_callback' => [ $this, 'update_item_permissions_check' ],
102	],
103	// Register our schema callback.
104	'schema' => [ $this, 'get_item_schema' ],
105	]
106	);
107
108	register_rest_route(
109	"$this->name/v$this->version",
110	$this->endpoint . '/(?P<id>\S+)/upcoming_period/',
111	[
112	[
113	'methods' => \WP_REST_Server::EDITABLE,
114	'callback' => $this->callback( $this->controller, 'upcomingPeriod' ),
115	'permission_callback' => [ $this, 'get_item_permissions_check' ],
116	],
117	// Register our schema callback.
118	'schema' => [ $this, 'get_item_schema' ],
119	]
120	);
121
122	register_rest_route(
123	"$this->name/v$this->version",
124	$this->endpoint . '/(?P<id>\S+)/pay_off/',
125	[
126	[
127	'methods' => \WP_REST_Server::EDITABLE,
128	'callback' => $this->callback( $this->controller, 'payOff' ),
129	'permission_callback' => [ $this, 'payoff_item_permissions_check' ],
130	],
131	// Register our schema callback.
132	'schema' => [ $this, 'get_item_schema' ],
133	]
134	);
135	}
136
137	/**
138	* Get our sample schema for a post.
139	*
140	* @return array The sample schema for a post
141	*/
142	public function get_item_schema() {
143	if ( $this->schema ) {
144	// Since WordPress 5.3, the schema can be cached in the $schema property.
145	return $this->schema;
146	}
147
148	$this->schema = [
149	// This tells the spec of JSON Schema we are using which is draft 4.
150	'$schema' => 'http://json-schema.org/draft-04/schema#',
151	// The title property marks the identity of the resource.
152	'title' => $this->endpoint,
153	'type' => 'object',
154	// In JSON Schema you can specify object properties in the properties attribute.
155	'properties' => [
156	'id' => [
157	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
158	'type' => 'string',
159	'context' => [ 'view', 'edit', 'embed' ],
160	'readonly' => true,
161	],
162	'trial_end_at' => [
163	'type' => 'integer',
164	'admin_only' => true,
165	],
166	],
167	];
168
169	return $this->schema;
170	}
171
172	/**
173	* Anyone can get a specific subscription
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	return current_user_can( 'read_sc_subscription', $request['id'] );
180	}
181
182	/**
183	* Need priveleges to read checkout sessions.
184	*
185	* @param \WP_REST_Request $request Full details about the request.
186	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
187	*/
188	public function get_items_permissions_check( $request ) {
189	return current_user_can( 'read_sc_subscriptions', $request->get_params() );
190	}
191
192	/**
193	* Check update permissions.
194	*
195	* @param \WP_REST_Request $request Full details about the request.
196	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
197	*/
198	public function update_item_permissions_check( $request ) {
199	return current_user_can( 'edit_sc_subscription', $request['id'], $request->get_params() );
200	}
201
202	/**
203	* Check cancel permissions.
204	*
205	* @param \WP_REST_Request $request Full details about the request.
206	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
207	*/
208	public function cancel_permissions_check( $request ) {
209	return current_user_can( 'cancel_sc_subscription', $request['id'] );
210	}
211
212	/**
213	* Check cancel permissions.
214	*
215	* @param \WP_REST_Request $request Full details about the request.
216	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
217	*/
218	public function restore_permissions_check( $request ) {
219	return current_user_can( 'restore_sc_subscription', $request['id'] );
220	}
221
222	/**
223	* Check complete permissions.
224	* Only users who can edit all subscriptions can complete a subscription.
225	*
226	* @param \WP_REST_Request $request Full details about the request.
227	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
228	*/
229	public function complete_permissions_check( $request ) {
230	return current_user_can( 'edit_sc_subscriptions' );
231	}
232
233	/**
234	* Only a person who has the ability to edit all subscription
235	* can pay off a subscription early.
236	*
237	* @param \WP_REST_Request $request Full details about the request.
238	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
239	*/
240	public function payoff_item_permissions_check( $request ) {
241	return current_user_can( 'edit_sc_subscriptions' );
242	}
243
244	/**
245	* Nobody can delete.
246	*
247	* @param \WP_REST_Request $request Full details about the request.
248	* @return false
249	*/
250	public function delete_item_permissions_check( $request ) {
251	return false;
252	}
253	}
254