Twig_NodeVisitor_SafeAnalysis Class Reference

@final More...

Inheritance diagram for Twig_NodeVisitor_SafeAnalysis:

Collaboration diagram for Twig_NodeVisitor_SafeAnalysis:

Public Member Functions
	setSafeVars ($safeVars)
	getSafe (Twig_NodeInterface $node)
	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
	setSafe (Twig_NodeInterface $node, array $safe)
	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...
	intersectSafe (array $a=null, array $b=null)
	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
	$data = array()
	$safeVars = array()

Detailed Description

@final

Definition at line 15 of file SafeAnalysis.php.

Member Function Documentation

doEnterNode()

Twig_NodeVisitor_SafeAnalysis::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 63 of file SafeAnalysis.php.

    {
        return $node;
    }

doLeaveNode()

Twig_NodeVisitor_SafeAnalysis::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 68 of file SafeAnalysis.php.

    {
        if ($node instanceof Twig_Node_Expression_Constant) {
            // constants are marked safe for all
            $this->setSafe($node, array('all'));
        } elseif ($node instanceof Twig_Node_Expression_BlockReference) {
            // blocks are safe by definition
            $this->setSafe($node, array('all'));
        } elseif ($node instanceof Twig_Node_Expression_Parent) {
            // parent block is safe by definition
            $this->setSafe($node, array('all'));
        } elseif ($node instanceof Twig_Node_Expression_Conditional) {
            // intersect safeness of both operands
            $safe = $this->intersectSafe($this->getSafe($node->getNode('expr2')), $this->getSafe($node->getNode('expr3')));
            $this->setSafe($node, $safe);
        } elseif ($node instanceof Twig_Node_Expression_Filter) {
            // filter expression is safe when the filter is safe
            $name = $node->getNode('filter')->getAttribute('value');
            $args = $node->getNode('arguments');
            if (false !== $filter = $env->getFilter($name)) {
                $safe = $filter->getSafe($args);
                if (null === $safe) {
                    $safe = $this->intersectSafe($this->getSafe($node->getNode('node')), $filter->getPreservesSafety());
                }
                $this->setSafe($node, $safe);
            } else {
                $this->setSafe($node, array());
            }
        } elseif ($node instanceof Twig_Node_Expression_Function) {
            // function expression is safe when the function is safe
            $name = $node->getAttribute('name');
            $args = $node->getNode('arguments');
            $function = $env->getFunction($name);
            if (false !== $function) {
                $this->setSafe($node, $function->getSafe($args));
            } else {
                $this->setSafe($node, array());
            }
        } elseif ($node instanceof Twig_Node_Expression_MethodCall) {
            if ($node->getAttribute('safe')) {
                $this->setSafe($node, array('all'));
            } else {
                $this->setSafe($node, array());
            }
        } elseif ($node instanceof Twig_Node_Expression_GetAttr && $node->getNode('node') instanceof Twig_Node_Expression_Name) {
            $name = $node->getNode('node')->getAttribute('name');
            // attributes on template instances are safe
            if ('_self' == $name || in_array($name, $this->safeVars)) {
                $this->setSafe($node, array('all'));
            } else {
                $this->setSafe($node, array());
            }
        } else {
            $this->setSafe($node, array());
        }
 
        return $node;
    }

References $env, $function, $name, Twig_Node\getAttribute(), Twig_Node\getNode(), getSafe(), intersectSafe(), and setSafe().

Here is the call graph for this function:

getPriority()

Twig_NodeVisitor_SafeAnalysis::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 144 of file SafeAnalysis.php.

    {
        return 0;
    }

getSafe()

Twig_NodeVisitor_SafeAnalysis::getSafe

(

Twig_NodeInterface

$node

)

Definition at line 25 of file SafeAnalysis.php.

    {
        $hash = spl_object_hash($node);
        if (!isset($this->data[$hash])) {
            return;
        }
 
        foreach ($this->data[$hash] as $bucket) {
            if ($bucket['key'] !== $node) {
                continue;
            }
 
            if (in_array('html_attr', $bucket['value'])) {
                $bucket['value'][] = 'html';
            }
 
            return $bucket['value'];
        }
    }

References data.

Referenced by doLeaveNode().

Here is the caller graph for this function:

intersectSafe()

Twig_NodeVisitor_SafeAnalysis::intersectSafe ( array  $a = null, array  $b = null  )

protected

Definition at line 127 of file SafeAnalysis.php.

    {
        if (null === $a || null === $b) {
            return array();
        }
 
        if (in_array('all', $a)) {
            return $b;
        }
 
        if (in_array('all', $b)) {
            return $a;
        }
 
        return array_intersect($a, $b);
    }

Referenced by doLeaveNode().

Here is the caller graph for this function:

setSafe()

Twig_NodeVisitor_SafeAnalysis::setSafe ( Twig_NodeInterface  $node, array  $safe  )

protected

Definition at line 45 of file SafeAnalysis.php.

    {
        $hash = spl_object_hash($node);
        if (isset($this->data[$hash])) {
            foreach ($this->data[$hash] as &$bucket) {
                if ($bucket['key'] === $node) {
                    $bucket['value'] = $safe;
 
                    return;
                }
            }
        }
        $this->data[$hash][] = array(
            'key' => $node,
            'value' => $safe,
        );
    }

References data.

Referenced by doLeaveNode().

Here is the caller graph for this function:

setSafeVars()

Twig_NodeVisitor_SafeAnalysis::setSafeVars

(

$safeVars

)

Definition at line 20 of file SafeAnalysis.php.

    {
        $this->safeVars = $safeVars;
    }

References $safeVars.

Field Documentation

$data

Twig_NodeVisitor_SafeAnalysis::$data = array()

protected

Definition at line 17 of file SafeAnalysis.php.

$safeVars

Twig_NodeVisitor_SafeAnalysis::$safeVars = array()

protected

Definition at line 18 of file SafeAnalysis.php.

Referenced by setSafeVars().

---

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

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