Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:120738
To: Rowan Tommins <rowan.collins@gmail.com>, "internals@lists.php.net"
	<internals@lists.php.net>
CC: Nikita Popov <nikita.ppv@gmail.com>
Thread-Topic: [PHP-DEV] [RFC] [Vote] Deprecate functions with overloaded
 signatures
Thread-Index:
 AQHZqDNOzscc7EYmMEqrpB8lsTz/k6+dZgkAgAAWZYCAAFdR/4AAsh6AgANtoEmABh+sxA==
Date: Mon, 3 Jul 2023 13:29:05 +0000
Message-ID:
 <BN7PR05MB40330F77229B2357E9C2B02EDE29A@BN7PR05MB4033.namprd05.prod.outlook.com>
References:
 <CAH5C8xV2ph8GOTDVZjK968+_AKLrrgkoTNDZpK6oE71PXhrOPQ@mail.gmail.com>
 <6B872612-2F31-49E0-949C-CDF6FB2B9BE4@benramsey.com>
 <b19e3af5-6505-40be-b84b-49ba432c46d0@app.fastmail.com>
 <BN7PR05MB403329C9AB32DEC445864B54DE27A@BN7PR05MB4033.namprd05.prod.outlook.com>
 <57104d4a-6e7a-ab57-e2b2-7973ce4bb429@gmail.com>
 <BN7PR05MB40330BFFD3D54E9D74369692DE25A@BN7PR05MB4033.namprd05.prod.outlook.com>
In-Reply-To:
 <BN7PR05MB40330BFFD3D54E9D74369692DE25A@BN7PR05MB4033.namprd05.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
msip_labels:
x-ms-exchange-messagesentrepresentingtype: 1
x-tmn: [TDeaA3qVQkyDx7GCXU00dZ8wANqQ4TCd]
x-ms-publictraffictype: Email
x-ms-traffictypediagnostic: BN7PR05MB4033:EE_|SJ2PR05MB9657:EE_
x-ms-office365-filtering-correlation-id: 1df67b85-938c-4fd6-4a5c-08db7bc9796a
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info:
 idWKVVC+HhhhSmolMu3rw36CiMAfR0kpBtlvrr1yLcBoYsaNnj0qzsMtunSA2cz7CLlC3Q8Cjq/37dmOA99XYO8oAl1oQMw1Sfj27XYG8FsDj7GE/yTY1KKUux6mUS4AdKKBok26H4UrME6IVXIk4cvERCUwsm9XlYNllLKXImgMfG5MwB0Ijh3wb2h+qjq26AYLh1SUq1uqf5/PBZ7Gu2p5ltpH/F9M2EmiTlRAW/C/iXli7+8ZYONYo44uiivJY7Bs32d/TkSOOyYa2tuJL1NcOo1XKJt5i80veldouwp+xB02dJlNcGv9AMNArFTqzlsZBEr3EZe36/UMMuEtnUYbUdHCHsBm4NAHHQg//H/4U3l5qkGs4/G5XxXVknezy2/x2UFf12Wf6lakj+I/aVLgQdHKjZRhWTkmw/Q2MO7imKwfGHnsYSVl460vM7yvjXMgD0l7plQT1w0KA5ecxgrKsQUi1gktkyuagMZxni+Bz/HKF5z30pQ6sTe/lBOFnyH9fDBBKpp4TQSkqlBg/i0oJGYZzkJqEAPySHE3sUQ=
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0:
 =?iso-8859-1?Q?czw36zbeu0cTIeEuxEBr4wODM3wBLuRlKNGxlAPpL0zfAnXJnEZKczZCNN?=
 =?iso-8859-1?Q?zmBdGFemcAR29IzKDDWHBGCJLDbCiqrgDUBU0Gens8aKUIACA7hQJQGiaH?=
 =?iso-8859-1?Q?dYiqRKSeiL30QmUIN/PPI4bvH2h9YB3gFHj4+DO9faEKNYKIST/3n7Ko83?=
 =?iso-8859-1?Q?eGcMnS+DhyjZQ9kRuEb+4tLsMc1EE/qMMdkbOb+Yd0uuklnS/xyyR5Sre4?=
 =?iso-8859-1?Q?tit3+uqbIMyEaaijXcqcCs+fLnn5I8vPgRP/KKfST45o/RTwAReLS0/rcJ?=
 =?iso-8859-1?Q?G8i6vYz5ZIdROse17+aqxH8IgjfWgLRx0MIPbixoL3DP7EU6B7UUkohApl?=
 =?iso-8859-1?Q?vRRupzLqrAzjDen4XTH6L+PMogRGg4ZDUVC4ESaOwDZcfSNsRXoAEipIzZ?=
 =?iso-8859-1?Q?29mXlXB4Xoo/55QAV7NiCqiqur3PVETW0K+tfbABxHdlmH1rvGuX1TTdOQ?=
 =?iso-8859-1?Q?padvw+/4NJkTC2qJXpRf7qhGGOOsQsZ1RVbCzt4x8feHGMdbOkennitmDi?=
 =?iso-8859-1?Q?K04TqB677m85bzJ32lFIEKD9b51ebdiG8O0fDu2gmegiT5jkeoaf2MJvdU?=
 =?iso-8859-1?Q?Ci+UARKxwZNhnXcVkhBVoVmY1Zk7tW/zMCB/A5vHhYzf3RuJWv04OylWq3?=
 =?iso-8859-1?Q?m/XhjzOrAk92pH+pdXXLuAKCybvfY46/IeY+QeLlmgbCOVF2SvhhXxRTfU?=
 =?iso-8859-1?Q?vlEo1+SULn81UPM1LarGXrDyQOc7D45Zvp6juvVakVkxQuilUul0uPvhZ7?=
 =?iso-8859-1?Q?ciqbG+hP53Xem7X6sotrTUpAVn8SLPoqLHj0Fz4nemh7UtwWDOEs9bJcG5?=
 =?iso-8859-1?Q?ZNwI5ytNBPDI7sHFHpTCPMpTmS1t/mwsu2ejmbCtrGiCW+ePD4IqR2AaDf?=
 =?iso-8859-1?Q?hNia3XC0o2winIABxPO9q6JLWMLGNfHRG25fWDqfR4jyPTeQrf3qqKOBbf?=
 =?iso-8859-1?Q?TRzzl3I9psQbPklkN/QVReRSAmWvgpTz3mbawUHtxZILZpWQBDsvkR+te4?=
 =?iso-8859-1?Q?yYTt7//4BVCNiT8YmfOu5TSkuiB4tlNnWA8kkmAQpVutbtr3JXm/LMaIvr?=
 =?iso-8859-1?Q?CHSlh+lZKPjM3zThH1KlpeYbaJnvFsxx0eraoZY1vL9ytrHU5DxIR73guI?=
 =?iso-8859-1?Q?U4WYKL0AbYdJK2c3cugb061zmQmj6bOubNAKHsYMPszxh1pmL03o+e9OjY?=
 =?iso-8859-1?Q?JkODCEC7n36Ld/de8qlQGUfTPIK2Y4zSrXQUr3FAA+0mIWo8qMum4LKXHR?=
 =?iso-8859-1?Q?bZUyzAa3Zs+O19Yw6tBQ=3D=3D?=
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: BN7PR05MB4033.namprd05.prod.outlook.com
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-Network-Message-Id: 1df67b85-938c-4fd6-4a5c-08db7bc9796a
X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-originalarrivaltime: 03 Jul 2023 13:29:05.8567
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ2PR05MB9657
Subject: Re: [PHP-DEV] [RFC] [Vote] Deprecate functions with overloaded
 signatures
