Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:120502
Feedback-ID: i8414410d:Fastmail
User-Agent: Cyrus-JMAP/3.9.0-alpha0-447-ge2460e13b3-fm-20230525.001-ge2460e13
Mime-Version: 1.0
Message-ID: <59ab68ce-8634-4ec5-92ae-ea46a04d774f@app.fastmail.com>
In-Reply-To: <97308c1d-e9f0-e28d-78ba-11da2a136ee6@fide.pl>
References: <97308c1d-e9f0-e28d-78ba-11da2a136ee6@fide.pl>
Date: Thu, 01 Jun 2023 16:29:46 +0000
To: "php internals" <internals@lists.php.net>
Content-Type: text/plain;charset=utf-8
Content-Transfer-Encoding: quoted-printable
Subject: Re: [PHP-DEV] Proposal: addition of array_find() and array_find_key()
 functions
From: larry@garfieldtech.com ("Larry Garfield")

On Thu, Jun 1, 2023, at 4:02 PM, Janusz Szczypka wrote:
> Dear PHP Internals,
>
> I would like to propose new functions to search in arrays: array_find(=
) and
> array_find_key().
>
> array_find(): This function would allow developers to find the first=20
> element in
> an array that satisfies a specific condition. The condition would be=20
> defined by
> a callback function. The functionality would be similar to the existing
> array_filter() function but would instead return the first element tha=
t=20
> matches
> the callback condition, rather than all matching elements.
> This function can be used in a way simliar to in_array with added=20
> functionality
> of custom check.
>
> array_find_key(): This function would return the key of the first=20
> element in an
> array that matches a given condition, defined by a callback function. =
This
> function can be used in a way simliar to array_search with added=20
> functionality
> of custom check.
>
> Both functions stop processing after first match is found, so any side=20
> effects
> of the callbacks should be avoided.
>
> Here are the proposed function definitions:
>
> /**
>  =C2=A0* @param callable(mixed):bool $callback
>  =C2=A0*/
> function array_find(callable $callback, array $array)
> {
>  =C2=A0=C2=A0=C2=A0 foreach ($array as $row) {
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 if (call_user_func($callba=
ck, $row) =3D=3D=3D true) {
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 re=
turn $row;
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 }
>  =C2=A0=C2=A0=C2=A0 }
>  =C2=A0=C2=A0=C2=A0 return null;
> }
>
> /**
>  =C2=A0* @param callable(mixed):bool $callback
>  =C2=A0* @return null|int|string
>  =C2=A0*/
> function array_find_key(callable $callback, array $array)
> {
>  =C2=A0=C2=A0=C2=A0 foreach($array as $key =3D> $row) {
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 if (call_user_func($callba=
ck, $row) =3D=3D=3D true) {
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 re=
turn $key;
>  =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 }
>  =C2=A0=C2=A0=C2=A0 }
>  =C2=A0=C2=A0=C2=A0 return null;
> }
>
> Both functions are easy to implement in PHP (and probably as easy to=20
> implement
> in C), but IMHO could be nice addition to set of array related functio=
ns=20
> in PHP.
>
> If the response to this e-mail will be positive, I will prepare RFC.
> We should also discuss order of arguments as the functions are similar=20
> to both
> array_search/in_array with condition-array and array_filter with
> array-condition, but as you can see above I am leaning towards=20
> condition-array.
>
> Looking forward to hearing your thoughts.
>
> Best regards,
> Janusz

As with the array_group thread:

What is the argument to put these functions in hard to update C, rather =
than PHP that is easy to download with Composer?  "could be a nice addit=
ion" is not a compelling argument.  Is it substantially faster?  It is t=
ruly universally used?  Does it correct some security concern?

Those are the questions that stdlib additions need to answer.

--Larry Garfield