mysqlidb: Added ArrayBuilder,ObjectBuilder and JsonBuilder to be consistent with dbObject

Author: avbdr

MysqliDb.php

@@ -112,6 +112,14 @@ class MysqliDb
      */
     protected $isSubQuery = false;
 
+    /**
+     * Return type: 'Array' to return results as array, 'Object' as object
+     * 'Json' as json string
+     *
+     * @var string
+     */
+    public $returnType = 'Object';
+
     /**
      * Variables for query execution tracing
      *
@@ -211,6 +219,38 @@ protected function reset()
         $this->_bindParams = array(''); // Create the empty 0 index
         $this->_query = null;
         $this->_queryOptions = array();
+        $this->returnType = 'Array';
+    }
+
+    /**
+     * Helper function to create dbObject with Json return type
+     *
+     * @return dbObject
+     */
+    public function JsonBuilder () {
+        $this->returnType = 'Json';
+        return $this;
+    }
+
+    /**
+     * Helper function to create dbObject with Array return type
+     * Added for consistency as thats default output type
+     *
+     * @return dbObject
+     */
+    public function ArrayBuilder () {
+        $this->returnType = 'Array';
+        return $this;
+    }
+
+    /**
+     * Helper function to create dbObject with Object return type.
+     *
+     * @return dbObject
+     */
+    public function ObjectBuilder () {
+        $this->returnType = 'Object';
+        return $this;
     }
 
     /**
@@ -358,11 +398,12 @@ public function getOne($tableName, $columns = '*')
     {
         $res = $this->get ($tableName, 1, $columns);
 
-        if (is_object($res))
+        if ($res instanceof MysqliDb)
             return $res;
-
-        if (isset($res[0]))
+        else if (is_array ($res) && isset ($res[0]))
             return $res[0];
+        else if ($res)
+            return $res;
 
         return null;
     }
@@ -376,7 +417,7 @@ public function getOne($tableName, $columns = '*')
      */
     public function getValue($tableName, $column) 
     {
-        $res = $this->get ($tableName, 1, "{$column} as retval");
+        $res = $this->ArrayBuilder()->get ($tableName, 1, "{$column} as retval");
 
         if (isset($res[0]["retval"]))
             return $res[0]["retval"];
@@ -801,9 +842,14 @@ protected function _dynamicBindResults(mysqli_stmt $stmt)
         $this->totalCount = 0;
         $this->count = 0;
         while ($stmt->fetch()) {
-            $x = array();
-            foreach ($row as $key => $val) {
-                $x[$key] = $val;
+            if ($this->returnType == 'Object') {
+                $x = new stdClass ();
+                foreach ($row as $key => $val)
+                    $x->$key = $val;
+            } else {
+                $x = array();
+                foreach ($row as $key => $val)
+                    $x[$key] = $val;
             }
             $this->count++;
             array_push($results, $x);
@@ -817,6 +863,9 @@ protected function _dynamicBindResults(mysqli_stmt $stmt)
             $totalCount = $stmt->fetch_row();
             $this->totalCount = $totalCount[0];
         }
+        if ($this->returnType == 'Json') {
+            return json_encode ($results);
+        }
 
         return $results;
     }

dbObject.php

@@ -59,6 +59,7 @@ class dbObject {
     public $isNew = true;
     /**
      * Return type: 'Array' to return results as array, 'Object' as object
+     * 'Json' as json string
      *
      * @var string
      */

readme.md

@@ -128,7 +128,6 @@ if ($db->update ('users', $data))
 else
     echo 'update failed: ' . $db->getLastError();
 ```
-
 ### Select Query
 After any select/get function calls amount or returned rows
 is stored in $count variable
@@ -165,7 +164,18 @@ or select one column value or function result
 $count = $db->getValue ("users", "count(*)");
 echo "{$count} users found";
 ```
-
+### Defining a return type
+MysqliDb can return result in 3 different formats: Array of Array, Array of Objects and a Json string. To select a return type use ArrayBuilder(), ObjectBuilder() and JsonBuilder() methods. Note that ArrayBuilder() is a default return type
+```php
+// Array return type
+$= $db->getOne("users");
+echo $u['login'];
+// Object return type
+$u = $db->ObjectBuilder()->getOne("users");
+echo $u->login;
+// Json return type
+$json = $db->JsonBuilder()->getOne("users");
+```
 ### Delete Query
 ```php
 $db->where('id', 1);