Exposes useful tools for working with/in templates. More...

Collaboration diagram for Whoops\Util\TemplateHelper:

Public Member Functions
	__construct ()

	escape ($raw)
	Escapes a string for output in an HTML document. More...

	escapeButPreserveUris ($raw)
	Escapes a string for output in an HTML document, but preserves URIs within it, and converts them to clickable anchor elements. More...

	breakOnDelimiter ($delimiter, $s)
	Makes sure that the given string breaks on the delimiter. More...

	shorten ($path)
	Replace the part of the path that all files have in common. More...

	dump ($value)
	Format the given value into a human readable string. More...

	dumpArgs (Frame $frame)
	Format the args of the given Frame as a human readable html string. More...

	slug ($original)
	Convert a string to a slug version of itself. More...

	render ($template, array $additionalVariables=null)
	Given a template path, render it within its own scope. More...

	setVariables (array $variables)
	Sets the variables to be passed to all templates rendered by this template helper. More...

	setVariable ($variableName, $variableValue)
	Sets a single template variable, by its name: More...

	getVariable ($variableName, $defaultValue=null)
	Gets a single template variable, by its name, or $defaultValue if the variable does not exist. More...

	delVariable ($variableName)
	Unsets a single template variable, by its name. More...

	getVariables ()
	Returns all variables for this helper. More...

	setCloner ($cloner)
	Set the cloner used for dumping variables. More...

	getCloner ()
	Get the cloner used for dumping variables. More...

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

	getApplicationRootPath ()
	Return the application root path. More...

Private Member Functions
	getDumper ()

Private Attributes
	$variables = []

	$htmlDumper

	$htmlDumperOutput

	$cloner

	$applicationRootPath

Detailed Description

Exposes useful tools for working with/in templates.

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

Definition at line 18 of file TemplateHelper.php.

Constructor & Destructor Documentation

◆ __construct()

Whoops\Util\TemplateHelper::__construct ( )

Definition at line 46 of file TemplateHelper.php.

    {
        // root path for ordinary composer projects
        $this->applicationRootPath = dirname(dirname(dirname(dirname(dirname(dirname(__DIR__))))));
    }

Member Function Documentation

◆ breakOnDelimiter()

Whoops\Util\TemplateHelper::breakOnDelimiter	(	$delimiter,
		$s
	)

Makes sure that the given string breaks on the delimiter.

Parameters

string	$delimiter
string	$s

Returns: string

Definition at line 103 of file TemplateHelper.php.

    {
        $parts = explode($delimiter, $s);
        foreach ($parts as &$part) {
            $part = '<div class="delimiter">' . $part . '</div>';
        }
 
        return implode($delimiter, $parts);
    }

◆ delVariable()

Whoops\Util\TemplateHelper::delVariable ( $variableName )

Unsets a single template variable, by its name.

Parameters

string $variableName

Definition at line 295 of file TemplateHelper.php.

    {
        unset($this->variables[$variableName]);
    }

◆ dump()

Whoops\Util\TemplateHelper::dump ( $value )

Format the given value into a human readable string.

Parameters

mixed $value

Returns: string

Definition at line 161 of file TemplateHelper.php.

    {
        $dumper = $this->getDumper();
 
        if ($dumper) {
            // re-use the same DumpOutput instance, so it won't re-render the global styles/scripts on each dump.
            // exclude verbose information (e.g. exception stack traces)
            if (class_exists('Symfony\Component\VarDumper\Caster\Caster')) {
                $cloneVar = $this->getCloner()->cloneVar($value, Caster::EXCLUDE_VERBOSE);
                // Symfony VarDumper 2.6 Caster class dont exist.
            } else {
                $cloneVar = $this->getCloner()->cloneVar($value);
            }
 
            $dumper->dump(
                $cloneVar,
                $this->htmlDumperOutput
            );
 
            $output = $this->htmlDumperOutput->getOutput();
            $this->htmlDumperOutput->clear();
 
            return $output;
        }
 
        return htmlspecialchars(print_r($value, true));
    }

References $output, Whoops\Util\TemplateHelper\getCloner(), and Whoops\Util\TemplateHelper\getDumper().

Referenced by Whoops\Util\TemplateHelper\dumpArgs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dumpArgs()

Whoops\Util\TemplateHelper::dumpArgs ( Frame $frame )

Format the args of the given Frame as a human readable html string.

Parameters

Frame $frame

Returns: string the rendered html

Definition at line 195 of file TemplateHelper.php.

    {
        // we support frame args only when the optional dumper is available
        if (!$this->getDumper()) {
            return '';
        }
 
        $html = '';
        $numFrames = count($frame->getArgs());
 
        if ($numFrames > 0) {
            $html = '<ol class="linenums">';
            foreach ($frame->getArgs() as $j => $frameArg) {
                $html .= '<li>'. $this->dump($frameArg) .'</li>';
            }
            $html .= '</ol>';
        }
 
        return $html;
    }

References $html, Whoops\Util\TemplateHelper\dump(), Whoops\Exception\Frame\getArgs(), and Whoops\Util\TemplateHelper\getDumper().

