Re: Proposal: Adding functions any(iterable $input, ?callable $cb = null, int $use_flags=0) and all(...)
| From: | Larry Garfield | Date: | Sun, 30 Aug 2020 14:49:23 +0000 |
| Subject: | Re: Proposal: Adding functions any(iterable $input, ?callable $cb = null, int $use_flags=0) and all(...) | ||
| References: | 1 | Groups: | php.internals |
| Request: | Send a blank email to internals+get-111721@lists.php.net to get a copy of this message | ||
On Sat, Aug 29, 2020, at 3:24 PM, tyson andre wrote:
> Hi internals,
>
> The primitives any() and all() are a common part of many programming
> languages and help in avoiding verbosity or unnecessary abstractions.
>
> -
>
> https://hackage.haskell.org/package/base-4.14.0.0/docs/Prelude.html#v:any
> -
>
> https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
> - https://docs.python.org/3/library/functions.html#all
> -
>
> https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html#allMatch-java.util.function.Predicate-
>
> For example, the following code could be shortened significantly
>
> ```
> // Old version
> $satisifes_predicate = false;
> foreach ($items as $item) {
> if (API::satisfiesCondition($item)) {
> $satisfies_predicate = true;
> break;
> }
> }
> if (!$satisfies_predicate) {
> throw new APIException("No matches found");
> }
>
> // New version is much shorter and readable
> if (!any($items, fn($x) => API::satisfiesCondition($x))) {
> throw new APIException("No matches found");
> }
> ```
>
> That example doesn't have any suitable helpers already in the standard
> library.
> Using array_filter would unnecessarily call satisfiesCondition even
> after the first item was found,
> and array_search doesn't take a callback.
>
> A proposed implementation is
> https://github.com/php/php-src/pull/6053 -
> it takes similar flags and param orders to array_filter().
>
> Previous discussion was in
> https://externals.io/message/103357#103373
>
> - New contributors to projects wouldn't know about any() and all() if
> it was reimplemented with different semantics and only occasionally used
> (e.g. MyArrayUtil::any()) in various projects)
> - If this was provided only in userland, there'd be low adoption and
> code such as the first example would remain common.
> If the standard library provided it, then polyfills would as well,
> making cleaner code easier to write.
>
> Thanks,
> - Tyson
I like this, but I do not like the flags. I don't think they're at all useful. A lot of
the other discussion in the thread seems to be needlessly complicating it, too.
all() and any() only need return booleans. Their callbacks only need return booleans. That's
the point. first() makes sense to add, and it would return the first value that matches.
For the callback itself, there is work to, hopefully, add partial function application to 8.1. (No
idea if it will be successful, but the effort is in progress.) If so, the upshot is that turning an
arbitrary function into a single-parameter function becomes silly easy, which means functions like
this can just expect a single parameter callback and be done with it. No need for extra-args or
flags or whatnot.
If you want to check the keys of an array, call array_keys() first and use that.
if (any(array_keys($foo), fn($k) => $k %2)) { ... }
all(), any(), and first() all sound like good things to include, but let's not over-complicate
them. We can do better today than we could in 1999...
--Larry Garfield