Documentation updates

Author: dcarbone

docs/KV.md

@@ -12,7 +12,7 @@ $kv = $client->KV();
 
 ## Actions
 
-### Key Getting
+### Get Single KVP
 
 ```php
 list($kvp, $qm, $err) = $client->KV()->get('prefix/keyname');
@@ -22,10 +22,18 @@ if (null !== $err)
 var_dump($qm, $kvp);
 ```
 
-### Key Listing
+### List All KVP's under specified prefix
 
+```php
+list($kvps, $qm, $err) = $client->KV()->list('prefix');
+if (null !== $err)
+    die($err);
+
+var_dump($qm, $kvps);
+```
+
+### List All Keys
 
-*All Keys*:
 ```php
 list($keys, $qm, $err) = $client->KV()->keys();
 if (null !== $err)
@@ -34,7 +42,8 @@ if (null !== $err)
 var_dump($qm, $keys);
 ```
 
-*Only Keys with Specific Prefix*
+### List All Keys Under Prefix
+
 ```php
 list($keys, $qm, $err) = $client->KV()->keys('prefix');
 if (null !== $err)
@@ -43,7 +52,7 @@ if (null !== $err)
 var_dump($qm, $keys);
 ```
 
-### Key Putting
+### Put KVP
 
 ```php
 $kvp = new KVPair(['Key' => 'prefix/mykey', 'Value' => 'my value']);
@@ -54,7 +63,7 @@ if (null !== $err)
 var_dump($wm);
 ```
 
-### Key Deletion
+### Delete KVP
 
 ```php
 list($wm, $err) = $client->KV()->delete('prefix/mykey');
@@ -64,7 +73,7 @@ var_dump($wm);
 
 ```
 
-### Tree Retrieval
+### Tree Listing
 
 This is a custom feature to allow `get-tree`-like functionality with 0.6.4 (the current release as of this writing)
 

src/KV/KVClient.php

@@ -44,7 +44,7 @@ public function get($key, QueryOptions $queryOptions = null)
         if (!is_string($key))
         {
             return [null, null, new Error('error', sprintf(
-                '%s::getValue - Key expected to be string, %s seen.',
+                '%s::get - Key expected to be string, %s seen.',
                 get_class($this),
                 gettype($key)
             ))];
@@ -67,6 +67,51 @@ public function get($key, QueryOptions $queryOptions = null)
         return [new KVPair(reset($data)), $qm, null];
     }
 
+    /**
+     * @param string $prefix
+     * @param QueryOptions|null $queryOptions
+     * @return array(
+     *  @type KVPair[]|null array of KVPair objects under specified prefix
+     *  @type QueryMeta|null query metadata
+     *  @type Error|null error, if any
+     * )
+     */
+    public function getList($prefix, QueryOptions $queryOptions = null)
+    {
+        if (!is_string($prefix) || '' === $prefix)
+        {
+            return [null, null, new Error('error', sprintf(
+                '%s::getList - Prefix expected to be empty or string, %s seen.',
+                get_class($this),
+                gettype($prefix)
+            ))];
+        }
+
+        $r = new Request('get', sprintf('v1/kv/%s', rawurlencode($prefix)), $this->_Config);
+        $r->setQueryOptions($queryOptions);
+        $r->params()->set('recurse', '');
+
+        list($duration, $response, $err) = $this->requireOK($this->doRequest($r));
+        $qm = $this->buildQueryMeta($duration, $response);
+
+        if (null !== $err)
+            return [null, $qm, $err];
+
+        list($data, $err) = $this->decodeBody($response);
+
+        if (null !== $err)
+            return [null, $qm, $err];
+
+        $kvPairs = array();
+        foreach($data as $v)
+        {
+            $kvp = new KVPair($v);
+            $kvPairs[$kvp->getKey()] = $kvp;
+        }
+
+        return [$kvPairs, $qm, null];
+    }
+
     /**
      * @param string $prefix Prefix to search for.  Null returns all keys.
      * @param QueryOptions $queryOptions
@@ -81,7 +126,7 @@ public function keys($prefix = null, QueryOptions $queryOptions = null)
         if (null !== $prefix && !is_string($prefix))
         {
             return [null, null, new Error('error', sprintf(
-                '%s::getKeys - Prefix expected to be empty or string, %s seen.',
+                '%s::keys - Prefix expected to be empty or string, %s seen.',
                 get_class($this),
                 gettype($prefix)
             ))];