Inheritance diagram for Whoops\Run:

Collaboration diagram for Whoops\Run:

Public Member Functions
	__construct (SystemFacade $system=null)

	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\Run 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...

	getSilenceErrorsInPaths ()
	Returns an array with silent errors in path configuration. 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 \ErrorException instances, before passing them off to be handled. More...

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

	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\Run 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 \ErrorException instances, before passing them off to be handled. More...

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

Private Member Functions
	getInspector ($exception)

	writeToOutputNow ($output)
	Echo something to the browser. More...

Private Attributes
	$isRegistered

	$allowQuit = true

	$sendOutput = true

	$sendHttpCode = 500

	$handlerStack = []

	$silencedPatterns = []

	$system

	$canThrowExceptions = true

Additional Inherited Members
Data Fields inherited from Whoops\RunInterface
const	EXCEPTION_HANDLER = "handleException"

const	ERROR_HANDLER = "handleError"

const	SHUTDOWN_HANDLER = "handleShutdown"

Detailed Description

Definition at line 18 of file Run.php.

Constructor & Destructor Documentation

◆ __construct()

Whoops\Run::__construct ( SystemFacade $system = null )

Definition at line 38 of file Run.php.

    {
        $this->system = $system ?: new SystemFacade;
    }

Member Function Documentation

◆ allowQuit()

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

Should Whoops allow Handlers to force the script to quit?

Parameters

bool | int $exit

Returns: bool

Implements Whoops\RunInterface.

Definition at line 152 of file Run.php.

    {
        if (func_num_args() == 0) {
            return $this->allowQuit;
        }
 
        return $this->allowQuit = (bool) $exit;
    }

◆ clearHandlers()

Whoops\Run::clearHandlers ( )

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

Returns: Run

Implements Whoops\RunInterface.

Definition at line 92 of file Run.php.

    {
        $this->handlerStack = [];
        return $this;
    }

◆ getHandlers()

Whoops\Run::getHandlers ( )

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

Returns: array

Implements Whoops\RunInterface.

Definition at line 82 of file Run.php.

    {
        return $this->handlerStack;
    }

◆ getInspector()

Whoops\Run::getInspector ( $exception )

private

Parameters

\Throwable $exception

Returns: Inspector

Definition at line 102 of file Run.php.

    {
        return new Inspector($exception);
    }

◆ getSilenceErrorsInPaths()

Whoops\Run::getSilenceErrorsInPaths ( )

Returns an array with silent errors in path configuration.

Returns: array

Definition at line 190 of file Run.php.

    {
        return $this->silencedPatterns;
    }

◆ handleError()

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

Converts generic PHP errors to \ErrorException 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

Implements Whoops\RunInterface.

Definition at line 334 of file Run.php.

    {
        if ($level & $this->system->getErrorReportingLevel()) {
            foreach ($this->silencedPatterns as $entry) {
                $pathMatches = (bool) preg_match($entry["pattern"], $file);
                $levelMatches = $level & $entry["levels"];
                if ($pathMatches && $levelMatches) {
                    // Ignore the error, abort handling
                    // See https://github.com/filp/whoops/issues/418
                    return true;
                }
            }
 
            // XXX we pass $level for the "code" param only for BC reasons.
            // see https://github.com/filp/whoops/issues/267
            $exception = new ErrorException($message, /*code*/ $level, /*severity*/ $level, $file, $line);
            if ($this->canThrowExceptions) {
                throw $exception;
            } else {
                $this->handleException($exception);
            }
            // Do not propagate errors which were already handled by Whoops.
            return true;
        }
 
        // Propagate error to the next handler, allows error_get_last() to
        // work on silenced errors.
        return false;
    }

References $message.

◆ handleException()

Whoops\Run::handleException ( $exception )

Handles an exception, ultimately generating a Whoops error page.

Parameters

\Throwable $exception

Returns: string Output generated by handlers

Implements Whoops\RunInterface.

