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_Request.php
83 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 | interface API_Request { |
| 27 | /** |
| 28 | * Returns the method for this request: one of HEAD, GET, PUT, PATCH, POST, DELETE |
| 29 | * |
| 30 | * @since 3.0.0 |
| 31 | * @return string the request method, or null to use the API default |
| 32 | */ |
| 33 | public function get_method(); |
| 34 | |
| 35 | |
| 36 | /** |
| 37 | * Returns the request path |
| 38 | * |
| 39 | * @since 3.0.0 |
| 40 | * @return string the request path, or '' if none |
| 41 | */ |
| 42 | public function get_path(); |
| 43 | |
| 44 | |
| 45 | /** |
| 46 | * Gets the request query params. |
| 47 | * |
| 48 | * @since 3.0.0 |
| 49 | * |
| 50 | * @return array |
| 51 | */ |
| 52 | public function get_params(); |
| 53 | |
| 54 | |
| 55 | /** |
| 56 | * Gets the request data. |
| 57 | * |
| 58 | * @since 3.0.0 |
| 59 | * |
| 60 | * @return array |
| 61 | */ |
| 62 | public function get_data(); |
| 63 | |
| 64 | |
| 65 | /** |
| 66 | * Returns the string representation of this request |
| 67 | * |
| 68 | * @since 3.0.0 |
| 69 | * @return string the request |
| 70 | */ |
| 71 | public function to_string(); |
| 72 | |
| 73 | |
| 74 | /** |
| 75 | * Returns the string representation of this request with any and all |
| 76 | * sensitive elements masked or removed |
| 77 | * |
| 78 | * @since 3.0.0 |
| 79 | * @return string the request, safe for logging/displaying |
| 80 | */ |
| 81 | public function to_string_safe(); |
| 82 | } |
| 83 |