summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php')
-rw-r--r--vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php219
1 files changed, 219 insertions, 0 deletions
diff --git a/vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php b/vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php
new file mode 100644
index 0000000..995a42e
--- /dev/null
+++ b/vendor/stripe/stripe-php/lib/Exception/ApiErrorException.php
@@ -0,0 +1,219 @@
+<?php
+
+namespace Stripe\Exception;
+
+/**
+ * Implements properties and methods common to all (non-SPL) Stripe exceptions.
+ */
+abstract class ApiErrorException extends \Exception implements ExceptionInterface
+{
+ protected $error;
+ protected $httpBody;
+ protected $httpHeaders;
+ protected $httpStatus;
+ protected $jsonBody;
+ protected $requestId;
+ protected $stripeCode;
+
+ /**
+ * Creates a new API error exception.
+ *
+ * @param string $message the exception message
+ * @param null|int $httpStatus the HTTP status code
+ * @param null|string $httpBody the HTTP body as a string
+ * @param null|array $jsonBody the JSON deserialized body
+ * @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array
+ * @param null|string $stripeCode the Stripe error code
+ *
+ * @return static
+ */
+ public static function factory(
+ $message,
+ $httpStatus = null,
+ $httpBody = null,
+ $jsonBody = null,
+ $httpHeaders = null,
+ $stripeCode = null
+ ) {
+ $instance = new static($message);
+ $instance->setHttpStatus($httpStatus);
+ $instance->setHttpBody($httpBody);
+ $instance->setJsonBody($jsonBody);
+ $instance->setHttpHeaders($httpHeaders);
+ $instance->setStripeCode($stripeCode);
+
+ $instance->setRequestId(null);
+ if ($httpHeaders && isset($httpHeaders['Request-Id'])) {
+ $instance->setRequestId($httpHeaders['Request-Id']);
+ }
+
+ $instance->setError($instance->constructErrorObject());
+
+ return $instance;
+ }
+
+ /**
+ * Gets the Stripe error object.
+ *
+ * @return null|\Stripe\ErrorObject
+ */
+ public function getError()
+ {
+ return $this->error;
+ }
+
+ /**
+ * Sets the Stripe error object.
+ *
+ * @param null|\Stripe\ErrorObject $error
+ */
+ public function setError($error)
+ {
+ $this->error = $error;
+ }
+
+ /**
+ * Gets the HTTP body as a string.
+ *
+ * @return null|string
+ */
+ public function getHttpBody()
+ {
+ return $this->httpBody;
+ }
+
+ /**
+ * Sets the HTTP body as a string.
+ *
+ * @param null|string $httpBody
+ */
+ public function setHttpBody($httpBody)
+ {
+ $this->httpBody = $httpBody;
+ }
+
+ /**
+ * Gets the HTTP headers array.
+ *
+ * @return null|array|\Stripe\Util\CaseInsensitiveArray
+ */
+ public function getHttpHeaders()
+ {
+ return $this->httpHeaders;
+ }
+
+ /**
+ * Sets the HTTP headers array.
+ *
+ * @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders
+ */
+ public function setHttpHeaders($httpHeaders)
+ {
+ $this->httpHeaders = $httpHeaders;
+ }
+
+ /**
+ * Gets the HTTP status code.
+ *
+ * @return null|int
+ */
+ public function getHttpStatus()
+ {
+ return $this->httpStatus;
+ }
+
+ /**
+ * Sets the HTTP status code.
+ *
+ * @param null|int $httpStatus
+ */
+ public function setHttpStatus($httpStatus)
+ {
+ $this->httpStatus = $httpStatus;
+ }
+
+ /**
+ * Gets the JSON deserialized body.
+ *
+ * @return null|array<string, mixed>
+ */
+ public function getJsonBody()
+ {
+ return $this->jsonBody;
+ }
+
+ /**
+ * Sets the JSON deserialized body.
+ *
+ * @param null|array<string, mixed> $jsonBody
+ */
+ public function setJsonBody($jsonBody)
+ {
+ $this->jsonBody = $jsonBody;
+ }
+
+ /**
+ * Gets the Stripe request ID.
+ *
+ * @return null|string
+ */
+ public function getRequestId()
+ {
+ return $this->requestId;
+ }
+
+ /**
+ * Sets the Stripe request ID.
+ *
+ * @param null|string $requestId
+ */
+ public function setRequestId($requestId)
+ {
+ $this->requestId = $requestId;
+ }
+
+ /**
+ * Gets the Stripe error code.
+ *
+ * Cf. the `CODE_*` constants on {@see \Stripe\ErrorObject} for possible
+ * values.
+ *
+ * @return null|string
+ */
+ public function getStripeCode()
+ {
+ return $this->stripeCode;
+ }
+
+ /**
+ * Sets the Stripe error code.
+ *
+ * @param null|string $stripeCode
+ */
+ public function setStripeCode($stripeCode)
+ {
+ $this->stripeCode = $stripeCode;
+ }
+
+ /**
+ * Returns the string representation of the exception.
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ $statusStr = (null === $this->getHttpStatus()) ? '' : "(Status {$this->getHttpStatus()}) ";
+ $idStr = (null === $this->getRequestId()) ? '' : "(Request {$this->getRequestId()}) ";
+
+ return "{$statusStr}{$idStr}{$this->getMessage()}";
+ }
+
+ protected function constructErrorObject()
+ {
+ if (null === $this->jsonBody || !\array_key_exists('error', $this->jsonBody)) {
+ return null;
+ }
+
+ return \Stripe\ErrorObject::constructFrom($this->jsonBody['error']);
+ }
+}