Merge pull request #1 from djfm/master

Added an optional default value to get

Author: Julien Martin

ArrayFinder.php

@@ -161,22 +161,25 @@ public function changeSeparator($separator)
 
     /**
      * Return a value from the array corresponding to the path.
+     * If the path is not set in the array, then $default is returned.
      *
      * ex:
      * $a = ['a' => ['b' => 'yeah']];
      * echo $this->get('a.b'); // yeah
+     * echo $this->get('a.b.c', 'nope'); // nope
      *
      * @param string|int|null $path Path to the value. If null, return all the content.
+     * @param mixed $default Default value to return when path is not contained in the array.
      *
      * @return mixed|null Value on the array corresponding to the path, null if the key does not exist.
      */
-    public function get($path = null)
+    public function get($path = null, $default = null)
     {
         if ($path === null) {
             return $this->content;
         }
 
-        $value = null;
+        $value = $default;
         $this->callAtPath($path, function(&$offset) use (&$value) {
             $value = $offset;
         });

Tests/ArrayFinderTest.php

@@ -229,4 +229,21 @@ public function testGetWithoutParamWillReturnAllTheArray()
 
         $this->assertEquals('end', $content['a']['b']['c']);
     }
+
+    public function testGetAcceptsADefaultArgument()
+    {
+        // ensure the default value is not returned when
+        // the array does have the key
+        $this->assertEquals(
+            "is defined",
+            (new ArrayFinder(["some" => ["key" => "is defined"]]))->get("some.key", "default value")
+        );
+
+        // ensure that when the key is not defined, the default
+        // value is used
+        $this->assertEquals(
+            "default value",
+            (new ArrayFinder([]))->get("some.key", "default value")
+        );
+    }
 }