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

surecart / app / src / Rest / ShippingProviderTypeRestServiceProvider.php

surecart / app / src / Rest Last commit date

ShippingProviderTypeRestServiceProvider.php

155 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\ShippingProviderTypesController;
7
8	/**
9	* Service provider for ShippingProvider Rest Requests
10	*/
11	class ShippingProviderTypeRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'shipping_providers';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = ShippingProviderTypesController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'index', 'find' ];
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 . '/(?P<id>[^/]+)/carrier_accounts',
42	[
43	[
44	'methods' => \WP_REST_Server::READABLE,
45	'callback' => $this->callback( $this->controller, 'carrierAccounts' ),
46	'permission_callback' => [ $this, 'carrier_accounts_permissions_check' ],
47	],
48	'schema' => [ $this, 'get_item_schema' ],
49	]
50	);
51
52	register_rest_route(
53	"$this->name/v$this->version",
54	$this->endpoint . '/(?P<id>[^/]+)/carrier_parcel_templates',
55	[
56	[
57	'methods' => \WP_REST_Server::READABLE,
58	'callback' => $this->callback( $this->controller, 'carrierParcelTemplates' ),
59	'permission_callback' => [ $this, 'carrier_parcel_templates_permissions_check' ],
60	'args' => [
61	'carrier_token' => [
62	'description' => esc_html__( 'Only return templates for this carrier, by token or display name.', 'surecart' ),
63	'type' => 'string',
64	],
65	],
66	],
67	'schema' => [ $this, 'get_item_schema' ],
68	]
69	);
70	}
71
72	/**
73	* Carrier account permissions.
74	*
75	* Settings-only data (used to pick services for live rates), so this stays
76	* manager-only even though the provider list itself is readable by order
77	* editors.
78	*
79	* @param \WP_REST_Request $request Full details about the request.
80	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
81	*/
82	public function carrier_accounts_permissions_check( $request ) {
83	return current_user_can( 'manage_sc_shop_settings' );
84	}
85
86	/**
87	* Carrier parcel template permissions.
88	*
89	* Read-only carrier reference data consumed by the fulfilment drawer, so
90	* this tracks the shipment quote capability rather than the
91	* `manage_sc_shop_settings` used by the settings-only routes above. Gating
92	* it on shop settings would stop an order editor from buying a label.
93	*
94	* @param \WP_REST_Request $request Full details about the request.
95	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
96	*/
97	public function carrier_parcel_templates_permissions_check( $request ) {
98	return current_user_can( 'edit_sc_orders' ) \|\| current_user_can( 'manage_sc_shop_settings' );
99	}
100
101	/**
102	* Get our sample schema for a post.
103	*
104	* @return array The sample schema for a post
105	*/
106	public function get_item_schema() {
107	if ( $this->schema ) {
108	return $this->schema;
109	}
110
111	$this->schema = [
112	'$schema' => 'http://json-schema.org/draft-04/schema#',
113	'title' => $this->endpoint,
114	'type' => 'object',
115	'properties' => [
116	'id' => [
117	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
118	'type' => 'string',
119	'context' => [ 'view', 'edit', 'embed' ],
120	'readonly' => true,
121	],
122	],
123	];
124
125	return $this->schema;
126	}
127
128	/**
129	* List permissions.
130	*
131	* Reads also allow order editors: the fulfilment drawer must know which
132	* provider (and mode) to quote against before a label can be bought.
133	* Connecting/configuring providers still happens app-side and the
134	* carrier_accounts route above stays manager-only.
135	*
136	* @param \WP_REST_Request $request Full details about the request.
137	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
138	*/
139	public function get_items_permissions_check( $request ) {
140	return current_user_can( 'edit_sc_orders' ) \|\| current_user_can( 'manage_sc_shop_settings' );
141	}
142
143	/**
144	* Single item permissions.
145	*
146	* Same read broadening as `get_items_permissions_check()`.
147	*
148	* @param \WP_REST_Request $request Full details about the request.
149	* @return true\|\WP_Error True if the request has access, WP_Error object otherwise.
150	*/
151	public function get_item_permissions_check( $request ) {
152	return current_user_can( 'edit_sc_orders' ) \|\| current_user_can( 'manage_sc_shop_settings' );
153	}
154	}
155