Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123251
Feedback-ID: i835c46d5:Fastmail
User-Agent: Cyrus-JMAP/3.11.0-alpha0-416-g2c1796742e-fm-20240424.001-g2c179674
Precedence: bulk
MIME-Version: 1.0
Message-ID: <88ea5de8-22ea-4c23-b570-229acd546c10@app.fastmail.com>
Date: Thu, 02 May 2024 13:48:36 +0100
To: =?UTF-8?Q?Bj=C3=B6rn_Larsson?= <internals@lists.php.net>
Subject: [PHP-DEV] Inconsistencies between parameter number and index when reflecting a method/function
Content-Type: multipart/alternative;
 boundary=81a34ca5fe744d1b90d8af0a5eaf9ef0
From: php@ollie.codes ("Ollie Read")

--81a34ca5fe744d1b90d8af0a5eaf9ef0
Content-Type: text/plain

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 lives 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 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.

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*

--81a34ca5fe744d1b90d8af0a5eaf9ef0
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>Hi All,<br></di=
v><div><br></div><div><div>I've been working on a PR that introduces Ref=
lectionFunctionAbstract::getParameter() and ReflectionFunctionAbstract::=
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/pu=
ll/10431">https://github.com/php/php-src/pull/10431</a><br></div><div><b=
r></div><div>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 tr=
eat it this way because the only other place where we deal with paramete=
r indexes, is ReflectionFunctionAbstract::getParameters() which returns =
the parameters zero-indexed.<br></div><div><br></div><div>The question t=
hat is holding this PR back is should these methods be 1 indexed, so tha=
t the provided position is consistent with the error messages, or how a =
person would typically count, or should they be 0 indexed to remain cons=
istent with the existing API.<br></div><div><br></div><div>Girgias has a=
sked 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.<br><=
/div><br></div><div><br></div><div id=3D"sig125548165"><div class=3D"sig=
nature">---<br></div><div class=3D"signature">Best Regards,<br></div><di=
v class=3D"signature"><b>Ollie Read</b><br></div></div><div><br></div></=
body></html>
--81a34ca5fe744d1b90d8af0a5eaf9ef0--