HttpSuccessfulException

Since v2.0.0

Description

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

This interface has been included for completeness. In practice, it would be very unusual to use an exception to indicate that an HTTP request has been successful.

Public Interface

HttpSuccessfulException has the following public interface:

// HttpSuccessfulException 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 HttpSuccessfulException 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 HttpSuccessfulException in any exceptions that map onto a HTTP 2xx status value. Combine it with one of the status provider traits to quickly and easily add the getHttpStatus() method that HttpSuccessfulException requires:

use GanbaroDigital\HttpStatus\Interfaces\HttpSuccessfulException;
use GanbaroDigital\HttpStatus\StatusProviders\Successful\OkStatusProvider;
use RuntimeException;

class MyException extends HttpSuccessfulException
{
    // adds getHttpStatus()
    // returns a HttpStatus value object of 200 OK
    use OkStatusProvider;
}

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

Notes