Make arrays iterable

Author: Sevavietl

src/BaseArray.php

@@ -2,11 +2,13 @@
 
 namespace Sevavietl\Arrays;
 
-class BaseArray implements \ArrayAccess
+class BaseArray implements \ArrayAccess, \Iterator
 {
     protected $container;
     protected $undefinedOffsetAction;
 
+    protected $iteration = 0;
+
     public function __construct($array = [])
     {
         $this->container = $array;
@@ -65,7 +67,7 @@ public function offsetGet($offset) {
     }
 
     public function offsetSet($offset, $value) {
-        if (is_null($offset)) {
+        if (null === $offset) {
             $this->container[] = $value;
         } else {
             $this->container[$offset] = $value;
@@ -75,4 +77,31 @@ public function offsetSet($offset, $value) {
     public function offsetUnset($offset) {
         unset($this->container[$offset]);
     }
+
+    public function current()
+    {
+        return $this->offsetGet($this->key());
+    }
+
+    public function next()
+    {
+        $this->iteration += 1;
+        next($this->container);
+    }
+
+    public function key()
+    {
+        return \key($this->container);
+    }
+
+    public function valid()
+    {
+        return $this->iteration < \count($this->container);
+    }
+
+    public function rewind()
+    {
+        $this->iteration = 0;
+        reset($this->container);
+    }
 }

src/OneOffArray.php

@@ -4,11 +4,35 @@
 
 class OneOffArray extends BaseArray
 {
+    /** @var int|string|null */
+    private $key;
+
     public function offsetGet($offset)
     {
         $value = parent::offsetGet($offset);
         unset($this->container[$offset]);
 
         return $value;
     }
+
+    public function next()
+    {
+        $this->iteration += 1;
+        $this->key = \key($this->container);
+    }
+
+    public function key()
+    {
+        return $this->key;
+    }
+
+    public function valid()
+    {
+        return 0 !== \count($this->container);
+    }
+
+    public function rewind()
+    {
+        $this->key = \key($this->container);
+    }
 }

tests/unit/BaseArrayTest.php

@@ -49,4 +49,15 @@ public function testThrowsExceptionOnUndefinedOffset()
         $arr = new BaseArray([1, 2, 3]);
         $arr[3];
     }
+
+    public function testItIsIterable()
+    {
+        $arr = new BaseArray($initial = [1, 2, 3]);
+
+        foreach ($arr as $key => $value) {
+            $this->assertEquals($initial[$key], $value);
+        }
+
+        $this->assertEquals($initial, $arr->toArray());
+    }
 }

tests/unit/CompositeKeyArrayTest.php

@@ -156,4 +156,18 @@ public function arrayDataProviderForUnsetTesting()
             [['foo' => ['bar' => ['baz']]], ['foo', 'bar', 0], ['foo' => ['bar' => []]]],
         ];
     }
+
+    public function testItIsIterable()
+    {
+        $arr = new CompositeKeyArray($initial = [
+            'foo' => ['bar' => ['baz']],
+            'quux' => 'foobar',
+        ]);
+
+        foreach ($arr as $key => $value) {
+            $this->assertEquals($initial[$key], $value);
+        }
+
+        $this->assertEquals($initial, $arr->toArray());
+    }
 }

tests/unit/OneOffArrayTest.php

@@ -18,7 +18,7 @@ public function testOffsetGet($array, $offset, $value)
             $value,
             $array[$offset]
         );
-        
+
         $this->assertFalse(isset($array[$offset]));
     }
 
@@ -32,4 +32,15 @@ public function arrayDataProviderForGetTesting()
             [new CompositeKeyArray(['foo' => ['bar' => 'baz']]), ['foo', 'bar'], 'baz'],
         ];
     }
+
+    public function testItIsIterable()
+    {
+        $arr = new OneOffArray($initial = [1, 2, 3]);
+
+        foreach ($arr as $key => $value) {
+            $this->assertEquals($initial[$key], $value);
+        }
+
+        $this->assertEmpty($arr->toArray());
+    }
 }