Merge pull request #240 from avbdr/master

dbObject updates

Author: avbdr

.gitattributes

@@ -0,0 +1,2 @@
+tests/ export-ignore
+index.php export-ignore

composer.json

@@ -20,6 +20,6 @@
 		"php": ">=5.3.0"
 	},
 	"autoload": {
-		"files": ["MysqliDb.php"]
+		"files": ["MysqliDb.php", "dbObject.php"]
 	}
 }

dbObject.md

@@ -4,10 +4,7 @@ Please note, that this library is not pretending to be a full stack ORM but a si
 <hr>
 ###Initialization
 
-1. Include mysqlidb and dbObject classes. 
-
-2. If you want to use model autoloading instead of manually including them in the scripts use autoload () method.
-
+Include mysqlidb and dbObject classes. If you want to use model autoloading instead of manually including them in the scripts use autoload () method.
 ```php
 require_once ("libs/MysqliDb.php");
 require_once ("libs/dbObject.php");
@@ -18,24 +15,65 @@ $db = new Mysqlidb ('localhost', 'user', '', 'testdb');
 dbObject::autoload ("models");
 ```
 
-3. Create simple user class (models/user.php):
+Each database table could be easily mapped into a dbObject instance.  If you do not want to create model for a simple table its object could be simply created with a table() method.
+```php
+$user = dbObject::table ("users");
+```
 
+Otherwise basic model should be declared as (in case if autoload is set to 'models' directory filename should be models/user.php):
 ```php
-class user extends dbObject {
-  protected $dbTable = "users";
-  protected $primaryKey = "id";
-  protected $dbFields = Array (
-    'login' => Array ('text', 'required'),
-    'password' => Array ('text'),
-    'createdAt' => Array ('datetime'),
-    'updatedAt' => Array ('datetime'),
-  );
+class user extends dbObject {}
+```
+
+Class will be related to 'user' table. To change table name define correct name in the $dbTable variable:
+
+```php
+    protected $dbTable = "users";
+```
+
+Both objects created throw new class file creation of with table() method will have the same set of methods available. Only exception is that relations, validation or custom model methods
+will not be working with an objects created with table() method.
+
+
+###Selects
+Retrieving objects from the database is pretty much the same process as a mysqliDb get()/getOne() methods without a need to specify table name. All mysqlidb functions like where(), orWhere(), orderBy(), join etc are supported.
+
+##Retrieving All Records
+
+```php
+//$users = dbObject::table('users')->get ();
+$users = user::get ();
+foreach (users as $u) {
+  echo $u->login;
 }
 ```
+
+## Using Where Condition And A Limit
+```php
+$users = user::where ("login", "demo")->get (Array (10, 20));
+foreach (users as $u) ...
+```
+
+##Retrieving A Model By Primary Key
+
+```php
+//$user = dbObject::table('users')->byId (1);
+$user = user::byId (1);
+echo $user->login;
+```
+
+dbObject will also assume that each table has a primary key column named "id". You may define a primaryKey property to override this assumption.
+
+```php
+  protected $primaryKey = "userId";
+```
+
+
 ###Insert Row
-1. OOP Way. Just create new object of a needed class, fill it in and call save () method. Save will return 
+1. OOP Way. Just create new object of a needed class, fill it in and call save () method. Save will return
 record id in case of success and false in case if insert will fail.
 ```php
+//$user = dbObject::table('users');
 $user = new user;
 $user->login = 'demo';
 $user->password = 'demo';
@@ -71,35 +109,8 @@ $p->seller = $user;
 $p->save ();
 ```
 
-After save() is call both new objects (user and product) will be saved.
-
-###Selects
-
-Retrieving objects from the database is pretty much the same process of a get ()/getOne () execution without a need to specify table name.
-
-All mysqlidb functions like where(), orWhere(), orderBy(), join etc are supported.
-Please note that objects returned with join() will not save changes to a joined properties. For this you can use relationships.
-
-Select row by primary key
-
-```php
-$user = user::byId (1);
-echo $user->login;
-```
-
-Get all users
-```php
-$users = user::orderBy ('id')->get ();
-foreach (users as $u) {
-  echo $u->login;
-}
-```
+After save() is called both new objects (user and product) will be saved.
 
