Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:115421
User-Agent: Cyrus-JMAP/3.5.0-alpha0-533-gf73e617b8a-fm-20210712.002-gf73e617b
Mime-Version: 1.0
Message-ID: <10a6e57c-394a-4966-b6dd-52d6ec38b6ea@www.fastmail.com>
In-Reply-To: 
 <DM6PR07MB66185254B3E799F927E945EBF9149@DM6PR07MB6618.namprd07.prod.outlook.com>
References: 
 <DM6PR07MB66185254B3E799F927E945EBF9149@DM6PR07MB6618.namprd07.prod.outlook.com>
Date: Tue, 13 Jul 2021 09:12:08 -0500
To: "php internals" <internals@lists.php.net>
Content-Type: text/plain
Subject: =?UTF-8?Q?Re:_[PHP-DEV]_Changing_method_naming_in_FFI_Type_Reflection_AP?=
 =?UTF-8?Q?I_from_Arg->Parameter,_etc?=
From: larry@garfieldtech.com ("Larry Garfield")

On Tue, Jul 13, 2021, at 8:51 AM, tyson andre wrote:
> Hi internals,
> 
> The FFI Type Reflection API mentioned in 
> https://externals.io/message/115336 was recently added
> 
> My opinion is that that they should be renamed to use the same naming 
> scheme that PHP's Reflection extension is already using.
> Having different ways of naming very similar concepts (different from 
> https://www.php.net/reflectionfunctionabstract) would make the language 
> harder to remember.
> I'd brought that up in 
> https://github.com/php/php-src/pull/7217#pullrequestreview-700990479 
> with no response
> 
> What do others think about the name? I was considering holding a short 
> vote
> (on getReturnType, getParameterCount, getParameterType) before the 
> feature freeze if there was interest
> 
> In particular,
> 
> - FFI\CData->getFuncReturnType should be changed to getReturnType - 
> only functions have return types
> 
>   This is consistent with 
> https://www.php.net/reflectionfunctionabstract 
> - I believe Arg should be renamed to Parameter and Func should be 
> removed from names where redundant.
>   E.g. getFuncArgCount should be renamed to getParameterCount 
> (getFuncArgType should be renamed getParameterType) - only functions 
> have parameters,
>   and PHP is already already using "Parameter" instead of "Argument" 
> for reflection on types elsewhere.
> 
>   Parameter is used to refer to the function declarations (AST_PARAM 
> internally in the AST, ReflectionFunctionAbstract->getParameters(), 
> etc.)
>   Argument is used to refer to expressions passed to the functions by 
> the caller (ArgumentCountError, etc.)
> 
>   Other languages use similar definitions, e.g. 
> https://developer.mozilla.org/en-US/docs/Glossary/Parameter
> - The discussion over where FFI arrays should support Countable::count 
> (and non-arrays should throw) might be contentious so I'd rather keep 
> getArrayLength

This all makes sense to me.  Consistent naming is better unless there's a very specific reason to to otherwise.

--Larry Garfield