Inheritance diagram for Whoops\Handler\PrettyPageHandler:

Collaboration diagram for Whoops\Handler\PrettyPageHandler:

Public Member Functions
	__construct ()
	Constructor. More...

	handle ()

	contentType ()

	addDataTable ($label, array $data)
	Adds an entry to the list of tables displayed in the template. More...

	addDataTableCallback ($label, $callback)
	Lazily adds an entry to the list of tables displayed in the table. More...

	getDataTables ($label=null)
	Returns all the extra data tables registered with this handler. More...

	handleUnconditionally ($value=null)
	Allows to disable all attempts to dynamically decide whether to handle or return prematurely. More...

	addEditor ($identifier, $resolver)

	setEditor ($editor)

	getEditorHref ($filePath, $line)
	Given a string file path, and an integer file line, executes the editor resolver and returns, if available, a string that may be used as the href property for that file reference. More...

	getEditorAjax ($filePath, $line)
	Given a boolean if the editor link should act as an Ajax request. More...

	setPageTitle ($title)

	getPageTitle ()

	addResourcePath ($path)
	Adds a path to the list of paths to be searched for resources. More...

	addCustomCss ($name)
	Adds a custom css file to be loaded. More...

	getResourcePaths ()

	getResourcesPath ()

	setResourcesPath ($resourcesPath)

	getApplicationPaths ()
	Return the application paths. More...

	setApplicationPaths ($applicationPaths)
	Set the application paths. More...

	setApplicationRootPath ($applicationRootPath)
	Set the application root path. More...

	blacklist ($superGlobalName, $key)
	blacklist a sensitive value within one of the superglobal arrays. More...

Public Member Functions inherited from Whoops\Handler\Handler
	setRun (RunInterface $run)

	setInspector (Inspector $inspector)

	setException ($exception)

	handle ()

	setRun (RunInterface $run)

	setException ($exception)

	setInspector (Inspector $inspector)

Protected Member Functions
	getExceptionFrames ()
	Get the stack trace frames of the exception that is currently being handled. More...

	getExceptionCode ()
	Get the code of the exception that is currently being handled. More...

	getEditor ($filePath, $line)
	Given a boolean if the editor link should act as an Ajax request. More...

	getResource ($resource)
	Finds a resource, by its relative path, in all available search paths. More...

Protected Member Functions inherited from Whoops\Handler\Handler
	getRun ()

	getInspector ()

	getException ()

Protected Attributes
	$editor

	$editors

Private Member Functions
	masked (array $superGlobal, $superGlobalName)
	Checks all values within the given superGlobal array. More...

Private Attributes
	$searchPaths = []

	$resourceCache = []

	$customCss = null

	$extraTables = []

	$handleUnconditionally = false

	$pageTitle = "Whoops! There was an error."

	$applicationPaths

	$blacklist

	$templateHelper

Additional Inherited Members
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10

const	LAST_HANDLER = 0x20
	The Handler has handled the Throwable in some way, and wishes to skip any other Handler. More...

const	QUIT = 0x30
	The Handler has handled the Throwable in some way, and wishes to quit/stop execution. More...

Detailed Description

Definition at line 18 of file PrettyPageHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Whoops\Handler\PrettyPageHandler::__construct ( )

Constructor.

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 109 of file PrettyPageHandler.php.

    {
        if (ini_get('xdebug.file_link_format') || extension_loaded('xdebug')) {
            // Register editor using xdebug's file_link_format option.
            $this->editors['xdebug'] = function ($file, $line) {
                return str_replace(['%f', '%l'], [$file, $line], ini_get('xdebug.file_link_format'));
            };
        }
 
        // Add the default, local resource search path:
        $this->searchPaths[] = __DIR__ . "/../Resources";
 
        // blacklist php provided auth based values
        $this->blacklist('_SERVER', 'PHP_AUTH_PW');
 
        $this->templateHelper = new TemplateHelper();
 
        if (class_exists('Symfony\Component\VarDumper\Cloner\VarCloner')) {
            $cloner = new VarCloner();
            // Only dump object internals if a custom caster exists.
            $cloner->addCasters(['*' => function ($obj, $a, $stub, $isNested, $filter = 0) {
                $class = $stub->class;
                $classes = [$class => $class] + class_parents($class) + class_implements($class);
 
                foreach ($classes as $class) {
                    if (isset(AbstractCloner::$defaultCasters[$class])) {
                        return $a;
                    }
                }
 
                // Remove all internals
                return [];
            }]);
            $this->templateHelper->setCloner($cloner);
        }
    }