-Using where with limit
-```php
-$users = user::where ("login", "demo")->get (Array (10, 20));
-foreach (users as $u) ...
-```
 
 ###Update
 To update model properties just set them and call save () method. As well values that needed to by changed could be passed as an array to the save () method.
@@ -116,7 +127,7 @@ $user->save ($data);
 ```
 
 ###Delete
-Use delete() method on any loaded object. 
+Use delete() method on any loaded object.
 ```php
 $user = user::byId (1);
 $user->delete ();
@@ -126,7 +137,7 @@ $user->delete ();
 Currently dbObject supports only hasMany and hasOne relations. To use them declare $relations array in the model class.
 After that you can get related object via variable names defined as keys.
 
-HasOne example:
+##HasOne example:
 ```php
     protected $relations = Array (
         'person' => Array ("hasOne", "person", 'id');
@@ -141,7 +152,7 @@ HasOne example:
 
 In HasMany Array should be defined target object name (product in example) and a relation key (userid).
 
-HasMany example:
+##HasMany example:
 ```php
     protected $relations = Array (
         'products' => Array ("hasMany", "product", 'userid')
@@ -155,6 +166,18 @@ HasMany example:
             echo $p->title;
     }
 ```
+
+### Joining tables
+```php
+$depts = product::join ('user');
+$depts = product::join ('user', 'productid');
+```
+
+First parameter will set an object which should be joined. Second paramter will define a key. Default key is $objectName+'Id'
+
+
+NOTE: Objects returned with join() will not save changes to a joined properties. For this you can use relationships.
+
 ###Timestamps
 Library provides a transparent way to set timestamps of an object creation and its modification:
 To enable that define $timestamps array as follows:
@@ -163,6 +186,31 @@ protected $timestamps = Array ('createdAt', 'updatedAt');
 ```
 Field names cant be changed.
 
+### Array Fields
+dbObject can automatically handle array type of values. Optionaly you can store arrays in json encoded or in pipe delimeted format.
+To enable automatic json serialization of the field define $jsonFields array in your modal:
+```php
+    protected $jsonFields = Array ('operations');
+```
+To enable pipe delimetered storage of the field define $arrayFields array in your modal:
+```php
+    protected $arrayFields = Array ('sections');
+```
+
+```php
+    $user = new user;
+    $user->login = 'admin';
+    $user->options = Array ('canReadNews', 'canPostNews', 'canDeleteNews');
+    $user->sections = Array ('news', 'companyNews');
+    $user->save ();
+    ...
+    $user = user::byId (1);
+    print_r ($user->options);
+```
+Following code will store 'options' variable as a json string in the database and will return back an array on load.
+Same with 'sections' variable except that it will be stored in pipe delimetered format.
+
+
 ###Validation and Error checking
 Before saving and updating the row dbObject do input validation. In case validation rules are set but their criteria is not met
 then save() will return an error with its description. For example:
@@ -189,6 +237,8 @@ Validation rules must be defined in $dbFields array.
 First parameter is a field type. Types could be the one of following: text, bool, int, datetime or a custom regexp.
 Second parameter is 'required' and its defines that following entry field be always defined.
 
+NOTE: All variables which are not defined in the $dbFields array will be ignored from insert/update statement.
+
 ###Array as return values
 dbObject can return its data as array instead of object. To do that ArrayBuilder() function should be used in the beginning of the call.
 ```php
@@ -222,4 +272,4 @@ Object could be easily converted to a json string or an array.
 
 ###Examples
 
-Please look for a use examples in tests/dbObjectTests.php file and test models inside the tests/models/ directory
+Please look for a use examples in <a href='tests/dbObjectTests.php'>tests file</a> and test models inside the <a href='tests/models/'>test models</a> directory

dbObject.php

@@ -88,12 +88,27 @@ class dbObject {
      * @var array
      */
     public $errors = null;
+    /**
+     * Primary key for an object. 'id' is a default value.
+     *
+     * @var stating
+     */
+    protected $primaryKey = 'id';
+    /**
+     * Table name for an object. Class name will be used by default
+     *
+     * @var stating
+     */
+    protected $dbTable;
 
     /**
      * @param array $data Data to preload on object creation
      */
     public function __construct ($data = null) {
         $this->db = MysqliDb::getInstance();
+        if (empty ($this->dbTable))
+            $this->dbTable = get_class ($this);
+
         if ($data)
             $this->data = $data;
     }
@@ -174,10 +189,21 @@ public static function ArrayBuilder () {
      * @return dbObject
      */
     public static function ObjectBuilder () {
-        $obj = new static;
-        return $obj;
+        return new static;
     }
 
+    /**
+     * Helper function to create a virtual table class
+     *
+     * @param string tableName Table name
+     * @return dbObject
+     */
+    public static function table ($tableName) {
+        $tableName = preg_replace ("/[^-a-z0-9_]+/i",'', $tableName);
+        if (!class_exists ($tableName))
+            eval ("class $tableName extends dbObject {}");
+        return new $tableName ();
+    }
     /**
      * @return mixed insert id or false in case of failure
      */
@@ -271,6 +297,7 @@ private function byId ($id, $fields = null) {
     private function getOne ($fields = null) {
         $results = $this->db->getOne ($this->dbTable, $fields);
         $this->processArrays ($results);
+        $this->data = $results;
         $this->processWith ($results);
         if ($this->returnType == 'Array')
             return $results;
@@ -296,6 +323,7 @@ private function get ($limit = null, $fields = null) {
         $results = $this->db->get ($this->dbTable, $limit, $fields);
         foreach ($results as &$r) {
             $this->processArrays ($r);
+            $this->data = $r;
             $this->processWith ($r);
             if ($this->returnType == 'Object') {
                 $item = new static ($r);
@@ -446,6 +474,7 @@ private function processWith (&$data) {
             return;
         foreach ($this->_with as $w)
             $data[$w] = $this->$w;
+
         $this->_with = Array();
     }
 
@@ -468,6 +497,9 @@ private function processArrays (&$data) {
      * @param array $data
      */
     private function validate ($data) {
+        if (!$this->dbFields)
+            return true;
+
         foreach ($this->dbFields as $key => $desc) {
             $type = null;
             $required = false;
@@ -528,6 +560,9 @@ private function prepareData () {
         if (method_exists ($this, "preLoad"))
             $this->preLoad ($data);
 
+        if (!$this->dbFields)
+            return $this->data;
+
         foreach ($this->data as $key => &$value) {
             if ($value instanceof dbObject && $value->isNew == true) {
                 $id = $value->save();
@@ -556,8 +591,9 @@ private function prepareData () {
     }
 
     private static function dbObjectAutoload ($classname) {
-        $filename = "models/". $classname .".php";
-        include ($filename);
+        $filename = static::$modelPath . $classname .".php";
+        if (file_exists ($filename))
+            include ($filename);
     }
 
     /*

readme.md

@@ -1,7 +1,8 @@
-MysqliDb -- Simple MySQLi wrapper with prepared statements
+MysqliDb -- Simple MySQLi wrapper and object mapper with prepared statements
 <hr>
 ### Table of Contents
 **[Initialization](#initialization)**  
+**[Objects mapping](#objects-mapping)**  
 **[Insert Query](#insert-query)**  
 **[Update Query](#update-query)**  
 **[Select Query](#select-query)**  
@@ -69,6 +70,10 @@ $db->setPrefix ('my_');
 
 Next, prepare your data, and call the necessary methods. 
 
+### Objects mapping
+dbObject.php is an object mapping library built on top of mysqliDb to provide model prepresentation functionality.
+See <a href='dbObject.md'>dbObject manual for more information</a>
+
 ### Insert Query
 Simple example
 ```php

tests/dbObjectTests.php

@@ -121,6 +121,13 @@ function createTable ($name, $data) {
     exit;
 }
 
+$product = product::with('userId')->byId(5);
+if (!is_object ($product->data['userId'])) {
+    echo "Error in with processing in getOne object";
+    exit;
+}
+
+
 $products = product::ArrayBuilder()->with('userId')->get(2);
 if (!is_array ($products[0]['userId'])) {
     echo "Error in with processing in get";

tests/models/user.php

@@ -16,7 +16,6 @@
  */
 class user extends dbObject {
     protected $dbTable = "users";
-    protected $primaryKey = "id";
     protected $dbFields = Array (
         'login' => Array ('text', 'required'),
         'active' => Array ('bool'),