Implemented ArrayAccess, IteratorAggregate and Countable in ArrObj

Author: minwork

src/ArrObj.php

@@ -3,16 +3,19 @@
 namespace Minwork\Helper;
 
 use ArrayAccess;
+use ArrayIterator;
 use BadMethodCallException;
+use Countable;
+use IteratorAggregate;
 
 /**
  * Class ArrObj
  * @package Minwork\Helper
  * @method bool has(mixed $keys)
  * @method bool hasKeys(mixed $keys, bool $strict = false)
  * @method mixed get(mixed $keys, $default = null)
- * @method self set(mixed $keys, mixed $value)
- * @method self remove(mixed $keys)
+ * @method ArrObj set(mixed $keys, mixed $value)
+ * @method ArrObj remove(mixed $keys)
  *
  * @method bool check(mixed|callable $condition, bool $strict = false)
  * @method bool isEmpty()
@@ -22,40 +25,40 @@
  * @method bool isNested()
  * @method bool isArrayOfArrays()
  *
- * @method self map(callable $callback, int $mode = Arr::MAP_ARRAY_KEY_VALUE)
- * @method self mapObjects(string $method, ...$args)
+ * @method ArrObj map(callable $callback, int $mode = Arr::MAP_ARRAY_KEY_VALUE)
+ * @method ArrObj mapObjects(string $method, ...$args)
  *
- * @method self filterByKeys(mixed $keys, bool $exclude = false)
- * @method self filterObjects(string $method, ...$args)
+ * @method ArrObj filterByKeys(mixed $keys, bool $exclude = false)
+ * @method ArrObj filterObjects(string $method, ...$args)
  *
- * @method self group(string|int $key)
- * @method self groupObjects(string $method, ...$args)
+ * @method ArrObj group(string|int $key)
+ * @method ArrObj groupObjects(string $method, ...$args)
  *
- * @method self orderByKeys(mixed $keys, bool $appendUnmatched = true)
- * @method self sortByKeys(mixed $keys = null, bool $assoc = true)
- * @method self sortObjects(string $method, ...$args)
+ * @method ArrObj orderByKeys(mixed $keys, bool $appendUnmatched = true)
+ * @method ArrObj sortByKeys(mixed $keys = null, bool $assoc = true)
+ * @method ArrObj sortObjects(string $method, ...$args)
  *
- * @method self sum(array ...$arrays)
- * @method self diffObjects(array $array, array ...$arrays)
- * @method self intersectObjects(array $array, array ...$arrays)
+ * @method ArrObj sum(array ...$arrays)
+ * @method ArrObj diffObjects(array $array, array ...$arrays)
+ * @method ArrObj intersectObjects(array $array, array ...$arrays)
  *
- * @method self flatten(?int $depth = null, bool $assoc = false)
- * @method self flattenSingle()
+ * @method ArrObj flatten(?int $depth = null, bool $assoc = false)
+ * @method ArrObj flattenSingle()
  *
  * @method int getDepth()
- * @method self clone()
+ * @method ArrObj clone()
  * @method mixed random(int $count = 1)
- * @method self shuffle()
- * @method self nth(int $A = 1, int $B = 0)
- * @method self even()
- * @method self odd()
+ * @method ArrObj shuffle()
+ * @method ArrObj nth(int $A = 1, int $B = 0)
+ * @method ArrObj even()
+ * @method ArrObj odd()
  *
  * @method string|int|null getFirstKey()
  * @method string|int|null getLastKey()
  * @method mixed getFirstValue()
  * @method mixed getLastValue()
  */
-class ArrObj
+class ArrObj implements IteratorAggregate, ArrayAccess, Countable
 {
     const METHODS = [
         'has',
@@ -164,4 +167,36 @@ public function setArray($array): self
         $this->array = $array;
         return $this;
     }
+
+    public function offsetExists($offset)
+    {
+        return array_key_exists($offset, $this->array);
+    }
+
+    public function offsetGet($offset)
+    {
+        return $this->array[$offset] ?? null;
+    }
+
+    public function offsetSet($offset, $value)
+    {
+        return $this->array[$offset] = $value;
+    }
+
+    public function offsetUnset($offset)
+    {
+        if (isset($this->array[$offset])) {
+            unset($this->array[$offset]);
+        }
+    }
+
+    public function getIterator()
+    {
+        return new ArrayIterator($this->array);
+    }
+
+    public function count()
+    {
+        return count($this->array);
+    }
 }

test/ArrObj/ArrObjTest.php

@@ -86,4 +86,59 @@ public function testThrowsExceptionOnInvalidMethod()
         /** @noinspection PhpUndefinedMethodInspection */
         (new ArrObj())->invalidMethodTest();
     }
+
+    /**
+     * @param array $array
+     *
+     * @dataProvider arrayProvider
+     */
+    public function testArrayAccess($array)
+    {
+        $obj = new ArrObj($array);
+        $key = Arr::getFirstKey($array);
+
+        $this->assertSame($array[$key], $obj[$key]);
+        $this->assertSame(isset($array[$key]), isset($obj[$key]));
+        $this->assertSame(isset($array['non_existent_key_643543543']), isset($obj['non_existent_key_643543543']));
+
+        $newKey = 'very_long_unique_key';
+        $newValue = 'dump_value_123';
+        $this->assertSame($array[$newKey] = $newValue, $obj[$newKey] = $newValue);
+        $this->assertSame($array[$newKey], $obj[$newKey]);
+        $this->assertSame(isset($array[$newKey]), isset($obj[$newKey]));
+
+        unset($array[$newKey], $obj[$newKey]);
+        $this->assertSame(isset($array[$newKey]), isset($obj[$newKey]));
+    }
+
+    /**
+     * @param array $array
+     *
+     * @dataProvider arrayProvider
+     */
+    public function testArrayCount($array)
+    {
+        $obj = new ArrObj($array);
+
+        $this->assertSame(count($array), count($obj));
+        $firstKey = Arr::getFirstKey($array);
+        $lastKey = Arr::getLastKey($array);
+
+        unset($array[$firstKey], $obj[$firstKey], $array[$lastKey], $obj[$lastKey]);
+        $this->assertSame(count($array), count($obj));
+    }
+
+    /**
+     * @param array $array
+     *
+     * @dataProvider arrayProvider
+     */
+    public function testArrayIterator($array)
+    {
+        $obj = new ArrObj($array);
+
+        foreach ($obj as $key => $value) {
+            $this->assertSame($array[$key], $value);
+        }
+    }
 }