bSecure\Exception\ApiErrorException

Complexity

Total Complexity

21

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	6	3
A	getHttpBody()	0	3	1
A	factory()	0	23	3
A	setJsonBody()	0	3	1
A	getJsonBody()	0	3	1
A	setHttpBody()	0	3	1
A	setHttpStatus()	0	3	1
A	constructErrorObject()	0	7	3
A	getError()	0	3	1
A	setHttpHeaders()	0	3	1
A	getHttpStatus()	0	3	1
A	getHttpHeaders()	0	3	1
A	getRequestId()	0	3	1
A	setBsecureCode()	0	3	1
A	setError()	0	3	1

<?php

namespace bSecure\Exception;

/**
 * Implements properties and methods common to all bSecure exceptions.
 */
abstract class ApiErrorException extends \Exception implements ExceptionInterface
{
    protected $error;
    protected $httpBody;
    protected $httpHeaders;
    protected $httpStatus;
    protected $jsonBody;
    protected $requestId;
    protected $code;

    /**
     * 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|\bSecure\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array
     * @param null|string $code the bSecure error code
     *
     * @return static
     */
    public static function factory(
      $message,
      $httpStatus = null,
      $httpBody = null,
      $jsonBody = null,
      $httpHeaders = null,
      $code = null
    ) {
        $instance = new static($message);
        $instance->setHttpStatus($httpStatus);
        $instance->setHttpBody($httpBody);
        $instance->setJsonBody($jsonBody);
        $instance->setHttpHeaders($httpHeaders);
        $instance->setBsecureCode($code);

        $instance->setRequestId(null);

The method setRequestId() does not exist on bSecure\Exception\ApiErrorException.

        if ($httpHeaders && isset($httpHeaders['Request-Id'])) {
            $instance->setRequestId($httpHeaders['Request-Id']);
        }

        $instance->setError($instance->constructErrorObject());

        return $instance;
    }

    /**
     * Gets the bSecure error object.
     *
     * @return null|\bSecure\ErrorObject

The type bSecure\ErrorObject was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getError()
    {
        return $this->error;
    }

    /**
     * Sets the bSecure error object.
     *
     * @param null|\bSecure\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|\bSecure\Util\CaseInsensitiveArray
     */
    public function getHttpHeaders()
    {
        return $this->httpHeaders;
    }

    /**
     * Sets the HTTP headers array.
     *
     * @param null|array|\bSecure\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 bSecure request ID.
     *
     * @return null|string
     */
    public function getRequestId()
    {
        return $this->requestId;
    }

    /**
     * Sets the bSecure error code.
     *
     * @param null|string $code
     */
    public function setBsecureCode($code)
    {
        $this->code = $code;
    }

    /**
     * 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 \bSecure\ErrorObject::constructFrom($this->jsonBody['error']);
    }
}