Improve getopt() function stub

Author: janedbal

stubs/core.stub

@@ -318,3 +318,11 @@ function abs($num) {}
  * @return ($categorize is true ? array<string, array<string, mixed>> : array<string, mixed>)
  */
 function get_defined_constants(bool $categorize = false): array {}
+
+/**
+ * @param array<string> $long_options
+ * @param-out int $rest_index
+ * @return __benevolent<array<string,string>|array<string,false>|array<string,list<mixed>>|false>
+ */
+function getopt(string $short_options, array $long_options = [], int &$rest_index = null): array|false {}
+

tests/PHPStan/Analyser/nsrt/getopt.php

@@ -5,5 +5,6 @@
 use function getopt;
 use function PHPStan\Testing\assertType;
 
-$opts = getopt("ab:c::", ["longopt1", "longopt2:", "longopt3::"]);
+$opts = getopt("ab:c::", ["longopt1", "longopt2:", "longopt3::"], $restIndex);
 assertType('(array<string, list<mixed>|string|false>|false)', $opts);
+assertType('int', $restIndex);