Container::getComponents() returns incorrect type

[jtojnar]

component-model 3.1.0 returns array Container::getComponents() when $deep === false:

nette/component-model@7f613ee

instead of Iterator:

phpstan-nette/stubs/ComponentModel/Container.stub

Lines 11 to 13 in 8af9474

	* @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

The return type should be something like

@phpstan-return (
    $deep is true
    ? ($filterType is null ? array<int|string, \Nette\ComponentModel\IComponent> : array<int|string, T>)
    : ($filterType is null ? \Iterator<int|string, \Nette\ComponentModel\IComponent> : \Iterator<int|string, T>)
)

I can open a PR but not sure what to do about older versions. Should I just add conflict with < 3.1.0?

[jtojnar]

Or maybe we should even remove the stub since the arguments were deprecated in 3.1.0 and Nette has correct annotations for argument-less use.

[ondrejmirtes]

You can detect which version of Nette the project uses. This has similar approach: https://github.com/phpstan/phpstan-doctrine/blob/4058fdc7333cb9e46f8cf5b952cd9cb59658f2e5/src/Stubs/Doctrine/StubFilesExtensionLoader.php#L75-L84

[jtojnar]

Thanks for the pointer, I opened #142

[jtojnar]

Now it seems even more wrong nette/component-model@c40aa8e but it looks like it is ignored by PHPStan.

[jtojnar]

Dumping it, PHPStan just seems to infer untyped array as Container::getComponents() return value. Perhaps because of the conflict between the stub and upstream types.

[jtojnar]

Indeed removing the stub contents makes it detect array<Nette\ComponentModel\IComponent> as expected.