Default Slim application error handler for PHP 7+ Throwables. More...

Inheritance diagram for Slim\Handlers\PhpError:

Collaboration diagram for Slim\Handlers\PhpError:

Public Member Functions
	__invoke (ServerRequestInterface $request, ResponseInterface $response, \Throwable $error)
	Invoke error handler. More...

Public Member Functions inherited from Slim\Handlers\AbstractError
	__construct ($displayErrorDetails=false)
	Constructor. More...

Protected Member Functions
	renderHtmlErrorMessage (\Throwable $error)
	Render HTML error page. More...

	renderHtmlError (\Throwable $error)
	Render error as HTML. More...

	renderJsonErrorMessage (\Throwable $error)
	Render JSON error. More...

	renderXmlErrorMessage (\Throwable $error)
	Render XML error. More...

Protected Member Functions inherited from Slim\Handlers\AbstractError
	writeToErrorLog ($throwable)
	Write to the error log if displayErrorDetails is false. More...

	renderThrowableAsText ($throwable)
	Render error as Text. More...

	logError ($message)
	Wraps the error_log function so that this can be easily tested. More...

Protected Member Functions inherited from Slim\Handlers\AbstractHandler
	determineContentType (ServerRequestInterface $request)
	Determine which content type we know about is wanted using Accept header. More...

Private Member Functions
	createCdataSection ($content)
	Returns a CDATA section with the given content. More...

Additional Inherited Members
Protected Attributes inherited from Slim\Handlers\AbstractError
	$displayErrorDetails

Protected Attributes inherited from Slim\Handlers\AbstractHandler
	$knownContentTypes

Detailed Description

Default Slim application error handler for PHP 7+ Throwables.

It outputs the error message and diagnostic information in either JSON, XML, or HTML based on the Accept header.

Definition at line 22 of file PhpError.php.

Member Function Documentation

◆ __invoke()

Slim\Handlers\PhpError::__invoke	(	ServerRequestInterface	$request,
		ResponseInterface	$response,
		\Throwable	$error
	)

Invoke error handler.

Parameters

ServerRequestInterface	$request	The most recent Request object
ResponseInterface	$response	The most recent Response object
\Throwable	$error	The caught Throwable object

Returns: ResponseInterface

Exceptions

UnexpectedValueException

Definition at line 34 of file PhpError.php.

    {
        $contentType = $this->determineContentType($request);
        switch ($contentType) {
            case 'application/json':
                $output = $this->renderJsonErrorMessage($error);
                break;
 
            case 'text/xml':
            case 'application/xml':
                $output = $this->renderXmlErrorMessage($error);
                break;
 
            case 'text/html':
                $output = $this->renderHtmlErrorMessage($error);
                break;
            default:
                throw new UnexpectedValueException('Cannot render unknown content type ' . $contentType);
        }
 
        $this->writeToErrorLog($error);
 
        $body = new Body(fopen('php://temp', 'r+'));
        $body->write($output);
 
        return $response
                ->withStatus(500)
                ->withHeader('Content-type', $contentType)
                ->withBody($body);
    }

References $contentType, $output, $response, Slim\Handlers\AbstractHandler\determineContentType(), Slim\Handlers\PhpError\renderHtmlErrorMessage(), Slim\Handlers\PhpError\renderJsonErrorMessage(), Slim\Handlers\PhpError\renderXmlErrorMessage(), and Slim\Handlers\AbstractError\writeToErrorLog().

Here is the call graph for this function:

◆ createCdataSection()

Slim\Handlers\PhpError::createCdataSection ( $content )

private

Returns a CDATA section with the given content.

Parameters

string $content

Returns: string

Definition at line 201 of file PhpError.php.

    {
        return sprintf('<![CDATA[%s]]>', str_replace(']]>', ']]]]><![CDATA[>', $content));
    }

References sprintf.

Referenced by Slim\Handlers\PhpError\renderXmlErrorMessage().

Here is the caller graph for this function:

◆ renderHtmlError()

Slim\Handlers\PhpError::renderHtmlError ( \Throwable $error )

protected

Render error as HTML.

Parameters

\Throwable $error

Returns: string

