FileXXXXXXXXXXX

File manager - Edit - /home/verseaumee/maze/wp-content/plugins/woocommerce/includes/rest-api/Controllers/Version3/class-wc-rest-data-currencies-controller.php

Back
<?php /** * REST API Data currencies controller. * * Handles requests to the /data/currencies endpoint. * * @package WooCommerce\RestApi * @since 3.5.0 / use Automattic\WooCommerce\Internal\Traits\RestApiCache; defined( 'ABSPATH' ) \|\| exit; /* * REST API Data Currencies controller class. * * @package WooCommerce\RestApi / class WC_REST_Data_Currencies_Controller extends WC_REST_Data_Controller { use RestApiCache; /* * Endpoint namespace. * * @var string / protected $namespace = 'wc/v3'; /* * Route base. * * @var string / protected $rest_base = 'data/currencies'; /* * Constructor. / public function __construct() { $this->initialize_rest_api_cache(); } /* * Register routes. / public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base, array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => $this->with_cache( 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' => $this->with_cache( 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 Currency code. * @param WP_REST_Request $request Request data. * @return array\|mixed Response data, ready for insertion into collection data. / public function get_currency( $code, $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 Request data. * @return WP_Error\|WP_REST_Response / public function get_items( $request ) { $currencies = get_woocommerce_currencies(); $data = array(); 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 Request data. * @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 Request data. * @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 ); } /* * Get the default entity type for response caching. * * @return string\|null The entity type. / protected function get_default_response_entity_type(): ?string { return 'currency'; } /* * Get the files relevant to response caching. * * @param WP_REST_Request<array<string, mixed>> $request The request object. * @param string\|null $endpoint_id Optional endpoint identifier. * @return array Array of file paths to track for cache invalidation. / protected function get_files_relevant_to_response_caching( WP_REST_Request $request, ?string $endpoint_id = null ): array { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint return array( 'i18n/currencies.php' ); } /* * Get the hooks relevant to response caching. * * @param WP_REST_Request<array<string, mixed>> $request The request object. * @param string\|null $endpoint_id Optional endpoint identifier. * @return array Array of hook names to track for cache invalidation. / protected function get_hooks_relevant_to_caching( WP_REST_Request $request, ?string $endpoint_id = null ): array { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint return array( 'woocommerce_rest_prepare_data_currency', 'woocommerce_currencies', ); } /* * Whether the response cache should vary by user. * * @param WP_REST_Request<array<string, mixed>> $request The request object. * @param string\|null $endpoint_id Optional endpoint identifier. * @return bool False since currency data doesn't vary by user. / protected function response_cache_vary_by_user( WP_REST_Request $request, ?string $endpoint_id = null ): bool { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint return false; } /* * Extract entity IDs from response data. * * Currencies don't have entity IDs, cache invalidation is file-based. * * @param array $response_data Response data. * @param WP_REST_Request<array<string, mixed>> $request The request object. * @param string\|null $endpoint_id Optional endpoint identifier. * @return array Empty array since currencies don't have entity IDs. */ protected function extract_entity_ids_from_response( array $response_data, WP_REST_Request $request, ?string $endpoint_id = null ): array { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint return array(); } }

| ver. 1.4 | Github | . | PHP 8.5.7 | Generation time: 0 | proxy | phpinfo | Settings