Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123260
Precedence: bulk
MIME-Version: 1.0
References: <88ea5de8-22ea-4c23-b570-229acd546c10@app.fastmail.com> <CAEPJdu=OTak-Taj8pKAZcKFtMQFNMHDB+j4c=ymxqnpRwR1ing@mail.gmail.com>
In-Reply-To: <CAEPJdu=OTak-Taj8pKAZcKFtMQFNMHDB+j4c=ymxqnpRwR1ing@mail.gmail.com>
Date: Fri, 3 May 2024 09:28:38 +0200
Message-ID: <CANS-=pdB-SZfvHz-MA4+6ruRcMVcRejRxJf920XY4stGSe7ZSA@mail.gmail.com>
Subject: Re: [PHP-DEV] Inconsistencies between parameter number and index when
 reflecting a method/function
To: =?UTF-8?Q?Benjamin_Au=C3=9Fenhofer?= <kontakt@beberlei.de>
Cc: Ollie Read <php@ollie.codes>, =?UTF-8?Q?Bj=C3=B6rn_Larsson?= <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="0000000000009202fb061787ac65"
From: kjarli@gmail.com (Lynn)

--0000000000009202fb061787ac65
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Thu, May 2, 2024 at 10:21=E2=80=AFPM Benjamin Au=C3=9Fenhofer <kontakt@b=
eberlei.de>
wrote:

>
>
> On Thu, May 2, 2024 at 2:51=E2=80=AFPM Ollie Read <php@ollie.codes> wrote=
:
>
>> Hi All,
>>
>> I've been working on a PR that introduces
>> ReflectionFunctionAbstract::getParameter() and
>> ReflectionFunctionAbstract::hasParameter(), to fall more inline with the
>> other method sets we have, as well as just generally making peoples live=
s
>> easier.
>>
>> The PR is here: https://github.com/php/php-src/pull/10431
>>
>> These methods accept an integer to retrieve a parameter by its position,
>> or a string to retrieve by its name. So far, I have built this so that i=
f
>> you required the first parameter, it's parameter 0. I treat it this way
>> because the only other place where we deal with parameter indexes, is
>> ReflectionFunctionAbstract::getParameters() which returns the parameters
>> zero-indexed.
>>
>> The question that is holding this PR back is should these methods be 1
>> indexed, so that the provided position is consistent with the error
>> messages, or how a person would typically count, or should they be 0
>> indexed to remain consistent with the existing API.
>>
>
> PHP being a mostly zero indexed language I would say it should be
> getParamter(0) to get the parameter #1 (referred to as 1 in error
> messages).
>
>>
>> Girgias has asked that I pause the PR until we can have a discussion on
>> this mailing list about how to approach it, so I'm looking for feedback =
on
>> this.
>>
>>
>> ---
>> Best Regards,
>> *Ollie Read*
>>
>>
The parameter number always confuses me because parameter 4 is actually the
4th, not the 3rd like I'd expect if I look at the indexes when
`...$parameters`. Whenever I get an error about parameters I always have to
triple check and it costs me extra time to verify the number. I wouldn't
mind having this number be consistent with the array indexes instead. I
write Lua on a regular basis and everything starts with 1, but it's
consistent in the behavior so I never have to think twice.

--0000000000009202fb061787ac65
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div dir=3D"ltr"><br></div><br><div class=3D"gmail_quote">=
<div dir=3D"ltr" class=3D"gmail_attr">On Thu, May 2, 2024 at 10:21=E2=80=AF=
PM Benjamin Au=C3=9Fenhofer &lt;<a href=3D"mailto:kontakt@beberlei.de">kont=
akt@beberlei.de</a>&gt; wrote:<br></div><blockquote class=3D"gmail_quote" s=
tyle=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);pad=
ding-left:1ex"><div dir=3D"ltr"><div dir=3D"ltr"><br></div><br><div class=
=3D"gmail_quote"><div dir=3D"ltr" class=3D"gmail_attr">On Thu, May 2, 2024 =
at 2:51=E2=80=AFPM Ollie Read &lt;php@ollie.codes&gt; wrote:<br></div><bloc=
kquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:=
1px solid rgb(204,204,204);padding-left:1ex"><div><u></u><div><div>Hi All,<=
br></div><div><br></div><div><div>I&#39;ve been working on a PR that introd=
uces ReflectionFunctionAbstract::getParameter() and ReflectionFunctionAbstr=
act::hasParameter(), to fall more inline with the other method sets we have=
, as well as just generally making peoples lives easier.<br></div><div><br>=
</div><div>The PR is here: <a href=3D"https://github.com/php/php-src/pull/1=
0431" target=3D"_blank">https://github.com/php/php-src/pull/10431</a><br></=
div><div><br></div><div>These methods accept an integer to retrieve a param=
eter by its position, or a string to retrieve by its name. So far, I have b=
uilt this so that if you required the first parameter, it&#39;s parameter 0=
. I treat it this way because the only other place where we deal with param=
eter indexes, is ReflectionFunctionAbstract::getParameters() which returns =
the parameters zero-indexed.<br></div><div><br></div><div>The question that=
 is holding this PR back is should these methods be 1 indexed, so that the =
provided position is consistent with the error messages, or how a person wo=
uld typically count, or should they be 0 indexed to remain consistent with =
the existing API.<br></div></div></div></div></blockquote><div><br></div><d=
iv>PHP being a mostly zero indexed language I would say it should be getPar=
amter(0) to get the parameter #1 (referred to as 1 in error messages).=C2=
=A0</div><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8e=
x;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div><div><div><=
div></div><div><br></div><div>Girgias has asked that I pause the PR until w=
e can have a discussion on this mailing list about how to approach it, so I=
&#39;m looking for feedback on this.<br></div><br></div><div><br></div><div=
 id=3D"m_-3076480800752814008m_-8402907408477054289sig125548165"><div>---<b=
r></div><div>Best Regards,<br></div><div><b>Ollie Read</b><br></div></div><=
div><br></div></div></div></blockquote></div></div></blockquote><div><br></=
div><div>The parameter number always confuses me because parameter 4 is act=
ually the 4th, not the 3rd like I&#39;d expect if I look at the indexes whe=
n `...$parameters`. Whenever I get an error about parameters I always have =
to triple check and it costs me extra time to verify the number. I wouldn&#=
39;t mind having this number be consistent with the array indexes instead. =
I write Lua on a regular basis and everything starts with 1, but it&#39;s c=
onsistent in the behavior so I never have to think twice.=C2=A0</div></div>=
</div>

--0000000000009202fb061787ac65--