Definition at line 109 of file PhpError.php.

    {
        $html = sprintf('<div><strong>Type:</strong> %s</div>', get_class($error));
 
        if (($code = $error->getCode())) {
            $html .= sprintf('<div><strong>Code:</strong> %s</div>', $code);
        }
 
        if (($message = $error->getMessage())) {
            $html .= sprintf('<div><strong>Message:</strong> %s</div>', htmlentities($message));
        }
 
        if (($file = $error->getFile())) {
            $html .= sprintf('<div><strong>File:</strong> %s</div>', $file);
        }
 
        if (($line = $error->getLine())) {
            $html .= sprintf('<div><strong>Line:</strong> %s</div>', $line);
        }
 
        if (($trace = $error->getTraceAsString())) {
            $html .= '<h2>Trace</h2>';
            $html .= sprintf('<pre>%s</pre>', htmlentities($trace));
        }
 
        return $html;
    }

References $code, $error, $file, $html, $message, and sprintf.

Referenced by Slim\Handlers\PhpError\renderHtmlErrorMessage().

Here is the caller graph for this function:

◆ renderHtmlErrorMessage()

Slim\Handlers\PhpError::renderHtmlErrorMessage ( \Throwable $error )

protected

Render HTML error page.

Parameters

\Throwable $error

Returns: string

Definition at line 72 of file PhpError.php.

    {
        $title = 'Slim Application Error';
 
        if ($this->displayErrorDetails) {
            $html = '<p>The application could not run because of the following error:</p>';
            $html .= '<h2>Details</h2>';
            $html .= $this->renderHtmlError($error);
 
            while ($error = $error->getPrevious()) {
                $html .= '<h2>Previous error</h2>';
                $html .= $this->renderHtmlError($error);
            }
        } else {
            $html = '<p>A website error has occurred. Sorry for the temporary inconvenience.</p>';
        }
 
        $output = sprintf(
            "<html><head><meta http-equiv='Content-Type' content='text/html; charset=utf-8'>" .
            "<title>%s</title><style>body{margin:0;padding:30px;font:12px/1.5 Helvetica,Arial,Verdana," .
            "sans-serif;}h1{margin:0;font-size:48px;font-weight:normal;line-height:48px;}strong{" .
            "display:inline-block;width:65px;}</style></head><body><h1>%s</h1>%s</body></html>",
            $title,
            $title,
            $html
        );
 
        return $output;
    }

References $error, $html, $output, $title, Slim\Handlers\PhpError\renderHtmlError(), and sprintf.

Referenced by Slim\Handlers\PhpError\__invoke().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderJsonErrorMessage()

Slim\Handlers\PhpError::renderJsonErrorMessage ( \Throwable $error )

protected

Render JSON error.

Parameters

\Throwable $error

Returns: string

Definition at line 144 of file PhpError.php.

    {
        $json = [
            'message' => 'Slim Application Error',
        ];
 
        if ($this->displayErrorDetails) {
            $json['error'] = [];
 
            do {
                $json['error'][] = [
                    'type' => get_class($error),
                    'code' => $error->getCode(),
                    'message' => $error->getMessage(),
                    'file' => $error->getFile(),
                    'line' => $error->getLine(),
                    'trace' => explode("\n", $error->getTraceAsString()),
                ];
            } while ($error = $error->getPrevious());
        }
 
        return json_encode($json, JSON_PRETTY_PRINT);
    }

References $error.

Referenced by Slim\Handlers\PhpError\__invoke().

Here is the caller graph for this function:

◆ renderXmlErrorMessage()

Slim\Handlers\PhpError::renderXmlErrorMessage ( \Throwable $error )

protected

Render XML error.

Parameters

\Throwable $error

Returns: string

Definition at line 175 of file PhpError.php.

    {
        $xml = "<error>\n  <message>Slim Application Error</message>\n";
        if ($this->displayErrorDetails) {
            do {
                $xml .= "  <error>\n";
                $xml .= "    <type>" . get_class($error) . "</type>\n";
                $xml .= "    <code>" . $error->getCode() . "</code>\n";
                $xml .= "    <message>" . $this->createCdataSection($error->getMessage()) . "</message>\n";
                $xml .= "    <file>" . $error->getFile() . "</file>\n";
                $xml .= "    <line>" . $error->getLine() . "</line>\n";
                $xml .= "    <trace>" . $this->createCdataSection($error->getTraceAsString()) . "</trace>\n";
                $xml .= "  </error>\n";
            } while ($error = $error->getPrevious());
        }
        $xml .= "</error>";
 
        return $xml;
    }