References Whoops\Handler\PrettyPageHandler\blacklist().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomCss()

Whoops\Handler\PrettyPageHandler::addCustomCss ( $name )

Adds a custom css file to be loaded.

Parameters

string $name

Returns: void

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 568 of file PrettyPageHandler.php.

    {
        $this->customCss = $name;
    }

References $name.

◆ addDataTable()

Whoops\Handler\PrettyPageHandler::addDataTable	(		$label,
		array	$data
	)

Adds an entry to the list of tables displayed in the template.

The expected data is a simple associative array. Any nested arrays will be flattened with print_r

Parameters

string	$label
array	$data

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 310 of file PrettyPageHandler.php.

    {
        $this->extraTables[$label] = $data;
    }

References $data.

◆ addDataTableCallback()

Whoops\Handler\PrettyPageHandler::addDataTableCallback	(	$label,
		$callback
	)

Lazily adds an entry to the list of tables displayed in the table.

The supplied callback argument will be called when the error is rendered, it should produce a simple associative array. Any nested arrays will be flattened with print_r.

Exceptions

InvalidArgumentException If $callback is not callable

Parameters

string	$label
callable	$callback	Callable returning an associative array

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 325 of file PrettyPageHandler.php.

    {
        if (!is_callable($callback)) {
            throw new InvalidArgumentException('Expecting callback argument to be callable');
        }
 
        $this->extraTables[$label] = function (\Whoops\Exception\Inspector $inspector = null) use ($callback) {
            try {
                $result = call_user_func($callback, $inspector);
 
                // Only return the result if it can be iterated over by foreach().
                return is_array($result) || $result instanceof \Traversable ? $result : [];
            } catch (\Exception $e) {
                // Don't allow failure to break the rendering of the original exception.
                return [];
            }
        };
    }

References Whoops\Handler\Handler\$inspector, and $result.

◆ addEditor()

Whoops\Handler\PrettyPageHandler::addEditor	(	$identifier,
		$resolver
	)

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 393 of file PrettyPageHandler.php.

    {
        $this->editors[$identifier] = $resolver;
    }

◆ addResourcePath()

Whoops\Handler\PrettyPageHandler::addResourcePath ( $path )

Adds a path to the list of paths to be searched for resources.

Exceptions

InvalidArgumentException If $path is not a valid directory

Parameters

string $path

Returns: void

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 551 of file PrettyPageHandler.php.

    {
        if (!is_dir($path)) {
            throw new InvalidArgumentException(
                "'$path' is not a valid directory"
            );
        }
 
        array_unshift($this->searchPaths, $path);
    }

References $path.

Referenced by Whoops\Handler\PrettyPageHandler\setResourcesPath().

Here is the caller graph for this function:

◆ blacklist()

Whoops\Handler\PrettyPageHandler::blacklist	(	$superGlobalName,
		$key
	)

blacklist a sensitive value within one of the superglobal arrays.

Parameters

$superGlobalName	string the name of the superglobal array, e.g. '_GET'
$key	string the key within the superglobal

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 679 of file PrettyPageHandler.php.

    {
        $this->blacklist[$superGlobalName][] = $key;
    }

References $key, and Whoops\Handler\PrettyPageHandler\blacklist().

Referenced by Whoops\Handler\PrettyPageHandler\__construct(), Whoops\Handler\PrettyPageHandler\blacklist(), and Whoops\Handler\PrettyPageHandler\masked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ contentType()

Whoops\Handler\PrettyPageHandler::contentType ( )

Returns: string

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 298 of file PrettyPageHandler.php.

    {
        return 'text/html';
    }

◆ getApplicationPaths()

Whoops\Handler\PrettyPageHandler::getApplicationPaths ( )

Return the application paths.

