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

surecart / app / src / Rest / BrandRestServiceProvider.php

surecart / app / src / Rest Last commit date

BrandRestServiceProvider.php

200 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\BrandController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class BrandRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'brand';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = BrandController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [];
32
33	public function registerRoutes() {
34	register_rest_route(
35	"$this->name/v$this->version",
36	"$this->endpoint",
37	array_filter(
38	[
39	[
40	'methods' => \WP_REST_Server::READABLE,
41	'callback' => $this->callback( $this->controller, 'find' ),
42	'permission_callback' => [ $this, 'get_item_permissions_check' ],
43	'args' => $this->get_collection_params(),
44	],
45	[
46	'methods' => \WP_REST_Server::EDITABLE,
47	'callback' => $this->callback( $this->controller, 'edit' ),
48	'permission_callback' => [ $this, 'update_item_permissions_check' ],
49	],
50	'schema' => [ $this, 'get_item_schema' ],
51	]
52	)
53	);
54
55	register_rest_route(
56	"$this->name/v$this->version",
57	$this->endpoint . '/purge_logo/',
58	[
59	[
60	'methods' => \WP_REST_Server::DELETABLE,
61	'callback' => $this->callback( $this->controller, 'purgeLogo' ),
62	'permission_callback' => [ $this, 'update_item_permissions_check' ],
63	],
64	// Register our schema callback.
65	'schema' => [ $this, 'get_item_schema' ],
66	]
67	);
68	}
69
70	/**
71	* Get our sample schema for a post.
72	*
73	* @return array The sample schema for a post
74	*/
75	public function get_item_schema() {
76	if ( $this->schema ) {
77	// Since WordPress 5.3, the schema can be cached in the $schema property.
78	return $this->schema;
79	}
80
81	$this->schema = [
82	// This tells the spec of JSON Schema we are using which is draft 4.
83	'$schema' => 'http://json-schema.org/draft-04/schema#',
84	// The title property marks the identity of the resource.
85	'title' => $this->endpoint,
86	'type' => 'object',
87	// In JSON Schema you can specify object properties in the properties attribute.
88	'properties' => [
89	'id' => [
90	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
91	'type' => 'string',
92	'context' => [ 'view', 'edit', 'embed' ],
93	'readonly' => true,
94	],
95	'object' => [
96	'description' => esc_html__( 'Type of object (Account)', 'surecart' ),
97	'type' => 'string',
98	'context' => [ 'view', 'edit' ],
99	'readonly' => true,
100	],
101	'created_at' => [
102	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
103	'type' => 'integer',
104	'context' => [ 'edit' ],
105	'readonly' => true,
106	],
107	'updated_at' => [
108	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
109	'type' => 'integer',
110	'context' => [ 'edit' ],
111	'readonly' => true,
112	],
113	'color' => [
114	'description' => esc_html__( 'The brand color.', 'surecart' ),
115	'type' => 'string',
116	'context' => [ 'view', 'edit' ],
117	],
118	'email' => [
119	'description' => esc_html__( 'The email address that will be shown to customers for support, on invoices, etc.', 'surecart' ),
120	'type' => 'string',
121	'context' => [ 'view', 'edit' ],
122	],
123	'phone' => [
124	'description' => esc_html__( 'The phone number that will be shown to customers for support, on invoices, etc.', 'surecart' ),
125	'type' => 'string',
126	'context' => [ 'view', 'edit' ],
127	],
128	'website' => [
129	'description' => esc_html__( 'The website that will be shown to customers for support, on invoices, etc.', 'surecart' ),
130	'type' => 'string',
131	'context' => [ 'view', 'edit' ],
132	],
133	'logo' => [
134	'description' => esc_html__( 'The brand logo media object.', 'surecart' ),
135	'type' => [ 'object', 'null' ],
136	'context' => [ 'view', 'edit' ],
137	],
138	'dark_logo' => [
139	'description' => esc_html__( 'The dark mode logo media object.', 'surecart' ),
140	'type' => [ 'object', 'null' ],
141	'context' => [ 'view', 'edit' ],
142	],
143	'theme' => [
144	'description' => esc_html__( 'The SureCart color scheme (light or dark).', 'surecart' ),
145	'type' => 'string',
146	'enum' => [ 'light', 'dark' ],
147	'context' => [ 'view', 'edit' ],
148	],
149	'dark_color' => [
150	'description' => esc_html__( 'The primary color used in dark mode.', 'surecart' ),
151	'type' => 'string',
152	'context' => [ 'view', 'edit' ],
153	],
154	'logo_url' => [
155	'description' => esc_html__( 'The URL of the brand logo.', 'surecart' ),
156	'type' => 'string',
157	'context' => [ 'view', 'edit' ],
158	],
159	'address' => [
160	'description' => esc_html__( 'The associated address.', 'surecart' ),
161	'type' => 'object',
162	'context' => [ 'view', 'edit' ],
163	],
164	'statement_memo' => [
165	'description' => esc_html__( 'The default memo for invoices and receipts.', 'surecart' ),
166	'type' => 'string',
167	'context' => [ 'view', 'edit' ],
168	],
169	'statement_footer' => [
170	'description' => esc_html__( 'The default footer for invoices and receipts.', 'surecart' ),
171	'type' => 'string',
172	'context' => [ 'view', 'edit' ],
173	],
174	],
175	];
176
177	return $this->schema;
178	}
179
180	/**
181	* Get items
182	*
183	* @param \WP_REST_Request $request Full details about the request.
184	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
185	*/
186	public function get_item_permissions_check( $request ) {
187	return true;
188	}
189
190	/**
191	* Update item
192	*
193	* @param \WP_REST_Request $request Full details about the request.
194	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
195	*/
196	public function update_item_permissions_check( $request ) {
197	return current_user_can( 'manage_options' );
198	}
199	}
200