CMPayments\JsonLint\Exceptions\JsonLintException

Complexity

Total Complexity

20

Size/Duplication

Total Lines	218
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	8
Bugs	1	Features	3

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getArgs()	0	4	1
A	getJsonLineNo()	0	4	1
A	setJsonLineNo()	0	4	1
A	getJsonColumnNo()	0	4	1
A	setJsonColumnNo()	0	4	1
A	getJsonMatch()	0	4	1
A	setJsonMatch()	0	4	1
A	getJsonToken()	0	4	1
A	setJsonToken()	0	4	1
A	getJsonExpected()	0	4	1
A	setJsonExpected()	0	4	1
A	appendMessage()	0	4	1
A	setArgs()	0	10	2
A	getDetails()	0	11	1
A	__construct()	0	7	1
A	getItemFromVariableArray()	0	16	3
A	getClassName()	0	4	1

<?php namespace CMPayments\JsonLint\Exceptions;

/**
 * Class JsonLintException
 *
 * @author  Bas Peters <bp@cm.nl>
 * @author  Boy Wijnmaalen <boy.wijnmaalen@cmtelecom.com>
 *
 * @package CMPayments\JsonLint\Exceptions
 */
class JsonLintException extends \ErrorException
{
    const ERROR_TEMPORARILY_UNAVAILABLE = 1;
    const ERROR_LEXICAL_ERROR           = 2;

    protected $messages = [
        self::ERROR_TEMPORARILY_UNAVAILABLE => 'This Service is temporarily unavailable',
        self::ERROR_LEXICAL_ERROR           => 'Lexical error on line %d, unrecognized text'
    ];

    /**
     * @var array
     */
    private $args = [];

    /**
     * @var null
     */
    private $jsonLineNo = null;

    /**
     * @var null
     */
    private $jsonColumnNo = null;

    /**
     * @var null
     */
    private $jsonMatch = null;

    /**
     * @var null
     */
    private $jsonToken = null;

    /**
     * @var null
     */
    private $jsonExpected = null;

    /**
     * @return mixed
     */
    public function getArgs()
    {
        return $this->args;
    }

    /**
     * @param mixed $args
     */
    public function setArgs($args)
    {
        // check is $args is an array, if not, cast it into an array
        if (!is_array($args)) {

            $args = [$args];
        }

        $this->args = $args;
    }

    /**
     * @return null
     */
    public function getJsonLineNo()
    {
        return $this->jsonLineNo;
    }

    /**
     * @param null $jsonLineNo
     */
    public function setJsonLineNo($jsonLineNo)
    {
        $this->jsonLineNo = $jsonLineNo;
    }

    /**
     * @return null
     */
    public function getJsonColumnNo()
    {
        return $this->jsonColumnNo;
    }

    /**
     * @param integer $jsonColumnNo
     */
    public function setJsonColumnNo($jsonColumnNo)
    {
        $this->jsonColumnNo = $jsonColumnNo;

It seems like $jsonColumnNo of type integer is incompatible with the declared type null of property $jsonColumnNo.

    }

    /**
     * @return null
     */
    public function getJsonMatch()
    {
        return $this->jsonMatch;
    }

    /**
     * @param null $jsonMatch
     */
    public function setJsonMatch($jsonMatch)
    {
        $this->jsonMatch = $jsonMatch;
    }

    /**
     * @return null
     */
    public function getJsonToken()
    {
        return $this->jsonToken;
    }

    /**
     * @param null $jsonToken
     */
    public function setJsonToken($jsonToken)
    {
        $this->jsonToken = $jsonToken;
    }

    /**
     * @return null
     */
    public function getJsonExpected()
    {
        return $this->jsonExpected;
    }

    /**
     * @param null $jsonExpected
     */
    public function setJsonExpected($jsonExpected)
    {
        $this->jsonExpected = $jsonExpected;
    }

    /**
     * @return array
     */
    public function getDetails()
    {
        return [
            'errorCode' => $this->getCode(),
            'match'     => $this->getJsonMatch(),
            'token'     => $this->getJsonToken(),
            'line'      => $this->getJsonLineNo(),
            'column'    => $this->getJsonColumnNo(),
            'expected'  => $this->getJsonExpected()
        ];
    }

    /**
     * Append the current message with some more text
     *
     * @param string|null $appendingText
     */
    public function appendMessage($appendingText)
    {
        $this->message = $this->getMessage() . $appendingText;
    }

    /**
     * ApiException constructor.
     *
     * @param string $code
     * @param array  $args
     * @param null   $message
     */
    public function __construct($code, $args = [], $message = null)
    {
        $this->setArgs($args);

        // parent constructor
        parent::__construct($this->getItemFromVariableArray($code, 'This service is temporarily unavailable'), $code);
    }

    /**
     * Retrieves a specific array key from a class constant
     *
     * @param int    $code
     * @param string $default
     * @param string $msgArray
     *
     * @return null|string
     */
    public function getItemFromVariableArray($code, $default = null, $msgArray = 'messages')
    {
        $messages = [];
        if (isset($this->$msgArray)) {

            $messages = $this->$msgArray;
        }

        // override because when the given code exists
        if (isset($messages[$code])) {

            $default = vsprintf($messages[$code], $this->getArgs());
        }

        return $default;
    }

    /**
     * PHP 5.4 workaround for something like this ClassA::class (which is invalid in PHP5.4)
     *
     * @return string
     */
    static public function getClassName()

As per PSR2, the static declaration should come after the visibility declaration.

    {
        return get_called_class();
    }
}