Merge pull request #193 from php-school/collection-func-and-each

Collection enhancements

Author: AydinHassan

src/Utils/ArrayObject.php

@@ -45,6 +45,19 @@ public function map(callable $callback): self
         return new static(array_map($callback, $this->array));
     }
 
+    /**
+     * Run a callable function over each item in the array
+     *
+     * @param callable $callback
+     * @return static
+     */
+    public function each(callable $callback): self
+    {
+        array_walk($this->array, $callback);
+
+        return new static($this->array);
+    }
+
     /**
      * @param callable $callback
      * @return static

src/functions.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use PhpSchool\PhpWorkshop\Utils\Collection;
 use PhpSchool\PhpWorkshop\Utils\StringUtils;
 
 if (!function_exists('mb_str_pad')) {
@@ -45,3 +46,16 @@ function canonicalise_path(string $path): string
         return StringUtils::canonicalisePath($path);
     }
 }
+
+if (!function_exists('collect')) {
+
+    /**
+     * @template T
+     * @param array<T> $array
+     * @return Collection<T>
+     */
+    function collect(array $array): Collection
+    {
+        return new Collection($array);
+    }
+}

test/Util/ArrayObjectTest.php

@@ -163,4 +163,16 @@ public function testFirst(): void
 
         $this->assertEquals(10, $arrayObject->first());
     }
+
+    public function testEach(): void
+    {
+        $c = new ArrayObject($original = [1, 2, 3, 4]);
+
+        $result = [];
+        $c->each(function ($item, $key) use (&$result) {
+            $result[$key] = $item;
+        });
+
+        $this->assertEquals($original, $result);
+    }
 }