Container::getComponents() parameters removed (BC break)

Author: dg

phpstan.neon

@@ -17,20 +17,8 @@ parameters:
 			count: 5
 			path: src/ComponentModel/Component.php
 
-		- # iterator wrapping is not expressible in return type
-			message: '#^Method Nette\\ComponentModel\\Container\:\:getComponents\(\) should return array\<int\|string, Nette\\ComponentModel\\IComponent\> but returns CallbackFilterIterator\<mixed, mixed, RecursiveIteratorIterator\<Nette\\ComponentModel\\RecursiveComponentIterator\>\>\|RecursiveIteratorIterator\<Nette\\ComponentModel\\RecursiveComponentIterator\>\.$#'
-			identifier: return.type
-			count: 1
-			path: src/ComponentModel/Container.php
-
 		- # IContainer::getComponent() has optional $throw parameter in implementation
 			message: '#^Method Nette\\ComponentModel\\IContainer\:\:getComponent\(\) invoked with 2 parameters, 1 required\.$#'
 			identifier: arguments.count
 			count: 1
 			path: src/ComponentModel/Container.php
-
-		- # duck-typing: IComponent may be IContainer with getComponents()
-			message: '#^Call to an undefined method Nette\\ComponentModel\\IComponent\:\:getComponents\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: src/ComponentModel/RecursiveComponentIterator.php

src/ComponentModel/Container.php

@@ -171,23 +171,17 @@ protected function createComponent(string $name): ?IComponent
 
 	/**
 	 * Returns all immediate child components.
-	 * @return array<int|string, IComponent>
+	 * @return IComponent[]
 	 */
-	final public function getComponents(): iterable
+	final public function getComponents(): array
 	{
-		$filterType = func_get_args()[1] ?? null;
-		if (func_get_args()[0] ?? null) { // back compatibility
-			$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 (func_get_args()[0] ?? null) {
+			throw new Nette\DeprecatedException(__METHOD__ . '() with recursive flag is deprecated. Use getComponentTree() instead.');
 		}
-
-		return $filterType
-			? array_filter($this->components, fn($item) => $item instanceof $filterType)
-			: $this->components;
+		if (func_get_args()[1] ?? null) {
+			throw new Nette\DeprecatedException('Using Container::getComponents() with filter type is deprecated.');
+		}
+		return $this->components;
 	}
 
 

src/ComponentModel/IContainer.php

@@ -34,7 +34,7 @@ function getComponent(string $name): ?IComponent;
 
 	/**
 	 * Returns immediate child components.
-	 * @return array<int|string, IComponent>
+	 * @return IComponent[]
 	 */
-	function getComponents(): iterable;
+	function getComponents(): array;
 }

src/ComponentModel/RecursiveComponentIterator.php

@@ -112,7 +112,7 @@ function testContainer(TestContainer $container): void
 	);
 
 	assertType(
-		'array<int|string, Nette\ComponentModel\IComponent>',
+		'array<Nette\ComponentModel\IComponent>',
 		$container->getComponents(),
 	);