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

surecart / app / src / Rest / WarehouseRestServiceProvider.php

surecart / app / src / Rest Last commit date

WarehouseRestServiceProvider.php

135 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\WarehousesController;
7
8	/**
9	* Service provider for Warehouse Rest Requests
10	*/
11	class WarehouseRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'warehouses';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = WarehousesController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'index', 'create', 'find', 'edit', 'delete' ];
32
33	/**
34	* Get our sample schema for a post.
35	*
36	* @return array The sample schema for a post
37	*/
38	public function get_item_schema() {
39	if ( $this->schema ) {
40	return $this->schema;
41	}
42
43	$this->schema = [
44	'$schema' => 'http://json-schema.org/draft-04/schema#',
45	'title' => $this->endpoint,
46	'type' => 'object',
47	'properties' => [
48	'id' => [
49	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
50	'type' => 'string',
51	'context' => [ 'view', 'edit', 'embed' ],
52	'readonly' => true,
53	],
54	],
55	];
56
57	return $this->schema;
58	}
59
60	/**
61	* Get the collection params.
62	*
63	* @return array
64	*/
65	public function get_collection_params() {
66	return [
67	'page' => [
68	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
69	'type' => 'integer',
70	],
71	'per_page' => [
72	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
73	'type' => 'integer',
74	],
75	];
76	}
77
78	/**
79	* Retrieve permissions.
80	*
81	* Reads also allow order editors: the fulfilment drawer needs the warehouse
82	* (ship-from) list to buy a label, and gating reads on shop settings alone
83	* stranded anyone who can fulfil an order but not manage settings. Writes
84	* stay restricted to shop managers below.
85	*
86	* @param \WP_REST_Request $request Full details about the request.
87	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
88	*/
89	public function get_item_permissions_check( $request ) {
90	return current_user_can( 'edit_sc_orders' ) \|\| current_user_can( 'manage_sc_shop_settings' );
91	}
92
93	/**
94	* List permissions.
95	*
96	* Same read broadening as `get_item_permissions_check()`.
97	*
98	* @param \WP_REST_Request $request Full details about the request.
99	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
100	*/
101	public function get_items_permissions_check( $request ) {
102	return current_user_can( 'edit_sc_orders' ) \|\| current_user_can( 'manage_sc_shop_settings' );
103	}
104
105	/**
106	* Create permissions.
107	*
108	* @param \WP_REST_Request $request Full details about the request.
109	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
110	*/
111	public function create_item_permissions_check( $request ) {
112	return current_user_can( 'manage_sc_shop_settings' );
113	}
114
115	/**
116	* Update permissions.
117	*
118	* @param \WP_REST_Request $request Full details about the request.
119	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
120	*/
121	public function update_item_permissions_check( $request ) {
122	return current_user_can( 'manage_sc_shop_settings' );
123	}
124
125	/**
126	* Delete permissions.
127	*
128	* @param \WP_REST_Request $request Full details about the request.
129	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
130	*/
131	public function delete_item_permissions_check( $request ) {
132	return current_user_can( 'manage_sc_shop_settings' );
133	}
134	}
135