Definition at line 248 of file Run.php.

    {
        // Walk the registered handlers in the reverse order
        // they were registered, and pass off the exception
        $inspector = $this->getInspector($exception);
 
        // Capture output produced while handling the exception,
        // we might want to send it straight away to the client,
        // or return it silently.
        $this->system->startOutputBuffering();
 
        // Just in case there are no handlers:
        $handlerResponse = null;
        $handlerContentType = null;
 
        foreach (array_reverse($this->handlerStack) as $handler) {
            $handler->setRun($this);
            $handler->setInspector($inspector);
            $handler->setException($exception);
 
            // The HandlerInterface does not require an Exception passed to handle()
            // and neither of our bundled handlers use it.
            // However, 3rd party handlers may have already relied on this parameter,
            // and removing it would be possibly breaking for users.
            $handlerResponse = $handler->handle($exception);
 
            // Collect the content type for possible sending in the headers.
            $handlerContentType = method_exists($handler, 'contentType') ? $handler->contentType() : null;
 
            if (in_array($handlerResponse, [Handler::LAST_HANDLER, Handler::QUIT])) {
                // The Handler has handled the exception in some way, and
                // wishes to quit execution (Handler::QUIT), or skip any
                // other handlers (Handler::LAST_HANDLER). If $this->allowQuit
                // is false, Handler::QUIT behaves like Handler::LAST_HANDLER
                break;
            }
        }
 
        $willQuit = $handlerResponse == Handler::QUIT && $this->allowQuit();
 
        $output = $this->system->cleanOutputBuffer();
 
        // If we're allowed to, send output generated by handlers directly
        // to the output, otherwise, and if the script doesn't quit, return
        // it so that it may be used by the caller
        if ($this->writeToOutput()) {
            // @todo Might be able to clean this up a bit better
            if ($willQuit) {
                // Cleanup all other output buffers before sending our output:
                while ($this->system->getOutputBufferLevel() > 0) {
                    $this->system->endOutputBuffering();
                }
 
                // Send any headers if needed:
                if (Misc::canSendHeaders() && $handlerContentType) {
                    header("Content-Type: {$handlerContentType}");
                }
            }
 
            $this->writeToOutputNow($output);
        }
 
        if ($willQuit) {
            // HHVM fix for https://github.com/facebook/hhvm/issues/4055
            $this->system->flushOutputBuffer();
 
            $this->system->stopExecution(1);
        }
 
        return $output;
    }

References $handler, and Sabre\VObject\$output.

◆ handleShutdown()

Whoops\Run::handleShutdown ( )

Special case to deal with Fatal errors and the like.

Implements Whoops\RunInterface.

Definition at line 367 of file Run.php.

    {
        // If we reached this step, we are in shutdown handler.
        // An exception thrown in a shutdown handler will not be propagated
        // to the exception handler. Pass that information along.
        $this->canThrowExceptions = false;
 
        $error = $this->system->getLastError();
        if ($error && Misc::isLevelFatal($error['type'])) {
            // If there was a fatal error,
            // it was not handled in handleError yet.
            $this->handleError(
                $error['type'],
                $error['message'],
                $error['file'],
                $error['line']
            );
        }
    }

◆ popHandler()

Whoops\Run::popHandler ( )

Removes the last handler in the stack and returns it.

Returns null if there"s nothing else to pop.

Returns: null|HandlerInterface

Implements Whoops\RunInterface.

Definition at line 72 of file Run.php.

    {
        return array_pop($this->handlerStack);
    }

◆ pushHandler()

Whoops\Run::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

Implements Whoops\RunInterface.

Definition at line 50 of file Run.php.

    {
        if (is_callable($handler)) {
            $handler = new CallbackHandler($handler);
        }
 
        if (!$handler instanceof HandlerInterface) {
            throw new InvalidArgumentException(
                  "Argument to " . __METHOD__ . " must be a callable, or instance of "
                . "Whoops\\Handler\\HandlerInterface"
            );
        }
 
        $this->handlerStack[] = $handler;
        return $this;
    }

References $handler.

◆ register()

Whoops\Run::register ( )

Registers this instance as an error handler.

Returns: Run

Implements Whoops\RunInterface.

