Whoops\Handler\PrettyPageHandler Class Reference

Inheritance diagram for Whoops\Handler\PrettyPageHandler:

Collaboration diagram for Whoops\Handler\PrettyPageHandler:

Public Member Functions
	__construct ()
	Constructor. More...
	handle ()
	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...
	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)
Public Member Functions inherited from Whoops\Handler\Handler
	setRun (Run $run)
	setInspector (Inspector $inspector)
	setException (Exception $exception)

Protected Member Functions
	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 Attributes
	$searchPaths = array()
	$resourceCache = array()
	$customCss = null
	$extraTables = array()
	$handleUnconditionally = false
	$pageTitle = "Whoops! There was an error."

Additional Inherited Members
Data Fields inherited from Whoops\Handler\Handler
const	DONE = 0x10
	Return constants that can be returned from Handler::handle to message the handler walker. More...
const	LAST_HANDLER = 0x20
const	QUIT = 0x30

Detailed Description

Definition at line 15 of file PrettyPageHandler.php.

Constructor & Destructor Documentation

__construct()

Whoops\Handler\PrettyPageHandler::__construct

(

)

Constructor.

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 80 of file PrettyPageHandler.php.

References $file.

    {
        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(array('%f', '%l'), array($file, $line), ini_get('xdebug.file_link_format'));
            };
        }

        // Add the default, local resource search path:
        $this->searchPaths[] = __DIR__ . "/../Resources";
    }

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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 393 of file PrettyPageHandler.php.

    {
        $this->customCss = $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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 196 of file PrettyPageHandler.php.

References $data.

    {
        $this->extraTables[$label] = $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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 211 of file PrettyPageHandler.php.

References $result.

    {
        if (!is_callable($callback)) {
            throw new InvalidArgumentException('Expecting callback argument to be callable');
        }

        $this->extraTables[$label] = function () use ($callback) {
            try {
                $result = call_user_func($callback);

                // Only return the result if it can be iterated over by foreach().
                return is_array($result) || $result instanceof \Traversable ? $result : array();
            } catch (\Exception $e) {
                // Don't allow failure to break the rendering of the original exception.
                return array();
            }
        };
    }

addEditor()

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

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

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

InvalidArgumnetException

If $path is not a valid directory

Parameters

string

$path

Returns

void

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 376 of file PrettyPageHandler.php.

References $path.

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

    {
        if (!is_dir($path)) {
            throw new InvalidArgumentException(
                "'$path' is not a valid directory"
            );
        }

        array_unshift($this->searchPaths, $path);
    }

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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 237 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$extraTables.

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

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

        return $this->extraTables;
    }

Here is the caller 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

false|string

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 321 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$editor.

    {
        if ($this->editor === null) {
            return false;
        }

        $editor = $this->editor;
        if (is_string($editor)) {
            $editor = $this->editors[$editor];
        }

        if (is_callable($editor)) {
            $editor = call_user_func($editor, $filePath, $line);
        }

        // Check that the editor is a string, and replace the
        // %line and %file placeholders:
        if (!is_string($editor)) {
            throw new InvalidArgumentException(
                __METHOD__ . " should always resolve to a string; got something else instead"
            );
        }

        $editor = str_replace("%line", rawurlencode($line), $editor);
        $editor = str_replace("%file", rawurlencode($filePath), $editor);

        return $editor;
    }

getPageTitle()

Whoops\Handler\PrettyPageHandler::getPageTitle

(

)

Returns

string

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 362 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$pageTitle.

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

    {
        return $this->pageTitle;
    }

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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 417 of file PrettyPageHandler.php.

References $path.

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

    {
        // 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). ")"
        );
    }

Here is the caller graph for this function:

getResourcePaths()

Whoops\Handler\PrettyPageHandler::getResourcePaths

(

)

Returns

array

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 401 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$searchPaths.

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

    {
        return $this->searchPaths;
    }

Here is the caller graph for this function:

getResourcesPath()

Whoops\Handler\PrettyPageHandler::getResourcesPath

(

)

Deprecated:

Returns

string

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 449 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\getResourcePaths().

    {
        $allPaths = $this->getResourcePaths();

        // Compat: return only the first path added
        return end($allPaths) ?: null;
    }

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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 96 of file PrettyPageHandler.php.

