Merge pull request bocharsky-bw#10 from talyssonoc/implement_find_method

Implement find method

Author: bocharsky-bw

README.md

@@ -405,6 +405,15 @@ $a->filter(function($value) {
 $a->toArray(); // [0 => 'a', 2 => 'b']
 ```
 
+### find
+
+``` php
+$a = MutableArray::create([4, 3, 2, 1]);
+$value = $a->find(function($value, $key, $array) {
+    return ($value % 2) === 0;
+});
+$value // 4
+
 ### first
 
 ``` php

src/AbstractArray.php

@@ -640,4 +640,22 @@ protected function sortingKeys(array &$elements, $order = SORT_ASC, $strategy =
                 ksort($elements, $strategy);
         }
     }
+
+    /**
+     * Returns the first value that matches $func condition
+     *
+     * @param Closure $func
+     *
+     * @return mixed The resulting value
+     */
+    public function find(Closure $func)
+    {
+        foreach ($this->elements as $key => $value) {
+            if($func($value, $key)) {
+                return $value;
+            }
+        }
+
+        return null;
+    }
 }

tests/ImmutableArrayTest.php

@@ -451,6 +451,21 @@ public function testFilter(array $array)
         $this->assertTrue($filteredArray === $copiedMa->toArray());
     }
 
+    public function testFind()
+    {
+        $callable = function($value) {
+            return 2 === $value;
+        };
+
+        $array = ['a', 'key' => 0, 2, 'hello'];
+
+        $a = new ImmutableArray($array);
+
+        $found = $a->find($callable);
+
+        $this->assertTrue($found === 2);
+    }
+
     /**
      * @dataProvider simpleArrayProvider
      */

tests/MutableArrayTest.php

@@ -468,6 +468,21 @@ public function testFilter(array $array)
         $this->assertTrue($filteredArray === $ma->toArray());
     }
 
+    public function testFind()
+    {
+        $callable = function($value) {
+            return 2 === $value;
+        };
+
+        $array = ['a', 'key' => 0, 2, 'hello'];
+
+        $a = new MutableArray($array);
+
+        $found = $a->find($callable);
+
+        $this->assertTrue($found === 2);
+    }
+
     /**
      * @dataProvider simpleArrayProvider
      */