class-wc-api-authentication.php
5 years ago
class-wc-api-coupons.php
5 years ago
class-wc-api-customers.php
5 years ago
class-wc-api-exception.php
5 years ago
class-wc-api-json-handler.php
5 years ago
class-wc-api-orders.php
4 years ago
class-wc-api-products.php
3 years ago
class-wc-api-reports.php
5 years ago
class-wc-api-resource.php
5 years ago
class-wc-api-server.php
5 years ago
class-wc-api-webhooks.php
3 years ago
interface-wc-api-handler.php
5 years ago
class-wc-api-exception.php
49 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce API Exception Class |
| 4 | * |
| 5 | * Extends Exception to provide additional data |
| 6 | * |
| 7 | * @author WooThemes |
| 8 | * @category API |
| 9 | * @package WooCommerce\RestApi |
| 10 | * @since 2.2 |
| 11 | */ |
| 12 | |
| 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 14 | exit; // Exit if accessed directly |
| 15 | } |
| 16 | |
| 17 | class WC_API_Exception extends Exception { |
| 18 | |
| 19 | /** @var string sanitized error code */ |
| 20 | protected $error_code; |
| 21 | |
| 22 | /** |
| 23 | * Setup exception, requires 3 params: |
| 24 | * |
| 25 | * error code - machine-readable, e.g. `woocommerce_invalid_product_id` |
| 26 | * error message - friendly message, e.g. 'Product ID is invalid' |
| 27 | * http status code - proper HTTP status code to respond with, e.g. 400 |
| 28 | * |
| 29 | * @since 2.2 |
| 30 | * @param string $error_code |
| 31 | * @param string $error_message user-friendly translated error message |
| 32 | * @param int $http_status_code HTTP status code to respond with |
| 33 | */ |
| 34 | public function __construct( $error_code, $error_message, $http_status_code ) { |
| 35 | $this->error_code = $error_code; |
| 36 | parent::__construct( $error_message, $http_status_code ); |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * Returns the error code |
| 41 | * |
| 42 | * @since 2.2 |
| 43 | * @return string |
| 44 | */ |
| 45 | public function getErrorCode() { |
| 46 | return $this->error_code; |
| 47 | } |
| 48 | } |
| 49 |