Container::getControls() returns list instead of iterator with names (BC break)

Author: dg

src/Forms/Container.php

@@ -285,11 +285,12 @@ public function addComponent(
 
 
 	/**
-	 * Iterates over all form controls.
+	 * Retrieves the entire hierarchy of form controls including nested.
+	 * @return list<Control>
 	 */
-	public function getControls(): \Iterator
+	public function getControls(): array
 	{
-		return $this->getComponents(true, Control::class);
+		return array_values(array_filter($this->getComponentTree(), fn($c) => $c instanceof Control));
 	}
 
 

tests/Forms/Container.getControls().phpt

@@ -15,22 +15,4 @@ $form->addContainer('cont')
 	->addText('name');
 
 $controls = $form->getControls();
-
-$names = $values = [];
-foreach ($controls as $name => $value) {
-	$names[] = $name;
-	$values[] = $value;
-}
-
-Assert::same(['name', 'age', 'name'], $names);
-Assert::same([$form['name'], $form['age'], $form['cont-name']], $values);
-
-// again
-$names = $values = [];
-foreach ($controls as $name => $value) {
-	$names[] = $name;
-	$values[] = $value;
-}
-
-Assert::same(['name', 'age', 'name'], $names);
-Assert::same([$form['name'], $form['age'], $form['cont-name']], $values);
+Assert::same([$form['name'], $form['age'], $form['cont-name']], $controls);