Updated readme + added random

Author: assertchris

composer.json

@@ -9,7 +9,8 @@
         }
     ],
     "require": {
-        "php": ">=5.4.0"
+        "php": ">=5.4.0",
+        "typedphp/number-functions": "*"
     },
     "autoload": {
         "files": [

composer.lock

@@ -8,15 +8,30 @@
 
 ## Example
 
-TODO
+```php
+use TypedPHP\Functions\ArrayFunctions;
+
+ArrayFunctions\map([1, 2, 3], function($item) { return $item * 2; }); // [2, 4, 6]
+ArrayFunctions\contains(["foo", "bar", "baz], "bar"); // true
+```
 
 Functions:
 
-TODO
+- `contains(array $haystack, $needle) → bool`
+- `each(array $array, callable $callback) → array`
+- `exclude(array $array, array $exclude) → array`
+- `filter(array $array, callable $callback) → array`
+- `length(array $array) → int`
+- `has(array $array, $needle) → bool`
+- `join(array $array, $glue) → string`
+- `map(array $array, callable $callback) →  array`
+- `merge(array $array, array $merge) → array`
+- `slice(array $array, $offset = 0, $limit = 0) → array`
+- `random(array $array) → mixed`
 
 Caveats:
 
-TODO
+- Nope
 
 ## Installation
 

readme.md

@@ -2,6 +2,8 @@
 
 namespace TypedPHP\Functions\ArrayFunctions;
 
+use TypedPHP\Functions\NumberFunctions;
+
 /**
  * @param array $haystack
  * @param mixed $needle
@@ -17,11 +19,13 @@ function contains(array $haystack, $needle)
  * @param array    $array
  * @param callable $callback
  *
- * @return bool
+ * @return array
  */
 function each(array $array, callable $callback)
 {
-    return array_walk($array, $callback);
+    array_walk($array, $callback);
+
+    return $array;
 }
 
 /**
@@ -115,3 +119,19 @@ function slice(array $array, $offset = 0, $limit = 0)
 
     return array_slice($array, $offset, $limit);
 }
+
+/**
+ * @param array $array
+ *
+ * @return mixed
+ */
+function random(array $array)
+{
+    $index = NumberFunctions\random(0, length($array));
+
+    if (isset($array[$index])) {
+        return $array[$index];
+    }
+
+    return null;
+}

src/ArrayFunctions.php

@@ -75,4 +75,10 @@ public function testSlice()
         $this->assertEquals([2, 3], ArrayFunctions\slice([1, 2, 3], 1));
         $this->assertEquals([2], ArrayFunctions\slice([1, 2, 3], 1, 1));
     }
+
+    public function testRandom()
+    {
+        $this->assertNull(ArrayFunctions\random([]));
+        $this->assertNotNull(ArrayFunctions\random([1, 2, 3]));
+    }
 }