ArrayHash: fixed iteration with reference (BC break) [Closes #253]

BC break, because it doesn't return RecursiveArrayIterator

Author: dg

src/Utils/ArrayHash.php

@@ -37,11 +37,13 @@ public static function from(array $array, bool $recursive = true): static
 
 	/**
 	 * Returns an iterator over all items.
-	 * @return \RecursiveArrayIterator<array-key, T>
+	 * @return \Iterator<int|string, T>
 	 */
-	public function getIterator(): \RecursiveArrayIterator
+	public function &getIterator(): \Iterator
 	{
-		return new \RecursiveArrayIterator((array) $this);
+		foreach ((array) $this as $key => $foo) {
+			yield $key => $this->$key;
+		}
 	}
 
 

tests/Utils/ArrayHash.phpt

@@ -117,7 +117,7 @@ test('', function () {
 		'j' => 'Jack',
 		'children' => $list['children'],
 		'c' => 'Jim',
-	], iterator_to_array(new RecursiveIteratorIterator($list, RecursiveIteratorIterator::SELF_FIRST)));
+	], iterator_to_array(new RecursiveIteratorIterator(new RecursiveArrayIterator($list), RecursiveIteratorIterator::SELF_FIRST)));
 });
 
 
@@ -204,3 +204,13 @@ test('PHP 7 changed behavior https://3v4l.org/2A1pf', function () {
 
 	Assert::count(0, $hash);
 });
+
+
+test('iteration with reference', function () {
+	$hash = ArrayHash::from([1, 2, 3]);
+	foreach ($hash as $key => &$value) {
+		$value = 'new';
+	}
+
+	Assert::same(['new', 'new', 'new'], (array) $hash);
+});