responsible\core\exception\errorException

Complexity

Total Complexity

10

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptions()	0	3	1
A	message()	0	4	1
A	error()	0	19	3
A	throwError()	0	21	3
A	setOptions()	0	4	1
A	__construct()	0	2	1

<?php
/**
 * ==================================
 * Responsible PHP API
 * ==================================
 *
 * @link Git https://github.com/vince-scarpa/responsibleAPI.git
 *
 * @api Responible API
 * @package responsible\core\exception
 *
 * @author Vince scarpa <vince.in2net@gmail.com>
 *
 */
namespace responsible\core\exception;

use responsible\core\headers;

class errorException extends responsibleException
{
    /**
     * Responsible API options
     */
    private static $options;

    /**
     * [__construct Use parent constructor]
     */
    public function __construct()
    {}

    /**
     * [$ERRORS Error sets Default error messages for supported error codes]
     * @var array
     */
    private $ERRORS = array(

        'APPLICATION_ERROR' => array(
            'ERROR_CODE' => 404,
            'ERROR_STATUS' => 'APPLICATION_ERROR',
            'MESSAGE' => '',
        ),

        'NOT_EXTENDED' => array(
            'ERROR_CODE' => 510,
            'ERROR_STATUS' => 'API_ERROR',
            'MESSAGE' => '',
        ),

        'NO_CONTENT' => array(
            'ERROR_CODE' => 200,
            'ERROR_STATUS' => 'NO_CONTENT',
            'MESSAGE' => [
                'error' => 'empty',
                'description' => 'No results'
            ],
        ),

        'NOT_FOUND' => array(
            'ERROR_CODE' => 404,
            'ERROR_STATUS' => 'NOT_FOUND',
            'MESSAGE' => [
                'error' => 'not found',
                'description' => 'We could not find the resource you requested or the request was not found'
            ],
        ),

        'METHOD_NOT_ALLOWED' => array(
            'ERROR_CODE' => 405,
            'ERROR_STATUS' => 'METHOD_NOT_ALLOWED',
            'MESSAGE' => [
                'error' => 'not allowed',
                'description' => 'The method request provided is not allowed'
            ],
        ),

        'UNAUTHORIZED' => array(
            'ERROR_CODE' => 401,
            'ERROR_STATUS' => 'UNAUTHORIZED',
            'MESSAGE' => [
                'error' => 'denied',
                'description' => 'Permission denied'
            ],
        ),

        'BAD_REQUEST' => array(
            'ERROR_CODE' => 400,
            'ERROR_STATUS' => 'BAD_REQUEST',
            'MESSAGE' => [
                'error' => 'bad request',
                'description' => 'The request provided was Invalid'
            ],
        ),

        'TOO_MANY_REQUESTS' => array(
            'ERROR_CODE' => 429,
            'ERROR_STATUS' => 'TOO_MANY_REQUESTS',
            'MESSAGE' => [
                'error' => 'too many requests',
                'description' => 'Too Many Requests'
            ],
        ),
    );

    /**
     * [$ERROR_STATE Current error state]
     * @var array
     */
    private $ERROR_STATE = array();

    /**
     * [error]
     * @return void
     */
    public function error($type)
    {
        if (!isset($this->ERRORS[$type])) {
            if (isset($this->ERRORS['MESSAGE'])) {
                $this->ERROR_STATE = array(
                    'ERROR_CODE' => 500,
                    'ERROR_STATUS' => $type,
                    'MESSAGE' => $this->ERRORS['MESSAGE'],
                );
                $this->throwError();
            }

            $this->ERROR_STATE = $this->ERRORS['APPLICATION_ERROR'];
            $this->ERROR_STATE['MESSAGE'] = "`" . $type . "`" . ' is not defined as an error code';
            $this->throwError();
        }

        $this->ERROR_STATE = $this->ERRORS[$type];
        $this->throwError();
    // @codeCoverageIgnoreStart
    }
    // @codeCoverageIgnoreEnd

    /**
     * [message Custom message override]
     * @return self
     */
    public function message($message)
    {
        $this->ERRORS['MESSAGE'] = $message;
        return $this;
    }

    /**
     * [errorMessage]
     */
    private function throwError()
    {
        $options = $this->getOptions();

The assignment to $options is dead and can be removed.

        $headers = new headers\header;
        $headers->setOptions($this->getOptions());
        $headers->setHeaders();

        http_response_code($this->ERROR_STATE['ERROR_CODE']);

        $message = isset($this->ERRORS['MESSAGE']) && !empty($this->ERRORS['MESSAGE'])
        ? $this->ERRORS['MESSAGE']
        : $this->ERROR_STATE['MESSAGE'];

        $eMessage = json_encode(array(
            'ERROR_CODE' => $this->ERROR_STATE['ERROR_CODE'],
            'ERROR_STATUS' => $this->ERROR_STATE['ERROR_STATUS'],
            'MESSAGE' => $message,
        ), JSON_PRETTY_PRINT);

        throw new responsibleException($eMessage, $this->ERROR_STATE['ERROR_CODE']);
    }

    /**
     * [setOptions Inherit Responsible API options]
     * @param array $options
     * @return self
     */
    public function setOptions($options)
    {
        self::$options = $options;
        return $this;
    }

    /**
     * [getOptions Get available options]
     * @return array
     */
    public function getOptions()
    {
        return self::$options;
    }
}