woocommerce/includes/class-wc-data-exception.php

65 lines
1.3 KiB
PHP
Raw Normal View History

2021-12-10 12:03:04 +00:00
<?php
/**
* WooCommerce Data Exception Class
*
* Extends Exception to provide additional data.
*
* @package WooCommerce\Classes
* @since 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Data exception class.
*/
class WC_Data_Exception extends Exception {
/**
* Sanitized error code.
*
* @var string
*/
protected $error_code;
/**
* Error extra data.
*
* @var array
*/
protected $error_data;
/**
* Setup exception.
*
* @param string $code Machine-readable error code, e.g `woocommerce_invalid_product_id`.
* @param string $message User-friendly translated error message, e.g. 'Product ID is invalid'.
* @param int $http_status_code Proper HTTP status code to respond with, e.g. 400.
* @param array $data Extra error data.
*/
public function __construct( $code, $message, $http_status_code = 400, $data = array() ) {
$this->error_code = $code;
$this->error_data = array_merge( array( 'status' => $http_status_code ), $data );
parent::__construct( $message, $http_status_code );
}
/**
* Returns the error code.
*
* @return string
*/
public function getErrorCode() {
return $this->error_code;
}
/**
* Returns error data.
*
* @return array
*/
public function getErrorData() {
return $this->error_data;
}
}