SwapRestServiceProvider.php at 4.4.1 · SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments

surecart / app / src / Rest / SwapRestServiceProvider.php

SwapRestServiceProvider.php

170 lines 5.3 KB

Raw Download Zip

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\SwapsController;
7
8	/**
9	* Service provider for Swaps
10	*/
11	class SwapRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'swaps';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = SwapsController::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	/**
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	'object' => [
60	'description' => esc_html__( 'Type of object (swap)', 'surecart' ),
61	'type' => 'string',
62	'context' => [ 'view', 'edit' ],
63	'readonly' => true,
64	],
65	'created_at' => [
66	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
67	'type' => 'integer',
68	'context' => [ 'edit' ],
69	'readonly' => true,
70	],
71	'updated_at' => [
72	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
73	'type' => 'integer',
74	'context' => [ 'edit' ],
75	'readonly' => true,
76	],
77	'discarded_at' => [
78	'description' => esc_html__( 'Time at which the object was discarded. Measured in seconds since the Unix epoch.', 'surecart' ),
79	'type' => 'integer',
80	'context' => [ 'edit' ],
81	'readonly' => true,
82	],
83	'archived_at' => [
84	'description' => esc_html__( 'Time at which the object was archived. Measured in seconds since the Unix epoch.', 'surecart' ),
85	'type' => 'integer',
86	'context' => [ 'edit' ],
87	'readonly' => true,
88	],
89	'description' => [
90	'description' => esc_html__( 'A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.', 'surecart' ),
91	'type' => 'string',
92	'context' => [ 'view', 'edit', 'embed' ],
93	],
94	'metadata' => [
95	'description' => esc_html__( 'Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.', 'surecart' ),
96	'type' => 'object',
97	'context' => [ 'view', 'edit', 'embed' ],
98	],
99	'price' => [
100	'description' => esc_html__( 'The associated price to swap from.', 'surecart' ),
101	'type' => 'string',
102	'context' => [ 'view', 'edit', 'embed' ],
103	],
104	'swap_price' => [
105	'description' => esc_html__( 'The associated price to swap to.', 'surecart' ),
106	'type' => 'string',
107	'context' => [ 'view', 'edit', 'embed' ],
108	],
109	'archived' => [
110	'description' => esc_html__( 'Whether or not this swap is archived.', 'surecart' ),
111	'type' => 'boolean',
112	'context' => [ 'view', 'edit', 'embed' ],
113	],
114	],
115	];
116
117	return $this->schema;
118	}
119
120	/**
121	* Anyone can get a specific price.
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( 'edit_sc_prices' );
128	}
129
130	/**
131	* Who can list prices
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 get_items_permissions_check( $request ) {
137	return current_user_can( 'edit_sc_prices' );
138	}
139
140	/**
141	* Create model.
142	*
143	* @param \WP_REST_Request $request Full details about the request.
144	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
145	*/
146	public function create_item_permissions_check( $request ) {
147	return current_user_can( 'publish_sc_prices' );
148	}
149
150	/**
151	* Update model.
152	*
153	* @param \WP_REST_Request $request Full details about the request.
154	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
155	*/
156	public function update_item_permissions_check( $request ) {
157	return current_user_can( 'edit_sc_prices' );
158	}
159
160	/**
161	* Delete model.
162	*
163	* @param \WP_REST_Request $request Full details about the request.
164	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
165	*/
166	public function delete_item_permissions_check( $request ) {
167	return current_user_can( 'delete_sc_prices' );
168	}
169	}
170