1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

<?php
namespace Automattic\WooCommerce\StoreApi\Exceptions;

/**
 * RouteException class.
 */
class RouteException extends \Exception {
    /**
     * Sanitized error code.
     *
     * @var string
     */
    public $error_code;

    /**
     * Additional error data.
     *
     * @var array
     */
    public $additional_data = [];

    /**
     * Setup exception.
     *
     * @param string $error_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  $additional_data  Extra data (key value pairs) to expose in the error response.
     */
    public function __construct( $error_code, $message, $http_status_code = 400, $additional_data = [] ) {
        $this->error_code      = $error_code;
        $this->additional_data = array_filter( (array) $additional_data );
        parent::__construct( $message, $http_status_code );
    }

    /**
     * Returns the error code.
     *
     * @return string
     */
    public function getErrorCode() {
        return $this->error_code;
    }

    /**
     * Returns additional error data.
     *
     * @return array
     */
    public function getAdditionalData() {
        return $this->additional_data;
    }
}