This repository has been archived by the owner on Oct 4, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add data endpoints for getting currencies (#9)
* Adds endpoints for getting a list of supported currencies, along with their name and symbol. * Limit regex check for currency code to 3 characters.
- Loading branch information
1 parent
db1c191
commit 6c7e95e
Showing
4 changed files
with
324 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| <?php | ||
| /** | ||
| * REST API Data currencies controller. | ||
| * | ||
| * Handles requests to the /data/currencies endpoint. | ||
| * | ||
| * @author Automattic | ||
| * @category API | ||
| * @package WooCommerce/API | ||
| */ | ||
|
|
||
| if ( ! defined( 'ABSPATH' ) ) { | ||
| exit; | ||
| } | ||
|
|
||
| /** | ||
| * REST API Data Currencies controller class. | ||
| * | ||
| * @package WooCommerce/API | ||
| */ | ||
| class WC_REST_Dev_Data_Currencies_Controller extends WC_REST_Dev_Data_Controller { | ||
|
|
||
| /** | ||
| * Endpoint namespace. | ||
| * | ||
| * @var string | ||
| */ | ||
| protected $namespace = 'wc/v3'; | ||
|
|
||
| /** | ||
| * Route base. | ||
| * | ||
| * @var string | ||
| */ | ||
| protected $rest_base = 'data/currencies'; | ||
|
|
||
| /** | ||
| * Register routes. | ||
| */ | ||
| public function register_routes() { | ||
| register_rest_route( $this->namespace, '/' . $this->rest_base, array( | ||
| array( | ||
| 'methods' => WP_REST_Server::READABLE, | ||
| 'callback' => array( $this, 'get_items' ), | ||
| 'permission_callback' => array( $this, 'get_items_permissions_check' ), | ||
| ), | ||
| 'schema' => array( $this, 'get_public_item_schema' ), | ||
| ) ); | ||
| register_rest_route( $this->namespace, '/' . $this->rest_base . '/current', array( | ||
| array( | ||
| 'methods' => WP_REST_Server::READABLE, | ||
| 'callback' => array( $this, 'get_current_item' ), | ||
| 'permission_callback' => array( $this, 'get_item_permissions_check' ), | ||
| ), | ||
| 'schema' => array( $this, 'get_public_item_schema' ), | ||
| ) ); | ||
| register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<currency>[\w-]{3}+)', array( | ||
| array( | ||
| 'methods' => WP_REST_Server::READABLE, | ||
| 'callback' => array( $this, 'get_item' ), | ||
| 'permission_callback' => array( $this, 'get_item_permissions_check' ), | ||
| 'args' => array( | ||
| 'location' => array( | ||
| 'description' => __( 'ISO4217 currency code.', 'woocommerce' ), | ||
| 'type' => 'string', | ||
| ), | ||
| ), | ||
| ), | ||
| 'schema' => array( $this, 'get_public_item_schema' ), | ||
| ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Get currency information. | ||
| * | ||
| * @param string $code | ||
| * @param WP_REST_Request $request | ||
| * @return array|mixed Response data, ready for insertion into collection data. | ||
| */ | ||
| public function get_currency( $code = false, $request ) { | ||
| $currencies = get_woocommerce_currencies(); | ||
| $data = array(); | ||
|
|
||
| if ( ! array_key_exists( $code, $currencies ) ) { | ||
| return false; | ||
| } | ||
|
|
||
| $currency = array( | ||
| 'code' => $code, | ||
| 'name' => $currencies[ $code ], | ||
| 'symbol' => get_woocommerce_currency_symbol( $code ), | ||
| ); | ||
|
|
||
| return $currency; | ||
| } | ||
|
|
||
| /** | ||
| * Return the list of currencies. | ||
| * | ||
| * @param WP_REST_Request $request | ||
| * @return WP_Error|WP_REST_Response | ||
| */ | ||
| public function get_items( $request ) { | ||
| $currencies = get_woocommerce_currencies(); | ||
| foreach ( array_keys( $currencies ) as $code ) { | ||
| $currency = $this->get_currency( $code, $request ); | ||
| $response = $this->prepare_item_for_response( $currency, $request ); | ||
| $data[] = $this->prepare_response_for_collection( $response ); | ||
| } | ||
|
|
||
| return rest_ensure_response( $data ); | ||
| } | ||
|
|
||
| /** | ||
| * Return information for a specific currency. | ||
| * | ||
| * @param WP_REST_Request $request | ||
| * @return WP_Error|WP_REST_Response | ||
| */ | ||
| public function get_item( $request ) { | ||
| $data = $this->get_currency( strtoupper( $request['currency'] ), $request ); | ||
| if ( empty( $data ) ) { | ||
| return new WP_Error( 'woocommerce_rest_data_invalid_currency', __( 'There are no currencies matching these parameters.', 'woocommerce' ), array( 'status' => 404 ) ); | ||
| } | ||
| return $this->prepare_item_for_response( $data, $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Return information for the current site currency. | ||
| * | ||
| * @param WP_REST_Request $request | ||
| * @return WP_Error|WP_REST_Response | ||
| */ | ||
| public function get_current_item( $request ) { | ||
| $currency = get_option( 'woocommerce_currency' ); | ||
| return $this->prepare_item_for_response( $this->get_currency( $currency, $request ), $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Prepare the data object for response. | ||
| * | ||
| * @param object $item Data object. | ||
| * @param WP_REST_Request $request Request object. | ||
| * @return WP_REST_Response $response Response data. | ||
| */ | ||
| public function prepare_item_for_response( $item, $request ) { | ||
| $data = $this->add_additional_fields_to_object( $item, $request ); | ||
| $data = $this->filter_response_by_context( $data, 'view' ); | ||
| $response = rest_ensure_response( $data ); | ||
|
|
||
| $response->add_links( $this->prepare_links( $item ) ); | ||
|
|
||
| /** | ||
| * Filter currency returned from the API. | ||
| * | ||
| * @param WP_REST_Response $response The response object. | ||
| * @param array $item Currency data. | ||
| * @param WP_REST_Request $request Request used to generate the response. | ||
| */ | ||
| return apply_filters( 'woocommerce_rest_prepare_data_currency', $response, $item, $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Prepare links for the request. | ||
| * | ||
| * @param object $item Data object. | ||
| * @return array Links for the given currency. | ||
| */ | ||
| protected function prepare_links( $item ) { | ||
| $code = strtoupper( $item['code'] ); | ||
| $links = array( | ||
| 'self' => array( | ||
| 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $code ) ), | ||
| ), | ||
| 'collection' => array( | ||
| 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), | ||
| ), | ||
| ); | ||
|
|
||
| return $links; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Get the currency schema, conforming to JSON Schema. | ||
| * | ||
| * @return array | ||
| */ | ||
| public function get_item_schema() { | ||
| $schema = array( | ||
| '$schema' => 'http://json-schema.org/draft-04/schema#', | ||
| 'title' => 'data_currencies', | ||
| 'type' => 'object', | ||
| 'properties' => array( | ||
| 'code' => array( | ||
| 'type' => 'string', | ||
| 'description' => __( 'ISO4217 currency code.', 'woocommerce' ), | ||
| 'context' => array( 'view' ), | ||
| 'readonly' => true, | ||
| ), | ||
| 'name' => array( | ||
| 'type' => 'string', | ||
| 'description' => __( 'Full name of currency.', 'woocommerce' ), | ||
| 'context' => array( 'view' ), | ||
| 'readonly' => true, | ||
| ), | ||
| 'symbol' => array( | ||
| 'type' => 'string', | ||
| 'description' => __( 'Currency symbol.', 'woocommerce' ), | ||
| 'context' => array( 'view' ), | ||
| 'readonly' => true, | ||
| ), | ||
| ), | ||
| ); | ||
|
|
||
| return $this->add_additional_fields_schema( $schema ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters