Proposal: Add iterable\any(iterable $input, ?callable $cb=null), all(...), none(...), find(...), reduce(...)

ext/standard/basic_functions.stub.php

@@ -2,6 +2,8 @@
 
 /** @generate-class-entries */
 
+namespace {
+
 final class __PHP_Incomplete_Class
 {
 }
@@ -1510,3 +1512,20 @@ function sapi_windows_set_ctrl_handler(?callable $handler, bool $add = true): bo
 
 function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): bool {}
 #endif
+} // end global namespace
+
+namespace iterable {
+
+function all(iterable $iterable, ?callable $callback = null): bool {}
+
+function any(iterable $iterable, ?callable $callback = null): bool {}
+
+function none(iterable $iterable, ?callable $callback = null): bool {}
+
+function find(iterable $iterable, callable $callback, mixed $default = null): mixed {}
+
+//function fold(iterable $iterable, callable $by, mixed $initial): mixed {}
+
+function reduce(iterable $iterable, callable $by): mixed {}
+
+}

ext/standard/basic_functions_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 088e107c889f44d0a9762c47fce668f4d82f28ba */
+ * Stub hash: c04b8fad2fb795a23786e6340a514c63d9edf5a1 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_set_time_limit, 0, 1, _IS_BOOL, 0)
 	ZEND_ARG_TYPE_INFO(0, seconds, IS_LONG, 0)
@@ -2218,6 +2218,26 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_sapi_windows_generate_ctrl_event
 ZEND_END_ARG_INFO()
 #endif
 
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_iterable_all, 0, 1, _IS_BOOL, 0)
+	ZEND_ARG_TYPE_INFO(0, iterable, IS_ITERABLE, 0)
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, callback, IS_CALLABLE, 1, "null")
+ZEND_END_ARG_INFO()
+
+#define arginfo_iterable_any arginfo_iterable_all
+
+#define arginfo_iterable_none arginfo_iterable_all
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_iterable_find, 0, 2, IS_MIXED, 0)
+	ZEND_ARG_TYPE_INFO(0, iterable, IS_ITERABLE, 0)
+	ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, default, IS_MIXED, 0, "null")
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_iterable_reduce, 0, 2, IS_MIXED, 0)
+	ZEND_ARG_TYPE_INFO(0, iterable, IS_ITERABLE, 0)
+	ZEND_ARG_TYPE_INFO(0, by, IS_CALLABLE, 0)
+ZEND_END_ARG_INFO()
+
 
 ZEND_FUNCTION(set_time_limit);
 ZEND_FUNCTION(header_register_callback);
@@ -2839,6 +2859,11 @@ ZEND_FUNCTION(sapi_windows_set_ctrl_handler);
 #if defined(PHP_WIN32)
 ZEND_FUNCTION(sapi_windows_generate_ctrl_event);
 #endif
