Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:115422
To: php internals <internals@lists.php.net>
Thread-Topic: [PHP-DEV] Changing method naming in FFI Type Reflection API from
 Arg->Parameter, etc
Thread-Index: AQHXd+yHhG4u7tRODEilHBKBJW2Z/KtA8kgAgAAAWVQ=
Date: Tue, 13 Jul 2021 14:18:29 +0000
Message-ID:
 <DM6PR07MB661891FE241055C5D3D9EC3FF9149@DM6PR07MB6618.namprd07.prod.outlook.com>
References:
 <DM6PR07MB66185254B3E799F927E945EBF9149@DM6PR07MB6618.namprd07.prod.outlook.com>,<10a6e57c-394a-4966-b6dd-52d6ec38b6ea@www.fastmail.com>
In-Reply-To: <10a6e57c-394a-4966-b6dd-52d6ec38b6ea@www.fastmail.com>
Accept-Language: en-CA, en-US
Content-Language: en-CA
x-ms-exchange-messagesentrepresentingtype: 1
x-tmn:
 [b/n63GDAYR43CLymt9tQJaEO7kunl1IsgPJ6eKOt6xyw2Kx3aUCc5r8wE3RrhWMJ+ex3A1mZ7wo=]
x-ms-publictraffictype: Email
x-incomingheadercount: 44
x-eopattributedmessage: 0
x-ms-office365-filtering-correlation-id: 5f4f8a9f-df9b-4226-0605-08d946091644
x-ms-traffictypediagnostic: MW2NAM10HT178:
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info:
 zvjkIAyxN/w4zeAbeAKqEI3gobFxZGQuKzvoDPzl3pKnP0DjjjkUssG8BURU74UeRKIJcwMouiVS8qo1BTfrNm2UBE1p5f560/2D7RXLJyJA3LUTFuCLc0EwvWx8WbwTKssJXuOUH7VKsnTXJqacKspPbjGI7AHIjfSi7y25zuCrCZoXTSWlj/HV9WKYWO806fd5ALsF9Iik6WDvQYDWcVp5hCFddDZwuO4CKCbb5WyYVDPwUvaVVlEIUnBxKUqIPP0m5Hn2VMVKJGOHXNc3kD5iOa0oQG0o416t3RUMIko5eV8SoxRLyK5Eu3HVtW44oJgQGg9AS1A6jvGQO6LlwjxcxZW+hn3Gvo+6nHZzqqICVUO3DpTL72ds9CrggPoM47sAPTYdm1oOfNroeghALbED+Y0Y69YahvKhv/CACFAB1jY/dthsPxv85qqZSexESMjr0jklz5sWYAWqyuyi25N0sZEB96OuJ5hO3WV03lg=
x-ms-exchange-antispam-messagedata:
 rWdAEIp/SlpcQq5fDgK7FQy1rTQm6eqa+AUpTu07OjvanJN7XygAqvfxPqeNS6Ytn/f0fYn3cvgkFrkO7MPsrZonXcXkxfFDGbrvNMyQiT7rZ70UOPDYeNBiVsL/Rw0dn7e+7+lKhJv+iN112VSNz0zh+0K50K3ar8YXvJkLBcV8bmob98LDc7yket5yM1ss9nfv5Vmz30DY28IMA9aHHw==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: hotmail.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-AuthSource: MW2NAM10FT067.eop-nam10.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-Network-Message-Id: 5f4f8a9f-df9b-4226-0605-08d946091644
X-MS-Exchange-CrossTenant-originalarrivaltime: 13 Jul 2021 14:18:29.0973
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Internet
X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW2NAM10HT178
Subject: Re: [PHP-DEV] Changing method naming in FFI Type Reflection API from
 Arg->Parameter, etc
From: tysonandre775@hotmail.com (tyson andre)

> > The FFI Type Reflection API mentioned in =0A=
> > https://externals.io/message/115336 was recently added=0A=
> > =0A=
> > My opinion is that that they should be renamed to use the same naming =
=0A=
> > scheme that PHP's Reflection extension is already using.=0A=
> > Having different ways of naming very similar concepts (different from =
=0A=
> > https://www.php.net/reflectionfunctionabstract) would make the language=
 =0A=
> > harder to remember.=0A=
> > I'd brought that up in =0A=
> > https://github.com/php/php-src/pull/7217#pullrequestreview-700990479 =
=0A=
> > with no response=0A=
> > =0A=
> > What do others think about the name? I was considering holding a short =
=0A=
> > vote=0A=
> > (on getReturnType, getParameterCount, getParameterType) before the =0A=
> > feature freeze if there was interest=0A=
> > =0A=
> > In particular,=0A=
> > =0A=
> > - FFI\CData->getFuncReturnType should be changed to getReturnType - =0A=
> > only functions have return types=0A=
> > =0A=
> >=A0=A0 This is consistent with =0A=
> > https://www.php.net/reflectionfunctionabstract =0A=
> > - I believe Arg should be renamed to Parameter and Func should be =0A=
> > removed from names where redundant.=0A=
> >=A0=A0 E.g. getFuncArgCount should be renamed to getParameterCount =0A=
> > (getFuncArgType should be renamed getParameterType) - only functions =
=0A=
> > have parameters,=0A=
> >=A0=A0 and PHP is already already using "Parameter" instead of "Argument=
" =0A=
> > for reflection on types elsewhere.=0A=
> > =0A=
> >=A0=A0 Parameter is used to refer to the function declarations (AST_PARA=
M =0A=
> > internally in the AST, ReflectionFunctionAbstract->getParameters(), =0A=
> > etc.)=0A=
> >=A0=A0 Argument is used to refer to expressions passed to the functions =
by =0A=
> > the caller (ArgumentCountError, etc.)=0A=
> > =0A=
> >=A0=A0 Other languages use similar definitions, e.g. =0A=
> > https://developer.mozilla.org/en-US/docs/Glossary/Parameter=0A=
> > - The discussion over where FFI arrays should support Countable::count =
=0A=
> > (and non-arrays should throw) might be contentious so I'd rather keep =
=0A=
> > getArrayLength=0A=
> =0A=
> This all makes sense to me.=A0 Consistent naming is better unless there's=
 a very specific reason to to otherwise.=0A=
=0A=
Created a PR https://github.com/php/php-src/pull/7236=0A=
=0A=
Actually, looking at this again, I don't see a need to drop the "Func" - th=
ere's already getFuncABI.=0A=
=0A=
If you look at the current implementation, there's getStruct* for structure=
s, getArray*, getPointer*, meaning `getFunc*` sort of makes sense for a nam=
ing scheme to make it easier to find functionality associated with a given =
func.=0A=
=0A=
Still, I find my proposal of Arg->Parameter continues to make sense to me.=
=0A=
=0A=
Thanks,=0A=
Tyson=0A=