array_split_filter

Author: freekmurze

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All Notable changes to `array-functions` will be documented in this file
 
+## 1.5.0 - 2015-06-29
+
+### Added
+- array_split_filter function
+
 ## 1.4.0 - 2015-06-29
 
 ### Added

README.md

@@ -76,6 +76,24 @@ function values_in_array($needles, array $haystack)
 function array_keys_exist($needles, array $haystack)
 ```
 
+```php`
+/**
+ * Returns an array with two elements.
+ * 
+ * Iterates over each value in the array passing them to the callback function.
+ * If the callback function returns true, the current value from array is returned in the first
+ * element of result array. If not, it is return in the second element of result array.
+ *
+ * Array keys are preserved.
+ *
+ * @param array $array
+ * @param callable $callback
+ * @return array
+ *
+ */
+function array_split_filter(array $array, callable $callback)
+``
+
 ## Change log
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

src/array_functions.php

@@ -28,9 +28,9 @@ function array_rand_value(array $array, $numReq = 1)
 /**
  * Get a random value from an array, with the ability to skew the results.
  * Example: array_rand_weighted(['foo' => 1, 'bar' => 2]) has a 66% chance of returning bar.
- * 
+ *
  * @param array $array
- * 
+ *
  * @return mixed
  */
 function array_rand_weighted(array $array)
@@ -65,7 +65,7 @@ function values_in_array($needles, array $haystack)
 
 /**
  * Determine if all given needles are present in the haystack as array keys.
- * 
+ *
  * @param array|string $needles
  * @param array $haystack
  *
@@ -77,5 +77,30 @@ function array_keys_exist($needles, array $haystack)
         return array_key_exists($needles, $haystack);
     }
 
-    return values_in_array($needles, array_keys($haystack));   
+    return values_in_array($needles, array_keys($haystack));
+}
+
+/**
+ * Returns an array with two elements.
+ *
+ * Iterates over each value in the array passing them to the callback function.
+ * If the callback function returns true, the current value from array is returned in the first
+ * element of result array. If not, it is return in the second element of result array.
+ *
+ * Array keys are preserved.
+ *
+ * @param array $array
+ * @param callable $callback
+ *
+ * @return array
+ */
+function array_split_filter(array $array, callable $callback)
+{
+    $passesFilter = array_filter($array, $callback);
+
+    $negatedCallback = function ($item) use ($callback) { return ! $callback($item); };
+
+    $doesNotPassFilter = array_filter($array, $negatedCallback);
+
+    return [$passesFilter, $doesNotPassFilter];
 }

tests/ArrayKeysExistTest.php

@@ -70,5 +70,4 @@ public function it_returns_false_when_needle_is_not_present_in_haystack()
         $this->assertFalse(array_keys_exist('d', ['a' => 'foo', 'b' => 'bar', 'c' => 'baz']));
         $this->assertFalse(array_keys_exist(['d'], ['a' => 'foo', 'b' => 'bar', 'c' => 'baz']));
     }
-
 }

tests/ArrayRandValueTest.php

@@ -9,7 +9,7 @@ class ArrayRandValueTest extends \PHPUnit_Framework_TestCase
     protected $testArray = [
         'one' => 'a',
         'two' => 'b',
-        'three' => 'c'
+        'three' => 'c',
     ];
 
     /**

tests/ArraySplitFilterTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Spatie\Test;
+
+use function spatie\array_split_filter;
+
+class ArraySplitFilterTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @test
+     */
+    public function it_will_put_all_that_pass_the_test_in_the_first_element_and_all_that_not_pass_in_the_second()
+    {
+        $numbers = range(1, 6);
+
+        $evenTest = function ($number) { return $number % 2 == 0; };
+        $oddTest = function ($number) { return $number % 2 != 0; };
+
+        $this->assertSame(array_filter($numbers, $evenTest), array_split_filter($numbers, $evenTest)[0]);
+        $this->assertSame(array_filter($numbers, $oddTest), array_split_filter($numbers, $evenTest)[1]);
+    }
+
+    /**
+     * @test
+     */
+    public function it_can_handle_an_empty_array()
+    {
+        $this->assertTrue(is_array(array_split_filter([], function () {})));
+        $this->assertCount(2, array_split_filter([], function () {}));
+    }
+}

tests/ValuesInArrayTest.php

@@ -63,5 +63,4 @@ public function it_returns_false_when_needle_is_not_present_in_haystack()
         $this->assertFalse(values_in_array('d', ['a', 'b', 'c']));
         $this->assertFalse(values_in_array(['d'], ['a', 'b', 'c']));
     }
-
 }