Add a mechanism to retrieve values several levels deep.. Resolves #7

Author: schlessera

CHANGELOG.md

@@ -4,7 +4,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.1.4] - 2016-02-11
 ### Added
-- getAll() and getConfigArray() with corresponding unit tests.
+- `AbstractConfig:getAll()` and `ConfigTrait::getConfigArray()`.
+- `hasKey()` and `getKey()` now support a list of strings to fetch a value from several levels deep.
+- Tests for the above.
+
+### Fixed
+- PHP requirement for unit tests was lowered from 5.6 to 5.4.
 
 ## [0.1.3] - 2016-02-10
 ### Added

src/AbstractConfig.php

@@ -43,33 +43,64 @@ public function __construct(array $config)
     /**
      * Check whether the Config has a specific key.
      *
+     * To check a value several levels deep, add the keys for each level as a comma-separated list.
+     *
      * @since 0.1.0
+     * @since 0.1.4 Accepts list of keys.
      *
-     * @param string $key The key to check the existence for.
+     * @param string ... List of keys.
      * @return bool
      */
-    public function hasKey($key)
+    public function hasKey()
     {
-        return array_key_exists($key, (array)$this);
+        $keys = array_reverse(func_get_args());
+
+        $array = $this->getArrayCopy();
+        while (count($keys) > 0) {
+            $key = array_pop($keys);
+            if ( ! array_key_exists($key, $array)) {
+                return false;
+            }
+            $array = $array[$key];
+        }
+
+        return true;
     }
 
     /**
      * Get the value of a specific key.
      *
+     * To get a value several levels deep, add the keys for each level as a comma-separated list.
+     *
      * @since 0.1.0
+     * @since 0.1.4 Accepts list of keys.
      *
-     * @param string $key The key to get the value for.
+     * @param string ... List of keys.
      * @return mixed
+     * @throws BadMethodCallException If no argument was provided.
      * @throws OutOfRangeException If an unknown key is requested.
      */
-    public function getKey($key)
+    public function getKey()
     {
-        if ( ! $this->hasKey($key)) {
+        if (func_num_args() < 1) {
+            throw new BadMethodCallException(_('No configuration was provided to getKey().'));
+        }
+
+        $keys = func_get_args();
+
+        if ( ! call_user_func_array([$this, 'hasKey'], $keys)) {
             throw new OutOfRangeException(sprintf(_('The configuration key %1$s does not exist.'),
-                (string)$key));
+                implode('->', $keys)));
+        }
+
+        $keys  = array_reverse($keys);
+        $array = $this->getArrayCopy();
+        while (count($keys) > 0) {
+            $key   = array_pop($keys);
+            $array = $array[$key];
         }
 
-        return $this[$key];
+        return $array;
     }
 
     /**
@@ -81,7 +112,7 @@ public function getKey($key)
      */
     public function getAll()
     {
-        return (array)$this;
+        return $this->getArrayCopy();
     }
 
     /**

src/ConfigInterface.php

@@ -43,24 +43,29 @@ public function getArrayCopy();
     /**
      * Check whether the Config has a specific key.
      *
-     * @since 0.1.0
+     * To check a value several levels deep, add the keys for each level as a comma-separated list.
      *
-     * @param string $key The key to check the existence for.
+     * @since 0.1.0
+     * @since 0.1.4 Accepts list of keys.
      *
+     * @param string ... List of keys.
      * @return bool
      */
-    public function hasKey($key);
+    public function hasKey();
 
     /**
      * Get the value of a specific key.
      *
+     * To get a value several levels deep, add the keys for each level as a comma-separated list.
+     *
      * @since 0.1.0
+     * @since 0.1.4 Accepts list of keys.
      *
-     * @param string $key The key to get the value for.
+     * @param string ... List of keys.
      *
      * @return mixed
      */
-    public function getKey($key);
+    public function getKey();
 
     /**
      * Get a (multi-dimensional) array of all the configuration settings.

tests/ConfigTest.php

@@ -39,6 +39,16 @@ class ConfigTest extends \PHPUnit_Framework_TestCase
         'negative_boolean' => false,
     ];
 
+    protected static $test_multi_array = [
+        'level1' => [
+            'level2' => [
+                'level3' => [
+                    'level4_key' => 'level4_value',
+                ],
+            ],
+        ],
+    ];
+
     /**
      * Test creation and value retrieval.
      *
@@ -153,6 +163,22 @@ public function testHasKey()
         $this->assertFalse($config->hasKey('some_other_key'));
     }
 
+    /**
+     * @covers BrightNucleus\Config\AbstractConfig::hasKey
+     */
+    public function testHasKeyWithMultipleLevels()
+    {
+        $config = new Config(ConfigTest::$test_multi_array);
+        $this->assertTrue($config->hasKey('level1'));
+        $this->assertTrue($config->hasKey('level1', 'level2'));
+        $this->assertTrue($config->hasKey('level1', 'level2', 'level3'));
+        $this->assertTrue($config->hasKey('level1', 'level2', 'level3', 'level4_key'));
+        $this->assertFalse($config->hasKey('level2'));
+        $this->assertFalse($config->hasKey('level1', 'level3'));
+        $this->assertFalse($config->hasKey('level1', 'level2', 'level4_key'));
+        $this->assertFalse($config->hasKey('level0', 'level1', 'level2', 'level3', 'level4_key'));
+    }
+
     /**
      * @covers BrightNucleus\Config\AbstractConfig::getKeys
      */
@@ -176,7 +202,19 @@ public function testGetKey()
         $this->assertFalse($config->getKey('negative_boolean'));
         $this->setExpectedException('OutOfRangeException',
             'The configuration key some_other_key does not exist.');
-        $this->assertFalse($config->getKey('some_other_key'));
+        $config->getKey('some_other_key');
+    }
+
+    /**
+     * @covers BrightNucleus\Config\AbstractConfig::getKey
+     */
+    public function testGetKeyWithMultipleLevels()
+    {
+        $config = new Config(ConfigTest::$test_multi_array);
+        $this->assertEquals('level4_value', $config->getKey('level1', 'level2', 'level3', 'level4_key'));
+        $this->setExpectedException('OutOfRangeException',
+            'The configuration key level1->level2->level4_key does not exist.');
+        $config->getKey('level1', 'level2', 'level4_key');
     }
 
     /**