Twig_NodeVisitor_Escaper Class Reference

Twig_NodeVisitor_Escaper implements output escaping. More...

Inheritance diagram for Twig_NodeVisitor_Escaper:

Collaboration diagram for Twig_NodeVisitor_Escaper:

Public Member Functions
	__construct ()
	getPriority ()
	Returns the priority for this visitor. More...
Public Member Functions inherited from Twig_BaseNodeVisitor
	enterNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	leaveNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called after child nodes are visited. More...
	enterNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	leaveNode (Twig_NodeInterface $node, Twig_Environment $env)
	Called after child nodes are visited. More...
	getPriority ()
	Returns the priority for this visitor. More...

Protected Member Functions
	doEnterNode (Twig_Node $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	doLeaveNode (Twig_Node $node, Twig_Environment $env)
	Called after child nodes are visited. More...
	escapePrintNode (Twig_Node_Print $node, Twig_Environment $env, $type)
	preEscapeFilterNode (Twig_Node_Expression_Filter $filter, Twig_Environment $env)
	isSafeFor ($type, Twig_NodeInterface $expression, $env)
	needEscaping (Twig_Environment $env)
	getEscaperFilter ($type, Twig_NodeInterface $node)
	doEnterNode (Twig_Node $node, Twig_Environment $env)
	Called before child nodes are visited. More...
	doLeaveNode (Twig_Node $node, Twig_Environment $env)
	Called after child nodes are visited. More...

Protected Attributes
	$statusStack = array()
	$blocks = array()
	$safeAnalysis
	$traverser
	$defaultStrategy = false
	$safeVars = array()

Detailed Description

Twig_NodeVisitor_Escaper implements output escaping.

@final

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file Escaper.php.

Constructor & Destructor Documentation

__construct()

Twig_NodeVisitor_Escaper::__construct

(

)

Definition at line 28 of file Escaper.php.

    {
        $this->safeAnalysis = new Twig_NodeVisitor_SafeAnalysis();
    }

Member Function Documentation

doEnterNode()

Twig_NodeVisitor_Escaper::doEnterNode ( Twig_Node  $node, Twig_Environment  $env  )

protected

Called before child nodes are visited.

Returns

Twig_Node The modified node

Reimplemented from Twig_BaseNodeVisitor.

Definition at line 33 of file Escaper.php.

    {
        if ($node instanceof Twig_Node_Module) {
            if ($env->hasExtension('Twig_Extension_Escaper') && $defaultStrategy = $env->getExtension('Twig_Extension_Escaper')->getDefaultStrategy($node->getTemplateName())) {
                $this->defaultStrategy = $defaultStrategy;
            }
            $this->safeVars = array();
            $this->blocks = array();
        } elseif ($node instanceof Twig_Node_AutoEscape) {
            $this->statusStack[] = $node->getAttribute('value');
        } elseif ($node instanceof Twig_Node_Block) {
            $this->statusStack[] = isset($this->blocks[$node->getAttribute('name')]) ? $this->blocks[$node->getAttribute('name')] : $this->needEscaping($env);
        } elseif ($node instanceof Twig_Node_Import) {
            $this->safeVars[] = $node->getNode('var')->getAttribute('name');
        }
 
        return $node;
    }

References $defaultStrategy, $env, Twig_Node\getAttribute(), Twig_Node\getNode(), Twig_Node\getTemplateName(), and needEscaping().

Here is the call graph for this function:

doLeaveNode()

Twig_NodeVisitor_Escaper::doLeaveNode ( Twig_Node  $node, Twig_Environment  $env  )

protected

Called after child nodes are visited.

Returns

Twig_Node|false The modified node or false if the node must be removed

Reimplemented from Twig_BaseNodeVisitor.

Definition at line 52 of file Escaper.php.

    {
        if ($node instanceof Twig_Node_Module) {
            $this->defaultStrategy = false;
            $this->safeVars = array();
            $this->blocks = array();
        } elseif ($node instanceof Twig_Node_Expression_Filter) {
            return $this->preEscapeFilterNode($node, $env);
        } elseif ($node instanceof Twig_Node_Print) {
            return $this->escapePrintNode($node, $env, $this->needEscaping($env));
        }
 
        if ($node instanceof Twig_Node_AutoEscape || $node instanceof Twig_Node_Block) {
            array_pop($this->statusStack);
        } elseif ($node instanceof Twig_Node_BlockReference) {
            $this->blocks[$node->getAttribute('name')] = $this->needEscaping($env);
        }
 
        return $node;
    }

References $env, escapePrintNode(), Twig_Node\getAttribute(), needEscaping(), and preEscapeFilterNode().

Here is the call graph for this function:

escapePrintNode()

Twig_NodeVisitor_Escaper::escapePrintNode ( Twig_Node_Print  $node, Twig_Environment  $env,   $type  )

protected

Definition at line 73 of file Escaper.php.

    {
        if (false === $type) {
            return $node;
        }
 
        $expression = $node->getNode('expr');
 
        if ($this->isSafeFor($type, $expression, $env)) {
            return $node;
        }
 
        $class = get_class($node);
 
        return new $class(
            $this->getEscaperFilter($type, $expression),
            $node->getTemplateLine()
        );
    }

References $env, $type, getEscaperFilter(), Twig_Node\getNode(), Twig_Node\getTemplateLine(), and isSafeFor().

Referenced by doLeaveNode().

Here is the call graph for this function:

Here is the caller graph for this function:

getEscaperFilter()

Twig_NodeVisitor_Escaper::getEscaperFilter (   $type, Twig_NodeInterface  $node  )

protected

Definition at line 139 of file Escaper.php.

    {
        $line = $node->getTemplateLine();
        $name = new Twig_Node_Expression_Constant('escape', $line);
        $args = new Twig_Node(array(new Twig_Node_Expression_Constant((string) $type, $line), new Twig_Node_Expression_Constant(null, $line), new Twig_Node_Expression_Constant(true, $line)));
 
        return new Twig_Node_Expression_Filter($node, $name, $args, $line);
    }

References $name, and $type.

Referenced by escapePrintNode(), and preEscapeFilterNode().

Here is the caller graph for this function:

getPriority()

Twig_NodeVisitor_Escaper::getPriority

(

)

Returns the priority for this visitor.

Priority should be between -10 and 10 (0 is the default).

Returns

int The priority level

Implements Twig_NodeVisitorInterface.

Definition at line 148 of file Escaper.php.

    {
        return 0;
    }

isSafeFor()

Twig_NodeVisitor_Escaper::isSafeFor (   $type, Twig_NodeInterface  $expression,   $env  )

protected

Definition at line 112 of file Escaper.php.

    {
        $safe = $this->safeAnalysis->getSafe($expression);
 
        if (null === $safe) {
            if (null === $this->traverser) {
                $this->traverser = new Twig_NodeTraverser($env, array($this->safeAnalysis));
            }
 
            $this->safeAnalysis->setSafeVars($this->safeVars);
 
            $this->traverser->traverse($expression);
            $safe = $this->safeAnalysis->getSafe($expression);
        }
 
        return in_array($type, $safe) || in_array('all', $safe);
    }

References $env, and $type.

Referenced by escapePrintNode(), and preEscapeFilterNode().

Here is the caller graph for this function:

needEscaping()

Twig_NodeVisitor_Escaper::needEscaping ( Twig_Environment  $env )

protected

Definition at line 130 of file Escaper.php.

    {
        if (count($this->statusStack)) {
            return $this->statusStack[count($this->statusStack) - 1];
        }
 
        return $this->defaultStrategy ? $this->defaultStrategy : false;
    }

Referenced by doEnterNode(), and doLeaveNode().

Here is the caller graph for this function:

preEscapeFilterNode()

Twig_NodeVisitor_Escaper::preEscapeFilterNode ( Twig_Node_Expression_Filter  $filter, Twig_Environment  $env  )

protected

Definition at line 93 of file Escaper.php.

    {
        $name = $filter->getNode('filter')->getAttribute('value');
 
        $type = $env->getFilter($name)->getPreEscape();
        if (null === $type) {
            return $filter;
        }
 
        $node = $filter->getNode('node');
        if ($this->isSafeFor($type, $node, $env)) {
            return $filter;
        }
 
        $filter->setNode('node', $this->getEscaperFilter($type, $node));
 
        return $filter;
    }

References $env, $name, $type, getEscaperFilter(), Twig_Node\getNode(), isSafeFor(), and Twig_Node\setNode().

Referenced by doLeaveNode().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$blocks

Twig_NodeVisitor_Escaper::$blocks = array()

protected

Definition at line 22 of file Escaper.php.

$defaultStrategy

Twig_NodeVisitor_Escaper::$defaultStrategy = false

protected

Definition at line 25 of file Escaper.php.

Referenced by doEnterNode().

$safeAnalysis

Twig_NodeVisitor_Escaper::$safeAnalysis

protected

Definition at line 23 of file Escaper.php.

$safeVars

Twig_NodeVisitor_Escaper::$safeVars = array()

protected

Definition at line 26 of file Escaper.php.

$statusStack

Twig_NodeVisitor_Escaper::$statusStack = array()

protected

Definition at line 21 of file Escaper.php.

$traverser

Twig_NodeVisitor_Escaper::$traverser

protected

Definition at line 24 of file Escaper.php.

---

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

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