Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123256
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 01:11:24 +0200
Message-ID: <CAPzBOBMrZ2__HTKg8XNf=2nkF4gEXpnuwPgG81eNwnU-CDLhaQ@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="0000000000009f20a0061780b9fd"
From: landers.robert@gmail.com (Robert Landers)

--0000000000009f20a0061780b9fd
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Thu, May 2, 2024 at 10:22=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*
>>
>>
Parameter zero is the first parameter. Both are correct, we access memory
from the start (0), but as humans, we count total items. You never say I
have zero goats and really mean that you have one goat. However, if you
wanted to start at the beginning of a line of goats, you'd start at
position zero to get the first goat.

Robert Landers
Software Engineer
Utrecht NL

--0000000000009f20a0061780b9fd
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div dir=3D"ltr"><div dir=3D"ltr"><div class=3D"gmail_defa=
ult" style=3D"font-family:&quot;trebuchet ms&quot;,sans-serif"><span style=
=3D"font-family:Arial,Helvetica,sans-serif">On Thu, May 2, 2024 at 10:22=E2=
=80=AFPM Benjamin Au=C3=9Fenhofer &lt;<a href=3D"mailto:kontakt@beberlei.de=
">kontakt@beberlei.de</a>&gt; wrote:</span><br></div></div><div class=3D"gm=
ail_quote"><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.=
8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir=3D"lt=
r"><div dir=3D"ltr"><br></div><br><div class=3D"gmail_quote"><div dir=3D"lt=
r" 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><blockquote class=3D"gmail_quote" st=
yle=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padd=
ing-left:1ex"><div><u></u><div><div>Hi All,<br></div><div><br></div><div><d=
iv>I&#39;ve been working on a PR that introduces ReflectionFunctionAbstract=
::getParameter() and ReflectionFunctionAbstract::hasParameter(), to fall mo=
re inline with the other method sets we have, as well as just generally mak=
ing peoples lives easier.<br></div><div><br></div><div>The PR is here: <a h=
ref=3D"https://github.com/php/php-src/pull/10431" target=3D"_blank">https:/=
/github.com/php/php-src/pull/10431</a><br></div><div><br></div><div>These m=
ethods accept an integer to retrieve a parameter by its position, or a stri=
ng to retrieve by its name. So far, I have built this so that if you requir=
ed the first parameter, it&#39;s parameter 0. I treat it this way because t=
he only other place where we deal with parameter indexes, is ReflectionFunc=
tionAbstract::getParameters() which returns the parameters zero-indexed.<br=
></div><div><br></div><div>The question that is holding this PR back is sho=
uld 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.<br></div></di=
v></div></div></blockquote><div><br></div><div>PHP being a mostly zero inde=
xed language I would say it should be getParamter(0) to get the parameter #=
1 (referred to as 1 in error messages).=C2=A0</div><blockquote class=3D"gma=
il_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,2=
04,204);padding-left:1ex"><div><div><div><div></div><div><br></div><div>Gir=
gias has asked that I pause the PR until we can have a discussion on this m=
ailing list about how to approach it, so I&#39;m looking for feedback on th=
is.<br></div><br></div><div><br></div><div id=3D"m_-4914379054915604984m_-8=
402907408477054289sig125548165"><div>---<br></div><div>Best Regards,<br></d=
iv><div><b>Ollie Read</b><br></div></div><div><br></div></div></div></block=
quote></div></div></blockquote><div><br></div><div><span style=3D"font-fami=
ly:&quot;trebuchet ms&quot;,sans-serif">Parameter zero is the first paramet=
er<span class=3D"gmail_default" style=3D"font-family:&quot;trebuchet ms&quo=
t;,sans-serif">. Both are correct, we access memory from the start (0), but=
 as humans, we count total items. You never say I have zero goats and reall=
y mean that you have one goat. However, if you wanted to start at the begin=
ning of a line of goats, you&#39;d start at position zero to get the first =
goat.</span></span></div><div><br></div><div class=3D"gmail_default" style=
=3D"font-family:&quot;trebuchet ms&quot;,sans-serif"><span style=3D"font-fa=
mily:Arial,Helvetica,sans-serif">Robert Landers</span></div><div>Software E=
ngineer</div><div>Utrecht NL</div><div><br></div></div></div></div>

--0000000000009f20a0061780b9fd--