Incorrect getopt return type?

[mind-bending-forks]

Please excuse me not sending a pull request for this. Please let me know if you need me to.

phpstan seems to think that between PHP 7.1 and 7.4, getopt returned array<string, array<int, mixed>|string|false>. For those versions of PHP, phpstan returns the following error if you attempt to do a strict comparison of the output of getopt with false.

Strict comparison using === between array<string, array<int, mixed>|string|false> and false will always evaluate to false.

I have taken a look at old versions of the documentation for getopt using the Wayback Machine, and while the documented method signature says that previously returned array only, the "Return Values" section always appears to have reported that it will return false on failure.

Therefore, I think that the error message being reported for PHP versions 7.1 to 7.4 is potentially incorrect - and in an unsafe way, since if someone stops checking for false due to this error message it could result in error conditions being missed.

I suggest that phpstan should be updated to define the return type for getopt as array<string, array<int, mixed>|string|false>|false for those PHP versions. (So, add false as a permitted return type).

[ondrejmirtes]

Fixed, thanks: phpstan/phpstan-src@94b6c03

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.