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

surecart / app / src / Rest / ReviewProtocolRestServiceProvider.php

ReviewProtocolRestServiceProvider.php

133 lines 3.8 KB

Raw Download Zip

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\ReviewProtocolController;
7
8	/**
9	* Service provider for ReviewProtocol Rest Requests
10	*/
11	class ReviewProtocolRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'review_protocol';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = ReviewProtocolController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'find', 'edit' ];
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	'object' => [
87	'description' => esc_html__( 'Type of object.', 'surecart' ),
88	'type' => 'string',
89	'context' => [ 'view', 'edit', 'embed' ],
90	'readonly' => true,
91	],
92	'reviews_enabled' => [
93	'description' => esc_html__( 'Whether reviews are enabled globally.', 'surecart' ),
94	'type' => 'boolean',
95	'context' => [ 'view', 'edit' ],
96	],
97	'solicit_reviews' => [
98	'description' => esc_html__( 'Whether to send review solicitation emails.', 'surecart' ),
99	'type' => 'boolean',
100	'context' => [ 'view', 'edit' ],
101	],
102	'solicit_reviews_after_days' => [
103	'description' => esc_html__( 'Days after order fulfillment to send review solicitation email.', 'surecart' ),
104	'type' => 'integer',
105	'context' => [ 'view', 'edit' ],
106	],
107	],
108	];
109
110	return $this->schema;
111	}
112
113	/**
114	* Get review protocol permissions.
115	*
116	* @param \WP_REST_Request $request Full details about the request.
117	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
118	*/
119	public function get_item_permissions_check( $request ) {
120	return current_user_can( 'manage_sc_shop_settings' );
121	}
122
123	/**
124	* Update review protocol.
125	*
126	* @param \WP_REST_Request $request Full details about the request.
127	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
128	*/
129	public function update_item_permissions_check( $request ) {
130	return current_user_can( 'manage_sc_shop_settings' );
131	}
132	}
133