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

surecart / app / src / Rest / StatisticRestServiceProvider.php

surecart / app / src / Rest Last commit date

StatisticRestServiceProvider.php

115 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Rest\RestServiceInterface;
6	use SureCart\Controllers\Rest\StatisticsController;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class StatisticRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'stats';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = StatisticsController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'find' ];
32
33	/**
34	* Get our sample schema for a post.
35	*
36	* @return array The sample schema for a post
37	*/
38	public function get_item_schema() {
39	if ( $this->schema ) {
40	// Since WordPress 5.3, the schema can be cached in the $schema property.
41	return $this->schema;
42	}
43
44	$this->schema = [
45	// This tells the spec of JSON Schema we are using which is draft 4.
46	'$schema' => 'http://json-schema.org/draft-04/schema#',
47	// The title property marks the identity of the resource.
48	'title' => $this->endpoint,
49	'type' => 'object',
50	// In JSON Schema you can specify object properties in the properties attribute.
51	'properties' => [
52	'id' => [
53	'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ),
54	'type' => 'string',
55	'context' => [ 'view', 'edit', 'embed' ],
56	'readonly' => true,
57	],
58	],
59	];
60
61	return $this->schema;
62	}
63
64	/**
65	* Get the collection params.
66	*
67	* @return array
68	*/
69	public function get_collection_params() {
70	return [
71	'page' => [
72	'description' => esc_html__( 'The page of items you want returned.', 'surecart' ),
73	'type' => 'integer',
74	],
75	'per_page' => [
76	'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ),
77	'type' => 'integer',
78	],
79	'currency' => [
80	'description' => esc_html__( "Only return objects that have this currency. If not set, this will fallback to the account's default currency.", 'surecart' ),
81	'type' => 'string',
82	'context' => [ 'view', 'edit', 'embed' ],
83	],
84	'end_at' => [
85	'description' => esc_html__( 'The end of the date range to query.', 'surecart' ),
86	'type' => 'string',
87	'context' => [ 'view', 'edit', 'embed' ],
88	'required' => true,
89	],
90	'interval' => [
91	'description' => esc_html__( 'The interval to group statistics on – one of hour, day, week, month, or year.', 'surecart' ),
92	'type' => 'string',
93	'context' => [ 'view', 'edit', 'embed' ],
94	'required' => true,
95	],
96	'start' => [
97	'description' => esc_html__( 'The start of the date range to query.', 'surecart' ),
98	'type' => 'string',
99	'context' => [ 'view', 'edit', 'embed' ],
100	'required' => true,
101	],
102	];
103	}
104
105	/**
106	* Get file
107	*
108	* @param \WP_REST_Request $request Full details about the request.
109	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
110	*/
111	public function get_item_permissions_check( $request ) {
112	return current_user_can( 'manage_sc_shop_settings' );
113	}
114	}
115