HttpRequestErrorException

Since v2.0.0

Description

HttpRequestErrorException is an interface. It is implemented by any exception that maps onto any of the HTTP 4xx status values.

Public Interface

HttpRequestErrorException has the following public interface:

// HttpRequestErrorException lives in this namespace
namespace GanbaroDigital\HttpStatus\Interfaces;

// our base interfaces
use GanbaroDigital\HttpStatus\Interfaces\HttpException;

// our return types
use GanbaroDigital\HttpStatus\Interfaces\HttpStatus;

interface HttpRequestErrorException extends HttpException
{
    /**
     * returns the HTTP status code that best represents this object
     *
     * @return HttpStatus
     * @inheritedFrom HttpStatusProvider
     */
    public function getHttpStatus();
}

How To Use

In Your Own Exceptions

Implement HttpRequestErrorException in any exceptions that map onto a HTTP 4xx status value. Combine it with one of the status provider traits to quickly and easily add the getHttpStatus() method that HttpRequestErrorException requires:

use GanbaroDigital\HttpStatus\Interfaces\HttpRequestErrorException;
use GanbaroDigital\HttpStatus\StatusProviders\RuntimeError\BadRequestStatusProvider;
use RuntimeException;

class MyException extends HttpRequestErrorException
{
    // adds getHttpStatus()
    // returns a HttpStatus value object of 400 Bad Request
    use BadRequestStatusProvider;
}

try {
    // ...
}
catch (HttpRequestErrorException $e) {
    $httpStatus = $e->getHttpStatus();
    // ...
}

Notes

If you're writing a library, think long and hard before using this interface in your library's exceptions.

Good practice dictates that any variables passed into libraries should have already been filtered and validated by the application (or its chosen framework). If a library is throwing exceptions about bad inputs, those exceptions are runtime errors, and they're entirely the fault of the calling application or library.