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

surecart / app / src / Rest / SubscriptionRestServiceProvider.php

surecart / app / src / Rest Last commit date

SubscriptionRestServiceProvider.php

194 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, 'cancel_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, 'cancel_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+)/upcoming_period/',
97	[
98	[
99	'methods' => \WP_REST_Server::EDITABLE,
100	'callback' => $this->callback( $this->controller, 'upcomingPeriod' ),
101	'permission_callback' => [ $this, 'get_item_permissions_check' ],
102	],
103	// Register our schema callback.
104	'schema' => [ $this, 'get_item_schema' ],
105	]
106	);
107	}
108
109	/**
110	* Get our sample schema for a post.
111	*
112	* @return array The sample schema for a post
113	*/
114	public function get_item_schema() {
115	if ( $this->schema ) {
116	// Since WordPress 5.3, the schema can be cached in the $schema property.
117	return $this->schema;
118	}
119
120	$this->schema = [
121	// This tells the spec of JSON Schema we are using which is draft 4.
122	'$schema' => 'http://json-schema.org/draft-04/schema#',
123	// The title property marks the identity of the resource.
124	'title' => $this->endpoint,
125	'type' => 'object',
126	// In JSON Schema you can specify object properties in the properties attribute.
127	'properties' => [
128	'id' => [
129	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
130	'type' => 'string',
131	'context' => [ 'view', 'edit', 'embed' ],
132	'readonly' => true,
133	],
134	'trial_end_at' => [
135	'type' => 'integer',
136	'admin_only' => true,
137	],
138	],
139	];
140
141	return $this->schema;
142	}
143
144	/**
145	* Anyone can get a specific subscription
146	*
147	* @param \WP_REST_Request $request Full details about the request.
148	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
149	*/
150	public function get_item_permissions_check( $request ) {
151	return current_user_can( 'read_sc_subscription', $request['id'] );
152	}
153
154	/**
155	* Need priveleges to read checkout sessions.
156	*
157	* @param \WP_REST_Request $request Full details about the request.
158	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
159	*/
160	public function get_items_permissions_check( $request ) {
161	return current_user_can( 'read_sc_subscriptions', $request->get_params() );
162	}
163
164	/**
165	* Check update permissions.
166	*
167	* @param \WP_REST_Request $request Full details about the request.
168	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
169	*/
170	public function update_item_permissions_check( $request ) {
171	return current_user_can( 'edit_sc_subscription', $request['id'], $request->get_params() );
172	}
173
174	/**
175	* Check cancel permissions.
176	*
177	* @param \WP_REST_Request $request Full details about the request.
178	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
179	*/
180	public function cancel_permissions_check( $request ) {
181	return current_user_can( 'cancel_sc_subscription', $request['id'] );
182	}
183
184	/**
185	* Nobody can delete.
186	*
187	* @param \WP_REST_Request $request Full details about the request.
188	* @return false
189	*/
190	public function delete_item_permissions_check( $request ) {
191	return false;
192	}
193	}
194