Merge pull request #3 from na2axl/adding_class_map

Add FETCH_CLASS mode for class mapping

Author: na2axl

src/JSONDB/JSONDB.php

@@ -84,6 +84,12 @@ class JSONDB
          */
         const FETCH_OBJECT = 5;
 
+        /**
+         * Define if we fetch results with class mapping
+         * @const int
+         */
+        const FETCH_CLASS = 6;
+
         /**
          * The current JSONDB instance
          * @var JSONDB

src/JSONDB/QueryResult.php

@@ -64,6 +64,12 @@ class QueryResult implements \Iterator, \SeekableIterator, \Countable, \Serializ
          */
         private $fetchMode;
 
+        /**
+         * Class name used for FETCH_CLASS method
+         * @var string
+         */
+        private $className;
+
         /**
          * JSONDB instance
          * @var JSONDB
@@ -110,7 +116,7 @@ public function queryString()
 
         /**
          * Returns the current result
-         * @return array|QueryResultObject
+         * @return array|QueryResultObject|object
          * @throws Exception
          */
         public function current()
@@ -124,6 +130,20 @@ public function current()
                 case JSONDB::FETCH_OBJECT:
                     return new QueryResultObject($return);
 
+                case JSONDB::FETCH_CLASS:
+                    if (!class_exists($this->className)) {
+                        throw new Exception("JSONDB Query Result Error: Can't fetch for data. Trying to use JSONDB::FETCH_CLASS mode with class \"{$this->className}\" but the class doesn't exist or not found.");
+                    }
+                    $mapper = new $this->className();
+                    $availableVars = get_class_vars($this->className);
+                    foreach ((array)$return as $item => $value) {
+                        if (!array_key_exists($item, $availableVars)) {
+                            throw new Exception("JSONDB Query Result Error: Can't fetch for data. Using JSONDB::FETCH_CLASS mode with class \"{$this->className}\" but the property \"{$item}\" doesn't exist or not public.");
+                        }
+                        $mapper->$item = $value;
+                    }
+                    return $mapper;
+
                 default:
                     throw new Exception('JSONDB Query Result Error: Fetch mode not supported.');
             }
@@ -260,14 +280,15 @@ public function offsetUnset($offset)
 
         /**
          * Fetch for results
-         * @param int $mode The fetch mode
+         * @param int    $mode      The fetch mode
+         * @param string $className The class name (for JSONDB::FETCH_CLASS)
          * @return array|QueryResultObject|bool
          * @throws Exception
          */
-        public function fetch($mode = NULL)
+        public function fetch($mode = NULL, $className = NULL)
         {
             if (NULL !== $mode) {
-                $this->setFetchMode($mode);
+                $this->setFetchMode($mode, $className);
             }
 
             if ($this->database->queryIsExecuted()) {
@@ -284,12 +305,14 @@ public function fetch($mode = NULL)
 
         /**
          * Changes the fetch mode
-         * @param int $mode
+         * @param int    $mode
+         * @param string $className
          * @return QueryResult
          */
-        public function setFetchMode($mode = JSONDB::FETCH_ARRAY)
+        public function setFetchMode($mode = JSONDB::FETCH_ARRAY, $className = NULL)
         {
             $this->fetchMode = $mode;
+            $this->className = $className;
             return $this;
         }
 

tests/JSONDBTest.php

@@ -4,7 +4,6 @@
 
 class JSONDBTest extends PHPUnit_Framework_TestCase
 {
-
     /**
      * @var \JSONDB\JSONDB
      */
@@ -181,4 +180,54 @@ public function testExceptionIsRaisedForDuplicatePKUKOnReplace() {
         self::$database->connect('__phpunit_test_server', '__phpunit', '', '__phpunit_test_database');
         self::$database->query('__phpunit_test_table_pk.replace(2)');
     }
+
+    /**
+     * @expectedException \JSONDB\Exception
+     */
+    public function testExceptionIsRaisedForFetchClassMode() {
+        $r = new \JSONDB\QueryResult(array(array('testVar1' => 'foo', 'testVar2' => 'bar')), self::$database);
+        $r->setFetchMode(\JSONDB\JSONDB::FETCH_CLASS, 'FakeClass');
+        $r->fetch();
+    }
+
+    /**
+     * @expectedException \JSONDB\Exception
+     */
+    public function testExceptionIsRaisedForFetchClassMode2() {
+        $r = new \JSONDB\QueryResult(array(array('testVar1' => 'foo', 'testVar3' => 'bar')), self::$database);
+        $r->setFetchMode(\JSONDB\JSONDB::FETCH_CLASS, 'TestClass');
+        $r->fetch();
+    }
+
+    /**
+     * @expectedException \JSONDB\Exception
+     */
+    public function testExceptionIsRaisedForFetchClassMode3() {
+        $r = new \JSONDB\QueryResult(array(array('testVar1' => 'foo', 'testVar4' => 'bar')), self::$database);
+        $r->setFetchMode(\JSONDB\JSONDB::FETCH_CLASS, 'TestClass');
+        $r->fetch();
+    }
+
+    public function testFetchClassMode() {
+        $r = new \JSONDB\QueryResult(array(array('testVar1' => 'foo', 'testVar2' => 'bar')), self::$database);
+        $r->setFetchMode(\JSONDB\JSONDB::FETCH_CLASS, 'TestClass');
+        $value = $r->current();
+        $this->assertInstanceOf('TestClass', $value);
+    }
+
+    public function testFetchClassMode2() {
+        $r = new \JSONDB\QueryResult(array(array('testVar1' => 'foo', 'testVar2' => 'bar')), self::$database);
+        $r->setFetchMode(\JSONDB\JSONDB::FETCH_CLASS, 'TestClass');
+        $value = $r->current();
+        $expected = new TestClass();
+        $expected->testVar1 = 'foo';
+        $expected->testVar2 = 'bar';
+        $this->assertEquals($expected, $value);
+    }
+}
+
+class TestClass {
+    public $testVar1;
+    public $testVar2;
+    private $testVar3;
 }