Flugg\Responder\Exceptions\Http\HttpException

Complexity

Total Complexity

7

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	statusCode()	0	4	1
A	errorCode()	0	4	1
A	message()	0	4	2
A	data()	0	4	1
A	headers()	0	4	1

<?php

namespace Flugg\Responder\Exceptions\Http;

use Symfony\Component\HttpKernel\Exception\HttpException as BaseHttpException;

/**
 * An abstract exception responsible for holding error response data.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
abstract class HttpException extends BaseHttpException
{
    /**
     * An HTTP status code.
     *
     * @var int
     */
    protected $status = 500;

    /**
     * An error code.
     *
     * @var string|null
     */
    protected $errorCode = null;

    /**
     * An error message.
     *
     * @var string|null
     */
    protected $message = null;

    /**
     * Additional error data.
     *
     * @var array|null
     */
    protected $data = null;

    /**
     * Attached headers.
     *
     * @var array
     */
    protected $headers = [];

    /**
     * Construct the exception class.
     *
     * @param string|null $message
     * @param array|null  $headers
     */
    public function __construct(string $message = null, array $headers = null)
    {
        parent::__construct($this->status, $message ?? $this->message, null, $headers ?? $this->headers);
    }

    /**
     * Retrieve the HTTP status code,
     *
     * @return int
     */
    public function statusCode(): int
    {
        return $this->status;
    }

    /**
     * Retrieve the error code.
     *
     * @return string|null
     */
    public function errorCode()
    {
        return $this->errorCode;
    }

    /**
     * Retrieve the error message.
     *
     * @return string|null
     */
    public function message()
    {
        return $this->message ?: null;
    }

    /**
     * Retrieve additional error data.
     *
     * @return array|null
     */
    public function data()
    {
        return $this->data;
    }

    /**
     * Retrieve attached headers.
     *
     * @return array|null
     */
    public function headers()
    {
        return $this->headers;
    }
}