API_JSON_Request.php
3 years ago
API_JSON_Response.php
3 years ago
API_Request.php
3 years ago
API_Response.php
3 years ago
Base.php
3 years ago
API_JSON_Request.php
125 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Plugin Framework |
| 4 | * |
| 5 | * This source file is subject to the GNU General Public License v3.0 |
| 6 | * that is bundled with this package in the file license.txt. |
| 7 | * It is also available through the world-wide-web at this URL: |
| 8 | * http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 9 | * If you did not receive a copy of the license and are unable to |
| 10 | * obtain it through the world-wide-web, please send an email |
| 11 | * to license@skyverge.com so we can send you a copy immediately. |
| 12 | * |
| 13 | * @since 3.0.0 |
| 14 | * @author WooCommerce / SkyVerge |
| 15 | * @copyright Copyright (c) 2021-2022, WooCommerce. |
| 16 | * @copyright Copyright (c) 2013-2019, SkyVerge, Inc. |
| 17 | * @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 18 | * |
| 19 | * Modified by WooCommerce on 01 December 2021. |
| 20 | */ |
| 21 | |
| 22 | namespace WooCommerce\Square\Framework\Api; |
| 23 | |
| 24 | defined( 'ABSPATH' ) or exit; |
| 25 | |
| 26 | /** |
| 27 | * Base JSON API request class. |
| 28 | * |
| 29 | * @since 3.0.0 |
| 30 | */ |
| 31 | abstract class API_JSON_Request implements API_Request { |
| 32 | |
| 33 | |
| 34 | /** @var string The request method, one of HEAD, GET, PUT, PATCH, POST, DELETE */ |
| 35 | protected $method; |
| 36 | |
| 37 | /** @var string The request path */ |
| 38 | protected $path; |
| 39 | |
| 40 | /** @var array The request parameters, if any */ |
| 41 | protected $params = array(); |
| 42 | |
| 43 | /** @var array the request data */ |
| 44 | protected $data = array(); |
| 45 | |
| 46 | |
| 47 | /** |
| 48 | * Get the request method. |
| 49 | * |
| 50 | * @since 3.0.0 |
| 51 | * @see API_Request::get_method() |
| 52 | * @return string |
| 53 | */ |
| 54 | public function get_method() { |
| 55 | return $this->method; |
| 56 | } |
| 57 | |
| 58 | |
| 59 | /** |
| 60 | * Get the request path. |
| 61 | * |
| 62 | * @since 3.0.0 |
| 63 | * @see API_Request::get_path() |
| 64 | * @return string |
| 65 | */ |
| 66 | public function get_path() { |
| 67 | return $this->path; |
| 68 | } |
| 69 | |
| 70 | |
| 71 | /** |
| 72 | * Get the request parameters. |
| 73 | * |
| 74 | * @since 3.0.0 |
| 75 | * @see API_Request::get_params() |
| 76 | * @return array |
| 77 | */ |
| 78 | public function get_params() { |
| 79 | return $this->params; |
| 80 | } |
| 81 | |
| 82 | |
| 83 | /** |
| 84 | * Get the request data. |
| 85 | * |
| 86 | * @since 3.0.0 |
| 87 | * @return array |
| 88 | */ |
| 89 | public function get_data() { |
| 90 | return $this->data; |
| 91 | } |
| 92 | |
| 93 | |
| 94 | /** API Helper Methods ******************************************************/ |
| 95 | |
| 96 | |
| 97 | /** |
| 98 | * Get the string representation of this request. |
| 99 | * |
| 100 | * @since 3.0.0 |
| 101 | * @see API_Request::to_string() |
| 102 | * @return string |
| 103 | */ |
| 104 | public function to_string() { |
| 105 | |
| 106 | $data = $this->get_data(); |
| 107 | |
| 108 | return ! empty( $data ) ? wp_json_encode( $data ) : ''; |
| 109 | } |
| 110 | |
| 111 | |
| 112 | /** |
| 113 | * Get the string representation of this request with any and all sensitive elements masked |
| 114 | * or removed. |
| 115 | * |
| 116 | * @since 3.0.0 |
| 117 | * @see API_Request::to_string_safe() |
| 118 | * @return string |
| 119 | */ |
| 120 | public function to_string_safe() { |
| 121 | |
| 122 | return $this->to_string(); |
| 123 | } |
| 124 | } |
| 125 |