Abstract Slim application error handler. More...

Inheritance diagram for Slim\Handlers\AbstractError:

Collaboration diagram for Slim\Handlers\AbstractError:

Public Member Functions
	__construct ($displayErrorDetails=false)
	Constructor. More...

Protected Member Functions
	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...

Protected Attributes
	$displayErrorDetails

Protected Attributes inherited from Slim\Handlers\AbstractHandler
	$knownContentTypes

Detailed Description

Abstract Slim application error handler.

Definition at line 14 of file AbstractError.php.

Constructor & Destructor Documentation

◆ __construct()

Slim\Handlers\AbstractError::__construct ( $displayErrorDetails = false )

Constructor.

Parameters

bool $displayErrorDetails Set to true to display full details

Definition at line 26 of file AbstractError.php.

    {
        $this->displayErrorDetails = (bool) $displayErrorDetails;
    }

References Slim\Handlers\AbstractError\$displayErrorDetails.

Member Function Documentation

◆ logError()

Slim\Handlers\AbstractError::logError ( $message )

protected

Wraps the error_log function so that this can be easily tested.

Parameters

$message

Definition at line 95 of file AbstractError.php.

    {
        error_log($message);
    }

References $message, and Monolog\Handler\error_log().

Referenced by Slim\Handlers\AbstractError\writeToErrorLog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderThrowableAsText()

Slim\Handlers\AbstractError::renderThrowableAsText ( $throwable )

protected

Render error as Text.

Parameters

\Exception | \Throwable $throwable

Returns: string

Definition at line 63 of file AbstractError.php.

    {
        $text = sprintf('Type: %s' . PHP_EOL, get_class($throwable));
 
        if ($code = $throwable->getCode()) {
            $text .= sprintf('Code: %s' . PHP_EOL, $code);
        }
 
        if ($message = $throwable->getMessage()) {
            $text .= sprintf('Message: %s' . PHP_EOL, htmlentities($message));
        }
 
        if ($file = $throwable->getFile()) {
            $text .= sprintf('File: %s' . PHP_EOL, $file);
        }
 
        if ($line = $throwable->getLine()) {
            $text .= sprintf('Line: %s' . PHP_EOL, $line);
        }
 
        if ($trace = $throwable->getTraceAsString()) {
            $text .= sprintf('Trace: %s', $trace);
        }
 
        return $text;
    }

References $code, $message, $text, and PHP_EOL.

Referenced by Slim\Handlers\AbstractError\writeToErrorLog().

Here is the caller graph for this function:

◆ writeToErrorLog()

Slim\Handlers\AbstractError::writeToErrorLog ( $throwable )

protected

Write to the error log if displayErrorDetails is false.

Parameters

\Exception | \Throwable $throwable

Returns: void

Definition at line 38 of file AbstractError.php.

    {
        if ($this->displayErrorDetails) {
            return;
        }
 
        $message = 'Slim Application Error:' . PHP_EOL;
        $message .= $this->renderThrowableAsText($throwable);
        while ($throwable = $throwable->getPrevious()) {
            $message .= PHP_EOL . 'Previous error:' . PHP_EOL;
            $message .= $this->renderThrowableAsText($throwable);
        }
 
        $message .= PHP_EOL . 'View in rendered output by enabling the "displayErrorDetails" setting.' . PHP_EOL;
 
        $this->logError($message);
    }