Here is the call graph for this function:

◆ escape()

Whoops\Util\TemplateHelper::escape ( $raw )

Escapes a string for output in an HTML document.

Parameters

string $raw

Returns: string

Definition at line 58 of file TemplateHelper.php.

    {
        $flags = ENT_QUOTES;
 
        // HHVM has all constants defined, but only ENT_IGNORE
        // works at the moment
        if (defined("ENT_SUBSTITUTE") && !defined("HHVM_VERSION")) {
            $flags |= ENT_SUBSTITUTE;
        } else {
            // This is for 5.3.
            // The documentation warns of a potential security issue,
            // but it seems it does not apply in our case, because
            // we do not blacklist anything anywhere.
            $flags |= ENT_IGNORE;
        }
 
        $raw = str_replace(chr(9), '    ', $raw);
 
        return htmlspecialchars($raw, $flags, "UTF-8");
    }

References defined.

Referenced by Whoops\Util\TemplateHelper\escapeButPreserveUris().

Here is the caller graph for this function:

◆ escapeButPreserveUris()

Whoops\Util\TemplateHelper::escapeButPreserveUris ( $raw )

Escapes a string for output in an HTML document, but preserves URIs within it, and converts them to clickable anchor elements.

Parameters

string $raw

Returns: string

Definition at line 86 of file TemplateHelper.php.

    {
        $escaped = $this->escape($raw);
        return preg_replace(
            "@([A-z]+?://([-\w\.]+[-\w])+(:\d+)?(/([\w/_\.#-]*(\?\S+)?[^\.\s])?)?)@",
            "<a href=\"$1\" target=\"_blank\" rel=\"noreferrer noopener\">$1</a>",
            $escaped
        );
    }

References Whoops\Util\TemplateHelper\escape().

Here is the call graph for this function:

◆ getApplicationRootPath()

Whoops\Util\TemplateHelper::getApplicationRootPath ( )

Return the application root path.

Returns: string

Definition at line 348 of file TemplateHelper.php.

    {
        return $this->applicationRootPath;
    }

References Whoops\Util\TemplateHelper\$applicationRootPath.

◆ getCloner()

Whoops\Util\TemplateHelper::getCloner ( )

Get the cloner used for dumping variables.

Returns: AbstractCloner

Definition at line 325 of file TemplateHelper.php.

    {
        if (!$this->cloner) {
            $this->cloner = new VarCloner();
        }
        return $this->cloner;
    }

References Whoops\Util\TemplateHelper\$cloner.

Referenced by Whoops\Util\TemplateHelper\dump().

Here is the caller graph for this function:

◆ getDumper()

Whoops\Util\TemplateHelper::getDumper ( )

private

Definition at line 128 of file TemplateHelper.php.

    {
        if (!$this->htmlDumper && class_exists('Symfony\Component\VarDumper\Cloner\VarCloner')) {
            $this->htmlDumperOutput = new HtmlDumperOutput();
            // re-use the same var-dumper instance, so it won't re-render the global styles/scripts on each dump.
            $this->htmlDumper = new HtmlDumper($this->htmlDumperOutput);
 
            $styles = [
                'default' => 'color:#FFFFFF; line-height:normal; font:12px "Inconsolata", "Fira Mono", "Source Code Pro", Monaco, Consolas, "Lucida Console", monospace !important; word-wrap: break-word; white-space: pre-wrap; position:relative; z-index:99999; word-break: normal',
                'num' => 'color:#BCD42A',
                'const' => 'color: #4bb1b1;',
                'str' => 'color:#BCD42A',
                'note' => 'color:#ef7c61',
                'ref' => 'color:#A0A0A0',
                'public' => 'color:#FFFFFF',
                'protected' => 'color:#FFFFFF',
                'private' => 'color:#FFFFFF',
                'meta' => 'color:#FFFFFF',
                'key' => 'color:#BCD42A',
                'index' => 'color:#ef7c61',
            ];
            $this->htmlDumper->setStyles($styles);
        }
 
        return $this->htmlDumper;
    }

References Whoops\Util\TemplateHelper\$htmlDumper, and $styles.

Referenced by Whoops\Util\TemplateHelper\dump(), and Whoops\Util\TemplateHelper\dumpArgs().

Here is the caller graph for this function:

◆ getVariable()

Whoops\Util\TemplateHelper::getVariable	(	$variableName,
		$defaultValue = `null`
	)

Gets a single template variable, by its name, or $defaultValue if the variable does not exist.

Parameters

string	$variableName
mixed	$defaultValue

Returns: mixed

Definition at line 284 of file TemplateHelper.php.

    {
        return isset($this->variables[$variableName]) ?
            $this->variables[$variableName] : $defaultValue;
    }

◆ getVariables()

Whoops\Util\TemplateHelper::getVariables ( )

Returns all variables for this helper.

Returns: array

Definition at line 305 of file TemplateHelper.php.

    {
        return $this->variables;
    }

