Arcanedev\Stripe\Exceptions\StripeException

Complexity

Total Complexity

17

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

95.74%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	2
A	getType()	0	4	1
A	setType()	0	6	1
A	getStripeCode()	0	4	1
A	setStripeCode()	0	6	1
A	getHttpStatus()	0	4	1
A	getHttpBody()	0	4	1
A	setHttpBody()	0	6	1
A	getJsonBody()	0	4	1
A	setJsonBody()	0	6	1
A	getParams()	0	4	1
A	setParams()	0	6	1
A	getHeaders()	0	4	1
A	setHeaders()	0	6	1
A	getRequestId()	0	4	1
A	setRequestId()	0	6	1

<?php namespace Arcanedev\Stripe\Exceptions;

use Exception;

/**
 * Class     StripeException
 *
 * @package  Arcanedev\Stripe\Bases
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class StripeException extends Exception
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Stripe Error type.
     *
     * @var string|null
     */
    protected $type;

    /**
     * Stripe Error code.
     *
     * @var string|null
     */
    protected $stripeCode;

    /**
     * HTTP Response Body (json).
     *
     * @var string|null
     */
    protected $httpBody;

    /**
     * HTTP Response Body (array).
     *
     * @var array|null
     */
    protected $jsonBody;

    /**
     * Parameters.
     *
     * @var array
     */
    protected $params = [];

    /**
     * Headers.
     *
     * @var array
     */
    protected $headers;

    /**
     * Request ID.
     *
     * @var string
     */
    protected $requestId;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create Stripe Exception instance.
     *
     * @param  string       $message
     * @param  int          $code
     * @param  string|null  $type
     * @param  string|null  $stripeCode
     * @param  string|null  $httpBody
     * @param  array        $jsonBody
     * @param  array        $params
     * @param  array        $headers
     */
    public function __construct(
        $message,
        $code = 0,
        $type = null,
        $stripeCode = null,
        $httpBody = null,
        $jsonBody = [],
        $params = [],
        $headers = []
    ) {
        parent::__construct($message, $code);

        // Stripe Properties
        //--------------------------------------
        $this->setType($type);
        $this->setStripeCode($stripeCode);
        $this->setHttpBody($httpBody);
        $this->setJsonBody($jsonBody);
        $this->setParams($params);
        $this->setHeaders($headers);
        $this->setRequestId(isset($headers['Request-Id']) ? $headers['Request-Id'] : null);
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get Stripe Error type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Set Type.
     *
     * @param  string|null  $type
     *
     * @return self
     */
    private function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Get Stripe code.
     *
     * @return string|null
     */
    public function getStripeCode()
    {
        return $this->stripeCode;
    }

    /**
     * Set Stripe code.
     *
     * @param  string|null  $stripeCode
     *
     * @return self
     */
    private function setStripeCode($stripeCode)
    {
        $this->stripeCode = $stripeCode;

        return $this;
    }

    /**
     * Get HTTP status code.
     *
     * @return int
     */
    public function getHttpStatus()
    {
        return $this->getCode();
    }

    /**
     * Get HTTP Body.
     *
     * @return string|null
     */
    public function getHttpBody()
    {
        return $this->httpBody;
    }

    /**
     * Set HTTP Body.
     *
     * @param  string|null  $httpBody
     *
     * @return self
     */
    private function setHttpBody($httpBody)
    {
        $this->httpBody = $httpBody;

        return $this;
    }

    /**
     * Get Json Body.
     *
     * @return array|null
     */
    public function getJsonBody()
    {
        return $this->jsonBody;
    }

    /**
     * Set Json Body.
     *
     * @param  array|null  $jsonBody
     *
     * @return self
     */
    private function setJsonBody($jsonBody)
    {
        $this->jsonBody = $jsonBody;

        return $this;
    }

    /**
     * Get Parameters.
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Set parameters.
     *
     * @param  array  $params
     *
     * @return self
     */
    private function setParams($params)
    {
        $this->params = $params;

        return $this;
    }

    /**
     * Get the response headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Set the response headers.
     *
     * @param  array  $headers
     *
     * @return self
     */
    private function setHeaders($headers)
    {
        $this->headers = $headers;

        return $this;
    }

    /**
     * Get the Request ID.
     *
     * @return string|null
     */
    public function getRequestId()
    {
        return $this->requestId;
    }

    /**
     * Set the Request ID.
     *
     * @param  string  $requestId
     *
     * @return $this
     */
    private function setRequestId($requestId)
    {
        $this->requestId = $requestId;

        return $this;
    }
}