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

surecart / app / src / Rest / ProductMediaRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductMediaRestServiceProvider.php

200 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\ProductMediaController;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Service provider for Product Medias Rest Requests
10	*/
11	class ProductMediaRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12
13	/**
14	* Endpoint.
15	*
16	* @var string
17	*/
18	protected $endpoint = 'product_medias';
19
20	/**
21	* Rest Controller
22	*
23	* @var string
24	*/
25	protected $controller = ProductMediaController::class;
26
27	/**
28	* Filter index list items by schema context.
29	*
30	* @var boolean
31	*/
32	protected $filters_list_items = true;
33
34	/**
35	* Methods allowed for the model.
36	*
37	* @var array
38	*/
39	protected $methods = [ 'index', 'create', 'find', 'edit', 'delete' ];
40
41	/**
42	* Register Additional REST Routes
43	*
44	* @return void
45	*/
46	public function registerRoutes() {
47	register_rest_route(
48	"$this->name/v$this->version",
49	$this->endpoint . '/(?P<id>\S+)/download/',
50	[
51	[
52	'methods' => \WP_REST_Server::EDITABLE,
53	'callback' => $this->callback( $this->controller, 'download' ),
54	'permission_callback' => [ $this, 'update_item_permissions_check' ],
55	],
56	// Register our schema callback.
57	'schema' => [ $this, 'get_item_schema' ],
58	]
59	);
60	}
61
62	/**
63	* Get our sample schema for a post.
64	*
65	* @return array The sample schema for a post
66	*/
67	public function get_item_schema() {
68	if ( $this->schema ) {
69	// Since WordPress 5.3, the schema can be cached in the $schema property.
70	return $this->schema;
71	}
72
73	$this->schema = [
74	// This tells the spec of JSON Schema we are using which is draft 4.
75	'$schema' => 'http://json-schema.org/draft-04/schema#',
76	// The title property marks the identity of the resource.
77	'title' => $this->endpoint,
78	'type' => 'object',
79	// In JSON Schema you can specify object properties in the properties attribute.
80	'properties' => [
81	'id' => [
82	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
83	'type' => 'string',
84	'context' => array( 'view', 'edit', 'embed' ),
85	'readonly' => true,
86	],
87	'content' => array(
88	'description' => esc_html__( 'The content for the object.', 'surecart' ),
89	'type' => 'string',
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	'ids' => [
105	'description' => __( 'Ensure result set excludes specific IDs.', 'surecart' ),
106	'type' => 'array',
107	'items' => [
108	'type' => 'string',
109	],
110	'default' => [],
111	],
112	'product_ids' => [
113	'description' => __( 'Only return objects that belong to the given products.', 'surecart' ),
114	'type' => 'array',
115	'items' => [
116	'type' => 'string',
117	],
118	'default' => [],
119	],
120	'page' => [
121	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
122	'type' => 'integer',
123	],
124	'per_page' => [
125	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
126	'type' => 'integer',
127	],
128	'limit' => [
129	'description' => esc_html__( 'A limit on the number of records returned', 'surecart' ),
130	'type' => 'integer',
131	],
132
133	];
134	}
135
136	/**
137	* Anyone can get a specific product media.
138	*
139	* @param \WP_REST_Request $request Full details about the request.
140	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
141	*/
142	public function get_item_permissions_check( $request ) {
143	$check = $this->forbidEditContextWithout( $request, 'edit_sc_products' );
144	if ( is_wp_error( $check ) ) {
145	return $check;
146	}
147
148	return true;
149	}
150
151	/**
152	* Who can list product media
153	*
154	* @param \WP_REST_Request $request Full details about the request.
155	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
156	*/
157	public function get_items_permissions_check( $request ) {
158	$check = $this->forbidEditContextWithout( $request, 'edit_sc_products' );
159	if ( is_wp_error( $check ) ) {
160	return $check;
161	}
162
163	if ( $request['archived'] ) {
164	return current_user_can( 'edit_sc_products' );
165	}
166
167	return true;
168	}
169
170	/**
171	* Create product media.
172	*
173	* @param \WP_REST_Request $request Full details about the request.
174	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
175	*/
176	public function create_item_permissions_check( $request ) {
177	return current_user_can( 'publish_sc_products' );
178	}
179
180	/**
181	* Update product media.
182	*
183	* @param \WP_REST_Request $request Full details about the request.
184	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
185	*/
186	public function update_item_permissions_check( $request ) {
187	return current_user_can( 'edit_sc_products' );
188	}
189
190	/**
191	* Delete product media.
192	*
193	* @param \WP_REST_Request $request Full details about the request.
194	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
195	*/
196	public function delete_item_permissions_check( $request ) {
197	return current_user_can( 'delete_sc_products' );
198	}
199	}
200