Returns: array

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 648 of file PrettyPageHandler.php.

    {
        return $this->applicationPaths;
    }

References Whoops\Handler\PrettyPageHandler\$applicationPaths.

Referenced by Whoops\Handler\PrettyPageHandler\getExceptionFrames(), and Whoops\Handler\PrettyPageHandler\handle().

Here is the caller graph for this function:

◆ getDataTables()

Whoops\Handler\PrettyPageHandler::getDataTables ( $label = null )

Returns all the extra data tables registered with this handler.

Optionally accepts a 'label' parameter, to only return the data table under that label.

Parameters

string | null $label

Returns: array[]|callable

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 351 of file PrettyPageHandler.php.

    {
        if ($label !== null) {
            return isset($this->extraTables[$label]) ?
                   $this->extraTables[$label] : [];
        }
 
        return $this->extraTables;
    }

References Whoops\Handler\PrettyPageHandler\$extraTables.

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the caller graph for this function:

◆ getEditor()

Whoops\Handler\PrettyPageHandler::getEditor	(	$filePath,
		$line
	)

protected

Given a boolean if the editor link should act as an Ajax request.

The editor must be a valid callable function/closure

Parameters

string	$filePath
int	$line

Returns: array

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 489 of file PrettyPageHandler.php.

    {
        if (!$this->editor || (!is_string($this->editor) && !is_callable($this->editor))) {
            return [];
        }
 
        if (is_string($this->editor) && isset($this->editors[$this->editor]) && !is_callable($this->editors[$this->editor])) {
            return [
                'ajax' => false,
                'url' => $this->editors[$this->editor],
            ];
        }
 
        if (is_callable($this->editor) || (isset($this->editors[$this->editor]) && is_callable($this->editors[$this->editor]))) {
            if (is_callable($this->editor)) {
                $callback = call_user_func($this->editor, $filePath, $line);
            } else {
                $callback = call_user_func($this->editors[$this->editor], $filePath, $line);
            }
 
            if (is_string($callback)) {
                return [
                    'ajax' => false,
                    'url' => $callback,
                ];
            }
 
            return [
                'ajax' => isset($callback['ajax']) ? $callback['ajax'] : false,
                'url' => isset($callback['url']) ? $callback['url'] : $callback,
            ];
        }
 
        return [];
    }

References Whoops\Handler\PrettyPageHandler\$editor.

Referenced by Whoops\Handler\PrettyPageHandler\getEditorAjax(), and Whoops\Handler\PrettyPageHandler\getEditorHref().

Here is the caller graph for this function:

◆ getEditorAjax()

Whoops\Handler\PrettyPageHandler::getEditorAjax	(	$filePath,
		$line
	)

Given a boolean if the editor link should act as an Ajax request.

The editor must be a valid callable function/closure

Exceptions

UnexpectedValueException If editor resolver does not return a boolean

Parameters

string	$filePath
int	$line

Returns: bool

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 467 of file PrettyPageHandler.php.

    {
        $editor = $this->getEditor($filePath, $line);
 
        // Check that the ajax is a bool
        if (!isset($editor['ajax']) || !is_bool($editor['ajax'])) {
            throw new UnexpectedValueException(
                __METHOD__ . " should always resolve to a bool; got something else instead."
            );
        }
        return $editor['ajax'];
    }

References Whoops\Handler\PrettyPageHandler\$editor, and Whoops\Handler\PrettyPageHandler\getEditor().

Here is the call graph for this function:

◆ getEditorHref()

Whoops\Handler\PrettyPageHandler::getEditorHref	(	$filePath,
		$line
	)

Given a string file path, and an integer file line, executes the editor resolver and returns, if available, a string that may be used as the href property for that file reference.

Exceptions

InvalidArgumentException If editor resolver does not return a string

Parameters

string	$filePath
int	$line

Returns: string|bool

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 435 of file PrettyPageHandler.php.

    {
        $editor = $this->getEditor($filePath, $line);
 
        if (empty($editor)) {
            return false;
        }
 
        // Check that the editor is a string, and replace the
        // %line and %file placeholders:
        if (!isset($editor['url']) || !is_string($editor['url'])) {
            throw new UnexpectedValueException(
                __METHOD__ . " should always resolve to a string or a valid editor array; got something else instead."
            );
        }
 
        $editor['url'] = str_replace("%line", rawurlencode($line), $editor['url']);
        $editor['url'] = str_replace("%file", rawurlencode($filePath), $editor['url']);
 
        return $editor['url'];
    }

