inc/Twig/Node/For.php

   1 <?php
   2
   3 /*
   4  * This file is part of Twig.
   5  *
   6  * (c) 2009 Fabien Potencier
   7  * (c) 2009 Armin Ronacher
   8  *
   9  * For the full copyright and license information, please view the LICENSE
  10  * file that was distributed with this source code.
  11  */
  12
  13 /**
  14  * Represents a for node.
  15  *
  16  * @author Fabien Potencier <fabien@symfony.com>
  17  */
  18 class Twig_Node_For extends Twig_Node
  19 {
  20     protected $loop;
  21
  22     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)
  23     {
  24         $body = new Twig_Node(array($body, $this->loop = new Twig_Node_ForLoop($lineno, $tag)));
  25
  26         if (null !== $ifexpr) {
  27             $body = new Twig_Node_If(new Twig_Node(array($ifexpr, $body)), null, $lineno, $tag);
  28         }
  29
  30         parent::__construct(array('key_target' => $keyTarget, 'value_target' => $valueTarget, 'seq' => $seq, 'body' => $body, 'else' => $else), array('with_loop' => true, 'ifexpr' => null !== $ifexpr), $lineno, $tag);
  31     }
  32
  33     /**
  34      * Compiles the node to PHP.
  35      *
  36      * @param Twig_Compiler A Twig_Compiler instance
  37      */
  38     public function compile(Twig_Compiler $compiler)
  39     {
  40         $compiler
  41             ->addDebugInfo($this)
  42             // the (array) cast bypasses a PHP 5.2.6 bug
  43             ->write("\$context['_parent'] = (array) \$context;\n")
  44             ->write("\$context['_seq'] = twig_ensure_traversable(")
  45             ->subcompile($this->getNode('seq'))
  46             ->raw(");\n")
  47         ;
  48
  49         if (null !== $this->getNode('else')) {
  50             $compiler->write("\$context['_iterated'] = false;\n");
  51         }
  52
  53         if ($this->getAttribute('with_loop')) {
  54             $compiler
  55                 ->write("\$context['loop'] = array(\n")
  56                 ->write("  'parent' => \$context['_parent'],\n")
  57                 ->write("  'index0' => 0,\n")
  58                 ->write("  'index'  => 1,\n")
  59                 ->write("  'first'  => true,\n")
  60                 ->write(");\n")
  61             ;
  62
  63             if (!$this->getAttribute('ifexpr')) {
  64                 $compiler
  65                     ->write("if (is_array(\$context['_seq']) || (is_object(\$context['_seq']) && \$context['_seq'] instanceof Countable)) {\n")
  66                     ->indent()
  67                     ->write("\$length = count(\$context['_seq']);\n")
  68                     ->write("\$context['loop']['revindex0'] = \$length - 1;\n")
  69                     ->write("\$context['loop']['revindex'] = \$length;\n")
  70                     ->write("\$context['loop']['length'] = \$length;\n")
  71                     ->write("\$context['loop']['last'] = 1 === \$length;\n")
  72                     ->outdent()
  73                     ->write("}\n")
  74                 ;
  75             }
  76         }
  77
  78         $this->loop->setAttribute('else', null !== $this->getNode('else'));
  79         $this->loop->setAttribute('with_loop', $this->getAttribute('with_loop'));
  80         $this->loop->setAttribute('ifexpr', $this->getAttribute('ifexpr'));
  81
  82         $compiler
  83             ->write("foreach (\$context['_seq'] as ")
  84             ->subcompile($this->getNode('key_target'))
  85             ->raw(" => ")
  86             ->subcompile($this->getNode('value_target'))
  87             ->raw(") {\n")
  88             ->indent()
  89             ->subcompile($this->getNode('body'))
  90             ->outdent()
  91             ->write("}\n")
  92         ;
  93
  94         if (null !== $this->getNode('else')) {
  95             $compiler
  96                 ->write("if (!\$context['_iterated']) {\n")
  97                 ->indent()
  98                 ->subcompile($this->getNode('else'))
  99                 ->outdent()
 100                 ->write("}\n")
 101             ;
 102         }
 103
 104         $compiler->write("\$_parent = \$context['_parent'];\n");
 105
 106         // remove some "private" loop variables (needed for nested loops)
 107         $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");
 108
 109         // keep the values set in the inner context for variables defined in the outer context
 110         $compiler->write("\$context = array_intersect_key(\$context, \$_parent) + \$_parent;\n");
 111     }
 112 }