Twig_NodeTraverser Class Reference

Twig_NodeTraverser is a node traverser. More...

Collaboration diagram for Twig_NodeTraverser:

Public Member Functions
	__construct (Twig_Environment $env, array $visitors=array())
	addVisitor (Twig_NodeVisitorInterface $visitor)
	traverse (Twig_NodeInterface $node)
	Traverses a node and calls the registered visitors. More...

Protected Member Functions
	traverseForVisitor (Twig_NodeVisitorInterface $visitor, Twig_NodeInterface $node=null)

Protected Attributes
	$env
	$visitors = array()

Detailed Description

Twig_NodeTraverser is a node traverser.

It visits all nodes and their children and calls the given visitor for each.

Author

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

Definition at line 21 of file NodeTraverser.php.

Constructor & Destructor Documentation

__construct()

Twig_NodeTraverser::__construct	(	Twig_Environment	$env,
		array	$visitors = array()
	)

Parameters

Twig_Environment	$env
	Twig_NodeVisitorInterface[]	$visitors

Definition at line 30 of file NodeTraverser.php.

References $env, $visitors, and addVisitor().

    {
        $this->env = $env;
        foreach ($visitors as $visitor) {
            $this->addVisitor($visitor);
        }
    }

Here is the call graph for this function:

Member Function Documentation

addVisitor()

Twig_NodeTraverser::addVisitor

(

Twig_NodeVisitorInterface

$visitor

)

Definition at line 38 of file NodeTraverser.php.

References array, and Twig_NodeVisitorInterface\getPriority().

Referenced by __construct().

    {
        if (!isset($this->visitors[$visitor->getPriority()])) {
            $this->visitors[$visitor->getPriority()] = array();
        }

        $this->visitors[$visitor->getPriority()][] = $visitor;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

traverse()

Twig_NodeTraverser::traverse

(

Twig_NodeInterface

$node

)

Traverses a node and calls the registered visitors.

Returns

Twig_NodeInterface

Definition at line 52 of file NodeTraverser.php.

References $visitors, and traverseForVisitor().

    {
        ksort($this->visitors);
        foreach ($this->visitors as $visitors) {
            foreach ($visitors as $visitor) {
                $node = $this->traverseForVisitor($visitor, $node);
            }
        }

        return $node;
    }

Here is the call graph for this function:

traverseForVisitor()

Twig_NodeTraverser::traverseForVisitor ( Twig_NodeVisitorInterface  $visitor, Twig_NodeInterface  $node = null  )

protected

Definition at line 64 of file NodeTraverser.php.

References $n, Twig_NodeVisitorInterface\enterNode(), and Twig_NodeVisitorInterface\leaveNode().

Referenced by traverse().

    {
        if (null === $node) {
            return;
        }

        $node = $visitor->enterNode($node, $this->env);

        foreach ($node as $k => $n) {
            if (false !== $n = $this->traverseForVisitor($visitor, $n)) {
                $node->setNode($k, $n);
            } else {
                $node->removeNode($k);
            }
        }

        return $visitor->leaveNode($node, $this->env);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$env

Twig_NodeTraverser::$env

protected

Definition at line 23 of file NodeTraverser.php.

Referenced by __construct().

$visitors

Twig_NodeTraverser::$visitors = array()

protected

Definition at line 24 of file NodeTraverser.php.

Referenced by __construct(), and traverse().

---

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

• libs/composer/vendor/twig/twig/lib/Twig/NodeTraverser.php