References Whoops\Handler\PrettyPageHandler\$editor, and Whoops\Handler\PrettyPageHandler\getEditor().

Here is the call graph for this function:

◆ getExceptionCode()

Whoops\Handler\PrettyPageHandler::getExceptionCode ( )

protected

Get the code of the exception that is currently being handled.

Returns: string

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 282 of file PrettyPageHandler.php.

    {
        $exception = $this->getException();
 
        $code = $exception->getCode();
        if ($exception instanceof \ErrorException) {
            // ErrorExceptions wrap the php-error types within the 'severity' property
            $code = Misc::translateErrorCode($exception->getSeverity());
        }
 
        return (string) $code;
    }

References $code, Whoops\Handler\Handler\$exception, Whoops\Handler\Handler\getException(), and Whoops\Util\Misc\translateErrorCode().

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExceptionFrames()

Whoops\Handler\PrettyPageHandler::getExceptionFrames ( )

protected

Get the stack trace frames of the exception that is currently being handled.

Returns: \Whoops\Exception\FrameCollection;

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 259 of file PrettyPageHandler.php.

    {
        $frames = $this->getInspector()->getFrames();
 
        if ($this->getApplicationPaths()) {
            foreach ($frames as $frame) {
                foreach ($this->getApplicationPaths() as $path) {
                    if (strpos($frame->getFile(), $path) === 0) {
                        $frame->setApplication(true);
                        break;
                    }
                }
            }
        }
 
        return $frames;
    }

References $path, Whoops\Handler\PrettyPageHandler\getApplicationPaths(), and Whoops\Handler\Handler\getInspector().

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPageTitle()

Whoops\Handler\PrettyPageHandler::getPageTitle ( )

Returns: string

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 537 of file PrettyPageHandler.php.

    {
        return $this->pageTitle;
    }

References Whoops\Handler\PrettyPageHandler\$pageTitle.

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the caller graph for this function:

◆ getResource()

Whoops\Handler\PrettyPageHandler::getResource ( $resource )

protected

Finds a resource, by its relative path, in all available search paths.

The search is performed starting at the last search path, and all the way back to the first, enabling a cascading-type system of overrides for all resources.

Exceptions

RuntimeException If resource cannot be found in any of the available paths

Parameters

string $resource

Returns: string

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 592 of file PrettyPageHandler.php.

    {
        // If the resource was found before, we can speed things up
        // by caching its absolute, resolved path:
        if (isset($this->resourceCache[$resource])) {
            return $this->resourceCache[$resource];
        }
 
        // Search through available search paths, until we find the
        // resource we're after:
        foreach ($this->searchPaths as $path) {
            $fullPath = $path . "/$resource";
 
            if (is_file($fullPath)) {
                // Cache the result:
                $this->resourceCache[$resource] = $fullPath;
                return $fullPath;
            }
        }
 
        // If we got this far, nothing was found.
        throw new RuntimeException(
            "Could not find resource '$resource' in any resource paths."
            . "(searched: " . join(", ", $this->searchPaths). ")"
        );
    }

References $path.

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the caller graph for this function:

◆ getResourcePaths()

Whoops\Handler\PrettyPageHandler::getResourcePaths ( )

Returns: array

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 576 of file PrettyPageHandler.php.

    {
        return $this->searchPaths;
    }

References Whoops\Handler\PrettyPageHandler\$searchPaths.

Referenced by Whoops\Handler\PrettyPageHandler\getResourcesPath().

Here is the caller graph for this function:

◆ getResourcesPath()

Whoops\Handler\PrettyPageHandler::getResourcesPath ( )

Deprecated:

Returns: string

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 624 of file PrettyPageHandler.php.

    {
        $allPaths = $this->getResourcePaths();
 
        // Compat: return only the first path added
        return end($allPaths) ?: null;
    }

References Whoops\Handler\PrettyPageHandler\getResourcePaths().