References Whoops\Util\TemplateHelper\$variables.

Referenced by Whoops\Util\TemplateHelper\render().

Here is the caller graph for this function:

◆ render()

Whoops\Util\TemplateHelper::render	(		$template,
		array	$additionalVariables = `null`
	)

Given a template path, render it within its own scope.

This method also accepts an array of additional variables to be passed to the template.

Parameters

string	$template
array	$additionalVariables

Definition at line 237 of file TemplateHelper.php.

    {
        $variables = $this->getVariables();
 
        // Pass the helper to the template:
        $variables["tpl"] = $this;
 
        if ($additionalVariables !== null) {
            $variables = array_replace($variables, $additionalVariables);
        }
 
        call_user_func(function () {
            extract(func_get_arg(1));
            require func_get_arg(0);
        }, $template, $variables);
    }

References Whoops\Util\TemplateHelper\$variables, and Whoops\Util\TemplateHelper\getVariables().

Here is the call graph for this function:

◆ setApplicationRootPath()

Whoops\Util\TemplateHelper::setApplicationRootPath ( $applicationRootPath )

Set the application root path.

Parameters

string $applicationRootPath

Definition at line 338 of file TemplateHelper.php.

    {
        $this->applicationRootPath = $applicationRootPath;
    }

References Whoops\Util\TemplateHelper\$applicationRootPath.

◆ setCloner()

Whoops\Util\TemplateHelper::setCloner ( $cloner )

Set the cloner used for dumping variables.

Parameters

AbstractCloner $cloner

Definition at line 315 of file TemplateHelper.php.

    {
        $this->cloner = $cloner;
    }

References Whoops\Util\TemplateHelper\$cloner.

◆ setVariable()

Whoops\Util\TemplateHelper::setVariable	(	$variableName,
		$variableValue
	)

Sets a single template variable, by its name:

Parameters

string	$variableName
mixed	$variableValue

Definition at line 271 of file TemplateHelper.php.

    {
        $this->variables[$variableName] = $variableValue;
    }

◆ setVariables()

Whoops\Util\TemplateHelper::setVariables ( array $variables )

Sets the variables to be passed to all templates rendered by this template helper.

Parameters

array $variables

Definition at line 260 of file TemplateHelper.php.

    {
        $this->variables = $variables;
    }

References Whoops\Util\TemplateHelper\$variables.

◆ shorten()

Whoops\Util\TemplateHelper::shorten ( $path )

Replace the part of the path that all files have in common.

Parameters

string $path

Returns: string

Definition at line 119 of file TemplateHelper.php.

    {
        if ($this->applicationRootPath != "/") {
            $path = str_replace($this->applicationRootPath, '&hellip;', $path);
        }
 
        return $path;
    }

References $path.

◆ slug()

Whoops\Util\TemplateHelper::slug ( $original )

Convert a string to a slug version of itself.

Parameters

string $original

Returns: string

Definition at line 222 of file TemplateHelper.php.

    {
        $slug = str_replace(" ", "-", $original);
        $slug = preg_replace('/[^\w\d\-\_]/i', '', $slug);
        return strtolower($slug);
    }

Field Documentation

◆ $applicationRootPath

Whoops\Util\TemplateHelper::$applicationRootPath

private

Definition at line 44 of file TemplateHelper.php.

Referenced by Whoops\Util\TemplateHelper\getApplicationRootPath(), and Whoops\Util\TemplateHelper\setApplicationRootPath().

◆ $cloner

Whoops\Util\TemplateHelper::$cloner

private

Definition at line 39 of file TemplateHelper.php.

Referenced by Whoops\Util\TemplateHelper\getCloner(), and Whoops\Util\TemplateHelper\setCloner().

◆ $htmlDumper

Whoops\Util\TemplateHelper::$htmlDumper

private

Definition at line 29 of file TemplateHelper.php.

Referenced by Whoops\Util\TemplateHelper\getDumper().

◆ $htmlDumperOutput

Whoops\Util\TemplateHelper::$htmlDumperOutput

private

Definition at line 34 of file TemplateHelper.php.

◆ $variables

Whoops\Util\TemplateHelper::$variables = []

private

Definition at line 24 of file TemplateHelper.php.

Referenced by Whoops\Util\TemplateHelper\getVariables(), Whoops\Util\TemplateHelper\render(), and Whoops\Util\TemplateHelper\setVariables().

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

libs/composer/vendor/filp/whoops/src/Whoops/Util/TemplateHelper.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ breakOnDelimiter()

◆ delVariable()

◆ dump()

◆ dumpArgs()

◆ escape()

◆ escapeButPreserveUris()

◆ getApplicationRootPath()

◆ getCloner()

◆ getDumper()

◆ getVariable()

◆ getVariables()

◆ render()

◆ setApplicationRootPath()

◆ setCloner()

◆ setVariable()

◆ setVariables()

◆ shorten()

◆ slug()

Field Documentation

◆ $applicationRootPath

◆ $cloner

◆ $htmlDumper

◆ $htmlDumperOutput

◆ $variables