abstract class Twig_BaseNodeVisitor in Zircon Profile 8

Twig_BaseNodeVisitor can be used to make node visitors compatible with Twig 1.x and 2.x.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_BaseNodeVisitor implements Twig_NodeVisitorInterface

File

vendor/twig/twig/lib/Twig/BaseNodeVisitor.php, line 17

abstract class Twig_BaseNodeVisitor implements Twig_NodeVisitorInterface {

  /**
   * {@inheritdoc}
   */
  public final function enterNode(Twig_NodeInterface $node, Twig_Environment $env) {
    if (!$node instanceof Twig_Node) {
      throw new LogicException('Twig_BaseNodeVisitor only supports Twig_Node instances.');
    }
    return $this
      ->doEnterNode($node, $env);
  }

  /**
   * {@inheritdoc}
   */
  public final function leaveNode(Twig_NodeInterface $node, Twig_Environment $env) {
    if (!$node instanceof Twig_Node) {
      throw new LogicException('Twig_BaseNodeVisitor only supports Twig_Node instances.');
    }
    return $this
      ->doLeaveNode($node, $env);
  }

  /**
   * Called before child nodes are visited.
   *
   * @param Twig_Node        $node The node to visit
   * @param Twig_Environment $env  The Twig environment instance
   *
   * @return Twig_Node The modified node
   */
  protected abstract function doEnterNode(Twig_Node $node, Twig_Environment $env);

  /**
   * Called after child nodes are visited.
   *
   * @param Twig_Node        $node The node to visit
   * @param Twig_Environment $env  The Twig environment instance
   *
   * @return Twig_Node|false The modified node or false if the node must be removed
   */
  protected abstract function doLeaveNode(Twig_Node $node, Twig_Environment $env);

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_BaseNodeVisitor::doEnterNode	abstract protected	function	Called before child nodes are visited.	5
Twig_BaseNodeVisitor::doLeaveNode	abstract protected	function	Called after child nodes are visited.	5
Twig_BaseNodeVisitor::enterNode	final public	function	Called before child nodes are visited. Overrides Twig_NodeVisitorInterface::enterNode
Twig_BaseNodeVisitor::leaveNode	final public	function	Called after child nodes are visited. Overrides Twig_NodeVisitorInterface::leaveNode
Twig_NodeVisitorInterface::getPriority	public	function	Returns the priority for this visitor.	7