Here is the call graph for this function:

◆ handle()

Whoops\Handler\PrettyPageHandler::handle ( )

Returns: int|null

Implements Whoops\Handler\HandlerInterface.

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 149 of file PrettyPageHandler.php.

    {
        if (!$this->handleUnconditionally()) {
            // Check conditions for outputting HTML:
            // @todo: Make this more robust
            if (PHP_SAPI === 'cli') {
                // Help users who have been relying on an internal test value
                // fix their code to the proper method
                if (isset($_ENV['whoops-test'])) {
                    throw new \Exception(
                        'Use handleUnconditionally instead of whoops-test'
                        .' environment variable'
                    );
                }
 
                return Handler::DONE;
            }
        }
 
        $templateFile = $this->getResource("views/layout.html.php");
        $cssFile      = $this->getResource("css/whoops.base.css");
        $zeptoFile    = $this->getResource("js/zepto.min.js");
        $prettifyFile = $this->getResource("js/prettify.min.js");
        $clipboard    = $this->getResource("js/clipboard.min.js");
        $jsFile       = $this->getResource("js/whoops.base.js");
 
        if ($this->customCss) {
            $customCssFile = $this->getResource($this->customCss);
        }
 
        $inspector = $this->getInspector();
        $frames = $this->getExceptionFrames();
        $code = $this->getExceptionCode();
 
        // List of variables that will be passed to the layout template.
        $vars = [
            "page_title" => $this->getPageTitle(),
 
            // @todo: Asset compiler
            "stylesheet" => file_get_contents($cssFile),
            "zepto"      => file_get_contents($zeptoFile),
            "prettify"   => file_get_contents($prettifyFile),
            "clipboard"  => file_get_contents($clipboard),
            "javascript" => file_get_contents($jsFile),
 
            // Template paths:
            "header"                     => $this->getResource("views/header.html.php"),
            "header_outer"               => $this->getResource("views/header_outer.html.php"),
            "frame_list"                 => $this->getResource("views/frame_list.html.php"),
            "frames_description"         => $this->getResource("views/frames_description.html.php"),
            "frames_container"           => $this->getResource("views/frames_container.html.php"),
            "panel_details"              => $this->getResource("views/panel_details.html.php"),
            "panel_details_outer"        => $this->getResource("views/panel_details_outer.html.php"),
            "panel_left"                 => $this->getResource("views/panel_left.html.php"),
            "panel_left_outer"           => $this->getResource("views/panel_left_outer.html.php"),
            "frame_code"                 => $this->getResource("views/frame_code.html.php"),
            "env_details"                => $this->getResource("views/env_details.html.php"),
 
            "title"          => $this->getPageTitle(),
            "name"           => explode("\\", $inspector->getExceptionName()),
            "message"        => $inspector->getExceptionMessage(),
            "docref_url"     => $inspector->getExceptionDocrefUrl(),
            "code"           => $code,
            "plain_exception" => Formatter::formatExceptionPlain($inspector),
            "frames"         => $frames,
            "has_frames"     => !!count($frames),
            "handler"        => $this,
            "handlers"       => $this->getRun()->getHandlers(),
 
            "active_frames_tab" => count($frames) && $frames->offsetGet(0)->isApplication() ?  'application' : 'all',
            "has_frames_tabs"   => $this->getApplicationPaths(),
 
            "tables"      => [
                "GET Data"              => $this->masked($_GET, '_GET'),
                "POST Data"             => $this->masked($_POST, '_POST'),
                "Files"                 => isset($_FILES) ? $this->masked($_FILES, '_FILES') : [],
                "Cookies"               => $this->masked($_COOKIE, '_COOKIE'),
                "Session"               => isset($_SESSION) ? $this->masked($_SESSION, '_SESSION') :  [],
                "Server/Request Data"   => $this->masked($_SERVER, '_SERVER'),
                "Environment Variables" => $this->masked($_ENV, '_ENV'),
            ],
        ];
 
        if (isset($customCssFile)) {
            $vars["stylesheet"] .= file_get_contents($customCssFile);
        }
 
        // Add extra entries list of data tables:
        // @todo: Consolidate addDataTable and addDataTableCallback
        $extraTables = array_map(function ($table) use ($inspector) {
            return $table instanceof \Closure ? $table($inspector) : $table;
        }, $this->getDataTables());
        $vars["tables"] = array_merge($extraTables, $vars["tables"]);
 
        $plainTextHandler = new PlainTextHandler();
        $plainTextHandler->setException($this->getException());
        $plainTextHandler->setInspector($this->getInspector());
        $vars["preface"] = "<!--\n\n\n" .  $this->templateHelper->escape($plainTextHandler->generateResponse()) . "\n\n\n\n\n\n\n\n\n\n\n-->";
 
        $this->templateHelper->setVariables($vars);
        $this->templateHelper->render($templateFile);
 
        return Handler::QUIT;
    }

