1 <?php declare(strict_types=1);
3 namespace PhpParser\Node\Stmt;
7 class Foreach_ extends Node\Stmt
9 /** @var Node\Expr Expression to iterate */
11 /** @var null|Node\Expr Variable to assign key to */
13 /** @var bool Whether to assign value by reference */
15 /** @var Node\Expr Variable to assign value to */
17 /** @var Node\Stmt[] Statements */
21 * Constructs a foreach node.
23 * @param Node\Expr $expr Expression to iterate
24 * @param Node\Expr $valueVar Variable to assign value to
25 * @param array $subNodes Array of the following optional subnodes:
26 * 'keyVar' => null : Variable to assign key to
27 * 'byRef' => false : Whether to assign value by reference
28 * 'stmts' => array(): Statements
29 * @param array $attributes Additional attributes
31 public function __construct(Node\Expr $expr, Node\Expr $valueVar, array $subNodes = [], array $attributes = []) {
32 parent::__construct($attributes);
34 $this->keyVar = $subNodes['keyVar'] ?? null;
35 $this->byRef = $subNodes['byRef'] ?? false;
36 $this->valueVar = $valueVar;
37 $this->stmts = $subNodes['stmts'] ?? [];
40 public function getSubNodeNames() : array {
41 return ['expr', 'keyVar', 'byRef', 'valueVar', 'stmts'];
44 public function getType() : string {
45 return 'Stmt_Foreach';