OAuth2\Exceptions\OAuthException

Complexity

Total Complexity

7

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getError()	0	3	1
A	getErrorUri()	0	3	1
A	getErrorDescription()	0	3	1
A	jsonSerialize()	0	13	3

<?php
/**
 * Created by PhpStorm.
 * User: Alexandre
 * Date: 04/03/2018
 * Time: 17:40
 */

namespace OAuth2\Exceptions;


class OAuthException extends \Exception implements \JsonSerializable
{
    /**
     * @var string
     */
    private $error;
    /**
     * @var null|string
     */
    private $errorDescription;
    /**
     * @var null|string
     */
    private $errorUri;

    /**
     * OAuthException constructor.
     * @param string $error
     * @param null|string $errorDescription
     * @param null|string $errorUri
     *
     * error
     * REQUIRED.  A single ASCII [USASCII] error code.
     *
     * Values for the "error" parameter MUST NOT include characters
     * outside the set %x20-21 / %x23-5B / %x5D-7E.
     *
     * error_description
     * OPTIONAL.  Human-readable ASCII [USASCII] text providing
     * additional information, used to assist the client developer in
     * understanding the error that occurred.
     * Values for the "error_description" parameter MUST NOT include
     * characters outside the set %x20-21 / %x23-5B / %x5D-7E.
     *
     * error_uri
     * OPTIONAL.  A URI identifying a human-readable web page with
     * information about the error, used to provide the client
     * developer with additional information about the error.
     * Values for the "error_uri" parameter MUST conform to the
     * URI-reference syntax and thus MUST NOT include characters
     * outside the set %x21 / %x23-5B / %x5D-7E.
     */
    public function __construct(string $error, ?string $errorDescription = null, ?string $errorUri = null)
    {
        parent::__construct($errorDescription);
        $this->error = $error;
        $this->errorDescription = $errorDescription;
        $this->errorUri = $errorUri;
    }

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

    /**
     * @return null|string
     */
    public function getErrorDescription(): ?string
    {
        return $this->errorDescription;
    }

    /**
     * @return null|string
     */
    public function getErrorUri(): ?string
    {
        return $this->errorUri;
    }

    /**
     * Specify data which should be serialized to JSON
     * @link  http://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     * which is a value of any type other than a resource.
     * @since 5.4.0
     */
    public function jsonSerialize()
    {
        $data = [
            'error' => $this->error
        ];
        if ($this->errorDescription) {
            $data['error_description'] = $this->errorDescription;
        }
        if ($this->errorUri) {
            $data['error_uri'] = $this->errorUri;
        }

        return json_encode($data);
    }
}