class Twig_Node in Zircon Profile 8

Represents a node in the AST.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Twig_Node implements Twig_NodeInterface

3 string references to 'Twig_Node'

TwigNodeTrans::compileString in core/lib/Drupal/Core/Template/TwigNodeTrans.php

Extracts the text and tokens for the "trans" tag.

Twig_NodeVisitor_Optimizer::doEnterNode in vendor/twig/twig/lib/Twig/NodeVisitor/Optimizer.php

Called before child nodes are visited.

Twig_NodeVisitor_Optimizer::doLeaveNode in vendor/twig/twig/lib/Twig/NodeVisitor/Optimizer.php

Called after child nodes are visited.

File

vendor/twig/twig/lib/Twig/Node.php, line 18

class Twig_Node implements Twig_NodeInterface {
  protected $nodes;
  protected $attributes;
  protected $lineno;
  protected $tag;

  /**
   * Constructor.
   *
   * The nodes are automatically made available as properties ($this->node).
   * The attributes are automatically made available as array items ($this['name']).
   *
   * @param array  $nodes      An array of named nodes
   * @param array  $attributes An array of attributes (should not be nodes)
   * @param int    $lineno     The line number
   * @param string $tag        The tag name associated with the Node
   */
  public function __construct(array $nodes = array(), array $attributes = array(), $lineno = 0, $tag = null) {
    $this->nodes = $nodes;
    $this->attributes = $attributes;
    $this->lineno = $lineno;
    $this->tag = $tag;
  }
  public function __toString() {
    $attributes = array();
    foreach ($this->attributes as $name => $value) {
      $attributes[] = sprintf('%s: %s', $name, str_replace("\n", '', var_export($value, true)));
    }
    $repr = array(
      get_class($this) . '(' . implode(', ', $attributes),
    );
    if (count($this->nodes)) {
      foreach ($this->nodes as $name => $node) {
        $len = strlen($name) + 4;
        $noderepr = array();
        foreach (explode("\n", (string) $node) as $line) {
          $noderepr[] = str_repeat(' ', $len) . $line;
        }
        $repr[] = sprintf('  %s: %s', $name, ltrim(implode("\n", $noderepr)));
      }
      $repr[] = ')';
    }
    else {
      $repr[0] .= ')';
    }
    return implode("\n", $repr);
  }

  /**
   * @deprecated since 1.16.1 (to be removed in 2.0)
   */
  public function toXml($asDom = false) {
    @trigger_error(sprintf('%s is deprecated.', __METHOD__), E_USER_DEPRECATED);
    $dom = new DOMDocument('1.0', 'UTF-8');
    $dom->formatOutput = true;
    $dom
      ->appendChild($xml = $dom
      ->createElement('twig'));
    $xml
      ->appendChild($node = $dom
      ->createElement('node'));
    $node
      ->setAttribute('class', get_class($this));
    foreach ($this->attributes as $name => $value) {
      $node
        ->appendChild($attribute = $dom
        ->createElement('attribute'));
      $attribute
        ->setAttribute('name', $name);
      $attribute
        ->appendChild($dom
        ->createTextNode($value));
    }
    foreach ($this->nodes as $name => $n) {
      if (null === $n) {
        continue;
      }
      $child = $n
        ->toXml(true)
        ->getElementsByTagName('node')
        ->item(0);
      $child = $dom
        ->importNode($child, true);
      $child
        ->setAttribute('name', $name);
      $node
        ->appendChild($child);
    }
    return $asDom ? $dom : $dom
      ->saveXML();
  }
  public function compile(Twig_Compiler $compiler) {
    foreach ($this->nodes as $node) {
      $node
        ->compile($compiler);
    }
  }
  public function getLine() {
    return $this->lineno;
  }
  public function getNodeTag() {
    return $this->tag;
  }

  /**
   * Returns true if the attribute is defined.
   *
   * @param string $name The attribute name
   *
   * @return bool true if the attribute is defined, false otherwise
   */
  public function hasAttribute($name) {
    return array_key_exists($name, $this->attributes);
  }

  /**
   * Gets an attribute value by name.
   *
   * @param string $name
   *
   * @return mixed
   */
  public function getAttribute($name) {
    if (!array_key_exists($name, $this->attributes)) {
      throw new LogicException(sprintf('Attribute "%s" does not exist for Node "%s".', $name, get_class($this)));
    }
    return $this->attributes[$name];
  }

  /**
   * Sets an attribute by name to a value.
   *
   * @param string $name
   * @param mixed  $value
   */
  public function setAttribute($name, $value) {
    $this->attributes[$name] = $value;
  }

  /**
   * Removes an attribute by name.
   *
   * @param string $name
   */
  public function removeAttribute($name) {
    unset($this->attributes[$name]);
  }

  /**
   * Returns true if the node with the given name exists.
   *
   * @param string $name
   *
   * @return bool
   */
  public function hasNode($name) {
    return array_key_exists($name, $this->nodes);
  }

  /**
   * Gets a node by name.
   *
   * @param string $name
   *
   * @return Twig_Node
   */
  public function getNode($name) {
    if (!array_key_exists($name, $this->nodes)) {
      throw new LogicException(sprintf('Node "%s" does not exist for Node "%s".', $name, get_class($this)));
    }
    return $this->nodes[$name];
  }

  /**
   * Sets a node.
   *
   * @param string    $name
   * @param Twig_Node $node
   */
  public function setNode($name, $node = null) {
    $this->nodes[$name] = $node;
  }

  /**
   * Removes a node by name.
   *
   * @param string $name
   */
  public function removeNode($name) {
    unset($this->nodes[$name]);
  }
  public function count() {
    return count($this->nodes);
  }
  public function getIterator() {
    return new ArrayIterator($this->nodes);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Node::$attributes	protected	property
Twig_Node::$lineno	protected	property
Twig_Node::$nodes	protected	property
Twig_Node::$tag	protected	property
Twig_Node::compile	public	function	Compiles the node to PHP. Overrides Twig_NodeInterface::compile	36
Twig_Node::count	public	function
Twig_Node::getAttribute	public	function	Gets an attribute value by name.
Twig_Node::getIterator	public	function
Twig_Node::getLine	public	function	Overrides Twig_NodeInterface::getLine
Twig_Node::getNode	public	function	Gets a node by name.
Twig_Node::getNodeTag	public	function	Overrides Twig_NodeInterface::getNodeTag
Twig_Node::hasAttribute	public	function	Returns true if the attribute is defined.
Twig_Node::hasNode	public	function	Returns true if the node with the given name exists.
Twig_Node::removeAttribute	public	function	Removes an attribute by name.
Twig_Node::removeNode	public	function	Removes a node by name.
Twig_Node::setAttribute	public	function	Sets an attribute by name to a value.
Twig_Node::setNode	public	function	Sets a node.
Twig_Node::toXml Deprecated	public	function
Twig_Node::__construct	public	function	Constructor.	36
Twig_Node::__toString	public	function