Definition at line 111 of file Run.php.

    {
        if (!$this->isRegistered) {
            // Workaround PHP bug 42098
            // https://bugs.php.net/bug.php?id=42098
            class_exists("\\Whoops\\Exception\\ErrorException");
            class_exists("\\Whoops\\Exception\\FrameCollection");
            class_exists("\\Whoops\\Exception\\Frame");
            class_exists("\\Whoops\\Exception\\Inspector");
 
            $this->system->setErrorHandler([$this, self::ERROR_HANDLER]);
            $this->system->setExceptionHandler([$this, self::EXCEPTION_HANDLER]);
            $this->system->registerShutdownFunction([$this, self::SHUTDOWN_HANDLER]);
 
            $this->isRegistered = true;
        }
 
        return $this;
    }

◆ sendHttpCode()

Whoops\Run::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

Implements Whoops\RunInterface.

Definition at line 203 of file Run.php.

    {
        if (func_num_args() == 0) {
            return $this->sendHttpCode;
        }
 
        if (!$code) {
            return $this->sendHttpCode = false;
        }
 
        if ($code === true) {
            $code = 500;
        }
 
        if ($code < 400 || 600 <= $code) {
            throw new InvalidArgumentException(
                 "Invalid status code '$code', must be 4xx or 5xx"
            );
        }
 
        return $this->sendHttpCode = $code;
    }

References $code.

◆ silenceErrorsInPaths()

Whoops\Run::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: \Whoops\Run

Implements Whoops\RunInterface.

Definition at line 167 of file Run.php.

    {
        $this->silencedPatterns = array_merge(
            $this->silencedPatterns,
            array_map(
                function ($pattern) use ($levels) {
                    return [
                        "pattern" => $pattern,
                        "levels" => $levels,
                    ];
                },
                (array) $patterns
            )
        );
        return $this;
    }

◆ unregister()

Whoops\Run::unregister ( )

Unregisters all handlers registered by this Whoops\Run instance.

Returns: Run

Implements Whoops\RunInterface.

Definition at line 135 of file Run.php.

    {
        if ($this->isRegistered) {
            $this->system->restoreExceptionHandler();
            $this->system->restoreErrorHandler();
 
            $this->isRegistered = false;
        }
 
        return $this;
    }

◆ writeToOutput()

Whoops\Run::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

Implements Whoops\RunInterface.

Definition at line 232 of file Run.php.

    {
        if (func_num_args() == 0) {
            return $this->sendOutput;
        }
 
        return $this->sendOutput = (bool) $send;
    }

◆ writeToOutputNow()

Whoops\Run::writeToOutputNow ( $output )

private

Echo something to the browser.

Parameters

string $output

Returns: $this

Definition at line 398 of file Run.php.

    {
        if ($this->sendHttpCode() && \Whoops\Util\Misc::canSendHeaders()) {
            $this->system->setHttpResponseCode(
                $this->sendHttpCode()
            );
        }
 
        echo $output;
 
        return $this;
    }

References Sabre\VObject\$output.

Field Documentation

◆ $allowQuit

Whoops\Run::$allowQuit = true

private

Definition at line 21 of file Run.php.

◆ $canThrowExceptions

Whoops\Run::$canThrowExceptions = true

private

Definition at line 391 of file Run.php.

◆ $handlerStack

Whoops\Run::$handlerStack = []

private

Definition at line 32 of file Run.php.

◆ $isRegistered

Whoops\Run::$isRegistered

private

Definition at line 20 of file Run.php.

◆ $sendHttpCode

Whoops\Run::$sendHttpCode = 500

private

Definition at line 27 of file Run.php.

◆ $sendOutput

Whoops\Run::$sendOutput = true

private

Definition at line 22 of file Run.php.

◆ $silencedPatterns

Whoops\Run::$silencedPatterns = []

private

Definition at line 34 of file Run.php.

◆ $system

Whoops\Run::$system

private

Definition at line 36 of file Run.php.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowQuit()

◆ clearHandlers()

◆ getHandlers()

◆ getInspector()

◆ getSilenceErrorsInPaths()

◆ handleError()

◆ handleException()

◆ handleShutdown()

◆ popHandler()

◆ pushHandler()

◆ register()

◆ sendHttpCode()

◆ silenceErrorsInPaths()

◆ unregister()

◆ writeToOutput()

◆ writeToOutputNow()

Field Documentation

◆ $allowQuit

◆ $canThrowExceptions

◆ $handlerStack

◆ $isRegistered

◆ $sendHttpCode

◆ $sendOutput

◆ $silencedPatterns

◆ $system