Container::getComponents() returns array when $deep is false (BC break)

Author: dg

src/ComponentModel/Container.php

@@ -15,7 +15,7 @@
 /**
  * ComponentContainer is default implementation of IContainer.
  *
- * @property-read \Iterator $components
+ * @property-read IComponent[] $components
  */
 class Container extends Component implements IContainer
 {
@@ -179,20 +179,22 @@ protected function createComponent(string $name): ?IComponent
 
 	/**
 	 * Iterates over descendants components.
-	 * @return \Iterator<int|string,IComponent>
+	 * @return iterable<int|string,IComponent>
 	 */
-	final public function getComponents(bool $deep = false, ?string $filterType = null): \Iterator
+	final public function getComponents(bool $deep = false, ?string $filterType = null): iterable
 	{
-		$iterator = new RecursiveComponentIterator($this->components);
 		if ($deep) {
+			$iterator = new RecursiveComponentIterator($this->components);
 			$iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::SELF_FIRST);
+			if ($filterType) {
+				$iterator = new \CallbackFilterIterator($iterator, fn($item) => $item instanceof $filterType);
+			}
+			return $iterator;
 		}
 
-		if ($filterType) {
-			$iterator = new \CallbackFilterIterator($iterator, fn($item) => $item instanceof $filterType);
-		}
-
-		return $iterator;
+		return $filterType
+			? array_filter($this->components, fn($item) => $item instanceof $filterType)
+			: $this->components;
 	}
 
 

src/ComponentModel/IContainer.php

@@ -36,7 +36,7 @@ function getComponent(string $name): ?IComponent;
 
 	/**
 	 * Iterates over descendants components.
-	 * @return \Iterator<int|string,IComponent>
+	 * @return iterable<int|string,IComponent>
 	 */
-	function getComponents(): \Iterator;
+	function getComponents(): iterable;
 }

src/ComponentModel/RecursiveComponentIterator.php

@@ -30,7 +30,7 @@ public function hasChildren(): bool
 	 */
 	public function getChildren(): self
 	{
-		return $this->current()->getComponents();
+		return new self($this->current()->getComponents());
 	}
 
 

tests/ComponentModel/Container.getComponents.phpt

@@ -38,26 +38,13 @@ Assert::same([
 	'one',
 	'two',
 	'button1',
-], array_keys(iterator_to_array($list)));
-
+], array_keys($list));
 
 // Filter
 $list = $c->getComponents(false, Button::class);
 Assert::same([
 	'button1',
-], array_keys(iterator_to_array($list)));
-
-
-// RecursiveIteratorIterator
-$list = new RecursiveIteratorIterator($c->getComponents(), 1);
-Assert::same([
-	'one',
-	'inner',
-	'inner2',
-	'button2',
-	'two',
-	'button1',
-], array_keys(iterator_to_array($list)));
+], array_keys($list));
 
 
 // Recursive

tests/ComponentModel/Container.zeroname.phpt

@@ -21,5 +21,5 @@ Assert::same('0', $container->getComponent('0')->getName());
 $container->addComponent($c1 = new Container, '1', '0');
 Assert::same(
 	[1 => $c1, 0 => $c0],
-	(array) $container->getComponents(),
+	$container->getComponents(),
 );