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

surecart / app / src / Rest / ProductMediaRestServiceProvider.php

surecart / app / src / Rest Last commit date

ProductMediaRestServiceProvider.php

183 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	* Methods allowed for the model.
29	*
30	* @var array
31	*/
32	protected $methods = [ 'index', 'create', 'find', 'edit', 'delete' ];
33
34	/**
35	* Register Additional REST Routes
36	*
37	* @return void
38	*/
39	public function registerRoutes() {
40	register_rest_route(
41	"$this->name/v$this->version",
42	$this->endpoint . '/(?P<id>\S+)/download/',
43	[
44	[
45	'methods' => \WP_REST_Server::EDITABLE,
46	'callback' => $this->callback( $this->controller, 'download' ),
47	'permission_callback' => [ $this, 'update_item_permissions_check' ],
48	],
49	// Register our schema callback.
50	'schema' => [ $this, 'get_item_schema' ],
51	]
52	);
53	}
54
55	/**
56	* Get our sample schema for a post.
57	*
58	* @return array The sample schema for a post
59	*/
60	public function get_item_schema() {
61	if ( $this->schema ) {
62	// Since WordPress 5.3, the schema can be cached in the $schema property.
63	return $this->schema;
64	}
65
66	$this->schema = [
67	// This tells the spec of JSON Schema we are using which is draft 4.
68	'$schema' => 'http://json-schema.org/draft-04/schema#',
69	// The title property marks the identity of the resource.
70	'title' => $this->endpoint,
71	'type' => 'object',
72	// In JSON Schema you can specify object properties in the properties attribute.
73	'properties' => [
74	'id' => [
75	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
76	'type' => 'string',
77	'context' => array( 'view', 'edit', 'embed' ),
78	'readonly' => true,
79	],
80	'content' => array(
81	'description' => esc_html__( 'The content for the object.', 'surecart' ),
82	'type' => 'string',
83	),
84	],
85	];
86
87	return $this->schema;
88	}
89
90	/**
91	* Get the collection params.
92	*
93	* @return array
94	*/
95	public function get_collection_params() {
96	return [
97	'ids' => [
98	'description' => __( 'Ensure result set excludes specific IDs.', 'surecart' ),
99	'type' => 'array',
100	'items' => [
101	'type' => 'string',
102	],
103	'default' => [],
104	],
105	'product_ids' => [
106	'description' => __( 'Only return objects that belong to the given products.', 'surecart' ),
107	'type' => 'array',
108	'items' => [
109	'type' => 'string',
110	],
111	'default' => [],
112	],
113	'page' => [
114	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
115	'type' => 'integer',
116	],
117	'per_page' => [
118	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
119	'type' => 'integer',
120	],
121	'limit' => [
122	'description' => esc_html__( 'A limit on the number of records returned', 'surecart' ),
123	'type' => 'integer',
124	],
125
126	];
127	}
128
129	/**
130	* Anyone can get a specific product media.
131	*
132	* @param \WP_REST_Request $request Full details about the request.
133	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
134	*/
135	public function get_item_permissions_check( $request ) {
136	return true;
137	}
138
139	/**
140	* Who can list product media
141	*
142	* @param \WP_REST_Request $request Full details about the request.
143	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
144	*/
145	public function get_items_permissions_check( $request ) {
146	if ( $request['archived'] ) {
147	return current_user_can( 'edit_sc_products' );
148	}
149
150	return true;
151	}
152
153	/**
154	* Create product media.
155	*
156	* @param \WP_REST_Request $request Full details about the request.
157	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
158	*/
159	public function create_item_permissions_check( $request ) {
160	return current_user_can( 'publish_sc_products' );
161	}
162
163	/**
164	* Update product media.
165	*
166	* @param \WP_REST_Request $request Full details about the request.
167	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
168	*/
169	public function update_item_permissions_check( $request ) {
170	return current_user_can( 'edit_sc_products' );
171	}
172
173	/**
174	* Delete product media.
175	*
176	* @param \WP_REST_Request $request Full details about the request.
177	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
178	*/
179	public function delete_item_permissions_check( $request ) {
180	return current_user_can( 'delete_sc_products' );
181	}
182	}
183