Added wrapper around array_filter

Author: minwork

src/Arr.php

@@ -671,6 +671,28 @@ public static function filterByKeys(array $array, $keys, bool $exclude = false):
         return $exclude ? array_diff_key($array, array_flip($keysArray)) : array_intersect_key($array, array_flip($keysArray));
     }
 
+    /**
+     * Wrapper around PHP built-in <b>array_filter</b> method.<br/>
+     * <br/>
+     * Iterates over each value in the array passing them to the <b>callback</b> function. If the <b>callback</b> function returns true, the current value from <b>array</b> is returned into the result array. Array keys are preserved.
+     *
+     * @param array $array The array to iterate over
+     * @param callable|null $callback <p>[optional]</p>
+     * <p>The callback function to use</p>
+     * <p>If no callback is supplied, all entries of input equal to false (see converting to boolean) will be removed.</p>
+     * @param int $flag <p>[optional]</p>
+     * <p>Flag determining what arguments are sent to callback:</p>
+     * <ul>
+     * <li><b>ARRAY_FILTER_USE_KEY</b> - pass key as the only argument to callback instead of the value</li>
+     * <li><b>ARRAY_FILTER_USE_BOTH</b> - pass both value and key as arguments to callback instead of the value</li>
+     * @return array
+     * @see array_filter()
+     */
+    public static function filter(array $array, ?callable $callback = null, int $flag = 0): array
+    {
+        return is_null($callback) ? array_filter($array) : array_filter($array, $callback, $flag);
+    }
+
     /**
      * Filter objects array using return value of specified method.<br>
      * <br>

src/ArrObj.php

@@ -68,6 +68,9 @@
  *
  * ---------------------------------------------------------------------------------
  *
+ * @method ArrObj filter(?callable $callback = null, int $flag = 0)
+ * @see Arr::filter()
+ *
  * @method ArrObj filterByKeys(mixed $keys, bool $exclude = false)
  * @see Arr::filterByKeys()
  *
@@ -174,6 +177,7 @@ class ArrObj implements IteratorAggregate, ArrayAccess, Countable
         'map',
         'mapObjects',
         'each',
+        'filter',
         'filterByKeys',
         'filterObjects',
         'group',
@@ -206,6 +210,7 @@ class ArrObj implements IteratorAggregate, ArrayAccess, Countable
         'map',
         'mapObjects',
         'each',
+        'filter',
         'filterByKeys',
         'filterObjects',
         'group',

test/Arr/ArrTest.php

@@ -149,7 +149,7 @@ public function testSetNestedElement($class)
 
         $this->assertSame([[['test']]], $this->callMethod([$class, 'set'], [], '[].[].[]', 'test'));
         $this->assertSame([[[[]]]], $this->callMethod([$class, 'set'], [], '[].[].[]', []));
-        $this->assertSame([[[[]]]], $this->callMethod([$class, 'set'], [], ['[]','[]','[]'], []));
+        $this->assertSame([[[[]]]], $this->callMethod([$class, 'set'], [], ['[]', '[]', '[]'], []));
         $this->assertSame([], $this->callMethod([$class, 'set'], [], [], 'test'));
         $this->assertSame([], $this->callMethod([$class, 'set'], [], [null], 'test'));
 
@@ -661,8 +661,7 @@ public function testMapObjects($class)
         $this->assertSame(['test', 2, 4, '2'], $this->callMethod([$class, 'mapObjects'], $array, 'test', 2));
         $this->assertSame([], $this->callMethod([$class, 'mapObjects'], [], 'test'));
 
-        $object = new class()
-        {
+        $object = new class() {
             function test($arg = 0)
             {
                 return 1 + $arg;
@@ -744,6 +743,35 @@ public function testFilterByKeys($class)
         $this->assertSame($array, $this->callMethod([$class, 'filterByKeys'], $array, [null, 0], true));
     }
 
+    /**
+     * @param $class string|ArrObj
+     *
+     * @dataProvider arrayClassProvider
+     */
+    public function testFilter($class)
+    {
+        $callback1 = function ($value) {
+            return boolval($value);
+        };
+        $callback2 = function ($value) {
+            return !$value;
+        };
+        $callback3 = function ($value, $key) {
+            return $key == $value;
+        };
+        $callback4 = function ($key) {
+            return boolval($key);
+        };
+
+        foreach ($this->arrayProvider() as [$array]) {
+            $this->assertSame(array_filter($array), $this->callMethod([$class, 'filter'], $array));
+            $this->assertSame(array_filter($array, $callback1), $this->callMethod([$class, 'filter'], $array, $callback1));
+            $this->assertSame(array_filter($array, $callback2), $this->callMethod([$class, 'filter'], $array, $callback2));
+            $this->assertSame(array_filter($array, $callback3, ARRAY_FILTER_USE_BOTH), $this->callMethod([$class, 'filter'], $array, $callback3, ARRAY_FILTER_USE_BOTH));
+            $this->assertSame(array_filter($array, $callback4, ARRAY_FILTER_USE_KEY), $this->callMethod([$class, 'filter'], $array, $callback4, ARRAY_FILTER_USE_KEY));
+        }
+    }
+
     /**
      * @param $class string|ArrObj
      *
@@ -1019,7 +1047,8 @@ public function testSortObjects($class)
         $object1 = new class() {
             public $i = 1;
 
-            public function getValue(bool $reverse = false) {
+            public function getValue(bool $reverse = false)
+            {
                 return $reverse ? 1 / $this->i : $this->i;
             }
         };
@@ -1039,7 +1068,7 @@ public function getValue(bool $reverse = false) {
         $array = $proto;
 
         $this->assertSame([1, 2, 3, 4, 5], $this->callMethod([$class, 'mapObjects'], $array, 'getValue'));
-        $this->assertSame([1, 1/2, 1/3, 1/4, 1/5], $this->callMethod([$class, 'mapObjects'], $array, 'getValue', true));
+        $this->assertSame([1, 1 / 2, 1 / 3, 1 / 4, 1 / 5], $this->callMethod([$class, 'mapObjects'], $array, 'getValue', true));
 
         // Ensure order is not the same
         do {
@@ -1465,8 +1494,7 @@ public function testClone($class)
     {
         $object = new stdClass();
         $object2 = new ArrayObject();
-        $object3 = new class()
-        {
+        $object3 = new class() {
             public $counter = 1;
 
             function __clone()