BaseNodeVisitor.php in Zircon Profile 8

File

vendor/twig/twig/lib/Twig/BaseNodeVisitor.php

<?php

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Twig_BaseNodeVisitor can be used to make node visitors compatible with Twig 1.x and 2.x.
 *
 * @author Fabien Potencier <[e-mail]>
 */
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);

}

Classes

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