Here is the call graph for this function:

◆ handleUnconditionally()

Whoops\Handler\PrettyPageHandler::handleUnconditionally ( $value = null )

Allows to disable all attempts to dynamically decide whether to handle or return prematurely.

Set this to ensure that the handler will perform no matter what.

Parameters

bool | null $value

Returns: bool|null

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 368 of file PrettyPageHandler.php.

    {
        if (func_num_args() == 0) {
            return $this->handleUnconditionally;
        }
 
        $this->handleUnconditionally = (bool) $value;
    }

References Whoops\Handler\PrettyPageHandler\$handleUnconditionally, and Whoops\Handler\PrettyPageHandler\handleUnconditionally().

Referenced by Whoops\Handler\PrettyPageHandler\handle(), and Whoops\Handler\PrettyPageHandler\handleUnconditionally().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ masked()

Whoops\Handler\PrettyPageHandler::masked	(	array	$superGlobal,
			$superGlobalName
	)

private

Checks all values within the given superGlobal array.

Blacklisted values will be replaced by a equal length string cointaining only '*' characters.

We intentionally dont rely on $GLOBALS as it depends on 'auto_globals_jit' php.ini setting.

Parameters

$superGlobal	array One of the superglobal arrays
$superGlobalName	string the name of the superglobal array, e.g. '_GET'

Returns: array $values without sensitive data

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 694 of file PrettyPageHandler.php.

    {
        $blacklisted = $this->blacklist[$superGlobalName];
 
        $values = $superGlobal;
        foreach ($blacklisted as $key) {
            if (isset($superGlobal[$key])) {
                $values[$key] = str_repeat('*', strlen($superGlobal[$key]));
            }
        }
        return $values;
    }

References $key, $values, and Whoops\Handler\PrettyPageHandler\blacklist().

Referenced by Whoops\Handler\PrettyPageHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setApplicationPaths()

Whoops\Handler\PrettyPageHandler::setApplicationPaths ( $applicationPaths )

Set the application paths.

Parameters

array $applicationPaths

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 658 of file PrettyPageHandler.php.

    {
        $this->applicationPaths = $applicationPaths;
    }

References Whoops\Handler\PrettyPageHandler\$applicationPaths.

◆ setApplicationRootPath()

Whoops\Handler\PrettyPageHandler::setApplicationRootPath ( $applicationRootPath )

Set the application root path.

Parameters

string $applicationRootPath

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 668 of file PrettyPageHandler.php.

    {
        $this->templateHelper->setApplicationRootPath($applicationRootPath);
    }

◆ setEditor()

Whoops\Handler\PrettyPageHandler::setEditor ( $editor )

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 412 of file PrettyPageHandler.php.

    {
        if (!is_callable($editor) && !isset($this->editors[$editor])) {
            throw new InvalidArgumentException(
                "Unknown editor identifier: $editor. Known editors:" .
                implode(",", array_keys($this->editors))
            );
        }
 
        $this->editor = $editor;
    }

References Whoops\Handler\PrettyPageHandler\$editor.

◆ setPageTitle()

Whoops\Handler\PrettyPageHandler::setPageTitle ( $title )

Parameters

string $title

Returns: void

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 529 of file PrettyPageHandler.php.

    {
        $this->pageTitle = (string) $title;
    }

References $title.

◆ setResourcesPath()

Whoops\Handler\PrettyPageHandler::setResourcesPath ( $resourcesPath )

