Whoops\Util\TemplateHelper Class Reference

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

Collaboration diagram for Whoops\Util\TemplateHelper:

Public Member Functions
	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...
	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...

Private Attributes
	$variables = array()

Detailed Description

Exposes useful tools for working with/in templates.

Definition at line 12 of file TemplateHelper.php.

Member Function Documentation

delVariable()

Whoops\Util\TemplateHelper::delVariable

(

$variableName

)

Unsets a single template variable, by its name.

Parameters

string

$variableName

Definition at line 140 of file TemplateHelper.php.

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

escape()

Whoops\Util\TemplateHelper::escape

(

$raw

)

Escapes a string for output in an HTML document.

Parameters

string

$raw

Returns

string

Definition at line 26 of file TemplateHelper.php.

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

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

        return htmlspecialchars($raw, $flags, "UTF-8");
    }

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 52 of file TemplateHelper.php.

References Whoops\Util\TemplateHelper\escape().

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

Here is the call 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 129 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 150 of file TemplateHelper.php.

References Whoops\Util\TemplateHelper\$variables.

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

    {
        return $this->variables;
    }

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 82 of file TemplateHelper.php.

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

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

Here is the call graph for this function:

setVariable()

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

Sets a single template variable, by its name:

Parameters

string	$variableName
mixd	$variableValue

Definition at line 116 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 105 of file TemplateHelper.php.

References Whoops\Util\TemplateHelper\$variables.

    {
        $this->variables = $variables;
    }

slug()

Whoops\Util\TemplateHelper::slug

(

$original

)

Convert a string to a slug version of itself.

Parameters

string

$original

Returns

string

Definition at line 67 of file TemplateHelper.php.

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

Field Documentation

$variables

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

private

Definition at line 18 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:

• Services/Exceptions/lib/Whoops/Util/TemplateHelper.php