fixup! Update ComponentModel\Container stub for component-model 3.1.0

Author: jtojnar

stubs/ComponentModel/Container.stub

@@ -10,7 +10,7 @@ class Container extends Component implements IContainer
 	 * @phpstan-param null|class-string<T> $filterType
 	 * @phpstan-return ($filterType is null ? \Iterator<int|string, \Nette\ComponentModel\IComponent> : \Iterator<int|string, T>)
 	 */
-	public function getComponents(bool $deep = false, string $filterType = null): \Iterator
+	public function getComponents(bool $deep = false, ?string $filterType = null): \Iterator
 	{
 		// nothing
 	}

stubs/ComponentModel/Container_3_1.stub

@@ -14,7 +14,7 @@ class Container extends Component implements IContainer
 	 * 	: ($filterType is null ? \Iterator<int|string, \Nette\ComponentModel\IComponent> : \Iterator<int|string, T>)
 	 * )
 	 */
-	public function getComponents(bool $deep = false, string $filterType = null): iterable
+	public function getComponents(bool $deep = false, ?string $filterType = null): iterable
 	{
 		// nothing
 	}

tests/Type/Nette/data/componentModel.php

@@ -3,6 +3,8 @@
 namespace PHPStan\Type\Nette\Data\ComponentModel;
 
 use Nette\Application\UI\Control;
+use Nette\Application\UI\Form;
+use Nette\Forms\Container;
 use function PHPStan\Testing\assertType;
 
 class SomeControl extends Control {
@@ -33,6 +35,26 @@ public function createComponent(string $name): AnotherControl {
 
 }
 
+class SomeForm extends Form {
+}
+
+function getInstalledVersion(string $package): ?string
+	{
+		if (!class_exists(InstalledVersions::class)) {
+			return null;
+		}
+
+		try {
+			$installedVersion = InstalledVersions::getVersion($package);
+		} catch (OutOfBoundsException $e) {
+			return null;
+		}
+
+		return $installedVersion;
+	}
+
+$componentModelVersion = self::getInstalledVersion('nette/component-model');
+
 $bool = rand(0, 1) ? true : false;
 
 $someControl = new SomeControl();
@@ -56,3 +78,18 @@ public function createComponent(string $name): AnotherControl {
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown', false));
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown', true));
 assertType('PHPStan\Type\Nette\Data\ComponentModel\AnotherControl', $overrideCreateControl->getComponent('unknown', $bool));
+
+$someForm = new SomeForm();
+if($componentModelVersion !== null && version_compare($componentModelVersion, '3.1.0', '>=')) {
+	assertType('array<int|string, Nette\ComponentModel\IComponent>', $someForm->getComponents(false));
+	assertType('array<int|string, Nette\Forms\Container>', $someForm->getComponents(false, Container::class));
+	assertType('Iterator<int|string, Nette\ComponentModel\IComponent>', $someForm->getComponents(true));
+	assertType('Iterator<int|string, Nette\Forms\Container>', $someForm->getComponents(true, Container::class));
+	assertType('array<int|string, Nette\ComponentModel\IComponent>|Iterator<int|string, Nette\ComponentModel\IComponent>', $someControl->getComponents($bool));
+} else {
+	assertType('Iterator<int|string, Nette\ComponentModel\IComponent>', $someForm->getComponents(false));
+	assertType('Iterator<int|string, Nette\Forms\Container>', $someForm->getComponents(false, Container::class));
+	assertType('Iterator<int|string, Nette\ComponentModel\IComponent>', $someForm->getComponents(true));
+	assertType('Iterator<int|string, Nette\Forms\Container>', $someForm->getComponents(true, Container::class));
+	assertType('Iterator<int|string, Nette\ComponentModel\IComponent>', $someControl->getComponents($bool));
+}