Deprecated:

Parameters

string $resourcesPath

Returns: void

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 638 of file PrettyPageHandler.php.

    {
        $this->addResourcePath($resourcesPath);
    }

References Whoops\Handler\PrettyPageHandler\addResourcePath().

Here is the call graph for this function:

Field Documentation

◆ $applicationPaths

Whoops\Handler\PrettyPageHandler::$applicationPaths

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 60 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\getApplicationPaths(), and Whoops\Handler\PrettyPageHandler\setApplicationPaths().

◆ $blacklist

Whoops\Handler\PrettyPageHandler::$blacklist

private

Initial value:

= [
        '_GET' => [],
        '_POST' => [],
        '_FILES' => [],
        '_COOKIE' => [],
        '_SESSION' => [],
        '_SERVER' => [],
        '_ENV' => [],
    ]

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 65 of file PrettyPageHandler.php.

◆ $customCss

Whoops\Handler\PrettyPageHandler::$customCss = null

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 40 of file PrettyPageHandler.php.

◆ $editor

mixed Whoops\Handler\PrettyPageHandler::$editor

protected

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 85 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\getEditor(), Whoops\Handler\PrettyPageHandler\getEditorAjax(), Whoops\Handler\PrettyPageHandler\getEditorHref(), and Whoops\Handler\PrettyPageHandler\setEditor().

◆ $editors

Whoops\Handler\PrettyPageHandler::$editors

protected

Initial value:

= [
        "sublime"  => "subl://open?url=file://%file&line=%line",
        "textmate" => "txmt://open?url=file://%file&line=%line",
        "emacs"    => "emacs://open?url=file://%file&line=%line",
        "macvim"   => "mvim://open/?url=file://%file&line=%line",
        "phpstorm" => "phpstorm://open?file=%file&line=%line",
        "idea"     => "idea://open?file=%file&line=%line",
        "vscode"   => "vscode://file/%file:%line",
    ]

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 91 of file PrettyPageHandler.php.

◆ $extraTables

Whoops\Handler\PrettyPageHandler::$extraTables = []

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 45 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\getDataTables(), and Whoops\Handler\PrettyPageHandler\handle().

◆ $handleUnconditionally

Whoops\Handler\PrettyPageHandler::$handleUnconditionally = false

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 50 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\handleUnconditionally().

◆ $pageTitle

Whoops\Handler\PrettyPageHandler::$pageTitle = "Whoops! There was an error."

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 55 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\getPageTitle().

◆ $resourceCache

Whoops\Handler\PrettyPageHandler::$resourceCache = []

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 33 of file PrettyPageHandler.php.

◆ $searchPaths

Whoops\Handler\PrettyPageHandler::$searchPaths = []

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 26 of file PrettyPageHandler.php.

Referenced by Whoops\Handler\PrettyPageHandler\getResourcePaths().

◆ $templateHelper

Whoops\Handler\PrettyPageHandler::$templateHelper

private

Examples: /usr/local/src/ilias/release_5-4/libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php.

Definition at line 104 of file PrettyPageHandler.php.

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

libs/composer/vendor/filp/whoops/src/Whoops/Handler/PrettyPageHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomCss()

◆ addDataTable()

◆ addDataTableCallback()

◆ addEditor()

◆ addResourcePath()

◆ blacklist()

◆ contentType()

◆ getApplicationPaths()

◆ getDataTables()

◆ getEditor()

◆ getEditorAjax()

◆ getEditorHref()

◆ getExceptionCode()

◆ getExceptionFrames()

◆ getPageTitle()

◆ getResource()

◆ getResourcePaths()

◆ getResourcesPath()

◆ handle()

◆ handleUnconditionally()

◆ masked()

◆ setApplicationPaths()

◆ setApplicationRootPath()

◆ setEditor()

◆ setPageTitle()

◆ setResourcesPath()

Field Documentation

◆ $applicationPaths

◆ $blacklist

◆ $customCss

◆ $editor

◆ $editors

◆ $extraTables

◆ $handleUnconditionally

◆ $pageTitle

◆ $resourceCache

◆ $searchPaths

◆ $templateHelper