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

surecart / app / src / Rest / CustomerLinksRestServiceProvider.php

surecart / app / src / Rest Last commit date

CustomerLinksRestServiceProvider.php

86 lines

1	<?php
2
3	namespace SureCart\Rest;
4
5	use SureCart\Controllers\Rest\CustomerLinksController;
6	use SureCart\Rest\RestServiceInterface;
7
8	/**
9	* Service provider for Price Rest Requests
10	*/
11	class CustomerLinksRestServiceProvider extends RestServiceProvider implements RestServiceInterface {
12	/**
13	* Endpoint.
14	*
15	* @var string
16	*/
17	protected $endpoint = 'customer_links';
18
19	/**
20	* Rest Controller
21	*
22	* @var string
23	*/
24	protected $controller = CustomerLinksController::class;
25
26	/**
27	* Methods allowed for the model.
28	*
29	* @var array
30	*/
31	protected $methods = [ 'create' ];
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	'email' => [
59	'description' => esc_html__( 'Email or username for the request', 'surecart' ),
60	'type' => 'string',
61	'context' => [ 'view', 'edit', 'embed' ],
62	'required' => true,
63	],
64	'return_url' => [
65	'description' => esc_html__( 'The URL that the customer should be directed to when the click the link from their email.', 'surecart' ),
66	'type' => 'string',
67	'context' => [ 'view', 'edit', 'embed' ],
68	'required' => true,
69	],
70	],
71	];
72
73	return $this->schema;
74	}
75
76	/**
77	* Anyone can create one.
78	*
79	* @param \WP_REST_Request $request Full details about the request.
80	* @return true\|\WP_Error True if the request has access to create items, WP_Error object otherwise.
81	*/
82	public function create_item_permissions_check( $request ) {
83	return true;
84	}
85	}
86