juliangut/http-exception

HTTP aware exceptions

0.1.1 2018-02-16 15:09 UTC

This package is auto-updated.

Last update: 2021-01-15 03:45:48 UTC


README

PHP version Latest Version License

Build Status Style Check Code Quality Code Coverage

Total Downloads Monthly Downloads

http-exception

HTTP aware exceptions

Installation

Composer

composer require juliangut/http-exception

Usage

Require composer autoload file

require './vendor/autoload.php';

HTTP aware exceptions are just like normal exceptions but carrying an HTTP Status Code

use Jgut\HttpException\HttpException;

$exceptionMessage = 'You shall not pass!';
$exceptionDescription = 'You do not have permission';
$exceptionCode = 1001; // Internal code
$previousException = new \Exception();
$exception = new BadRequestHttpException($exceptionMessage, $exceptionDescription, $exceptionCode, $previousException);

$exception->getStatusCode(); // 400 Bad Request

Additionally exceptions have a description and a unique identifier which can be used in logging and displaying for example on APIs, allowing you to have more information over the erroneous situation when addressed

$exception->getDescription();
$exception->getIdentifier();

Contributing

Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before.

See file CONTRIBUTING.md

License

See file LICENSE included with the source code for a copy of the license terms.