give / vendor / stripe / stripe-php / lib / Exception / ApiErrorException.php

ApiErrorException.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.4, at vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php

220 lines 4.9 KB

Raw Download Zip

1	<?php
2
3	namespace Stripe\Exception;
4
5	/**
6	* Implements properties and methods common to all (non-SPL) Stripe exceptions.
7	*/
8	abstract class ApiErrorException extends \Exception implements ExceptionInterface
9	{
10	protected $error;
11	protected $httpBody;
12	protected $httpHeaders;
13	protected $httpStatus;
14	protected $jsonBody;
15	protected $requestId;
16	protected $stripeCode;
17
18	/**
19	* Creates a new API error exception.
20	*
21	* @param string $message the exception message
22	* @param null\|int $httpStatus the HTTP status code
23	* @param null\|string $httpBody the HTTP body as a string
24	* @param null\|array $jsonBody the JSON deserialized body
25	* @param null\|array\|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array
26	* @param null\|string $stripeCode the Stripe error code
27	*
28	* @return static
29	*/
30	public static function factory(
31	$message,
32	$httpStatus = null,
33	$httpBody = null,
34	$jsonBody = null,
35	$httpHeaders = null,
36	$stripeCode = null
37	) {
38	$instance = new static($message);
39	$instance->setHttpStatus($httpStatus);
40	$instance->setHttpBody($httpBody);
41	$instance->setJsonBody($jsonBody);
42	$instance->setHttpHeaders($httpHeaders);
43	$instance->setStripeCode($stripeCode);
44
45	$instance->setRequestId(null);
46	if ($httpHeaders && isset($httpHeaders['Request-Id'])) {
47	$instance->setRequestId($httpHeaders['Request-Id']);
48	}
49
50	$instance->setError($instance->constructErrorObject());
51
52	return $instance;
53	}
54
55	/**
56	* Gets the Stripe error object.
57	*
58	* @return null\|\Stripe\ErrorObject
59	*/
60	public function getError()
61	{
62	return $this->error;
63	}
64
65	/**
66	* Sets the Stripe error object.
67	*
68	* @param null\|\Stripe\ErrorObject $error
69	*/
70	public function setError($error)
71	{
72	$this->error = $error;
73	}
74
75	/**
76	* Gets the HTTP body as a string.
77	*
78	* @return null\|string
79	*/
80	public function getHttpBody()
81	{
82	return $this->httpBody;
83	}
84
85	/**
86	* Sets the HTTP body as a string.
87	*
88	* @param null\|string $httpBody
89	*/
90	public function setHttpBody($httpBody)
91	{
92	$this->httpBody = $httpBody;
93	}
94
95	/**
96	* Gets the HTTP headers array.
97	*
98	* @return null\|array\|\Stripe\Util\CaseInsensitiveArray
99	*/
100	public function getHttpHeaders()
101	{
102	return $this->httpHeaders;
103	}
104
105	/**
106	* Sets the HTTP headers array.
107	*
108	* @param null\|array\|\Stripe\Util\CaseInsensitiveArray $httpHeaders
109	*/
110	public function setHttpHeaders($httpHeaders)
111	{
112	$this->httpHeaders = $httpHeaders;
113	}
114
115	/**
116	* Gets the HTTP status code.
117	*
118	* @return null\|int
119	*/
120	public function getHttpStatus()
121	{
122	return $this->httpStatus;
123	}
124
125	/**
126	* Sets the HTTP status code.
127	*
128	* @param null\|int $httpStatus
129	*/
130	public function setHttpStatus($httpStatus)
131	{
132	$this->httpStatus = $httpStatus;
133	}
134
135	/**
136	* Gets the JSON deserialized body.
137	*
138	* @return null\|array<string, mixed>
139	*/
140	public function getJsonBody()
141	{
142	return $this->jsonBody;
143	}
144
145	/**
146	* Sets the JSON deserialized body.
147	*
148	* @param null\|array<string, mixed> $jsonBody
149	*/
150	public function setJsonBody($jsonBody)
151	{
152	$this->jsonBody = $jsonBody;
153	}
154
155	/**
156	* Gets the Stripe request ID.
157	*
158	* @return null\|string
159	*/
160	public function getRequestId()
161	{
162	return $this->requestId;
163	}
164
165	/**
166	* Sets the Stripe request ID.
167	*
168	* @param null\|string $requestId
169	*/
170	public function setRequestId($requestId)
171	{
172	$this->requestId = $requestId;
173	}
174
175	/**
176	* Gets the Stripe error code.
177	*
178	* Cf. the `CODE_*` constants on {@see \Stripe\ErrorObject} for possible
179	* values.
180	*
181	* @return null\|string
182	*/
183	public function getStripeCode()
184	{
185	return $this->stripeCode;
186	}
187
188	/**
189	* Sets the Stripe error code.
190	*
191	* @param null\|string $stripeCode
192	*/
193	public function setStripeCode($stripeCode)
194	{
195	$this->stripeCode = $stripeCode;
196	}
197
198	/**
199	* Returns the string representation of the exception.
200	*
201	* @return string
202	*/
203	public function __toString()
204	{
205	$statusStr = (null === $this->getHttpStatus()) ? '' : "(Status {$this->getHttpStatus()}) ";
206	$idStr = (null === $this->getRequestId()) ? '' : "(Request {$this->getRequestId()}) ";
207
208	return "{$statusStr}{$idStr}{$this->getMessage()}";
209	}
210
211	protected function constructErrorObject()
212	{
213	if (null === $this->jsonBody \|\| !\array_key_exists('error', $this->jsonBody)) {
214	return null;
215	}
216
217	return \Stripe\ErrorObject::constructFrom($this->jsonBody['error']);
218	}
219	}
220