LocationRoute.php
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Onboarding\Routes; |
| 4 | |
| 5 | use Give\API\RestRoute; |
| 6 | use Give\Onboarding\Helpers\CountryCode; |
| 7 | use Give\Onboarding\Helpers\LocationList; |
| 8 | use WP_REST_Request; |
| 9 | |
| 10 | /** |
| 11 | * @since 2.8.0 |
| 12 | */ |
| 13 | class LocationRoute implements RestRoute |
| 14 | { |
| 15 | |
| 16 | /** @var string */ |
| 17 | protected $endpoint = 'onboarding/location'; |
| 18 | |
| 19 | /** |
| 20 | * @since 2.8.0 |
| 21 | * |
| 22 | * @param WP_REST_Request $request |
| 23 | * |
| 24 | * @return array |
| 25 | * |
| 26 | */ |
| 27 | public function handleRequest(WP_REST_Request $request) |
| 28 | { |
| 29 | return [ |
| 30 | 'states' => LocationList::getStates( |
| 31 | $request->get_param('countryCode') |
| 32 | ), |
| 33 | ]; |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * @inheritDoc |
| 38 | */ |
| 39 | public function registerRoute() |
| 40 | { |
| 41 | register_rest_route( |
| 42 | 'give-api/v2', |
| 43 | $this->endpoint, |
| 44 | [ |
| 45 | [ |
| 46 | 'methods' => 'GET', |
| 47 | 'callback' => [$this, 'handleRequest'], |
| 48 | 'permission_callback' => function () { |
| 49 | return current_user_can('manage_options'); |
| 50 | }, |
| 51 | 'args' => [ |
| 52 | 'countryCode' => [ |
| 53 | 'type' => 'string', |
| 54 | 'required' => true, |
| 55 | 'validate_callback' => 'give_get_country_name_by_key', |
| 56 | 'sanitize_callback' => 'sanitize_text_field', |
| 57 | ], |
| 58 | ], |
| 59 | ], |
| 60 | 'schema' => [$this, 'getSchema'], |
| 61 | ] |
| 62 | ); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @since 2.8.0 |
| 67 | * @return array |
| 68 | * |
| 69 | */ |
| 70 | public function getSchema() |
| 71 | { |
| 72 | return [ |
| 73 | // This tells the spec of JSON Schema we are using which is draft 4. |
| 74 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 75 | // The title property marks the identity of the resource. |
| 76 | 'title' => 'onboarding', |
| 77 | 'type' => 'object', |
| 78 | // In JSON Schema you can specify object properties in the properties attribute. |
| 79 | 'properties' => [ |
| 80 | 'countryCode' => [ |
| 81 | 'description' => esc_html__('A short alphabetic geographical code representing a country.', 'give'), |
| 82 | 'type' => 'string', |
| 83 | ], |
| 84 | ], |
| 85 | ]; |
| 86 | } |
| 87 | } |
| 88 |