Twig_NodeVisitorInterface Interface Reference

Twig_NodeVisitorInterface is the interface the all node visitor classes must implement. More...

Inheritance diagram for Twig_NodeVisitorInterface:

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

Detailed Description

Twig_NodeVisitorInterface is the interface the all node visitor classes must implement.

Author

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

Definition at line 17 of file NodeVisitorInterface.php.

Member Function Documentation

enterNode	(	Twig_NodeInterface	$node,
		Twig_Environment	$env
	)

Called before child nodes are visited.

Parameters

Twig_NodeInterface	$node	The node to visit
Twig_Environment	$env	The Twig environment instance

Returns

Twig_NodeInterface The modified node

Implemented in Twig_NodeVisitor_Optimizer, Twig_NodeVisitor_SafeAnalysis, Twig_NodeVisitor_Escaper, and Twig_NodeVisitor_Sandbox.

getPriority

(

)

Returns the priority for this visitor.

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

Returns

integer The priority level

Implemented in Twig_NodeVisitor_Optimizer, Twig_NodeVisitor_Escaper, Twig_NodeVisitor_SafeAnalysis, and Twig_NodeVisitor_Sandbox.

leaveNode	(	Twig_NodeInterface	$node,
		Twig_Environment	$env
	)

Called after child nodes are visited.

Parameters

Twig_NodeInterface	$node	The node to visit
Twig_Environment	$env	The Twig environment instance

Returns

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

Implemented in Twig_NodeVisitor_Optimizer, Twig_NodeVisitor_Sandbox, Twig_NodeVisitor_Escaper, and Twig_NodeVisitor_SafeAnalysis.

---

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

• lib/templateEngines/twig/NodeVisitorInterface.php