vendor/twig/twig/src/Node/ForNode.php line 96

  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  * (c) 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.  */
  13. namespace Twig\Node;
  15. use Twig\Attribute\YieldReady;
  16. use Twig\Compiler;
  17. use Twig\Node\Expression\AbstractExpression;
  18. use Twig\Node\Expression\Variable\AssignContextVariable;
  20. /**
  21.  * Represents a for node.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. #[YieldReady]
  26. class ForNode extends Node
  27. {
  28.     private $loop;
  30.     public function __construct(AssignContextVariable $keyTarget, AssignContextVariable $valueTarget, AbstractExpression $seq, ?Node $ifexpr, Node $body, ?Node $else, int $lineno)
  31.     {
  32.         $body = new Nodes([$body, $this->loop = new ForLoopNode($lineno)]);
  34.         if (null !== $ifexpr) {
  35.             trigger_deprecation('twig/twig', '3.19', \sprintf('Passing not-null to the "ifexpr" argument of the "%s" constructor is deprecated.', static::class));
  36.         }
  38.         if (null !== $else && !$else instanceof ForElseNode) {
  39.             trigger_deprecation('twig/twig', '3.19', \sprintf('Not passing an instance of "%s" to the "else" argument of the "%s" constructor is deprecated.', ForElseNode::class, static::class));
  41.             $else = new ForElseNode($else, $else->getTemplateLine());
  42.         }
  44.         $nodes = ['key_target' => $keyTarget, 'value_target' => $valueTarget, 'seq' => $seq, 'body' => $body];
  45.         if (null !== $else) {
  46.             $nodes['else'] = $else;
  47.         }
  49.         parent::__construct($nodes, ['with_loop' => true], $lineno);
  50.     }
  52.     public function compile(Compiler $compiler): void
  53.     {
  54.         $compiler
  55.             ->addDebugInfo($this)
  56.             ->write("\$context['_parent'] = \$context;\n")
  57.             ->write("\$context['_seq'] = CoreExtension::ensureTraversable(")
  58.             ->subcompile($this->getNode('seq'))
  59.             ->raw(");\n")
  60.         ;
  62.         if ($this->hasNode('else')) {
  63.             $compiler->write("\$context['_iterated'] = false;\n");
  64.         }
  66.         if ($this->getAttribute('with_loop')) {
  67.             $compiler
  68.                 ->write("\$context['loop'] = [\n")
  69.                 ->write("  'parent' => \$context['_parent'],\n")
  70.                 ->write("  'index0' => 0,\n")
  71.                 ->write("  'index'  => 1,\n")
  72.                 ->write("  'first'  => true,\n")
  73.                 ->write("];\n")
  74.                 ->write("if (is_array(\$context['_seq']) || (is_object(\$context['_seq']) && \$context['_seq'] instanceof \Countable)) {\n")
  75.                 ->indent()
  76.                 ->write("\$length = count(\$context['_seq']);\n")
  77.                 ->write("\$context['loop']['revindex0'] = \$length - 1;\n")
  78.                 ->write("\$context['loop']['revindex'] = \$length;\n")
  79.                 ->write("\$context['loop']['length'] = \$length;\n")
  80.                 ->write("\$context['loop']['last'] = 1 === \$length;\n")
  81.                 ->outdent()
  82.                 ->write("}\n")
  83.             ;
  84.         }
  86.         $this->loop->setAttribute('else', $this->hasNode('else'));
  87.         $this->loop->setAttribute('with_loop', $this->getAttribute('with_loop'));
  89.         $compiler
  90.             ->write("foreach (\$context['_seq'] as ")
  91.             ->subcompile($this->getNode('key_target'))
  92.             ->raw(' => ')
  93.             ->subcompile($this->getNode('value_target'))
  94.             ->raw(") {\n")
  95.             ->indent()
  96.             ->subcompile($this->getNode('body'))
  97.             ->outdent()
  98.             ->write("}\n")
  99.         ;
  101.         if ($this->hasNode('else')) {
  102.             $compiler->subcompile($this->getNode('else'));
  103.         }
  105.         $compiler->write("\$_parent = \$context['_parent'];\n");
  107.         // remove some "private" loop variables (needed for nested loops)
  108.         $compiler->write('unset($context[\'_seq\'], $context[\''.$this->getNode('key_target')->getAttribute('name').'\'], $context[\''.$this->getNode('value_target')->getAttribute('name').'\'], $context[\'_parent\']');
  109.         if ($this->hasNode('else')) {
  110.             $compiler->raw(', $context[\'_iterated\']');
  111.         }
  112.         if ($this->getAttribute('with_loop')) {
  113.             $compiler->raw(', $context[\'loop\']');
  114.         }
  115.         $compiler->raw(");\n");
  117.         // keep the values set in the inner context for variables defined in the outer context
  118.         $compiler->write("\$context = array_intersect_key(\$context, \$_parent) + \$_parent;\n");
  119.     }
  120. }