boltics/http-exception

An exception that contains http status code

v1.0.5 2020-08-27 02:28 UTC

Requires

• php: >=7.1
• symfony/http-foundation: ^4.1 || ^5.0

Requires (Dev)

• phpunit/phpunit: ^5.7 || ^6.0 || ^7.0 || ^8.0

MIT

• Boltics team

• exception
• type
• http-status-code
• http-code
• httpcode

README

A exception that extends PHP exception and also contains http status code.

Now you can easily manage your error code and http status code together!

Installation

composer require boltics\http-exception

Declaration

use Boltics\HttpException\Exception;
use Symfony\Component\HttpFoundation\Response;

Usage

$errorInfo = [
    'message' => 'Hola',
    'errorCode' => 1234,
    'httpCode' => Response::HTTP_BAD_REQUEST
];

throw new Exception($errorInfo);

// For Laravel Response
// You can use one exception to manage both error code and http code

class CustomizedException extends Exception
{
    const FIRST_ERROR = [
        'message' => 'Hola',
        'errorCode' => 1234,
        'httpCode' => Response::HTTP_BAD_REQUEST
    ];
}

try {
    // do something
    throw new CustomizedException(CustomizedException::FIRST_ERROR);
} catch (CustomizedException $e) {
    return $reponse()->json($data, $e->getHttpCode())
}

Documentation

• __construct() The constructor checks that the value exist in the enum
• getHttpCode() Returns http code
• setHttpCode() Set http code
• getErrorCode() Another approach to get exception code
• setAdditionalData() Set additional data
• getAdditionalData() Get additional data
• appendAdditionalData() Append data to the additional data

Static methods:

• isValidHttpCode() method Returns boolean that http code is valid (in the supported list)
• sanitizeException() method Returns valid exception info for __construct()