Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:126051
Precedence: bulk
MIME-Version: 1.0
Date: Tue, 26 Nov 2024 11:40:23 +0200
Message-ID: <CAM0CcxiBSTQi3u=_eew17OYzr=G88iAiY+-Xbr2zmvF8QxYPkg@mail.gmail.com>
Subject: [PHP-DEV] iterator_count signature for iterables
To: PHP Internals <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="00000000000005536b0627cda45c"
From: zsidelnik@gmail.com (Eugene Sidelnyk)

--00000000000005536b0627cda45c
Content-Type: text/plain; charset="UTF-8"

Hello internals!

Currently, iterator_count has the following signature:

 iterator_count(Traversable|array $iterator): int

If we try to use iterable type and pass it to iterator_count function, we'd
get following static analysis error:

 Argument 1 of iterator_count expects Traversable|array<array-key, mixed>,
but iterable<int, list<string>> provided (see https://psalm.dev/004)
$start(iterator_count($chunks));

From what I know, iterable is just built-in compile time type alias
for array|Traversable
(https://www.php.net/manual/en/language.types.iterable.php)

I think it would make sense to change the signature of iterator_count to
accept iterable rather than array|Traversable so that static analysis tools
would pick it up better

--00000000000005536b0627cda45c
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div>Hello internals!</div><div><br></div><div>Currently,=
=C2=A0iterator_count has the following signature:</div><div><br></div><div>=
=C2=A0iterator_count(Traversable|array $iterator): int</div><div><br></div>=
<div>If we try to use iterable type and pass it to iterator_count function,=
 we&#39;d get following static analysis error:</div><div><br></div><div>=C2=
=A0Argument 1 of iterator_count expects Traversable|array&lt;array-key, mix=
ed&gt;, but iterable&lt;int, list&lt;string&gt;&gt; provided (see <a href=
=3D"https://psalm.dev/004">https://psalm.dev/004</a>)<br>$start(iterator_co=
unt($chunks));</div><div><br></div><div>From what I know, iterable is just =
 built-in compile time type alias for
 =20
  <code class=3D"gmail-literal">array|Traversable </code>(<a href=3D"https:=
//www.php.net/manual/en/language.types.iterable.php">https://www.php.net/ma=
nual/en/language.types.iterable.php</a>)</div><div><br></div><div>I think i=
t would make sense to change the signature of iterator_count to accept iter=
able rather than array|Traversable so that static analysis tools would pick=
 it up better<br></div><div><br></div><div><br></div></div>

--00000000000005536b0627cda45c--