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

surecart / app / src / Rest / LineItemsRestServiceProvider.php

surecart / app / src / Rest Last commit date

LineItemsRestServiceProvider.php

170 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\LineItemsController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class LineItemsRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'line_items';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = LineItemsController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'index', 'edit', 'create', 'find', 'delete' ];
32
33	/**
34	* Register REST Routes.
35	*
36	* @return void
37	*/
38	public function registerRoutes() {
39	register_rest_route(
40	"$this->name/v$this->version",
41	$this->endpoint . '/upsell/',
42	[
43	[
44	'methods' => \WP_REST_Server::EDITABLE,
45	'callback' => $this->callback( $this->controller, 'upsell' ),
46	'permission_callback' => [ $this, 'update_item_permissions_check' ],
47	],
48	// Register our schema callback.
49	'schema' => [ $this, 'get_item_schema' ],
50	]
51	);
52	}
53
54	/**
55	* Get our sample schema for a post.
56	*
57	* @return array The sample schema for a post
58	*/
59	public function get_item_schema() {
60	if ( $this->schema ) {
61	// Since WordPress 5.3, the schema can be cached in the $schema property.
62	return $this->schema;
63	}
64
65	$this->schema = [
66	// This tells the spec of JSON Schema we are using which is draft 4.
67	'$schema' => 'http://json-schema.org/draft-04/schema#',
68	// The title property marks the identity of the resource.
69	'title' => $this->endpoint,
70	'type' => 'object',
71	// In JSON Schema you can specify object properties in the properties attribute.
72	'properties' => [
73	'id' => [
74	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
75	'type' => 'string',
76	'context' => [ 'view', 'edit', 'embed' ],
77	'readonly' => true,
78	],
79	'checkout' => [
80	'description' => esc_html__( 'The checkout for the line item.', 'surecart' ),
81	'type' => 'object',
82	'context' => [ 'view', 'edit', 'embed' ],
83	'properties' => [
84	'customer' => [
85	'description' => esc_html__( 'The customer associated with the checkout.', 'surecart' ),
86	'type' => 'object',
87	'context' => [ 'edit' ], // customer is only available in the edit context.
88	],
89	],
90	],
91	],
92	];
93
94	return $this->schema;
95	}
96
97	/**
98	* Get the collection params.
99	*
100	* @return array
101	*/
102	public function get_collection_params() {
103	return [
104	'page' => [
105	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
106	'type' => 'integer',
107	],
108	'per_page' => [
109	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
110	'type' => 'integer',
111	],
112	];
113	}
114
115	/**
116	* Anyone can get a specific price.
117	*
118	* @param \WP_REST_Request $request Full details about the request.
119	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
120	*/
121	public function get_item_permissions_check( $request ) {
122	return true;
123	}
124
125	/**
126	* Who can list checkouts
127	*
128	* @param \WP_REST_Request $request Full details about the request.
129	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
130	*/
131	public function get_items_permissions_check( $request ) {
132	// if not listing based on a single checkout, the person must be able to list prices.
133	if ( empty( $request['checkout_ids'] ) \|\| count( $request['checkout_ids'] ) > 1 ) {
134	return current_user_can( 'read_sc_prices' );
135	}
136
137	return true;
138	}
139
140	/**
141	* Anyone can create line items.
142	*
143	* @param \WP_REST_Request $request Full details about the request.
144	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
145	*/
146	public function create_item_permissions_check( $request ) {
147	return true;
148	}
149
150	/**
151	* Update model.
152	*
153	* @param \WP_REST_Request $request Full details about the request.
154	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
155	*/
156	public function update_item_permissions_check( $request ) {
157	return true;
158	}
159
160	/**
161	* Delete model.
162	*
163	* @param \WP_REST_Request $request Full details about the request.
164	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
165	*/
166	public function delete_item_permissions_check( $request ) {
167	return true;
168	}
169	}
170