+ZEND_FUNCTION(all);
+ZEND_FUNCTION(any);
+ZEND_FUNCTION(none);
+ZEND_FUNCTION(find);
+ZEND_FUNCTION(reduce);
 
 
 static const zend_function_entry ext_functions[] = {
@@ -3492,6 +3517,11 @@ static const zend_function_entry ext_functions[] = {
 #if defined(PHP_WIN32)
 	ZEND_FE(sapi_windows_generate_ctrl_event, arginfo_sapi_windows_generate_ctrl_event)
 #endif
+	ZEND_NS_FE("iterable", all, arginfo_iterable_all)
+	ZEND_NS_FE("iterable", any, arginfo_iterable_any)
+	ZEND_NS_FE("iterable", none, arginfo_iterable_none)
+	ZEND_NS_FE("iterable", find, arginfo_iterable_find)
+	ZEND_NS_FE("iterable", reduce, arginfo_iterable_reduce)
 	ZEND_FE_END
 };
 

ext/standard/tests/iterable/all_array.phpt

@@ -0,0 +1,68 @@
+--TEST--
+Test all() function
+--FILE--
+<?php
+
+use function iterable\all;
+
+/*
+    Prototype: bool all(array $array, mixed $callback);
+    Description: Iterate array and stop based on return value of callback
+*/
+
+function is_int_ex($item)
+{
+    return is_int($item);
+}
+
+echo "\n*** Testing not enough or wrong arguments ***\n";
+
+function dump_all(...$args) {
+    try {
+        var_dump(all(...$args));
+    } catch (Error $e) {
+        printf("Caught %s: %s\n", $e::class, $e->getMessage());
+    }
+}
+
+dump_all();
+dump_all(true);
+dump_all([]);
+dump_all(true, function () {});
+dump_all([], true);
+
+echo "\n*** Testing basic functionality ***\n";
+
+dump_all([1, 2, 3], 'is_int_ex');
+dump_all(['hello', 1, 2, 3], 'is_int_ex');
+$iterations = 0;
+dump_all(['hello', 1, 2, 3], function($item) use (&$iterations) {
+    ++$iterations;
+    return is_int($item);
+});
+var_dump($iterations);
+
+echo "\n*** Testing edge cases ***\n";
+
+dump_all([], 'is_int_ex');
+
+echo "\nDone";
+?>
+--EXPECT--
+*** Testing not enough or wrong arguments ***
+Caught ArgumentCountError: iterable\all() expects at least 1 argument, 0 given
+Caught TypeError: iterable\all(): Argument #1 ($iterable) must be of type iterable, bool given
+bool(true)
+Caught TypeError: iterable\all(): Argument #1 ($iterable) must be of type iterable, bool given
+Caught TypeError: iterable\all(): Argument #2 ($callback) must be a valid callback or null, no array or string given
+
+*** Testing basic functionality ***
+bool(true)
+bool(false)
+bool(false)
+int(1)
+
+*** Testing edge cases ***
+bool(true)
+
+Done

ext/standard/tests/iterable/all_traversable.phpt

@@ -0,0 +1,63 @@
+--TEST--
+Test all() function
+--FILE--
+<?php
+
+use function iterable\all;
+
+/*
+    Prototype: bool all(array $array, ?callable $callback = null, int $use_type = 0);
+    Description: Iterate array and stop based on return value of callback
+*/
+
+function is_int_ex($item)
+{
+    return is_int($item);
+}
+
+function dump_all(...$args) {
+    try {
+        var_dump(all(...$args));
+    } catch (Error $e) {
+        printf("Caught %s: %s\n", $e::class, $e->getMessage());
+    }
+}
+
+
+echo "\n*** Testing not enough or wrong arguments ***\n";
+
+dump_all(new ArrayIterator());
+dump_all(new ArrayIterator(), true);
+
+echo "\n*** Testing basic functionality ***\n";
+
+dump_all(new ArrayIterator([1, 2, 3]), 'is_int_ex');
+dump_all(new ArrayIterator(['hello', 1, 2, 3]), 'is_int_ex');
+$iterations = 0;
+dump_all(new ArrayIterator(['hello', 1, 2, 3]), function($item) use (&$iterations) {
+    ++$iterations;
+    return is_int($item);
+});
+var_dump($iterations);
+
+echo "\n*** Testing edge cases ***\n";
+
+dump_all(new ArrayIterator(), 'is_int_ex');
+
+echo "\nDone";
+?>
+--EXPECT--
+*** Testing not enough or wrong arguments ***
+bool(true)
+Caught TypeError: iterable\all(): Argument #2 ($callback) must be a valid callback or null, no array or string given
+
+*** Testing basic functionality ***
+bool(true)
+bool(false)
+bool(false)
+int(1)
+
+*** Testing edge cases ***
+bool(true)
+
+Done

ext/standard/tests/iterable/any_array.phpt

@@ -0,0 +1,81 @@
+--TEST--
+Test any() function
+--FILE--
+<?php
+
+use function iterable\any;
+
+/*
+	Prototype: bool any(array $iterable, mixed $callback);
+	Description: Iterate array and stop based on return value of callback
+*/
+
+function is_int_ex($nr)
+{
+	return is_int($nr);
+}
+
+echo "\n*** Testing not enough or wrong arguments ***\n";
+
+function dump_any(...$args) {
+    try {
+        var_dump(any(...$args));
+    } catch (Error $e) {
+        printf("Caught %s: %s\n", $e::class, $e->getMessage());
+    }
+}
+
+dump_any();
+dump_any(true);
+dump_any([]);
+dump_any(true, function () {});
+dump_any([], true);
+
+echo "\n*** Testing basic functionality ***\n";
+
+dump_any(['hello', 'world'], 'is_int_ex');
+dump_any(['hello', 1, 2, 3], 'is_int_ex');
+$iterations = 0;
+dump_any(['hello', 1, 2, 3], function($item) use (&$iterations) {
+	++$iterations;
+	return is_int($item);
+});
+var_dump($iterations);
+
+echo "\n*** Testing second argument to predicate ***\n";
+
+dump_any([1, 2, 3], function($item, $key) {
+	var_dump($key);
+	return false;
+});
+
+echo "\n*** Testing edge cases ***\n";
+
+dump_any([], 'is_int_ex');
+
+dump_any(['key' => 'x'], null);
+
+echo "\nDone";
+?>
+--EXPECT--
+*** Testing not enough or wrong arguments ***
+Caught ArgumentCountError: iterable\any() expects at least 1 argument, 0 given
+Caught TypeError: iterable\any(): Argument #1 ($iterable) must be of type iterable, bool given
+bool(false)
+Caught TypeError: iterable\any(): Argument #1 ($iterable) must be of type iterable, bool given
+Caught TypeError: iterable\any(): Argument #2 ($callback) must be a valid callback or null, no array or string given
+
+*** Testing basic functionality ***
+bool(false)
+bool(true)
+bool(true)
+int(2)
+
+*** Testing second argument to predicate ***
+Caught ArgumentCountError: Too few arguments to function {closure}(), 1 passed and exactly 2 expected
+
+*** Testing edge cases ***
+bool(false)
+bool(true)
+
+Done