Inheritance diagram for Whoops\RunInterface:

Collaboration diagram for Whoops\RunInterface:

Public Member Functions
	pushHandler ($handler)
	Pushes a handler to the end of the stack. More...

	popHandler ()
	Removes the last handler in the stack and returns it. More...

	getHandlers ()
	Returns an array with all handlers, in the order they were added to the stack. More...

	clearHandlers ()
	Clears all handlers in the handlerStack, including the default PrettyPage handler. More...

	register ()
	Registers this instance as an error handler. More...

	unregister ()
	Unregisters all handlers registered by this Whoops instance. More...

	allowQuit ($exit=null)
	Should Whoops allow Handlers to force the script to quit? More...

	silenceErrorsInPaths ($patterns, $levels=10240)
	Silence particular errors in particular files. More...

	sendHttpCode ($code=null)
	Should Whoops send HTTP error code to the browser if possible? Whoops will by default send HTTP code 500, but you may wish to use 502, 503, or another 5xx family code. More...

	writeToOutput ($send=null)
	Should Whoops push output directly to the client? If this is false, output will be returned by handleException. More...

	handleException ($exception)
	Handles an exception, ultimately generating a Whoops error page. More...

	handleError ($level, $message, $file=null, $line=null)
	Converts generic PHP errors to instances, before passing them off to be handled. More...

	handleShutdown ()
	Special case to deal with Fatal errors and the like. More...

Data Fields
const	EXCEPTION_HANDLER = "handleException"

const	ERROR_HANDLER = "handleError"

const	SHUTDOWN_HANDLER = "handleShutdown"

Detailed Description

Definition at line 13 of file RunInterface.php.

Member Function Documentation

◆ allowQuit()

Whoops\RunInterface::allowQuit ( $exit = null )

Should Whoops allow Handlers to force the script to quit?

Parameters

bool | int $exit

Returns: bool

Implemented in Whoops\Run.

◆ clearHandlers()

Whoops\RunInterface::clearHandlers ( )

Clears all handlers in the handlerStack, including the default PrettyPage handler.

Returns: Run

Implemented in Whoops\Run.

◆ getHandlers()

Whoops\RunInterface::getHandlers ( )

Returns an array with all handlers, in the order they were added to the stack.

Returns: array

Implemented in Whoops\Run.

◆ handleError()

Whoops\RunInterface::handleError	(	$level,
		$message,
		$file = `null`,
		$line = `null`
	)

Converts generic PHP errors to instances, before passing them off to be handled.

This method MUST be compatible with set_error_handler.

Parameters

int	$level
string	$message
string	$file
int	$line

Returns: bool

Exceptions

ErrorException

Implemented in Whoops\Run.

◆ handleException()

Whoops\RunInterface::handleException ( $exception )

Handles an exception, ultimately generating a Whoops error page.

Parameters

\Throwable $exception

Returns: string Output generated by handlers

Implemented in Whoops\Run.

◆ handleShutdown()

Whoops\RunInterface::handleShutdown ( )

Special case to deal with Fatal errors and the like.

Implemented in Whoops\Run.

◆ popHandler()

Whoops\RunInterface::popHandler ( )

Removes the last handler in the stack and returns it.

Returns null if there"s nothing else to pop.

Returns: null|HandlerInterface

Implemented in Whoops\Run.

◆ pushHandler()

Whoops\RunInterface::pushHandler ( $handler )

Pushes a handler to the end of the stack.

Exceptions

InvalidArgumentException If argument is not callable or instance of HandlerInterface

Parameters

Callable | HandlerInterface $handler

Returns: Run

Implemented in Whoops\Run.

◆ register()

Whoops\RunInterface::register ( )

Registers this instance as an error handler.

Returns: Run

Implemented in Whoops\Run.

◆ sendHttpCode()

Whoops\RunInterface::sendHttpCode ( $code = null )

Should Whoops send HTTP error code to the browser if possible? Whoops will by default send HTTP code 500, but you may wish to use 502, 503, or another 5xx family code.

Parameters

bool | int $code

Returns: int|false

Implemented in Whoops\Run.

◆ silenceErrorsInPaths()

Whoops\RunInterface::silenceErrorsInPaths	(	$patterns,
		$levels = `10240`
	)

Silence particular errors in particular files.

Parameters

array \| string	$patterns	List or a single regex pattern to match
int	$levels	Defaults to E_STRICT \| E_DEPRECATED

Returns

Implemented in Whoops\Run.

◆ unregister()

Whoops\RunInterface::unregister ( )

Unregisters all handlers registered by this Whoops instance.

Returns: Run

Implemented in Whoops\Run.

◆ writeToOutput()

Whoops\RunInterface::writeToOutput ( $send = null )

Should Whoops push output directly to the client? If this is false, output will be returned by handleException.

Parameters

bool | int $send

Returns: bool

Implemented in Whoops\Run.

Field Documentation

◆ ERROR_HANDLER

const Whoops\RunInterface::ERROR_HANDLER = "handleError"

Definition at line 16 of file RunInterface.php.

◆ EXCEPTION_HANDLER

const Whoops\RunInterface::EXCEPTION_HANDLER = "handleException"

Definition at line 15 of file RunInterface.php.

◆ SHUTDOWN_HANDLER

const Whoops\RunInterface::SHUTDOWN_HANDLER = "handleShutdown"

Definition at line 17 of file RunInterface.php.

The documentation for this interface was generated from the following file:

libs/composer/vendor/filp/whoops/src/Whoops/RunInterface.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ allowQuit()

◆ clearHandlers()

◆ getHandlers()

◆ handleError()

◆ handleException()

◆ handleShutdown()

◆ popHandler()

◆ pushHandler()

◆ register()

◆ sendHttpCode()

◆ silenceErrorsInPaths()

◆ unregister()

◆ writeToOutput()

Field Documentation

◆ ERROR_HANDLER

◆ EXCEPTION_HANDLER

◆ SHUTDOWN_HANDLER