ArrayList support returning references (#289)

Author: duncanxia97

src/Utils/ArrayList.php

@@ -41,11 +41,13 @@ public static function from(array $array): static
 
 	/**
 	 * Returns an iterator over all items.
-	 * @return \ArrayIterator<int, T>
+	 * @return \Iterator<int, T>
 	 */
-	public function getIterator(): \ArrayIterator
+	public function &getIterator(): \Iterator
 	{
-		return new \ArrayIterator($this->list);
+		foreach ($this->list as &$item) {
+			yield $item;
+		}
 	}
 
 

tests/Utils/ArrayList.phpt

@@ -157,3 +157,13 @@ test('', function () {
 		unset($list['key']);
 	}, OutOfRangeException::class, 'Offset invalid or out of range');
 });
+
+
+test('returning references', function () {
+	$list = ArrayList::from([1, 2, 3]);
+	foreach ($list as $key => &$value) {
+		$value = 'new';
+	}
+
+	Assert::same(['new', 'new', 'new'], iterator_to_array($list));
+});