IntegrationProvidersRestServiceProvider.php
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Rest; |
| 4 | |
| 5 | use SureCart\Controllers\Rest\IntegrationProvidersController; |
| 6 | use SureCart\Rest\RestServiceInterface; |
| 7 | |
| 8 | /** |
| 9 | * Service provider for Price Rest Requests |
| 10 | */ |
| 11 | class IntegrationProvidersRestServiceProvider extends RestServiceProvider implements RestServiceInterface { |
| 12 | /** |
| 13 | * Rest Controller |
| 14 | * |
| 15 | * @var string |
| 16 | */ |
| 17 | protected $controller = IntegrationProvidersController::class; |
| 18 | |
| 19 | /** |
| 20 | * Register Additional REST Routes |
| 21 | * |
| 22 | * @return void |
| 23 | */ |
| 24 | public function registerModelRoutes() { |
| 25 | // List available providers for a specific model. |
| 26 | register_rest_route( |
| 27 | "$this->name/v$this->version", |
| 28 | 'integration_providers', |
| 29 | [ |
| 30 | [ |
| 31 | 'methods' => \WP_REST_Server::READABLE, |
| 32 | 'callback' => $this->callback( $this->controller, 'index' ), |
| 33 | 'permission_callback' => [ $this, 'get_items_permission_check' ], |
| 34 | ], |
| 35 | // Register our schema callback. |
| 36 | 'schema' => [ $this, 'get_item_schema' ], |
| 37 | ] |
| 38 | ); |
| 39 | |
| 40 | // Find a specific provider data. |
| 41 | register_rest_route( |
| 42 | "$this->name/v$this->version", |
| 43 | 'integration_providers/(?P<provider>\S+)', |
| 44 | [ |
| 45 | [ |
| 46 | 'methods' => \WP_REST_Server::READABLE, |
| 47 | 'callback' => $this->callback( $this->controller, 'find' ), |
| 48 | 'permission_callback' => [ $this, 'get_item_permission_check' ], |
| 49 | ], |
| 50 | // Register our schema callback. |
| 51 | 'schema' => [ $this, 'get_item_schema' ], |
| 52 | ] |
| 53 | ); |
| 54 | |
| 55 | // list all item choices for the provider. |
| 56 | register_rest_route( |
| 57 | "$this->name/v$this->version", |
| 58 | 'integration_provider_items', |
| 59 | [ |
| 60 | [ |
| 61 | 'methods' => \WP_REST_Server::READABLE, |
| 62 | 'callback' => $this->callback( $this->controller, 'items' ), |
| 63 | 'permission_callback' => [ $this, 'get_items_permission_check' ], |
| 64 | ], |
| 65 | // Register our schema callback . |
| 66 | 'schema' => [ $this, 'get_item_schema' ], |
| 67 | ] |
| 68 | ); |
| 69 | |
| 70 | // list all item choices for the provider. |
| 71 | register_rest_route( |
| 72 | "$this->name/v$this->version", |
| 73 | 'integration_provider_items/(?P<id>\S+)', |
| 74 | [ |
| 75 | [ |
| 76 | 'methods' => \WP_REST_Server::READABLE, |
| 77 | 'callback' => $this->callback( $this->controller, 'item' ), |
| 78 | 'permission_callback' => [ $this, 'get_item_permission_check' ], |
| 79 | ], |
| 80 | // Register our schema callback . |
| 81 | 'schema' => [ $this, 'get_item_schema' ], |
| 82 | ] |
| 83 | ); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Get our sample schema for a post. |
| 88 | * |
| 89 | * @return array The sample schema for a post |
| 90 | */ |
| 91 | public function get_item_schema() { |
| 92 | if ( $this->schema ) { |
| 93 | // Since WordPress 5.3, the schema can be cached in the $schema property. |
| 94 | return $this->schema; |
| 95 | } |
| 96 | |
| 97 | $this->schema = [ |
| 98 | // This tells the spec of JSON Schema we are using which is draft 4. |
| 99 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 100 | // The title property marks the identity of the resource. |
| 101 | 'title' => $this->endpoint, |
| 102 | 'type' => 'object', |
| 103 | // In JSON Schema you can specify object properties in the properties attribute. |
| 104 | 'properties' => [ |
| 105 | 'id' => [ |
| 106 | 'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ), |
| 107 | 'type' => 'string', |
| 108 | 'context' => [ 'view', 'edit', 'embed' ], |
| 109 | 'readonly' => true, |
| 110 | ], |
| 111 | ], |
| 112 | ]; |
| 113 | |
| 114 | return $this->schema; |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Get the collection params. |
| 119 | * |
| 120 | * @return array |
| 121 | */ |
| 122 | public function get_collection_params() { |
| 123 | return [ |
| 124 | 'model' => [ |
| 125 | 'description' => __( 'The model to get integration providers for.', 'surecart' ), |
| 126 | 'type' => 'string', |
| 127 | ], |
| 128 | 'page' => [ |
| 129 | 'description' => esc_html__( 'The page of items you want returned.', 'surecart' ), |
| 130 | 'type' => 'integer', |
| 131 | ], |
| 132 | 'per_page' => [ |
| 133 | 'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ), |
| 134 | 'type' => 'integer', |
| 135 | 'minimum' => 1, |
| 136 | 'maximum' => 100, |
| 137 | ], |
| 138 | ]; |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * List permissions. |
| 143 | * |
| 144 | * @param \WP_REST_Request $request Full details about the request. |
| 145 | * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. |
| 146 | */ |
| 147 | public function get_items_permission_check( $request ) { |
| 148 | return current_user_can( 'read_sc_products' ); |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * List permissions. |
| 153 | * |
| 154 | * @param \WP_REST_Request $request Full details about the request. |
| 155 | * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. |
| 156 | */ |
| 157 | public function get_item_permission_check( $request ) { |
| 158 | return current_user_can( 'read_sc_products' ); |
| 159 | } |
| 160 | } |
| 161 |