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

surecart / app / src / Rest / UpsellFunnelRestServiceProvider.php

surecart / app / src / Rest Last commit date

UpsellFunnelRestServiceProvider.php

168 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\UpsellFunnelsController;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class UpsellFunnelRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'upsell_funnels';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = UpsellFunnelsController::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	* 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	'object' => [
59	'description' => esc_html__( 'Type of object (upsell_funnel)', 'surecart' ),
60	'type' => 'string',
61	'context' => [ 'view', 'edit', 'embed' ],
62	'readonly' => true,
63	],
64	'created_at' => [
65	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
66	'type' => 'integer',
67	'context' => [ 'view', 'edit', 'embed' ],
68	'readonly' => true,
69	],
70	'updated_at' => [
71	'description' => esc_html__( 'Created at timestamp', 'surecart' ),
72	'type' => 'integer',
73	'context' => [ 'view', 'edit', 'embed' ],
74	'readonly' => true,
75	],
76	'filter_match_type' => [
77	'description' => esc_html__( 'The matching strategy to use when filtering upsell funnels – can be null or one of all, any, none. If null, the upsell funnel will not be filtered and will be applicable to all checkouts.', 'surecart' ),
78	'type' => 'string',
79	'context' => [ 'view', 'edit', 'embed' ],
80	],
81	'filter_price_ids' => [
82	'description' => esc_html__( 'The prices to filter this upsell funnel by.', 'surecart' ),
83	'type' => 'array',
84	'items' => [
85	'type' => 'string',
86	],
87	'context' => [ 'view', 'edit', 'embed' ],
88	],
89	'filter_product_ids' => [
90	'description' => esc_html__( 'The products to filter this upsell funnel by.', 'surecart' ),
91	'type' => 'array',
92	'items' => [
93	'type' => 'string',
94	],
95	'context' => [ 'view', 'edit', 'embed' ],
96	],
97	'enabled' => [
98	'description' => esc_html__( 'Whether or not this upsell is currently enabled and being shown to customers.', 'surecart' ),
99	'type' => 'boolean',
100	'context' => [ 'view', 'edit', 'embed' ],
101	],
102	'name' => [
103	'description' => esc_html__( 'A name for this upsell that will be visible to customers. If empty, the product name will be used.', 'surecart' ),
104	'type' => 'string',
105	'context' => [ 'view', 'edit', 'embed' ],
106	],
107	'priority' => [
108	'description' => esc_html__( 'The priority of this upsell in relation to other upsells. Must be in the range of 1 - 5.', 'surecart' ),
109	'type' => 'integer',
110	'context' => [ 'view', 'edit', 'embed' ],
111	],
112	],
113	];
114
115	return $this->schema;
116	}
117
118	/**
119	* Anyone can get an upsell funnel.
120	*
121	* @param \WP_REST_Request $request Full details about the request.
122	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
123	*/
124	public function get_item_permissions_check( $request ) {
125	return true;
126	}
127
128	/**
129	* Who can list funnels
130	*
131	* @param \WP_REST_Request $request Full details about the request.
132	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
133	*/
134	public function get_items_permissions_check( $request ) {
135	return current_user_can( 'edit_sc_prices' );
136	}
137
138	/**
139	* Create model.
140	*
141	* @param \WP_REST_Request $request Full details about the request.
142	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
143	*/
144	public function create_item_permissions_check( $request ) {
145	return current_user_can( 'publish_sc_prices' );
146	}
147
148	/**
149	* Update model.
150	*
151	* @param \WP_REST_Request $request Full details about the request.
152	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
153	*/
154	public function update_item_permissions_check( $request ) {
155	return current_user_can( 'edit_sc_prices' );
156	}
157
158	/**
159	* Delete model.
160	*
161	* @param \WP_REST_Request $request Full details about the request.
162	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
163	*/
164	public function delete_item_permissions_check( $request ) {
165	return current_user_can( 'delete_sc_prices' );
166	}
167	}
168