Collaboration diagram for Whoops\Run:

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\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)

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

	handleException (Exception $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...

Data Fields
const	EXCEPTION_HANDLER = "handleException"

const	ERROR_HANDLER = "handleError"

const	SHUTDOWN_HANDLER = "handleShutdown"

Protected Member Functions
	getInspector (Exception $exception)

Protected Attributes
	$isRegistered

	$allowQuit = true

	$sendOutput = true

	$sendHttpCode = 500

	$handlerStack = array()

	$silencedPatterns = array()

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

Static Private Member Functions
static	isLevelFatal ($level)

Private Attributes
	$canThrowExceptions = true

Detailed Description

Definition at line 17 of file Run.php.

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

Definition at line 148 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

Definition at line 88 of file Run.php.

    {
        $this->handlerStack = array();
        return $this;
    }

◆ getHandlers()

Whoops\Run::getHandlers ( )

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

Returns: array

Definition at line 78 of file Run.php.

    {
        return $this->handlerStack;
    }

◆ getInspector()

Whoops\Run::getInspector ( Exception $exception )

protected

Parameters

Exception $exception

Returns: Inspector

Definition at line 98 of file Run.php.

    {
        return new Inspector($exception);
    }

◆ 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

Definition at line 309 of file Run.php.

    {
        if ($level & error_reporting()) {
            foreach ($this->silencedPatterns as $entry) {
                $pathMatches = (bool) preg_match($entry["pattern"], $file);
                $levelMatches = $level & $entry["levels"];
                if ($pathMatches && $levelMatches) {
                    // Ignore the error, abort handling
                    return true;
                }
            }
 
            $exception = new ErrorException($message, $level, 0, $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 $file.

◆ handleException()

Whoops\Run::handleException ( Exception $exception )

Handles an exception, ultimately generating a Whoops error page.

Parameters

Exception $exception

Returns: string Output generated by handlers

Definition at line 233 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.
        ob_start();
 
        // Just in case there are no handlers:
        $handlerResponse = 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);
 
            if (in_array($handlerResponse, array(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 = ob_get_clean();
 
        // 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 we're going to quit execution, cleanup all other output
            // buffers before sending our own output:
            if ($willQuit) {
                while (ob_get_level() > 0) {
                    ob_end_clean();
                }
            }
 
            $this->writeToOutputNow($output);
        }
 
        if ($willQuit) {
            flush(); // HHVM fix for https://github.com/facebook/hhvm/issues/4055
            exit(1);
        }
 
        return $output;
    }

References exit.

◆ handleShutdown()

Whoops\Run::handleShutdown ( )

Special case to deal with Fatal errors and the like.

Definition at line 339 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 = error_get_last();
        if ($error && $this->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']
            );
        }
    }

◆ isLevelFatal()

static Whoops\Run::isLevelFatal ( $level )

staticprivate

Definition at line 396 of file Run.php.

    {
        $errors = E_ERROR;
        $errors |= E_PARSE;
        $errors |= E_CORE_ERROR;
        $errors |= E_CORE_WARNING;
        $errors |= E_COMPILE_ERROR;
        $errors |= E_COMPILE_WARNING;
        return ($level & $errors) > 0;
    }

References $errors.

◆ 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

Definition at line 68 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

Definition at line 46 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;
    }

◆ register()

Whoops\Run::register ( )

Registers this instance as an error handler.

Returns: Run

Definition at line 107 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");
 
            set_error_handler(array($this, self::ERROR_HANDLER));
            set_exception_handler(array($this, self::EXCEPTION_HANDLER));
            register_shutdown_function(array($this, self::SHUTDOWN_HANDLER));
 
            $this->isRegistered = true;
        }
 
        return $this;
    }

◆ sendHttpCode()

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

Definition at line 188 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

Definition at line 163 of file Run.php.

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

◆ unregister()

Whoops\Run::unregister ( )

Unregisters all handlers registered by this Whoops\Run instance.

Returns: Run

Definition at line 131 of file Run.php.

    {
        if ($this->isRegistered) {
            restore_exception_handler();
            restore_error_handler();
 
            $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

Definition at line 217 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 370 of file Run.php.

    {
        if ($this->sendHttpCode() && \Whoops\Util\Misc::canSendHeaders()) {
            $httpCode   = $this->sendHttpCode();
 
            if (function_exists('http_response_code')) {
                http_response_code($httpCode);
            } else {
                // http_response_code is added in 5.4.
                // For compatibility with 5.3 we use the third argument in header call
                // First argument must be a real header.
                // If it is empty, PHP will ignore the third argument.
                // If it is invalid, such as a single space, Apache will handle it well,
                // but the PHP development server will hang.
                // Setting a full status line would require us to hardcode
                // string values for all different status code, and detect the protocol.
                // which is an extra error-prone complexity.
                header('X-Ignore-This: 1', true, $httpCode);
            }
        }
 
        echo $output;
 
        return $this;
    }

Field Documentation

◆ $allowQuit

Whoops\Run::$allowQuit = true

protected

Definition at line 24 of file Run.php.

◆ $canThrowExceptions

Whoops\Run::$canThrowExceptions = true

private

Definition at line 363 of file Run.php.

◆ $handlerStack

Whoops\Run::$handlerStack = array()

protected

Definition at line 35 of file Run.php.

◆ $isRegistered

Whoops\Run::$isRegistered

protected

Definition at line 23 of file Run.php.

◆ $sendHttpCode

Whoops\Run::$sendHttpCode = 500

protected

Definition at line 30 of file Run.php.

◆ $sendOutput

Whoops\Run::$sendOutput = true

protected

Definition at line 25 of file Run.php.

◆ $silencedPatterns

Whoops\Run::$silencedPatterns = array()

protected

Definition at line 37 of file Run.php.

◆ ERROR_HANDLER

const Whoops\Run::ERROR_HANDLER = "handleError"

Definition at line 20 of file Run.php.

◆ EXCEPTION_HANDLER

const Whoops\Run::EXCEPTION_HANDLER = "handleException"

Definition at line 19 of file Run.php.

◆ SHUTDOWN_HANDLER

const Whoops\Run::SHUTDOWN_HANDLER = "handleShutdown"

Definition at line 21 of file Run.php.

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

Services/Exceptions/lib/Whoops/Run.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ allowQuit()

◆ clearHandlers()

◆ getHandlers()

◆ getInspector()

◆ handleError()

◆ handleException()

◆ handleShutdown()

◆ isLevelFatal()

◆ popHandler()

◆ pushHandler()

◆ register()

◆ sendHttpCode()

◆ silenceErrorsInPaths()

◆ unregister()

◆ writeToOutput()

◆ writeToOutputNow()

Field Documentation

◆ $allowQuit

◆ $canThrowExceptions

◆ $handlerStack

◆ $isRegistered

◆ $sendHttpCode

◆ $sendOutput

◆ $silencedPatterns

◆ ERROR_HANDLER

◆ EXCEPTION_HANDLER

◆ SHUTDOWN_HANDLER