You are here

NodeVisitorInterface.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 vendor/twig/twig/lib/Twig/NodeVisitorInterface.php

File

vendor/twig/twig/lib/Twig/NodeVisitorInterface.php
View source
<?php

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

/**
 * Twig_NodeVisitorInterface is the interface the all node visitor classes must implement.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
interface Twig_NodeVisitorInterface {

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

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

  /**
   * Returns the priority for this visitor.
   *
   * Priority should be between -10 and 10 (0 is the default).
   *
   * @return int The priority level
   */
  public function getPriority();

}

Interfaces

Namesort descending Description
Twig_NodeVisitorInterface Twig_NodeVisitorInterface is the interface the all node visitor classes must implement.