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

surecart / app / src / Rest / OrderProtocolRestServiceProvider.php

surecart / app / src / Rest Last commit date

OrderProtocolRestServiceProvider.php

140 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\OrderProtocolController;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class OrderProtocolRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'order_protocol';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = OrderProtocolController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [];
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",
42	array_filter(
43	[
44	[
45	'methods' => \WP_REST_Server::READABLE,
46	'callback' => $this->callback( $this->controller, 'find' ),
47	'permission_callback' => [ $this, 'get_item_permissions_check' ],
48	'args' => $this->get_collection_params(),
49	],
50	[
51	'methods' => \WP_REST_Server::EDITABLE,
52	'callback' => $this->callback( $this->controller, 'edit' ),
53	'permission_callback' => [ $this, 'update_item_permissions_check' ],
54	],
55	'schema' => [ $this, 'get_item_schema' ],
56	]
57	)
58	);
59	}
60
61	/**
62	* Get our sample schema for a post.
63	*
64	* @return array The sample schema for a post
65	*/
66	public function get_item_schema() {
67	if ( $this->schema ) {
68	// Since WordPress 5.3, the schema can be cached in the $schema property.
69	return $this->schema;
70	}
71
72	$this->schema = [
73	// This tells the spec of JSON Schema we are using which is draft 4.
74	'$schema' => 'http://json-schema.org/draft-04/schema#',
75	// The title property marks the identity of the resource.
76	'title' => $this->endpoint,
77	'type' => 'object',
78	// In JSON Schema you can specify object properties in the properties attribute.
79	'properties' => [
80	'id' => [
81	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
82	'type' => 'string',
83	'context' => [ 'view', 'edit', 'embed' ],
84	'readonly' => true,
85	],
86	'created_at' => [
87	'type' => 'integer',
88	'context' => [ 'edit' ],
89	],
90	'updated_at' => [
91	'type' => 'integer',
92	'context' => [ 'edit' ],
93	],
94	'footer' => [
95	'description' => esc_html__( 'The default footer that is shown on all order statements (i.e. invoices and receipts).', 'surecart' ),
96	'type' => 'string',
97	'context' => [ 'view', 'edit', 'embed' ],
98	],
99	'memo' => [
100	'description' => esc_html__( 'The default memo that is shown on all order statements (i.e. invoices and receipts).', 'surecart' ),
101	'type' => 'string',
102	'context' => [ 'view', 'edit', 'embed' ],
103	],
104	'number_prefix' => [
105	'description' => esc_html__( 'The prefix that is added to all order numbers. Must be between 3-12 characters and only include letters.', 'surecart' ),
106	'type' => 'string',
107	'context' => [ 'view', 'edit', 'embed' ],
108	],
109	'number_type' => [
110	'description' => esc_html__( 'The type of number to use for orders – one of sequential or token.', 'surecart' ),
111	'type' => 'string',
112	'context' => [ 'view', 'edit', 'embed' ],
113	],
114	],
115	];
116
117	return $this->schema;
118	}
119
120	/**
121	* Anyone can get the protocols.
122	*
123	* @param \WP_REST_Request $request Full details about the request.
124	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
125	*/
126	public function get_item_permissions_check( $request ) {
127	return current_user_can( 'read_sc_orders' );
128	}
129
130	/**
131	* Need priveleges to update.
132	*
133	* @param \WP_REST_Request $request Full details about the request.
134	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
135	*/
136	public function update_item_permissions_check( $request ) {
137	return current_user_can( 'read_sc_orders' );
138	}
139	}
140