Custom Error Handler Error 500

1

I have added a custom error handler to my backend. However, I am getting 500 Internal Server Error.
Here’s my code:

$errorHandler = new HttpErrorHandler($callableResolver, $responseFactory);
$app->addRoutingMiddleware();
$errorMiddleware = $app->addErrorMiddleware($displayErrorDetails, $logErrors, $logErrorDetails);
$errorMiddleware->setDefaultErrorHandler($customErrorHandler);

My HttpErrorHandler

class HttpErrorHandler extends ErrorHandler
{
public const BAD_REQUEST = ‘BAD_REQUEST’;
public const INSUFFICIENT_PRIVILEGES = ‘INSUFFICIENT_PRIVILEGES’;
public const NOT_ALLOWED = ‘NOT_ALLOWED’;
public const NOT_IMPLEMENTED = ‘NOT_IMPLEMENTED’;
public const RESOURCE_NOT_FOUND = ‘RESOURCE_NOT_FOUND’;
public const SERVER_ERROR = ‘SERVER_ERROR’;
public const UNAUTHENTICATED = ‘UNAUTHENTICATED’;
protected function logError(string $error): void
{
//TODO
// Insert custom error logging function.
}

protected function respond(): ResponseInterface
{
    $exception = $this->exception;
    $statusCode = 500;
    $type = self::SERVER_ERROR;
    $description = 'An internal error has occurred while processing your request.';

    if ($exception instanceof HttpException) {
        $statusCode = $exception->getCode();
        $description = $exception->getMessage();

        if ($exception instanceof HttpNotFoundException) {
            $type = self::RESOURCE_NOT_FOUND;
        } elseif ($exception instanceof HttpMethodNotAllowedException) {
            $type = self::NOT_ALLOWED;
        } elseif ($exception instanceof HttpUnauthorizedException) {
            $type = self::UNAUTHENTICATED;
        } elseif ($exception instanceof HttpForbiddenException) {
            $type = self::UNAUTHENTICATED;
        } elseif ($exception instanceof HttpBadRequestException) {
            $type = self::BAD_REQUEST;
        } elseif ($exception instanceof HttpNotImplementedException) {
            $type = self::NOT_IMPLEMENTED;
        }
    }

    if (
        !($exception instanceof HttpException)
        && ($exception instanceof Exception || $exception instanceof Throwable)
        && $this->displayErrorDetails
    ) {
        $description = $exception->getMessage();
    }

    $error = [
        'statusCode' => $statusCode,
        'error' => [
            'type' => $type,
            'description' => $description,
        ],
    ];
    
    $payload = json_encode($error, JSON_PRETTY_PRINT);
    
    $response = $this->responseFactory->createResponse($statusCode);        
    $response->getBody()->write($payload);
    
    return $response;
}

}

What am I doing wrong?
My requirement here is pretty simple: Everytime there’s an error (404, 500 or similar), I want to render a common web page with different status code and message each time. I couldn’t figure out how to catch those errors automatically.

2

Have you tried this HttpExceptionMiddleware ?

3

Hi Odan. Thank you for your reply. I am definitely not experienced with Php and slim. Could you help me understand how can I implement this line into my code:
$app->add(HttpExceptionMiddleware::class);
This is my current code, but it is showing Slim application error:

    $app->addRoutingMiddleware();
    $app->add(HttpExceptionMiddleware::class);
    $errorMiddleware = $app->addErrorMiddleware($displayErrorDetails, $logErrors, $logErrorDetails);
4

You will find step-by-step instructions within the article.
Do you have installed a dependency injection container, like PHP-DI?
If not, you have to instantiate the objects manually.

5

Hi odan.
I don’t have any dependency injection container. I’m trying this code to manually instantiate the object:

$app->addRoutingMiddleware();
$responseFactory = $app->getResponseFactory();
$app->add(new HttpExceptionMiddleware($responseFactory));
$errorMiddleware = $app->addErrorMiddleware($displayErrorDetails, $logErrors, $logErrorDetails);

It is definitely not working. Same 500 error. I guess this is not how I should instantiate the class
new HttpExceptionMiddleware($responseFactory)
How can I do it manually?

6

The code looks OK. What is the exact error message? Do you have xdebug installed to debug it?
In the long run you need a dependency injection container anyway. I really recommend installing it.

7

Hi Odan. I don’t get any error message. It’s just a blank page with status code 500.

I will try to install a dependency injection container.

8

The 500 status code indicates that your web server generated the error, so you should find it in your server (Apache, Nginx, etc) log.