References $_COOKIE, $_GET, $_POST, $_SERVER, $_SESSION, $code, Whoops\Handler\PrettyPageHandler\$extraTables, Whoops\Handler\Handler\$inspector, Whoops\Handler\Handler\DONE, Whoops\Exception\Formatter\formatExceptionPlain(), Whoops\Handler\PrettyPageHandler\getDataTables(), Whoops\Handler\Handler\getInspector(), Whoops\Handler\PrettyPageHandler\getPageTitle(), Whoops\Handler\PrettyPageHandler\getResource(), Whoops\Handler\Handler\getRun(), Whoops\Handler\PrettyPageHandler\handleUnconditionally(), Whoops\Handler\Handler\QUIT, and Whoops\Util\Misc\translateErrorCode().

    {
        if (!$this->handleUnconditionally()) {
            // Check conditions for outputting HTML:
            // @todo: Make this more robust
            if (php_sapi_name() === '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;
            }
        }

        // @todo: Make this more dynamic
        $helper = new TemplateHelper();

        $templateFile = $this->getResource("views/layout.html.php");
        $cssFile      = $this->getResource("css/whoops.base.css");
        $zeptoFile    = $this->getResource("js/zepto.min.js");
        $jsFile       = $this->getResource("js/whoops.base.js");

        if ($this->customCss) {
            $customCssFile = $this->getResource($this->customCss);
        }

        $inspector = $this->getInspector();
        $frames    = $inspector->getFrames();

        $code = $inspector->getException()->getCode();

        if ($inspector->getException() instanceof \ErrorException) {
            $code = Misc::translateErrorCode($code);
        }

        // List of variables that will be passed to the layout template.
        $vars = array(
            "page_title" => $this->getPageTitle(),

            // @todo: Asset compiler
            "stylesheet" => file_get_contents($cssFile),
            "zepto"      => file_get_contents($zeptoFile),
            "javascript" => file_get_contents($jsFile),

            // Template paths:
            "header"      => $this->getResource("views/header.html.php"),
            "frame_list"  => $this->getResource("views/frame_list.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->getException()->getMessage(),
            "code"           => $code,
            "plain_exception" => Formatter::formatExceptionPlain($inspector),
            "frames"         => $frames,
            "has_frames"     => !!count($frames),
            "handler"        => $this,
            "handlers"       => $this->getRun()->getHandlers(),

            "tables"      => array(
                "Server/Request Data"   => $_SERVER,
                "GET Data"              => $_GET,
                "POST Data"             => $_POST,
                "Files"                 => $_FILES,
                "Cookies"               => $_COOKIE,
                "Session"               => isset($_SESSION) ? $_SESSION :  array(),
                "Environment Variables" => $_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) {
            return $table instanceof \Closure ? $table() : $table;
        }, $this->getDataTables());
        $vars["tables"] = array_merge($extraTables, $vars["tables"]);

        $helper->setVariables($vars);
        $helper->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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 254 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$handleUnconditionally.

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

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

        $this->handleUnconditionally = (bool) $value;
    }

Here is the caller graph for this function:

setEditor()

Whoops\Handler\PrettyPageHandler::setEditor

(

$editor

)

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 298 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\$editor.

    {
        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;
    }

setPageTitle()

Whoops\Handler\PrettyPageHandler::setPageTitle

(

$title

)

Parameters

string

$title

Returns

void

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 354 of file PrettyPageHandler.php.

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

setResourcesPath()

Whoops\Handler\PrettyPageHandler::setResourcesPath

(

$resourcesPath

)

Deprecated:

Parameters

string

$resourcesPath

Returns

void

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 463 of file PrettyPageHandler.php.

References Whoops\Handler\PrettyPageHandler\addResourcePath().

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

Here is the call graph for this function:

Field Documentation

$customCss

Whoops\Handler\PrettyPageHandler::$customCss = null

private

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 37 of file PrettyPageHandler.php.

$editor

mixed Whoops\Handler\PrettyPageHandler::$editor

protected

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 64 of file PrettyPageHandler.php.

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

$editors

Whoops\Handler\PrettyPageHandler::$editors

protected

Initial value:

= array(
        "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",
    )

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 70 of file PrettyPageHandler.php.

$extraTables

Whoops\Handler\PrettyPageHandler::$extraTables = array()

private

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 42 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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 47 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-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 52 of file PrettyPageHandler.php.

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

$resourceCache

Whoops\Handler\PrettyPageHandler::$resourceCache = array()

private

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 30 of file PrettyPageHandler.php.

$searchPaths

Whoops\Handler\PrettyPageHandler::$searchPaths = array()

private

Examples:

/usr/local/src/ilias/release_5-1/Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php.

Definition at line 23 of file PrettyPageHandler.php.

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

---

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

• Services/Exceptions/lib/Whoops/Handler/PrettyPageHandler.php