Twig_Extension_Escaper Class Reference

@final More...

Inheritance diagram for Twig_Extension_Escaper:

Collaboration diagram for Twig_Extension_Escaper:

Public Member Functions
	__construct ($defaultStrategy='html')
	getTokenParsers ()
	Returns the token parser instances to add to the existing list. More...
	getNodeVisitors ()
	Returns the node visitor instances to add to the existing list. More...
	getFilters ()
	Returns a list of filters to add to the existing list. More...
	setDefaultStrategy ($defaultStrategy)
	Sets the default strategy to use when not defined by the user. More...
	getDefaultStrategy ($name)
	Gets the default strategy to use when not defined by the user. More...
	getName ()
Public Member Functions inherited from Twig_Extension
	initRuntime (Twig_Environment $environment)
	getTokenParsers ()
	Returns the token parser instances to add to the existing list. More...
	getNodeVisitors ()
	Returns the node visitor instances to add to the existing list. More...
	getFilters ()
	Returns a list of filters to add to the existing list. More...
	getTests ()
	Returns a list of tests to add to the existing list. More...
	getFunctions ()
	Returns a list of functions to add to the existing list. More...
	getOperators ()
	Returns a list of operators to add to the existing list. More...
	getGlobals ()
	getName ()
	initRuntime (Twig_Environment $environment)
	Initializes the runtime environment. More...
	getTokenParsers ()
	Returns the token parser instances to add to the existing list. More...
	getNodeVisitors ()
	Returns the node visitor instances to add to the existing list. More...
	getFilters ()
	Returns a list of filters to add to the existing list. More...
	getTests ()
	Returns a list of tests to add to the existing list. More...
	getFunctions ()
	Returns a list of functions to add to the existing list. More...
	getOperators ()
	Returns a list of operators to add to the existing list. More...
	getGlobals ()
	Returns a list of global variables to add to the existing list. More...
	getName ()
	Returns the name of the extension. More...

Protected Attributes
	$defaultStrategy

Detailed Description

@final

Definition at line 15 of file Escaper.php.

Constructor & Destructor Documentation

__construct()

Twig_Extension_Escaper::__construct

(

$defaultStrategy = 'html'

)

Parameters

string | false | callable

$defaultStrategy

An escaping strategy

See also

setDefaultStrategy()

Definition at line 24 of file Escaper.php.

    {
        $this->setDefaultStrategy($defaultStrategy);
    }

References $defaultStrategy, and setDefaultStrategy().

Here is the call graph for this function:

Member Function Documentation

getDefaultStrategy()

Twig_Extension_Escaper::getDefaultStrategy

(

$name

)

Gets the default strategy to use when not defined by the user.

Parameters

string

$name

The template name

Returns

string|false The default strategy to use for the template

Definition at line 83 of file Escaper.php.

    {
        // disable string callables to avoid calling a function named html or js,
        // or any other upcoming escaping strategy
        if (!is_string($this->defaultStrategy) && false !== $this->defaultStrategy) {
            return call_user_func($this->defaultStrategy, $name);
        }
 
        return $this->defaultStrategy;
    }

References $defaultStrategy, and $name.

getFilters()

Twig_Extension_Escaper::getFilters

(

)

Returns a list of filters to add to the existing list.

Returns

Twig_SimpleFilter[]

Reimplemented from Twig_Extension.

Definition at line 39 of file Escaper.php.

    {
        return array(
            new Twig_SimpleFilter('raw', 'twig_raw_filter', array('is_safe' => array('all'))),
        );
    }

getName()

Twig_Extension_Escaper::getName

(

)

Deprecated:

since 1.26 (to be removed in 2.0), not used anymore internally

Reimplemented from Twig_Extension.

Definition at line 94 of file Escaper.php.

    {
        return 'escaper';
    }

getNodeVisitors()

Twig_Extension_Escaper::getNodeVisitors

(

)

Returns the node visitor instances to add to the existing list.

Returns

Twig_NodeVisitorInterface[]

Reimplemented from Twig_Extension.

Definition at line 34 of file Escaper.php.

    {
        return array(new Twig_NodeVisitor_Escaper());
    }

getTokenParsers()

Twig_Extension_Escaper::getTokenParsers

(

)

Returns the token parser instances to add to the existing list.

Returns

Twig_TokenParserInterface[]

Reimplemented from Twig_Extension.

Definition at line 29 of file Escaper.php.

    {
        return array(new Twig_TokenParser_AutoEscape());
    }

setDefaultStrategy()

Twig_Extension_Escaper::setDefaultStrategy

(

$defaultStrategy

)

Sets the default strategy to use when not defined by the user.

The strategy can be a valid PHP callback that takes the template name as an argument and returns the strategy to use.

Parameters

string | false | callable

$defaultStrategy

An escaping strategy

Definition at line 54 of file Escaper.php.

    {
        // for BC
        if (true === $defaultStrategy) {
            @trigger_error('Using "true" as the default strategy is deprecated since version 1.21. Use "html" instead.', E_USER_DEPRECATED);
 
            $defaultStrategy = 'html';
        }
 
        if ('filename' === $defaultStrategy) {
            @trigger_error('Using "filename" as the default strategy is deprecated since version 1.27. Use "name" instead.', E_USER_DEPRECATED);
 
            $defaultStrategy = 'name';
        }
 
        if ('name' === $defaultStrategy) {
            $defaultStrategy = array('Twig_FileExtensionEscapingStrategy', 'guess');
        }
 
        $this->defaultStrategy = $defaultStrategy;
    }

References $defaultStrategy.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$defaultStrategy

Twig_Extension_Escaper::$defaultStrategy

protected

Definition at line 17 of file Escaper.php.

Referenced by __construct(), getDefaultStrategy(), and setDefaultStrategy().

---

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

• libs/composer/vendor/twig/twig/lib/Twig/Extension/Escaper.php