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

surecart / app / src / Rest / DownloadRestServiceProvider.php

surecart / app / src / Rest Last commit date

DownloadRestServiceProvider.php

151 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\DownloadsController;
7
8	/**
9	* Service provider for Download Rest Requests
10	*/
11	class DownloadRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'downloads';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = DownloadsController::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	/**
35	* Get our sample schema for a post.
36	*
37	* @return array The sample schema for a post
38	*/
39	public function get_item_schema() {
40	if ( $this->schema ) {
41	// Since WordPress 5.3, the schema can be cached in the $schema property.
42	return $this->schema;
43	}
44
45	$this->schema = [
46	// This tells the spec of JSON Schema we are using which is draft 4.
47	'$schema' => 'http://json-schema.org/draft-04/schema#',
48	// The title property marks the identity of the resource.
49	'title' => $this->endpoint,
50	'type' => 'object',
51	// In JSON Schema you can specify object properties in the properties attribute.
52	'properties' => [
53	'id' => [
54	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
55	'type' => 'string',
56	'context' => [ 'view', 'edit', 'embed' ],
57	'readonly' => true,
58	],
59	],
60	];
61
62	return $this->schema;
63	}
64
65	/**
66	* Get the collection params.
67	*
68	* @return array
69	*/
70	public function get_collection_params() {
71	return [
72	'page' => [
73	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
74	'type' => 'integer',
75	],
76	'per_page' => [
77	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
78	'type' => 'integer',
79	],
80	'variant_ids' => [
81	'description' => esc_html__( 'Filter downloads by variant IDs.', 'surecart' ),
82	'type' => 'array',
83	'items' => [ 'type' => 'string' ],
84	'validate_callback' => 'rest_validate_request_arg',
85	'sanitize_callback' => function( $param ) {
86	return array_map( 'sanitize_text_field', (array) $param );
87	},
88	],
89	'product_ids' => [
90	'description' => esc_html__( 'Filter downloads by product IDs.', 'surecart' ),
91	'type' => 'array',
92	'items' => [ 'type' => 'string' ],
93	'validate_callback' => 'rest_validate_request_arg',
94	'sanitize_callback' => function( $param ) {
95	return array_map( 'sanitize_text_field', (array) $param );
96	},
97	],
98	];
99	}
100
101	/**
102	* Get file
103	*
104	* @param \WP_REST_Request $request Full details about the request.
105	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
106	*/
107	public function get_item_permissions_check( $request ) {
108	return current_user_can( 'read_sc_medias' );
109	}
110
111	/**
112	* List files.
113	*
114	* @param \WP_REST_Request $request Full details about the request.
115	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
116	*/
117	public function get_items_permissions_check( $request ) {
118	return current_user_can( 'read_sc_downloads', $request->get_params() );
119	}
120
121	/**
122	* Create model.
123	*
124	* @param \WP_REST_Request $request Full details about the request.
125	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
126	*/
127	public function create_item_permissions_check( $request ) {
128	return current_user_can( 'publish_sc_medias' );
129	}
130
131	/**
132	* Update model.
133	*
134	* @param \WP_REST_Request $request Full details about the request.
135	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
136	*/
137	public function update_item_permissions_check( $request ) {
138	return current_user_can( 'edit_sc_medias' );
139	}
140
141	/**
142	* Delete model.
143	*
144	* @param \WP_REST_Request $request Full details about the request.
145	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
146	*/
147	public function delete_item_permissions_check( $request ) {
148	return current_user_can( 'delete_sc_medias' );
149	}
150	}
151