Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123262
Feedback-ID: i835c46d5:Fastmail
User-Agent: Cyrus-JMAP/3.11.0-alpha0-417-gddc99d37d-fm-hotfix-20240424.001-g2c179674
Precedence: bulk
MIME-Version: 1.0
Message-ID: <ba13ca74-bce1-4d76-860a-c37decfd3dd5@app.fastmail.com>
In-Reply-To: 
 <63GXg3pF4DIRrXn-zuvO46emeZTrmkMOuiLUFwDA18PdV0y8BNqFvwidOxktGf3Z8geBiwCksbQ-Jpzg9OaxPv6VxDJRDkWCE5S2kabhmF4=@gpb.moe>
References: <88ea5de8-22ea-4c23-b570-229acd546c10@app.fastmail.com>
 <28215C90-191D-4159-9C47-86D03B9A683D@php.net>
 <63GXg3pF4DIRrXn-zuvO46emeZTrmkMOuiLUFwDA18PdV0y8BNqFvwidOxktGf3Z8geBiwCksbQ-Jpzg9OaxPv6VxDJRDkWCE5S2kabhmF4=@gpb.moe>
Date: Fri, 03 May 2024 10:10:18 +0100
To: "Gina P. Banyard" <internals@gpb.moe>, "Derick Rethans" <derick@php.net>
Cc: =?UTF-8?Q?Bj=C3=B6rn_Larsson?= <internals@lists.php.net>
Subject: Re: [PHP-DEV] Inconsistencies between parameter number and index when
 reflecting a method/function
Content-Type: multipart/alternative;
 boundary=06d9b4a962044aeea7de115d4970204d
From: php@ollie.codes ("Ollie Read")

--06d9b4a962044aeea7de115d4970204d
Content-Type: text/plain

On Fri, May 3, 2024, at 1:45 AM, Gina P. Banyard wrote:
> On Thursday, 2 May 2024 at 21:33, Derick Rethans <derick@php.net> wrote:
> 
> > On 2 May 2024 13:48:36 BST, Ollie Read php@ollie.codes wrote:
> > 
> > > 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 if 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.
> > 
> > 
> > 0-indexed, as that's what PHP does everywhere else.
> > 
> > cheers
> > Derick
> 
> Well not really, if you have an error (TypeError or ValueError) which indicate what parameter is the problem, it will be 1-indexed.
> 
> Which, for me, makes it more logical to have it 1-indexed.
> If the ReflectionFunctionAbstract::getParameters() API did not exist, this is what I would have pushed for.
> 
> Moreover, PHP already has a 1-indexed and 0-indexed discrepancy with the ob_get_level() and ob_get_status() functions.
> 
> In the end, I don't really care what we choose, but this just needed clarification from internals on how to proceed.
> 
> Best regards,
> 
> Gina P. Banyard
> 

It looks like the consensus seems to be 0-indexed, but I'm happy to allow it a bit more time to get a few more opinions if you'd prefer.

I do totally understand what you're saying, though. I think people are typically already capable of differentiation. We know that the first entry in a list array, so entry 1, is index 0. Not to mention the way getPosition() and getParameters() works.

---
Best Regards,
*Ollie Read*

--06d9b4a962044aeea7de115d4970204d
Content-Type: text/html
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE html><html><head><title></title><style type=3D"text/css">p.Mso=
Normal,p.MsoNoSpacing{margin:0}</style></head><body><div>On Fri, May 3, =
2024, at 1:45 AM, Gina P. Banyard wrote:<br></div><blockquote type=3D"ci=
te" id=3D"qt" style=3D""><div>On Thursday, 2 May 2024 at 21:33, Derick R=
ethans &lt;<a href=3D"mailto:derick@php.net">derick@php.net</a>&gt; wrot=
e:<br></div><div><br></div><div>&gt; On 2 May 2024 13:48:36 BST, Ollie R=
ead&nbsp;<a href=3D"mailto:php@ollie.codes">php@ollie.codes</a> wrote:<b=
r></div><div>&gt;&nbsp;<br></div><div>&gt; &gt; 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 if you required the firs=
t parameter, it's parameter 0. I treat it this way because the only othe=
r place where we deal with parameter indexes, is ReflectionFunctionAbstr=
act::getParameters() which returns the parameters zero-indexed.<br></div=
><div>&gt; &gt;&nbsp;<br></div><div>&gt; &gt; The question that is holdi=
ng this PR back is should these methods be 1 indexed, so that the provid=
ed 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><div>&gt;&nbsp;<br></div><div>&gt;&nbsp;<br><=
/div><div>&gt; 0-indexed, as that's what PHP does everywhere else.<br></=
div><div>&gt;&nbsp;<br></div><div>&gt; cheers<br></div><div>&gt; Derick<=
br></div><div><br></div><div>Well not really, if you have an error (Type=
Error or ValueError) which indicate what parameter is the problem, it wi=
ll be 1-indexed.<br></div><div><br></div><div>Which, for me, makes it mo=
re logical to have it 1-indexed.<br></div><div>If the ReflectionFunction=
Abstract::getParameters() API did not exist, this is what I would have p=
ushed for.<br></div><div><br></div><div>Moreover, PHP already has a 1-in=
dexed and 0-indexed discrepancy with the ob_get_level() and ob_get_statu=
s() functions.<br></div><div><br></div><div>In the end, I don't really c=
are what we choose, but this just needed clarification from internals on=
 how to proceed.<br></div><div><br></div><div>Best regards,<br></div><di=
v><br></div><div>Gina P. Banyard<br></div><div><br></div></blockquote><d=
iv><br></div><div>It looks like the consensus seems to be 0-indexed, but=
 I'm happy to allow it a bit more time to get a few more opinions if you=
'd prefer.<br></div><div><br></div><div>I do totally understand what you=
're saying, though. I think people are typically already capable of diff=
erentiation. We know that the first entry in a list array, so entry 1, i=
s index 0. Not to mention the way getPosition() and getParameters() work=
s.<br></div><div><br></div><div id=3D"sig125548165"><div class=3D"signat=
ure">---<br></div><div class=3D"signature">Best Regards,<br></div><div c=
lass=3D"signature"><b>Ollie Read</b><br></div></div><div><br></div></bod=
y></html>
--06d9b4a962044aeea7de115d4970204d--