Default Slim application error handler. More...

Inheritance diagram for Slim\Handlers\Error:

Collaboration diagram for Slim\Handlers\Error:

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

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

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

	renderHtmlException (\Exception $exception)
	Render exception as HTML. More...

	renderHtmlExceptionOrError ($exception)
	Render exception or error as HTML. More...

	renderJsonErrorMessage (\Exception $exception)
	Render JSON error. More...

	renderXmlErrorMessage (\Exception $exception)
	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.

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 Error.php.

Member Function Documentation

◆ __invoke()

Slim\Handlers\Error::__invoke	(	ServerRequestInterface	$request,
		ResponseInterface	$response,
		\Exception	$exception
	)

Invoke error handler.

Parameters

ServerRequestInterface	$request	The most recent Request object
ResponseInterface	$response	The most recent Response object
\Exception	$exception	The caught Exception object

Returns: ResponseInterface

Exceptions

UnexpectedValueException

Definition at line 34 of file Error.php.

    {
        $contentType = $this->determineContentType($request);
        switch ($contentType) {
            case 'application/json':
                $output = $this->renderJsonErrorMessage($exception);
                break;
 
            case 'text/xml':
            case 'application/xml':
                $output = $this->renderXmlErrorMessage($exception);
                break;
 
            case 'text/html':
                $output = $this->renderHtmlErrorMessage($exception);
                break;
 
            default:
                throw new UnexpectedValueException('Cannot render unknown content type ' . $contentType);
        }
 
        $this->writeToErrorLog($exception);
 
        $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\Error\renderHtmlErrorMessage(), Slim\Handlers\Error\renderJsonErrorMessage(), Slim\Handlers\Error\renderXmlErrorMessage(), and Slim\Handlers\AbstractError\writeToErrorLog().

Here is the call graph for this function:

◆ createCdataSection()

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

private

Returns a CDATA section with the given content.

Parameters

string $content

Returns: string

Definition at line 220 of file Error.php.

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

References sprintf.

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

Here is the caller graph for this function:

◆ renderHtmlErrorMessage()

Slim\Handlers\Error::renderHtmlErrorMessage ( \Exception $exception )

protected

Render HTML error page.

Parameters

\Exception $exception

Returns: string

Definition at line 73 of file Error.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->renderHtmlException($exception);
 
            while ($exception = $exception->getPrevious()) {
                $html .= '<h2>Previous exception</h2>';
                $html .= $this->renderHtmlExceptionOrError($exception);
            }
        } 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 $html, $output, $title, Slim\Handlers\Error\renderHtmlException(), Slim\Handlers\Error\renderHtmlExceptionOrError(), and sprintf.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderHtmlException()

Slim\Handlers\Error::renderHtmlException ( \Exception $exception )

protected

Render exception as HTML.

Provided for backwards compatibility; use renderHtmlExceptionOrError().

Parameters

\Exception $exception

Returns: string

Definition at line 112 of file Error.php.

    {
        return $this->renderHtmlExceptionOrError($exception);
    }

References Slim\Handlers\Error\renderHtmlExceptionOrError().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderHtmlExceptionOrError()

Slim\Handlers\Error::renderHtmlExceptionOrError ( $exception )

protected

Render exception or error as HTML.

Parameters

\Exception | \Error $exception

Returns: string

Definition at line 124 of file Error.php.

    {
        if (!$exception instanceof \Exception && !$exception instanceof \Error) {
            throw new \RuntimeException("Unexpected type. Expected Exception or Error.");
        }
 
        $html = sprintf('<div><strong>Type:</strong> %s</div>', get_class($exception));
 
        if (($code = $exception->getCode())) {
            $html .= sprintf('<div><strong>Code:</strong> %s</div>', $code);
        }
 
        if (($message = $exception->getMessage())) {
            $html .= sprintf('<div><strong>Message:</strong> %s</div>', htmlentities($message));
        }
 
        if (($file = $exception->getFile())) {
            $html .= sprintf('<div><strong>File:</strong> %s</div>', $file);
        }
 
        if (($line = $exception->getLine())) {
            $html .= sprintf('<div><strong>Line:</strong> %s</div>', $line);
        }
 
        if (($trace = $exception->getTraceAsString())) {
            $html .= '<h2>Trace</h2>';
            $html .= sprintf('<pre>%s</pre>', htmlentities($trace));
        }
 
        return $html;
    }

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

Referenced by Slim\Handlers\Error\renderHtmlErrorMessage(), and Slim\Handlers\Error\renderHtmlException().

Here is the caller graph for this function:

◆ renderJsonErrorMessage()

Slim\Handlers\Error::renderJsonErrorMessage ( \Exception $exception )

protected

Render JSON error.

Parameters

\Exception $exception

Returns: string

Definition at line 163 of file Error.php.

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

References $error.

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

Here is the caller graph for this function:

◆ renderXmlErrorMessage()

Slim\Handlers\Error::renderXmlErrorMessage ( \Exception $exception )

protected

Render XML error.

Parameters

\Exception $exception

Returns: string

Definition at line 194 of file Error.php.

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