1. class
  2. mako
  3. \
  4. error
  5. \
  6. ErrorHandler

ErrorHandler

class ErrorHandler

Error handler.

Properties

protected Container $container Container.
protected bool $disableShutdownHandler Is the shutdown handler disabled?
protected array $handlers Exception handlers.
protected Closure|LoggerInterface|null $logger Logger instance.
protected array $dontLog Exception types that shouldn't be logged.

Methods

__construct(Container|null $container = null)

Constructor.

bool
displayErrors()

Should errors be displayed?

write(string $output)

Write to output.

Closure
getFallbackHandler()

Returns the fallback handler.

register()

Registers the exception handler.

setLogger(Closure|LoggerInterface $logger)

Set logger instance or closure that returns a logger instance.

LoggerInterface|null
getLogger()

Return logger instance.

dontLog(array|string $exceptionType)

Disables logging for an exception type.

disableShutdownHandler()

Disables the shutdown handler.

handle(string $exceptionType, Closure|string $handler)

Prepends an exception handler to the stack.

clearHandlers(string $exceptionType)

Clears all error handlers for an exception type.

replaceHandlers(string $exceptionType, Closure $handler)

Replaces all error handlers for an exception type with a new one.

clearOutputBuffers()

Clear output buffers.

bool
shouldExceptionBeLogged(Throwable $exception)

Should the exception be logged?

HandlerInterface
handlerFactory(string $handler)

Creates and returns an error handler instance.

mixed
handleException(Closure|string $handler, Throwable $exception)

Handle the exception.

handler(Throwable $exception)

Handles uncaught exceptions.

Details

at line 80
__construct(Container|null $container = null)

Constructor.

Parameters

Container|null $container Container

at line 98
protected bool displayErrors()

Should errors be displayed?

Return Value

bool

at line 115
protected write(string $output)

Write to output.

Parameters

string $output String to write to output

at line 132
protected Closure getFallbackHandler()

Returns the fallback handler.

Return Value

Closure

at line 148
protected register()

Registers the exception handler.

at line 172
setLogger(Closure|LoggerInterface $logger)

Set logger instance or closure that returns a logger instance.

Parameters

Closure|LoggerInterface $logger Logger

at line 182
LoggerInterface|null getLogger()

Return logger instance.

Return Value

LoggerInterface|null

at line 197
dontLog(array|string $exceptionType)

Disables logging for an exception type.

Parameters

array|string $exceptionType Exception type or array of exception types

at line 205
disableShutdownHandler()

Disables the shutdown handler.

at line 216
handle(string $exceptionType, Closure|string $handler)

Prepends an exception handler to the stack.

Parameters

string $exceptionType Exception type
Closure|string $handler Exception handler

at line 226
clearHandlers(string $exceptionType)

Clears all error handlers for an exception type.

Parameters

string $exceptionType Exception type

at line 243
replaceHandlers(string $exceptionType, Closure $handler)

Replaces all error handlers for an exception type with a new one.

Parameters

string $exceptionType Exception type
Closure $handler Exception handler

at line 253
protected clearOutputBuffers()

Clear output buffers.

at line 264
protected bool shouldExceptionBeLogged(Throwable $exception)

Should the exception be logged?

Parameters

Throwable $exception An exception object

Return Value

bool

at line 288
protected HandlerInterface handlerFactory(string $handler)

Creates and returns an error handler instance.

Parameters

string $handler Handler class name

Return Value

HandlerInterface

at line 300
protected mixed handleException(Closure|string $handler, Throwable $exception)

Handle the exception.

Parameters

Closure|string $handler Exception handler
Throwable $exception Exceotion

Return Value

mixed

at line 315
handler(Throwable $exception)

Handles uncaught exceptions.

Parameters

Throwable $exception An exception object