From: theodorejb@outlook.com (Theodore Brown)

On Thu June 29, 2023 at 11:51 AM Theodore Brown wrote:=0A=
> On Tue, June 27, 2023, 6:33 Rowan Tommins wrote:=0A=
> > On 27/06/2023 02:25, Theodore Brown wrote:=0A=
> > > Currently the following code returns only the array keys that loosely=
 equal null:=0A=
> > >=0A=
> > >      array_keys($array, null)=0A=
> > >=0A=
> > > If the function is changed to a single signature with $filter_value d=
efaulting to null (with an argument count check to preserve the above funct=
ionality), its behavior becomes a lot more surprising/unexpected. If a para=
meter defaults to null, as a user I don't expect the function to work diffe=
rently when I explicitly pass the default value.=0A=
> >=0A=
> >=0A=
> > An alternative solution to this situation is to introduce a new dummy=
=0A=
> > value for such parameters, similar to how JavaScript uses the special=
=0A=
> > "Symbol" type to have keys that can't collide with any userland value.=
=0A=
> > In this context, this could be achieved with a single-value enum, i.e.:=
=0A=
> >=0A=
> > enum ArrayKeys { case IncludeAll; }=0A=
> >=0A=
> > function array_keys(array $array, mixed $filter_value =3D=0A=
> > ArrayKeys::IncludeAll, bool $strict =3D false): array {}=0A=
> >=0A=
> > That way, the optional parameter has a real default value, distinct fro=
m=0A=
> > any value the user might wish to filter by, including null, and full=0A=
> > compatibility is maintained with existing code.=0A=
>=0A=
> ...Note that currently there is a draft RFC to support objects in array k=
eys. [1] If that feature is accepted, would it not be allowed to filter arr=
ay keys by the `ArrayKeys::IncludeAll` enum value? That would also be surpr=
ising/unexpected.=0A=
=0A=
=0A=
I must have been really tired when I wrote the above paragraph, because I f=
orgot that the `filter_value` parameter matches against the value, not the =
key (so the Object Keys in Arrays RFC has nothing to do with it).=0A=
=0A=
But this makes using an enum as the default `filter_value` even more proble=
matic, since enums can already be used as array values and this would preve=
nt filtering an array to return keys for this value. I.e. the following cod=
e would stop working: https://3v4l.org/5Br1a=0A=
=0A=
So I still believe the overloaded array_keys signature should be deprecated=
 for consistency and to avoid confusing behavior.=0A=
=0A=
Best regards,=0A=
Theodore=0A=
=0A=
[1]: https://wiki.php.net/rfc/object_keys_in_arrays=