class Twig_Node_For

Represents a for node.

@package twig @author Fabien Potencier <fabien@symfony.com>

Hierarchy

Expanded class hierarchy of Twig_Node_For

File

drupal/core/vendor/twig/twig/lib/Twig/Node/For.php, line 19

View source
class Twig_Node_For extends Twig_Node {
  protected $loop;
  public function __construct(Twig_Node_Expression_AssignName $keyTarget, Twig_Node_Expression_AssignName $valueTarget, Twig_Node_Expression $seq, Twig_Node_Expression $ifexpr = null, Twig_NodeInterface $body, Twig_NodeInterface $else = null, $lineno, $tag = null) {
    $body = new Twig_Node(array(
      $body,
      $this->loop = new Twig_Node_ForLoop($lineno, $tag),
    ));
    if (null !== $ifexpr) {
      $body = new Twig_Node_If(new Twig_Node(array(
        $ifexpr,
        $body,
      )), null, $lineno, $tag);
    }
    parent::__construct(array(
      'key_target' => $keyTarget,
      'value_target' => $valueTarget,
      'seq' => $seq,
      'body' => $body,
      'else' => $else,
    ), array(
      'with_loop' => true,
      'ifexpr' => null !== $ifexpr,
    ), $lineno, $tag);
  }

  /**
   * Compiles the node to PHP.
   *
   * @param Twig_Compiler A Twig_Compiler instance
   */
  public function compile(Twig_Compiler $compiler) {
    $compiler
      ->addDebugInfo($this)
      ->write("\$context['_parent'] = (array) \$context;\n")
      ->write("\$context['_seq'] = twig_ensure_traversable(")
      ->subcompile($this
      ->getNode('seq'))
      ->raw(");\n");
    if (null !== $this
      ->getNode('else')) {
      $compiler
        ->write("\$context['_iterated'] = false;\n");
    }
    if ($this
      ->getAttribute('with_loop')) {
      $compiler
        ->write("\$context['loop'] = array(\n")
        ->write("  'parent' => \$context['_parent'],\n")
        ->write("  'index0' => 0,\n")
        ->write("  'index'  => 1,\n")
        ->write("  'first'  => true,\n")
        ->write(");\n");
      if (!$this
        ->getAttribute('ifexpr')) {
        $compiler
          ->write("if (is_array(\$context['_seq']) || (is_object(\$context['_seq']) && \$context['_seq'] instanceof Countable)) {\n")
          ->indent()
          ->write("\$length = count(\$context['_seq']);\n")
          ->write("\$context['loop']['revindex0'] = \$length - 1;\n")
          ->write("\$context['loop']['revindex'] = \$length;\n")
          ->write("\$context['loop']['length'] = \$length;\n")
          ->write("\$context['loop']['last'] = 1 === \$length;\n")
          ->outdent()
          ->write("}\n");
      }
    }
    $this->loop
      ->setAttribute('else', null !== $this
      ->getNode('else'));
    $this->loop
      ->setAttribute('with_loop', $this
      ->getAttribute('with_loop'));
    $this->loop
      ->setAttribute('ifexpr', $this
      ->getAttribute('ifexpr'));
    $compiler
      ->write("foreach (\$context['_seq'] as ")
      ->subcompile($this
      ->getNode('key_target'))
      ->raw(" => ")
      ->subcompile($this
      ->getNode('value_target'))
      ->raw(") {\n")
      ->indent()
      ->subcompile($this
      ->getNode('body'))
      ->outdent()
      ->write("}\n");
    if (null !== $this
      ->getNode('else')) {
      $compiler
        ->write("if (!\$context['_iterated']) {\n")
        ->indent()
        ->subcompile($this
        ->getNode('else'))
        ->outdent()
        ->write("}\n");
    }
    $compiler
      ->write("\$_parent = \$context['_parent'];\n");

    // remove some "private" loop variables (needed for nested loops)
    $compiler
      ->write('unset($context[\'_seq\'], $context[\'_iterated\'], $context[\'' . $this
      ->getNode('key_target')
      ->getAttribute('name') . '\'], $context[\'' . $this
      ->getNode('value_target')
      ->getAttribute('name') . '\'], $context[\'_parent\'], $context[\'loop\']);' . "\n");

    // keep the values set in the inner context for variables defined in the outer context
    $compiler
      ->write("\$context = array_merge(\$_parent, array_intersect_key(\$context, \$_parent));\n");
  }

}

Members

Namesort descending 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::count public function
Twig_Node::getAttribute public function Gets an attribute.
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 identifier exists.
Twig_Node::removeAttribute public function Removes an attribute.
Twig_Node::removeNode public function Removes a node by name.
Twig_Node::setAttribute public function Sets an attribute.
Twig_Node::setNode public function Sets a node.
Twig_Node::toXml public function
Twig_Node::__toString public function
Twig_Node_For::$loop protected property
Twig_Node_For::compile public function Compiles the node to PHP. Overrides Twig_Node::compile
Twig_Node_For::__construct public function Constructor. Overrides Twig_Node::__construct