Remove each()

This has been deprecated in PHP 7.2 as part of
https://wiki.php.net/rfc/deprecations_php_7_2.

Author: nikic

UPGRADING

@@ -24,6 +24,7 @@ PHP 8.0 UPGRADE NOTES
   . Removed track_errors ini directive. This means that $php_errormsg is no
     longer available. The error_get_last() function may be used instead.
   . Removed create_function(). Anonymous functions may be used instead.
+  . Removed each(). foreach or ArrayIterator should be used instead.
 
 - GD:
   . The deprecated function image2wbmp() has been removed.

Zend/tests/007.phpt

@@ -37,7 +37,6 @@ static ZEND_FUNCTION(strcmp);
 static ZEND_FUNCTION(strncmp);
 static ZEND_FUNCTION(strcasecmp);
 static ZEND_FUNCTION(strncasecmp);
-static ZEND_FUNCTION(each);
 static ZEND_FUNCTION(error_reporting);
 static ZEND_FUNCTION(define);
 static ZEND_FUNCTION(defined);
@@ -108,10 +107,6 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_strncmp, 0, 0, 3)
 	ZEND_ARG_INFO(0, len)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_each, 0, 0, 1)
-	ZEND_ARG_INFO(1, arr)
-ZEND_END_ARG_INFO()
-
 ZEND_BEGIN_ARG_INFO_EX(arginfo_error_reporting, 0, 0, 0)
 	ZEND_ARG_INFO(0, new_error_level)
 ZEND_END_ARG_INFO()
@@ -238,7 +233,6 @@ static const zend_function_entry builtin_functions[] = { /* {{{ */
 	ZEND_FE(strncmp,		arginfo_strncmp)
 	ZEND_FE(strcasecmp,		arginfo_strcmp)
 	ZEND_FE(strncasecmp,		arginfo_strncmp)
-	ZEND_FE(each,			arginfo_each)
 	ZEND_FE(error_reporting,	arginfo_error_reporting)
 	ZEND_FE(define,			arginfo_define)
 	ZEND_FE(defined,		arginfo_defined)
@@ -653,66 +647,6 @@ ZEND_FUNCTION(strncasecmp)
 }
 /* }}} */
 
-/* {{{ proto mixed each(array &arr)
-   Return the currently pointed key..value pair in the passed array, and advance the pointer to the next element, or false if there is no element at this place */
-ZEND_FUNCTION(each)
-{
-	zval *array, *entry, tmp;
-	zend_ulong num_key;
-	HashTable *target_hash;
-	zend_string *key;
-
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "z/", &array) == FAILURE) {
-		return;
-	}
-
-	if (!EG(each_deprecation_thrown)) {
-		zend_error(E_DEPRECATED, "The each() function is deprecated. This message will be suppressed on further calls");
-		EG(each_deprecation_thrown) = 1;
-	}
-
-	target_hash = HASH_OF(array);
-	if (!target_hash) {
-		zend_error(E_WARNING,"Variable passed to each() is not an array or object");
-		return;
-	}
-	while (1) {
-		entry = zend_hash_get_current_data(target_hash);
-		if (!entry) {
-			RETURN_FALSE;
-		} else if (Z_TYPE_P(entry) == IS_INDIRECT) {
-			entry = Z_INDIRECT_P(entry);
-			if (Z_TYPE_P(entry) == IS_UNDEF) {
-				zend_hash_move_forward(target_hash);
-				continue;
-			}
-		}
-		break;
-	}
-	array_init_size(return_value, 4);
-	zend_hash_real_init_mixed(Z_ARRVAL_P(return_value));
-
-	/* add value elements */
-	ZVAL_DEREF(entry);
-	if (Z_REFCOUNTED_P(entry)) {
-		GC_ADDREF_EX(Z_COUNTED_P(entry), 2);
-	}
-	zend_hash_index_add_new(Z_ARRVAL_P(return_value), 1, entry);
-	zend_hash_add_new(Z_ARRVAL_P(return_value), ZSTR_KNOWN(ZEND_STR_VALUE), entry);
-
-	/* add the key elements */
-	if (zend_hash_get_current_key(target_hash, &key, &num_key) == HASH_KEY_IS_STRING) {
-		ZVAL_STR_COPY(&tmp, key);
-		Z_TRY_ADDREF(tmp);
-	} else {
-		ZVAL_LONG(&tmp, num_key);
-	}
-	zend_hash_index_add_new(Z_ARRVAL_P(return_value), 0, &tmp);
-	zend_hash_add_new(Z_ARRVAL_P(return_value), ZSTR_KNOWN(ZEND_STR_KEY), &tmp);
-	zend_hash_move_forward(target_hash);
-}
-/* }}} */
-
 /* {{{ proto int error_reporting([int new_error_level])
    Return the current error_reporting level, and if an argument was passed - change to the new level */
 ZEND_FUNCTION(error_reporting)

Zend/tests/each_001.phpt

@@ -177,8 +177,6 @@ void init_executor(void) /* {{{ */
 	EG(ht_iterators) = EG(ht_iterators_slots);
 	memset(EG(ht_iterators), 0, sizeof(EG(ht_iterators_slots)));
 
-	EG(each_deprecation_thrown) = 0;
-
 	EG(persistent_constants_count) = EG(zend_constants)->nNumUsed;
 	EG(persistent_functions_count) = EG(function_table)->nNumUsed;
 	EG(persistent_classes_count)   = EG(class_table)->nNumUsed;

Zend/tests/each_002.phpt

@@ -225,8 +225,6 @@ struct _zend_executor_globals {
 	zend_function trampoline;
 	zend_op       call_trampoline_op;
 
-	zend_bool each_deprecation_thrown;
-
 	void *reserved[ZEND_MAX_RESERVED_RESOURCES];
 };
 

Zend/tests/each_003.phpt

@@ -228,7 +228,6 @@ static const func_info_t func_infos[] = {
 	FC("strncmp",                 zend_lb_ssn_info),
 	FC("strcasecmp",              zend_l_ss_info),
 	FC("strncasecmp",             zend_lb_ssn_info),
-	F1("each",                    MAY_BE_NULL | MAY_BE_FALSE | MAY_BE_ARRAY | MAY_BE_ARRAY_OF_REF | MAY_BE_ARRAY_OF_ANY | MAY_BE_ARRAY_KEY_ANY),
 	F0("error_reporting",         MAY_BE_NULL | MAY_BE_LONG),
 	F0("define",                  MAY_BE_FALSE | MAY_BE_TRUE | MAY_BE_NULL), // TODO: inline
 	FC("defined",                 zend_b_s_info), // TODO: inline