tnhfw / tnh-fw

tests/bootstrap.php

Indentation +243 added lines, -243 removed lines

@@ -1,292 +1,292 @@
 <?php
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	error_reporting(E_ALL | E_STRICT);
-	ini_set('display_errors', 1);
+    error_reporting(E_ALL | E_STRICT);
+    ini_set('display_errors', 1);
 
-	/**
-	* the directory separator, under windows it is \ and unix, linux /
-	*/
-	define('DS', DIRECTORY_SEPARATOR);
+    /**
+     * the directory separator, under windows it is \ and unix, linux /
+     */
+    define('DS', DIRECTORY_SEPARATOR);
 
-	/**
-	* The root directory of the application.
-	*
-	* you can place this directory outside of your web directory, for example "/home/your_app", etc.
-	*/
-	define('ROOT_PATH', dirname(realpath(__FILE__)) . DS . '..' . DS);
+    /**
+     * The root directory of the application.
+     *
+     * you can place this directory outside of your web directory, for example "/home/your_app", etc.
+     */
+    define('ROOT_PATH', dirname(realpath(__FILE__)) . DS . '..' . DS);
 	
-	//tests dir path
-	define('TESTS_PATH', dirname(realpath(__FILE__)) . DS);
+    //tests dir path
+    define('TESTS_PATH', dirname(realpath(__FILE__)) . DS);
 
 
-	/**
-	* The path to the directory.
-	*
-	* That contains your static files (javascript, css, images, etc.)
-	* Note: the path must be relative to the file index.php (the front-end controller).
-	*/
-	define('ASSETS_PATH', 'assets/');
+    /**
+     * The path to the directory.
+     *
+     * That contains your static files (javascript, css, images, etc.)
+     * Note: the path must be relative to the file index.php (the front-end controller).
+     */
+    define('ASSETS_PATH', 'assets/');
 
-	/**
-	* The path to the directory of your cache files.
-	*
-	* This feature is available currently for database and views.
-	*/
-	define('CACHE_PATH', ROOT_PATH . 'cache' . DS);
+    /**
+     * The path to the directory of your cache files.
+     *
+     * This feature is available currently for database and views.
+     */
+    define('CACHE_PATH', ROOT_PATH . 'cache' . DS);
 
-	/**
-	* Custom application path for tests 
-	*/
-	define('APPS_PATH', TESTS_PATH .'hmvc' . DS);
+    /**
+     * Custom application path for tests 
+     */
+    define('APPS_PATH', TESTS_PATH .'hmvc' . DS);
 
-	/**
-	* The path to the controller directory of your application.
-	*
-	* If you already know the MVC architecture you know what a controller means; 
-	* it is he who makes the business logic of your application in general.
-	*/
-	define('APPS_CONTROLLER_PATH', APPS_PATH . 'controllers' . DS);
+    /**
+     * The path to the controller directory of your application.
+     *
+     * If you already know the MVC architecture you know what a controller means; 
+     * it is he who makes the business logic of your application in general.
+     */
+    define('APPS_CONTROLLER_PATH', APPS_PATH . 'controllers' . DS);
 
-	/**
-	* The path to the directory of your model classes of your application. 
-	*
-	* If you already know the MVC architecture you know what a model means; 
-	* it's the one who interacts with the database, in one word persistent data from your application.
-	*/
-	define('APPS_MODEL_PATH', APPS_PATH . 'models' . DS);
+    /**
+     * The path to the directory of your model classes of your application. 
+     *
+     * If you already know the MVC architecture you know what a model means; 
+     * it's the one who interacts with the database, in one word persistent data from your application.
+     */
+    define('APPS_MODEL_PATH', APPS_PATH . 'models' . DS);
 
-	/**
-	* The path to the directory of your views.
-	*
-	* If you already know the MVC architecture you know what a view means, 
-	* a view is just a user interface (html page, form, etc.) that is to say 
-	* everything displayed in the browser interface, etc.
-	*/
-	define('APPS_VIEWS_PATH', APPS_PATH . 'views' . DS);
+    /**
+     * The path to the directory of your views.
+     *
+     * If you already know the MVC architecture you know what a view means, 
+     * a view is just a user interface (html page, form, etc.) that is to say 
+     * everything displayed in the browser interface, etc.
+     */
+    define('APPS_VIEWS_PATH', APPS_PATH . 'views' . DS);
 
-	/**
-	* The path to the configuration directory.
-	*
-	* That contains most of the configuration files for your 
-	* application (database, class loading file, functions, etc.)
-	*/
-	define('CONFIG_PATH', ROOT_PATH . 'config' . DS);
+    /**
+     * The path to the configuration directory.
+     *
+     * That contains most of the configuration files for your 
+     * application (database, class loading file, functions, etc.)
+     */
+    define('CONFIG_PATH', ROOT_PATH . 'config' . DS);
 
-	/** 
-	* The core directory
-	*
-	* It is recommended to put this folder out of the web directory of your server and 
-	* you should not change its content because in case of update you could lose the modified files.
-	*/
-	define('CORE_PATH', ROOT_PATH . 'core' . DS);
+    /** 
+     * The core directory
+     *
+     * It is recommended to put this folder out of the web directory of your server and 
+     * you should not change its content because in case of update you could lose the modified files.
+     */
+    define('CORE_PATH', ROOT_PATH . 'core' . DS);
 	
-	/**
-	* The path to the directory of core classes that used by the system.
-	*
-	* It contains PHP classes that are used by the framework internally.
-	*/
-	define('CORE_CLASSES_PATH', CORE_PATH . 'classes' . DS);
+    /**
+     * The path to the directory of core classes that used by the system.
+     *
+     * It contains PHP classes that are used by the framework internally.
+     */
+    define('CORE_CLASSES_PATH', CORE_PATH . 'classes' . DS);
 	
-	/**
-	* The path to the directory of core classes for the cache used by the system.
-	*
-	* It contains PHP classes for the cache drivers.
-	*/
-	define('CORE_CLASSES_CACHE_PATH', CORE_CLASSES_PATH . 'cache' . DS);
+    /**
+     * The path to the directory of core classes for the cache used by the system.
+     *
+     * It contains PHP classes for the cache drivers.
+     */
+    define('CORE_CLASSES_CACHE_PATH', CORE_CLASSES_PATH . 'cache' . DS);
 	
     /**
-	* The path to the directory of core classes for the database used by the system.
-	*
-	* It contains PHP classes for the database library, drivers, etc.
-	*/
-	define('CORE_CLASSES_DATABASE_PATH', CORE_CLASSES_PATH . 'database' . DS);
+     * The path to the directory of core classes for the database used by the system.
+     *
+     * It contains PHP classes for the database library, drivers, etc.
+     */
+    define('CORE_CLASSES_DATABASE_PATH', CORE_CLASSES_PATH . 'database' . DS);
     
-	/**
-	* The path to the directory of core classes for the model used by the system.
-	*
-	* It contains PHP classes for the models.
-	*/
-	define('CORE_CLASSES_MODEL_PATH', CORE_CLASSES_PATH . 'model' . DS);
+    /**
+     * The path to the directory of core classes for the model used by the system.
+     *
+     * It contains PHP classes for the models.
+     */
+    define('CORE_CLASSES_MODEL_PATH', CORE_CLASSES_PATH . 'model' . DS);
 
-	/**
-	* The path to the directory of functions or helper systems.
-	*
-	* It contains PHP functions that perform a particular task: character string processing, URL, etc.
-	*/
-	define('CORE_FUNCTIONS_PATH', CORE_PATH . 'functions' . DS);
+    /**
+     * The path to the directory of functions or helper systems.
+     *
+     * It contains PHP functions that perform a particular task: character string processing, URL, etc.
+     */
+    define('CORE_FUNCTIONS_PATH', CORE_PATH . 'functions' . DS);
 
-	/**
-	* The path to the core directory of languages files. 
-	*
-	*/
-	define('CORE_LANG_PATH', CORE_PATH . 'lang' . DS);
+    /**
+     * The path to the core directory of languages files. 
+     *
+     */
+    define('CORE_LANG_PATH', CORE_PATH . 'lang' . DS);
 
-	/**
-	* The path to the system library directory.
-	*
-	* Which contains the libraries most often used in your web application, as for the 
-	* core directory it is advisable to put it out of the root directory of your application.
-	*/
-	define('CORE_LIBRARY_PATH', CORE_PATH . 'libraries' . DS);
+    /**
+     * The path to the system library directory.
+     *
+     * Which contains the libraries most often used in your web application, as for the 
+     * core directory it is advisable to put it out of the root directory of your application.
+     */
+    define('CORE_LIBRARY_PATH', CORE_PATH . 'libraries' . DS);
 
-	/**
-	* The path to the system view directory.
-	*
-	* That contains the views used for the system, such as error messages, and so on.
-	*/
-	define('CORE_VIEWS_PATH', CORE_PATH . 'views' . DS);
+    /**
+     * The path to the system view directory.
+     *
+     * That contains the views used for the system, such as error messages, and so on.
+     */
+    define('CORE_VIEWS_PATH', CORE_PATH . 'views' . DS);
 	
-	/**
-	* The path to the directory of your PHP personal functions or helper.
-	*
-	* It contains your PHP functions that perform a particular task: utilities, etc.
-	* Note: Do not put your personal functions or helpers in the system functions directory, 
-	* because if you update the system you may lose them.
-	*/
-	define('FUNCTIONS_PATH', ROOT_PATH . 'functions' . DS);
+    /**
+     * The path to the directory of your PHP personal functions or helper.
+     *
+     * It contains your PHP functions that perform a particular task: utilities, etc.
+     * Note: Do not put your personal functions or helpers in the system functions directory, 
+     * because if you update the system you may lose them.
+     */
+    define('FUNCTIONS_PATH', ROOT_PATH . 'functions' . DS);
 
-	/**
-	* The path to the app directory of personal language. 
-	*
-	* This feature is not yet available. 
-	* You can help us do this if you are nice or wish to see the developed framework.
-	*/
-	define('APP_LANG_PATH', ROOT_PATH . 'lang' . DS);
+    /**
+     * The path to the app directory of personal language. 
+     *
+     * This feature is not yet available. 
+     * You can help us do this if you are nice or wish to see the developed framework.
+     */
+    define('APP_LANG_PATH', ROOT_PATH . 'lang' . DS);
 
-	/**
-	* The path to the directory of your personal libraries
-	*
-	* It contains your PHP classes, package, etc.
-	* Note: you should not put your personal libraries in the system library directory, 
-	* because it is recalled in case of updating the system you might have surprises.
-	*/
-	define('LIBRARY_PATH', ROOT_PATH . 'libraries' . DS);
+    /**
+     * The path to the directory of your personal libraries
+     *
+     * It contains your PHP classes, package, etc.
+     * Note: you should not put your personal libraries in the system library directory, 
+     * because it is recalled in case of updating the system you might have surprises.
+     */
+    define('LIBRARY_PATH', ROOT_PATH . 'libraries' . DS);
 
-	/**
-	* The path to the directory that contains the log files.
-	*
-	* Note: This directory must be available in writing and if possible must have as owner the user who launches your web server, 
-	* under unix or linux most often with the apache web server it is "www-data" or "httpd" even "nobody" for more
-	* details see the documentation of your web server.
-	* Example for Unix or linux with apache web server:
-	* # chmod -R 700 /path/to/your/logs/directory/
-	* # chown -R www-data:www-data /path/to/your/logs/directory/
-	*/
-	define('LOGS_PATH', ROOT_PATH . 'logs' . DS);
+    /**
+     * The path to the directory that contains the log files.
+     *
+     * Note: This directory must be available in writing and if possible must have as owner the user who launches your web server, 
+     * under unix or linux most often with the apache web server it is "www-data" or "httpd" even "nobody" for more
+     * details see the documentation of your web server.
+     * Example for Unix or linux with apache web server:
+     * # chmod -R 700 /path/to/your/logs/directory/
+     * # chown -R www-data:www-data /path/to/your/logs/directory/
+     */
+    define('LOGS_PATH', ROOT_PATH . 'logs' . DS);
 
-	/**
-	* The path to the modules directory. 
-	*
-	* It contains your modules used files (config, controllers, libraries, etc.) that is to say which contains your files of the modules, 
-	* in HMVC architecture (hierichical, controllers, models, views).
-	*/
-	define('MODULE_PATH', dirname(realpath(__FILE__)) . DS .'hmvc' . DS . 'modules' . DS);
+    /**
+     * The path to the modules directory. 
+     *
+     * It contains your modules used files (config, controllers, libraries, etc.) that is to say which contains your files of the modules, 
+     * in HMVC architecture (hierichical, controllers, models, views).
+     */
+    define('MODULE_PATH', dirname(realpath(__FILE__)) . DS .'hmvc' . DS . 'modules' . DS);
 
-	/**
-	* The path to the directory of sources external to your application.
-	*
-	* If you have already used "composer" you know what that means.
-	*/
-	define('VENDOR_PATH', ROOT_PATH . 'vendor' . DS);
+    /**
+     * The path to the directory of sources external to your application.
+     *
+     * If you have already used "composer" you know what that means.
+     */
+    define('VENDOR_PATH', ROOT_PATH . 'vendor' . DS);
 
-	/**
-	* The front controller of your application.
-	*
-	* "index.php" it is through this file that all the requests come, there is a possibility to hidden it in the url of 
-	* your application by using the rewrite module URL of your web server .
-	* For example, under apache web server, there is a configuration example file that is located at the root 
-	* of your framework folder : "htaccess.txt" rename it to ".htaccess".
-	*/
-	define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME));
+    /**
+     * The front controller of your application.
+     *
+     * "index.php" it is through this file that all the requests come, there is a possibility to hidden it in the url of 
+     * your application by using the rewrite module URL of your web server .
+     * For example, under apache web server, there is a configuration example file that is located at the root 
+     * of your framework folder : "htaccess.txt" rename it to ".htaccess".
+     */
+    define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME));
 	
-	/**
-	 * Check if user run the application under CLI
-	 */
-	define('IS_CLI', stripos('cli', php_sapi_name()) !== false);
+    /**
+     * Check if user run the application under CLI
+     */
+    define('IS_CLI', stripos('cli', php_sapi_name()) !== false);
 
-	/**
-	* The environment of your application (production, test, development). 
-	*
-	* if your application is still in development you use the value "development" 
-	* so you will have the display of the error messages, etc. 
-	* Once you finish the development of your application that is to put it online 
-	* you change this value to "production" or "testing", in this case there will be deactivation of error messages, 
-	* the loading of the system, will be fast.
-	*/
-	define('ENVIRONMENT', 'testing');
+    /**
+     * The environment of your application (production, test, development). 
+     *
+     * if your application is still in development you use the value "development" 
+     * so you will have the display of the error messages, etc. 
+     * Once you finish the development of your application that is to put it online 
+     * you change this value to "production" or "testing", in this case there will be deactivation of error messages, 
+     * the loading of the system, will be fast.
+     */
+    define('ENVIRONMENT', 'testing');
 	
 	
-	//Fix to allow test as if application is running in CLI mode $_SESSION global variable is not available
-	$_SESSION = array();
+    //Fix to allow test as if application is running in CLI mode $_SESSION global variable is not available
+    $_SESSION = array();
 	
-	if(! isset($_SERVER['REMOTE_ADDR'])){ 
-		$_SERVER['REMOTE_ADDR'] = '127.0.0.1';
-	}
+    if(! isset($_SERVER['REMOTE_ADDR'])){ 
+        $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
+    }
 	
-	//check for composer autoload file if exists include it
-	if (file_exists(VENDOR_PATH . 'autoload.php')){
-		require_once VENDOR_PATH . 'autoload.php';
+    //check for composer autoload file if exists include it
+    if (file_exists(VENDOR_PATH . 'autoload.php')){
+        require_once VENDOR_PATH . 'autoload.php';
 		
-		//define the class alias for vstream
-		class_alias('org\bovigo\vfs\vfsStream', 'vfsStream');
-		class_alias('org\bovigo\vfs\vfsStreamDirectory', 'vfsStreamDirectory');
-		class_alias('org\bovigo\vfs\vfsStreamWrapper', 'vfsStreamWrapper');
+        //define the class alias for vstream
+        class_alias('org\bovigo\vfs\vfsStream', 'vfsStream');
+        class_alias('org\bovigo\vfs\vfsStreamDirectory', 'vfsStreamDirectory');
+        class_alias('org\bovigo\vfs\vfsStreamWrapper', 'vfsStreamWrapper');
 		
-	}
+    }
 
-	//require autoloader for test
-	require_once  'include/autoloader.php';
+    //require autoloader for test
+    require_once  'include/autoloader.php';
 	
 	
 
-	//grap from core/common.php functions and mock some functions for tests
-	require_once  'include/common.php';
+    //grap from core/common.php functions and mock some functions for tests
+    require_once  'include/common.php';
 	
-	//Some utilities functions, classes, etc.
-	require_once  'include/testsUtil.php';
+    //Some utilities functions, classes, etc.
+    require_once  'include/testsUtil.php';
 	
-	/**
-	* Setting of the PHP error message handling function
-	*/
-	set_error_handler('php_error_handler');
+    /**
+     * Setting of the PHP error message handling function
+     */
+    set_error_handler('php_error_handler');
 
-	/**
-	* Setting of the PHP error exception handling function
-	*/
-	set_exception_handler('php_exception_handler');
+    /**
+     * Setting of the PHP error exception handling function
+     */
+    set_exception_handler('php_exception_handler');
 
-	/**
-	 * Setting of the PHP shutdown handling function
-	 */
-	register_shutdown_function('php_shudown_handler');
+    /**
+     * Setting of the PHP shutdown handling function
+     */
+    register_shutdown_function('php_shudown_handler');
 	
-	/**
-	* Register the tests autoload
-	*/
-	spl_autoload_register('tests_autoload');
+    /**
+     * Register the tests autoload
+     */
+    spl_autoload_register('tests_autoload');
 	
 	
-	
\ No newline at end of file
+    
\ No newline at end of file

tests/tnhfw/classes/DBSessionHandlerTest.php

Indentation +204 added lines, -204 removed lines

@@ -1,226 +1,226 @@
 <?php 
 
-	use PHPUnit\Framework\TestCase;
+    use PHPUnit\Framework\TestCase;
 
-	class DBSessionHandlerTest extends TestCase
-	{	
+    class DBSessionHandlerTest extends TestCase
+    {	
 	
-		private $db = null;
+        private $db = null;
 		
-		private $model = null;
+        private $model = null;
 		
-		private $secret = 'bXlzZWNyZXQ';
+        private $secret = 'bXlzZWNyZXQ';
 		
-		private static $config = null;
+        private static $config = null;
 		
-		public function __construct(){
-			$this->db = new Database(array(
-								'driver'    =>  'sqlite',
-								'database'  =>  TESTS_PATH . 'assets/db_tests.db',
-								'charset'   => 'utf8',
-								'collation' => 'utf8_general_ci',
-							));
+        public function __construct(){
+            $this->db = new Database(array(
+                                'driver'    =>  'sqlite',
+                                'database'  =>  TESTS_PATH . 'assets/db_tests.db',
+                                'charset'   => 'utf8',
+                                'collation' => 'utf8_general_ci',
+                            ));
             $qr = new DatabaseQueryRunner($this->db->getPdo());
             $qr->setBenchmark(new Benchmark());
             $qr->setDriver('sqlite');
             $this->db->setQueryRunner($qr);
-		}
+        }
 		
-		public static function setUpBeforeClass()
-		{
-			require APPS_MODEL_PATH . 'DBSessionModel.php';
-			self::$config = new Config();
-			self::$config->init();
-		}
+        public static function setUpBeforeClass()
+        {
+            require APPS_MODEL_PATH . 'DBSessionModel.php';
+            self::$config = new Config();
+            self::$config->init();
+        }
 		
 		
-		public static function tearDownAfterClass()
-		{
+        public static function tearDownAfterClass()
+        {
 			
-		}
+        }
 		
-		protected function setUp()
-		{
-			$this->model = new DBSessionModel($this->db);
+        protected function setUp()
+        {
+            $this->model = new DBSessionModel($this->db);
             //to prevent old data conflict
-			$this->model->truncate();
-		}
+            $this->model->truncate();
+        }
 
-		protected function tearDown()
-		{
-		}
+        protected function tearDown()
+        {
+        }
 
 		
 		
-		public function testUsingSessionConfiguration(){
-			//using value in the configuration
-			self::$config->set('session_save_path', 'DBSessionModel');
-			self::$config->set('session_secret', $this->secret);
-			$dbsh = new DBSessionHandler();
-			//assign Database instance manually
-			$o = &get_instance();
-			$o->database = $this->db;
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->close());
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//do update of existing data
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-			$this->assertTrue($dbsh->destroy('foo'));
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->gc(13));
-			$encoded = $dbsh->encode('foo');
-			$this->assertNotEmpty($encoded);
-			$this->assertEquals($dbsh->decode($encoded), 'foo');
-		}
-		
-		public function testWhenDataIsExpired(){
-			$dbsh = new DBSessionHandler($this->model);
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//put it in expired
-			$this->model->update('foo', array('s_time' => 1234567));
-			$this->assertNull($dbsh->read('foo'));
-		}
-		
-		public function testWhenDataAlreadyExistDoUpdate(){
-			$dbsh = new DBSessionHandler($this->model);
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//do update of existing data
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-		}
-		
-		public function testUsingCustomModelInstance(){
-			$dbsh = new DBSessionHandler($this->model);
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->close());
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//put it in expired
-			$this->model->update('foo', array('s_time' => 1234567));
-			
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			
-			//do update of existing data
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-			$this->assertTrue($dbsh->destroy('foo'));
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->gc(13));
-			$encoded = $dbsh->encode('foo');
-			$this->assertNotEmpty($encoded);
-			$this->assertEquals($dbsh->decode($encoded), 'foo');
-		}
-			
-			
-		public function testUsingCustomLogInstance(){
-			$dbsh = new DBSessionHandler($this->model, new Log());
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->close());
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//put it in expired
-			$this->model->update('foo', array('s_time' => 1234567));
-			
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			
-			//do update of existing data
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-			$this->assertTrue($dbsh->destroy('foo'));
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->gc(13));
-			$encoded = $dbsh->encode('foo');
-			$this->assertNotEmpty($encoded);
-			$this->assertEquals($dbsh->decode($encoded), 'foo');
-		}
-		
-		public function testUsingCustomLoaderInstance(){
-			$dbsh = new DBSessionHandler($this->model, null, new Loader());
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->close());
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//put it in expired
-			$this->model->update('foo', array('s_time' => 1234567));
-			
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			
-			//do update of existing data
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-			$this->assertTrue($dbsh->destroy('foo'));
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->gc(13));
-			$encoded = $dbsh->encode('foo');
-			$this->assertNotEmpty($encoded);
-			$this->assertEquals($dbsh->decode($encoded), 'foo');
-		}
-		
-		
-		public function testWhenModelInsanceIsNotSet(){
-			$dbsh = new DBSessionHandler(null, null, new Loader());
-			$dbsh->setSessionSecret($this->secret);
-			
-			$this->assertTrue($dbsh->open(null, null));
-			$this->assertTrue($dbsh->close());
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			$this->assertNotEmpty($dbsh->read('foo'));
-			$this->assertEquals($dbsh->read('foo'), '444');
-			//put it in expired
-			$this->model->update('foo', array('s_time' => 1234567));
-			
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->write('foo', '444'));
-			
-			//do update of existing data
-			$this->assertTrue($dbsh->write('tnh', '445'));
-			$this->assertTrue($dbsh->write('foo', '445'));
-			$this->assertEquals($dbsh->read('foo'), '445');	
-			$this->assertTrue($dbsh->destroy('foo'));
-			$this->assertNull($dbsh->read('foo'));
-			$this->assertTrue($dbsh->gc(13));
-			$encoded = $dbsh->encode('foo');
-			$this->assertNotEmpty($encoded);
-			$this->assertEquals($dbsh->decode($encoded), 'foo');
-		}
-		
-		public function testWhenModelTableColumnsIsNotSet(){
-			//session table is empty
-			$this->model->setSessionTableColumns(array());
-			$dbsh = new DBSessionHandler($this->model);
-			$this->assertTrue($dbsh->open(null, null));
-		}
-		
-		
-	}
\ No newline at end of file
+        public function testUsingSessionConfiguration(){
+            //using value in the configuration
+            self::$config->set('session_save_path', 'DBSessionModel');
+            self::$config->set('session_secret', $this->secret);
+            $dbsh = new DBSessionHandler();
+            //assign Database instance manually
+            $o = &get_instance();
+            $o->database = $this->db;
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->close());
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //do update of existing data
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+            $this->assertTrue($dbsh->destroy('foo'));
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->gc(13));
+            $encoded = $dbsh->encode('foo');
+            $this->assertNotEmpty($encoded);
+            $this->assertEquals($dbsh->decode($encoded), 'foo');
+        }
+		
+        public function testWhenDataIsExpired(){
+            $dbsh = new DBSessionHandler($this->model);
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //put it in expired
+            $this->model->update('foo', array('s_time' => 1234567));
+            $this->assertNull($dbsh->read('foo'));
+        }
+		
+        public function testWhenDataAlreadyExistDoUpdate(){
+            $dbsh = new DBSessionHandler($this->model);
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //do update of existing data
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+        }
+		
+        public function testUsingCustomModelInstance(){
+            $dbsh = new DBSessionHandler($this->model);
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->close());
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //put it in expired
+            $this->model->update('foo', array('s_time' => 1234567));
+			
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+			
+            //do update of existing data
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+            $this->assertTrue($dbsh->destroy('foo'));
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->gc(13));
+            $encoded = $dbsh->encode('foo');
+            $this->assertNotEmpty($encoded);
+            $this->assertEquals($dbsh->decode($encoded), 'foo');
+        }
+			
+			
+        public function testUsingCustomLogInstance(){
+            $dbsh = new DBSessionHandler($this->model, new Log());
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->close());
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //put it in expired
+            $this->model->update('foo', array('s_time' => 1234567));
+			
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+			
+            //do update of existing data
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+            $this->assertTrue($dbsh->destroy('foo'));
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->gc(13));
+            $encoded = $dbsh->encode('foo');
+            $this->assertNotEmpty($encoded);
+            $this->assertEquals($dbsh->decode($encoded), 'foo');
+        }
+		
+        public function testUsingCustomLoaderInstance(){
+            $dbsh = new DBSessionHandler($this->model, null, new Loader());
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->close());
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //put it in expired
+            $this->model->update('foo', array('s_time' => 1234567));
+			
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+			
+            //do update of existing data
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+            $this->assertTrue($dbsh->destroy('foo'));
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->gc(13));
+            $encoded = $dbsh->encode('foo');
+            $this->assertNotEmpty($encoded);
+            $this->assertEquals($dbsh->decode($encoded), 'foo');
+        }
+		
+		
+        public function testWhenModelInsanceIsNotSet(){
+            $dbsh = new DBSessionHandler(null, null, new Loader());
+            $dbsh->setSessionSecret($this->secret);
+			
+            $this->assertTrue($dbsh->open(null, null));
+            $this->assertTrue($dbsh->close());
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+            $this->assertNotEmpty($dbsh->read('foo'));
+            $this->assertEquals($dbsh->read('foo'), '444');
+            //put it in expired
+            $this->model->update('foo', array('s_time' => 1234567));
+			
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->write('foo', '444'));
+			
+            //do update of existing data
+            $this->assertTrue($dbsh->write('tnh', '445'));
+            $this->assertTrue($dbsh->write('foo', '445'));
+            $this->assertEquals($dbsh->read('foo'), '445');	
+            $this->assertTrue($dbsh->destroy('foo'));
+            $this->assertNull($dbsh->read('foo'));
+            $this->assertTrue($dbsh->gc(13));
+            $encoded = $dbsh->encode('foo');
+            $this->assertNotEmpty($encoded);
+            $this->assertEquals($dbsh->decode($encoded), 'foo');
+        }
+		
+        public function testWhenModelTableColumnsIsNotSet(){
+            //session table is empty
+            $this->model->setSessionTableColumns(array());
+            $dbsh = new DBSessionHandler($this->model);
+            $this->assertTrue($dbsh->open(null, null));
+        }
+		
+		
+    }
\ No newline at end of file

tests/include/autoloader.php

Indentation +53 added lines, -53 removed lines

@@ -1,54 +1,54 @@
 <?php
-	//Autoload function
-	function tests_autoload($class){
-		$classesMap = array(
-			//Caches
-			'ApcCache' => CORE_CLASSES_CACHE_PATH . 'ApcCache.php',
-			'CacheInterface' => CORE_CLASSES_CACHE_PATH . 'CacheInterface.php',
-			'FileCache' => CORE_CLASSES_CACHE_PATH . 'FileCache.php',
-			//models
-			'DBSessionHandlerModel' => CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php',
-			'Model' => CORE_CLASSES_MODEL_PATH . 'Model.php',
-			//Core classes
-			'Config' => CORE_CLASSES_PATH . 'Config.php',
-			'Controller' => CORE_CLASSES_PATH . 'Controller.php',
-			'Database' => CORE_CLASSES_DATABASE_PATH . 'Database.php',
-			'DatabaseQueryBuilder' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryBuilder.php',
-			'DatabaseQueryResult' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryResult.php',
-			'DatabaseQueryRunner' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryRunner.php',
-			'DBSessionHandler' => CORE_CLASSES_PATH . 'DBSessionHandler.php',
-			'EventInfo' => CORE_CLASSES_PATH . 'EventInfo.php',
-			'EventDispatcher' => CORE_CLASSES_PATH . 'EventDispatcher.php',
-			'Lang' => CORE_CLASSES_PATH . 'Lang.php',
-			'Loader' => CORE_CLASSES_PATH . 'Loader.php',
-			'Log' => CORE_CLASSES_PATH . 'Log.php',
-			'Module' => CORE_CLASSES_PATH . 'Module.php',
-			'Request' => CORE_CLASSES_PATH . 'Request.php',
-			'Response' => CORE_CLASSES_PATH . 'Response.php',
-			'Router' => CORE_CLASSES_PATH . 'Router.php',
-			'Security' => CORE_CLASSES_PATH . 'Security.php',
-			'Session' => CORE_CLASSES_PATH . 'Session.php',
-			'Url' => CORE_CLASSES_PATH . 'Url.php',
-			//Core libraries
-			'Assets' => CORE_LIBRARY_PATH . 'Assets.php',
-			'Benchmark' => CORE_LIBRARY_PATH . 'Benchmark.php',
-			'Browser' => CORE_LIBRARY_PATH . 'Browser.php',
-			'Cookie' => CORE_LIBRARY_PATH . 'Cookie.php',
-			'Email' => CORE_LIBRARY_PATH . 'Email.php',
-			'Form' => CORE_LIBRARY_PATH . 'Form.php',
-			'FormValidation' => CORE_LIBRARY_PATH . 'FormValidation.php',
-			'Html' => CORE_LIBRARY_PATH . 'Html.php',
-			'Pagination' => CORE_LIBRARY_PATH . 'Pagination.php',
-			'PDF' => CORE_LIBRARY_PATH . 'PDF.php',
-			'StringHash' => CORE_LIBRARY_PATH . 'StringHash.php',
-			'Upload' => CORE_LIBRARY_PATH . 'Upload.php',
-		);
-		if(isset($classesMap[$class])){
-			if(file_exists($classesMap[$class])){
-				require_once $classesMap[$class];
-			}
-			else{
-				echo 'File for class ' . $class . ' not found';
-			}
-		}
-	}
\ No newline at end of file
+    //Autoload function
+    function tests_autoload($class){
+        $classesMap = array(
+            //Caches
+            'ApcCache' => CORE_CLASSES_CACHE_PATH . 'ApcCache.php',
+            'CacheInterface' => CORE_CLASSES_CACHE_PATH . 'CacheInterface.php',
+            'FileCache' => CORE_CLASSES_CACHE_PATH . 'FileCache.php',
+            //models
+            'DBSessionHandlerModel' => CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php',
+            'Model' => CORE_CLASSES_MODEL_PATH . 'Model.php',
+            //Core classes
+            'Config' => CORE_CLASSES_PATH . 'Config.php',
+            'Controller' => CORE_CLASSES_PATH . 'Controller.php',
+            'Database' => CORE_CLASSES_DATABASE_PATH . 'Database.php',
+            'DatabaseQueryBuilder' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryBuilder.php',
+            'DatabaseQueryResult' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryResult.php',
+            'DatabaseQueryRunner' => CORE_CLASSES_DATABASE_PATH . 'DatabaseQueryRunner.php',
+            'DBSessionHandler' => CORE_CLASSES_PATH . 'DBSessionHandler.php',
+            'EventInfo' => CORE_CLASSES_PATH . 'EventInfo.php',
+            'EventDispatcher' => CORE_CLASSES_PATH . 'EventDispatcher.php',
+            'Lang' => CORE_CLASSES_PATH . 'Lang.php',
+            'Loader' => CORE_CLASSES_PATH . 'Loader.php',
+            'Log' => CORE_CLASSES_PATH . 'Log.php',
+            'Module' => CORE_CLASSES_PATH . 'Module.php',
+            'Request' => CORE_CLASSES_PATH . 'Request.php',
+            'Response' => CORE_CLASSES_PATH . 'Response.php',
+            'Router' => CORE_CLASSES_PATH . 'Router.php',
+            'Security' => CORE_CLASSES_PATH . 'Security.php',
+            'Session' => CORE_CLASSES_PATH . 'Session.php',
+            'Url' => CORE_CLASSES_PATH . 'Url.php',
+            //Core libraries
+            'Assets' => CORE_LIBRARY_PATH . 'Assets.php',
+            'Benchmark' => CORE_LIBRARY_PATH . 'Benchmark.php',
+            'Browser' => CORE_LIBRARY_PATH . 'Browser.php',
+            'Cookie' => CORE_LIBRARY_PATH . 'Cookie.php',
+            'Email' => CORE_LIBRARY_PATH . 'Email.php',
+            'Form' => CORE_LIBRARY_PATH . 'Form.php',
+            'FormValidation' => CORE_LIBRARY_PATH . 'FormValidation.php',
+            'Html' => CORE_LIBRARY_PATH . 'Html.php',
+            'Pagination' => CORE_LIBRARY_PATH . 'Pagination.php',
+            'PDF' => CORE_LIBRARY_PATH . 'PDF.php',
+            'StringHash' => CORE_LIBRARY_PATH . 'StringHash.php',
+            'Upload' => CORE_LIBRARY_PATH . 'Upload.php',
+        );
+        if(isset($classesMap[$class])){
+            if(file_exists($classesMap[$class])){
+                require_once $classesMap[$class];
+            }
+            else{
+                echo 'File for class ' . $class . ' not found';
+            }
+        }
+    }
\ No newline at end of file

core/classes/database/DatabaseQueryResult.php

Indentation +47 added lines, -47 removed lines

@@ -1,43 +1,43 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
   
-  class DatabaseQueryResult{
+    class DatabaseQueryResult{
   	
-  	/**
-  	 * The database query result
-  	 * @var mixed
-  	 */
-     private $result  = null;
+        /**
+         * The database query result
+         * @var mixed
+         */
+        private $result  = null;
   	
     
-  	/**
-	 * The number of rows returned by the last query
-	 * @var int
-     */
-     private $numRows = 0;
+        /**
+         * The number of rows returned by the last query
+         * @var int
+         */
+        private $numRows = 0;
   	
 	
     /**
@@ -51,24 +51,24 @@ 
     }
 
     
-     /**
-     * Return the query result
-     *
-     * @return mixed
-     */
+        /**
+         * Return the query result
+         *
+         * @return mixed
+         */
     public function getResult(){
-      return $this->result;
+        return $this->result;
     }
 
     /**
      * Set the query result
      * @param mixed $result the query result
      *
-	 * @return object DatabaseQueryResult
+     * @return object DatabaseQueryResult
      */
     public function setResult($result){
-      $this->result = $result;
-      return $this;
+        $this->result = $result;
+        return $this;
     }
     
     /**
@@ -77,18 +77,18 @@ 
      * @return int
      */
     public function getNumRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
      * Set the number of rows returned by the query
      * @param int $numRows the number of rows returned
      *
-	 * @return object DatabaseQueryResult
+     * @return object DatabaseQueryResult
      */
     public function setNumRows($numRows){
-      $this->numRows = $numRows;
-      return $this;
+        $this->numRows = $numRows;
+        return $this;
     }
    
 }

Spacing +7 added lines, -7 removed lines

@@ -24,13 +24,13 @@ 
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
   
-  class DatabaseQueryResult{
+  class DatabaseQueryResult {
   	
   	/**
   	 * The database query result
   	 * @var mixed
   	 */
-     private $result  = null;
+     private $result = null;
   	
     
   	/**
@@ -45,7 +45,7 @@ 
      * @param mixed $result the query result
      * @param int $numRows the number of rows returned by the query
      */
-    public function __construct($result = null, $numRows = 0){
+    public function __construct($result = null, $numRows = 0) {
         $this->result = $result;
         $this->numRows = $numRows;
     }
@@ -56,7 +56,7 @@ 
      *
      * @return mixed
      */
-    public function getResult(){
+    public function getResult() {
       return $this->result;
     }
 
@@ -66,7 +66,7 @@ 
      *
 	 * @return object DatabaseQueryResult
      */
-    public function setResult($result){
+    public function setResult($result) {
       $this->result = $result;
       return $this;
     }
@@ -76,7 +76,7 @@ 
      *
      * @return int
      */
-    public function getNumRows(){
+    public function getNumRows() {
       return $this->numRows;
     }
 
@@ -86,7 +86,7 @@ 
      *
 	 * @return object DatabaseQueryResult
      */
-    public function setNumRows($numRows){
+    public function setNumRows($numRows) {
       $this->numRows = $numRows;
       return $this;
     }

core/classes/database/DatabaseQueryBuilder.php

Indentation +388 added lines, -388 removed lines

@@ -1,108 +1,108 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
-  class DatabaseQueryBuilder{
-  	/**
-  	 * The SQL SELECT statment
-  	 * @var string
-  	*/
-  	private $select              = '*';
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class DatabaseQueryBuilder{
+        /**
+         * The SQL SELECT statment
+         * @var string
+         */
+        private $select              = '*';
   	
-  	/**
-  	 * The SQL FROM statment
-  	 * @var string
-  	*/
-      private $from              = null;
+        /**
+         * The SQL FROM statment
+         * @var string
+         */
+        private $from              = null;
   	
-  	/**
-  	 * The SQL WHERE statment
-  	 * @var string
-  	*/
-      private $where               = null;
+        /**
+         * The SQL WHERE statment
+         * @var string
+         */
+        private $where               = null;
   	
-  	/**
-  	 * The SQL LIMIT statment
-  	 * @var string
-  	*/
-      private $limit               = null;
+        /**
+         * The SQL LIMIT statment
+         * @var string
+         */
+        private $limit               = null;
   	
-  	/**
-  	 * The SQL JOIN statment
-  	 * @var string
-  	*/
-      private $join                = null;
+        /**
+         * The SQL JOIN statment
+         * @var string
+         */
+        private $join                = null;
   	
-  	/**
-  	 * The SQL ORDER BY statment
-  	 * @var string
-  	*/
-      private $orderBy             = null;
+        /**
+         * The SQL ORDER BY statment
+         * @var string
+         */
+        private $orderBy             = null;
   	
-  	/**
-  	 * The SQL GROUP BY statment
-  	 * @var string
-  	*/
-      private $groupBy             = null;
+        /**
+         * The SQL GROUP BY statment
+         * @var string
+         */
+        private $groupBy             = null;
   	
-  	/**
-  	 * The SQL HAVING statment
-  	 * @var string
-  	*/
-      private $having              = null;
+        /**
+         * The SQL HAVING statment
+         * @var string
+         */
+        private $having              = null;
   	
-  	/**
-  	 * The full SQL query statment after build for each command
-  	 * @var string
-  	*/
-      private $query               = null;
+        /**
+         * The full SQL query statment after build for each command
+         * @var string
+         */
+        private $query               = null;
   	
-  	/**
-  	 * The list of SQL valid operators
-  	 * @var array
-  	*/
+        /**
+         * The list of SQL valid operators
+         * @var array
+         */
     private $operatorList        = array('=','!=','<','>','<=','>=','<>');
   	
 	
-	/**
-	 * The prefix used in each database table
-	 * @var string
-	*/
+    /**
+     * The prefix used in each database table
+     * @var string
+     */
     private $prefix              = null;
     
 
     /**
-  	 * The PDO instance
-  	 * @var object
-  	*/
+     * The PDO instance
+     * @var object
+     */
     private $pdo                 = null;
 	
-  	/**
-  	 * The database driver name used
-  	 * @var string
-  	*/
-  	private $driver              = null;
+        /**
+         * The database driver name used
+         * @var string
+         */
+        private $driver              = null;
   	
 	
     /**
@@ -111,7 +111,7 @@ 
      */
     public function __construct(PDO $pdo = null){
         if (is_object($pdo)){
-          $this->setPdo($pdo);
+            $this->setPdo($pdo);
         }
     }
 
@@ -121,16 +121,16 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function from($table){
-	  if (is_array($table)){
+        if (is_array($table)){
         $froms = '';
         foreach($table as $key){
-          $froms .= $this->getPrefix() . $key . ', ';
+            $froms .= $this->getPrefix() . $key . ', ';
         }
         $this->from = rtrim($froms, ', ');
-      } else {
+        } else {
         $this->from = $this->getPrefix() . $table;
-      }
-      return $this;
+        }
+        return $this;
     }
 
     /**
@@ -139,9 +139,9 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function select($fields){
-      $select = (is_array($fields) ? implode(', ', $fields) : $fields);
-      $this->select = (($this->select == '*' || empty($this->select)) ? $select : $this->select . ', ' . $select);
-      return $this;
+        $select = (is_array($fields) ? implode(', ', $fields) : $fields);
+        $this->select = (($this->select == '*' || empty($this->select)) ? $select : $this->select . ', ' . $select);
+        return $this;
     }
 
     /**
@@ -150,19 +150,19 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function distinct($field){
-      $distinct = ' DISTINCT ' . $field;
-      $this->select = (($this->select == '*' || empty($this->select)) ? $distinct : $this->select . ', ' . $distinct);
-      return $this;
+        $distinct = ' DISTINCT ' . $field;
+        $this->select = (($this->select == '*' || empty($this->select)) ? $distinct : $this->select . ', ' . $distinct);
+        return $this;
     }
 
-     /**
-     * Set the SQL function COUNT in SELECT statment
-     * @param  string $field the field name
-     * @param  string $name  if is not null represent the alias used for this field in the result
-     * @return object        the current DatabaseQueryBuilder instance
-     */
+        /**
+         * Set the SQL function COUNT in SELECT statment
+         * @param  string $field the field name
+         * @param  string $name  if is not null represent the alias used for this field in the result
+         * @return object        the current DatabaseQueryBuilder instance
+         */
     public function count($field = '*', $name = null){
-      return $this->select_min_max_sum_count_avg('COUNT', $field, $name);
+        return $this->select_min_max_sum_count_avg('COUNT', $field, $name);
     }
     
     /**
@@ -172,7 +172,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function min($field, $name = null){
-      return $this->select_min_max_sum_count_avg('MIN', $field, $name);
+        return $this->select_min_max_sum_count_avg('MIN', $field, $name);
     }
 
     /**
@@ -182,7 +182,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function max($field, $name = null){
-      return $this->select_min_max_sum_count_avg('MAX', $field, $name);
+        return $this->select_min_max_sum_count_avg('MAX', $field, $name);
     }
 
     /**
@@ -192,7 +192,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function sum($field, $name = null){
-      return $this->select_min_max_sum_count_avg('SUM', $field, $name);
+        return $this->select_min_max_sum_count_avg('SUM', $field, $name);
     }
 
     /**
@@ -202,7 +202,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function avg($field, $name = null){
-      return $this->select_min_max_sum_count_avg('AVG', $field, $name);
+        return $this->select_min_max_sum_count_avg('AVG', $field, $name);
     }
 
 
@@ -216,20 +216,20 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function join($table, $field1 = null, $op = null, $field2 = null, $type = ''){
-      $on = $field1;
-      $table = $this->getPrefix() . $table;
-      if (! is_null($op)){
+        $on = $field1;
+        $table = $this->getPrefix() . $table;
+        if (! is_null($op)){
         $on = (! in_array($op, $this->operatorList) 
-													? ($this->getPrefix() . $field1 . ' = ' . $this->getPrefix() . $op) 
-													: ($this->getPrefix() . $field1 . ' ' . $op . ' ' . $this->getPrefix() . $field2));
-      }
-      if (empty($this->join)){
+                                                    ? ($this->getPrefix() . $field1 . ' = ' . $this->getPrefix() . $op) 
+                                                    : ($this->getPrefix() . $field1 . ' ' . $op . ' ' . $this->getPrefix() . $field2));
+        }
+        if (empty($this->join)){
         $this->join = ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
-      }
-      else{
+        }
+        else{
         $this->join = $this->join . ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
-      }
-      return $this;
+        }
+        return $this;
     }
 
     /**
@@ -238,7 +238,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function innerJoin($table, $field1, $op = null, $field2 = ''){
-      return $this->join($table, $field1, $op, $field2, 'INNER ');
+        return $this->join($table, $field1, $op, $field2, 'INNER ');
     }
 
     /**
@@ -247,16 +247,16 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function leftJoin($table, $field1, $op = null, $field2 = ''){
-      return $this->join($table, $field1, $op, $field2, 'LEFT ');
-	}
+        return $this->join($table, $field1, $op, $field2, 'LEFT ');
+    }
 
-	/**
+    /**
      * Set the SQL RIGHT JOIN statment
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function rightJoin($table, $field1, $op = null, $field2 = ''){
-      return $this->join($table, $field1, $op, $field2, 'RIGHT ');
+        return $this->join($table, $field1, $op, $field2, 'RIGHT ');
     }
 
     /**
@@ -265,7 +265,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function fullOuterJoin($table, $field1, $op = null, $field2 = ''){
-    	return $this->join($table, $field1, $op, $field2, 'FULL OUTER ');
+        return $this->join($table, $field1, $op, $field2, 'FULL OUTER ');
     }
 
     /**
@@ -274,7 +274,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function leftOuterJoin($table, $field1, $op = null, $field2 = ''){
-      return $this->join($table, $field1, $op, $field2, 'LEFT OUTER ');
+        return $this->join($table, $field1, $op, $field2, 'LEFT OUTER ');
     }
 
     /**
@@ -283,7 +283,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function rightOuterJoin($table, $field1, $op = null, $field2 = ''){
-      return $this->join($table, $field1, $op, $field2, 'RIGHT OUTER ');
+        return $this->join($table, $field1, $op, $field2, 'RIGHT OUTER ');
     }
 
     /**
@@ -293,14 +293,14 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function whereIsNull($field, $andOr = 'AND'){
-      if (is_array($field)){
+        if (is_array($field)){
         foreach($field as $f){
-        	$this->whereIsNull($f, $andOr);
+            $this->whereIsNull($f, $andOr);
         }
-      } else {
-          $this->setWhereStr($field.' IS NULL ', $andOr);
-      }
-      return $this;
+        } else {
+            $this->setWhereStr($field.' IS NULL ', $andOr);
+        }
+        return $this;
     }
 
     /**
@@ -310,14 +310,14 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function whereIsNotNull($field, $andOr = 'AND'){
-      if (is_array($field)){
+        if (is_array($field)){
         foreach($field as $f){
-          $this->whereIsNotNull($f, $andOr);
+            $this->whereIsNotNull($f, $andOr);
+        }
+        } else {
+            $this->setWhereStr($field.' IS NOT NULL ', $andOr);
         }
-      } else {
-          $this->setWhereStr($field.' IS NOT NULL ', $andOr);
-      }
-      return $this;
+        return $this;
     }
     
     /**
@@ -331,19 +331,19 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function where($where, $op = null, $val = null, $type = '', $andOr = 'AND', $escape = true){
-      $whereStr = '';
-      if (is_array($where)){
+        $whereStr = '';
+        if (is_array($where)){
         $whereStr = $this->getWhereStrIfIsArray($where, $type, $andOr, $escape);
-      }
-      else{
+        }
+        else{
         if (is_array($op)){
-          $whereStr = $this->getWhereStrIfOperatorIsArray($where, $op, $type, $escape);
+            $whereStr = $this->getWhereStrIfOperatorIsArray($where, $op, $type, $escape);
         } else {
-          $whereStr = $this->getWhereStrForOperator($where, $op, $val, $type, $escape = true);
+            $whereStr = $this->getWhereStrForOperator($where, $op, $val, $type, $escape = true);
+        }
         }
-      }
-      $this->setWhereStr($whereStr, $andOr);
-      return $this;
+        $this->setWhereStr($whereStr, $andOr);
+        return $this;
     }
 
     /**
@@ -352,7 +352,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orWhere($where, $op = null, $val = null, $escape = true){
-      return $this->where($where, $op, $val, '', 'OR', $escape);
+        return $this->where($where, $op, $val, '', 'OR', $escape);
     }
 
 
@@ -362,7 +362,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function notWhere($where, $op = null, $val = null, $escape = true){
-      return $this->where($where, $op, $val, 'NOT ', 'AND', $escape);
+        return $this->where($where, $op, $val, 'NOT ', 'AND', $escape);
     }
 
     /**
@@ -371,7 +371,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orNotWhere($where, $op = null, $val = null, $escape = true){
-    	return $this->where($where, $op, $val, 'NOT ', 'OR', $escape);
+        return $this->where($where, $op, $val, 'NOT ', 'OR', $escape);
     }
 
     /**
@@ -381,16 +381,16 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function groupStart($type = '', $andOr = ' AND'){
-      if (empty($this->where)){
+        if (empty($this->where)){
         $this->where = $type . ' (';
-      } else {
-          if (substr(trim($this->where), -1) == '('){
+        } else {
+            if (substr(trim($this->where), -1) == '('){
             $this->where .= $type . ' (';
-          } else {
-          	$this->where .= $andOr . ' ' . $type . ' (';
-          }
-      }
-      return $this;
+            } else {
+                $this->where .= $andOr . ' ' . $type . ' (';
+            }
+        }
+        return $this;
     }
 
     /**
@@ -399,7 +399,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function notGroupStart(){
-      return $this->groupStart('NOT');
+        return $this->groupStart('NOT');
     }
 
     /**
@@ -408,16 +408,16 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orGroupStart(){
-      return $this->groupStart('', ' OR');
+        return $this->groupStart('', ' OR');
     }
 
-     /**
-     * Set the opened parenthesis for the complex SQL query using OR for separator and NOT for type
-     * @see  DatabaseQueryBuilder::groupStart()
-     * @return object        the current DatabaseQueryBuilder instance
-     */
+        /**
+         * Set the opened parenthesis for the complex SQL query using OR for separator and NOT for type
+         * @see  DatabaseQueryBuilder::groupStart()
+         * @return object        the current DatabaseQueryBuilder instance
+         */
     public function orNotGroupStart(){
-      return $this->groupStart('NOT', ' OR');
+        return $this->groupStart('NOT', ' OR');
     }
 
     /**
@@ -425,8 +425,8 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function groupEnd(){
-      $this->where .= ')';
-      return $this;
+        $this->where .= ')';
+        return $this;
     }
 
     /**
@@ -439,17 +439,17 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function in($field, array $keys, $type = '', $andOr = 'AND', $escape = true){
-      $_keys = array();
-      foreach ($keys as $k => $v){
+        $_keys = array();
+        foreach ($keys as $k => $v){
         if (is_null($v)){
-          $v = '';
+            $v = '';
         }
         $_keys[] = (is_numeric($v) ? $v : $this->escape($v, $escape));
-      }
-      $keys = implode(', ', $_keys);
-      $whereStr = $field . ' ' . $type . ' IN (' . $keys . ')';
-      $this->setWhereStr($whereStr, $andOr);
-      return $this;
+        }
+        $keys = implode(', ', $_keys);
+        $whereStr = $field . ' ' . $type . ' IN (' . $keys . ')';
+        $this->setWhereStr($whereStr, $andOr);
+        return $this;
     }
 
     /**
@@ -458,7 +458,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function notIn($field, array $keys, $escape = true){
-      return $this->in($field, $keys, 'NOT ', 'AND', $escape);
+        return $this->in($field, $keys, 'NOT ', 'AND', $escape);
     }
 
     /**
@@ -467,7 +467,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orIn($field, array $keys, $escape = true){
-      return $this->in($field, $keys, '', 'OR', $escape);
+        return $this->in($field, $keys, '', 'OR', $escape);
     }
 
     /**
@@ -476,7 +476,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orNotIn($field, array $keys, $escape = true){
-      return $this->in($field, $keys, 'NOT ', 'OR', $escape);
+        return $this->in($field, $keys, 'NOT ', 'OR', $escape);
     }
 
     /**
@@ -490,15 +490,15 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function between($field, $value1, $value2, $type = '', $andOr = 'AND', $escape = true){
-      if (is_null($value1)){
+        if (is_null($value1)){
         $value1 = '';
-      }
-      if (is_null($value2)){
+        }
+        if (is_null($value2)){
         $value2 = '';
-      }
-      $whereStr = $field . ' ' . $type . ' BETWEEN ' . $this->escape($value1, $escape) . ' AND ' . $this->escape($value2, $escape);
-      $this->setWhereStr($whereStr, $andOr);
-      return $this;
+        }
+        $whereStr = $field . ' ' . $type . ' BETWEEN ' . $this->escape($value1, $escape) . ' AND ' . $this->escape($value2, $escape);
+        $this->setWhereStr($whereStr, $andOr);
+        return $this;
     }
 
     /**
@@ -507,7 +507,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function notBetween($field, $value1, $value2, $escape = true){
-      return $this->between($field, $value1, $value2, 'NOT ', 'AND', $escape);
+        return $this->between($field, $value1, $value2, 'NOT ', 'AND', $escape);
     }
 
     /**
@@ -516,7 +516,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orBetween($field, $value1, $value2, $escape = true){
-      return $this->between($field, $value1, $value2, '', 'OR', $escape);
+        return $this->between($field, $value1, $value2, '', 'OR', $escape);
     }
 
     /**
@@ -525,7 +525,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orNotBetween($field, $value1, $value2, $escape = true){
-      return $this->between($field, $value1, $value2, 'NOT ', 'OR', $escape);
+        return $this->between($field, $value1, $value2, 'NOT ', 'OR', $escape);
     }
 
     /**
@@ -538,11 +538,11 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function like($field, $data, $type = '', $andOr = 'AND', $escape = true){
-      if (empty($data)){
+        if (empty($data)){
         $data = '';
-      }
-      $this->setWhereStr($field . ' ' . $type . ' LIKE ' . ($this->escape($data, $escape)), $andOr);
-      return $this;
+        }
+        $this->setWhereStr($field . ' ' . $type . ' LIKE ' . ($this->escape($data, $escape)), $andOr);
+        return $this;
     }
 
     /**
@@ -551,7 +551,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orLike($field, $data, $escape = true){
-      return $this->like($field, $data, '', 'OR', $escape);
+        return $this->like($field, $data, '', 'OR', $escape);
     }
 
     /**
@@ -560,7 +560,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function notLike($field, $data, $escape = true){
-      return $this->like($field, $data, 'NOT ', 'AND', $escape);
+        return $this->like($field, $data, 'NOT ', 'AND', $escape);
     }
 
     /**
@@ -569,7 +569,7 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orNotLike($field, $data, $escape = true){
-      return $this->like($field, $data, 'NOT ', 'OR', $escape);
+        return $this->like($field, $data, 'NOT ', 'OR', $escape);
     }
 
     /**
@@ -580,16 +580,16 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function limit($limit, $limitEnd = null){
-      if (empty($limit)){
+        if (empty($limit)){
         $limit = 0;
-      }
-      if (! is_null($limitEnd)){
+        }
+        if (! is_null($limitEnd)){
         $this->limit = $limit . ', ' . $limitEnd;
-      }
-      else{
+        }
+        else{
         $this->limit = $limit;
-      }
-      return $this;
+        }
+        return $this;
     }
 
     /**
@@ -599,15 +599,15 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function orderBy($orderBy, $orderDir = ' ASC'){
-      if (stristr($orderBy, ' ') || $orderBy == 'rand()'){
+        if (stristr($orderBy, ' ') || $orderBy == 'rand()'){
         $this->orderBy = empty($this->orderBy) ? $orderBy : $this->orderBy . ', ' . $orderBy;
-      }
-      else{
+        }
+        else{
         $this->orderBy = empty($this->orderBy) 
-						? ($orderBy . ' ' . strtoupper($orderDir)) 
-						: $this->orderBy . ', ' . $orderBy . ' ' . strtoupper($orderDir);
-      }
-      return $this;
+                        ? ($orderBy . ' ' . strtoupper($orderDir)) 
+                        : $this->orderBy . ', ' . $orderBy . ' ' . strtoupper($orderDir);
+        }
+        return $this;
     }
 
     /**
@@ -616,13 +616,13 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function groupBy($field){
-      if (is_array($field)){
+        if (is_array($field)){
         $this->groupBy = implode(', ', $field);
-      }
-      else{
+        }
+        else{
         $this->groupBy = $field;
-      }
-      return $this;
+        }
+        return $this;
     }
 
     /**
@@ -634,22 +634,22 @@ 
      * @return object        the current DatabaseQueryBuilder instance
      */
     public function having($field, $op = null, $val = null, $escape = true){
-      if (is_array($op)){
+        if (is_array($op)){
         $this->having = $this->getHavingStrIfOperatorIsArray($field, $op, $escape);
-      }
-      else if (! in_array($op, $this->operatorList)){
+        }
+        else if (! in_array($op, $this->operatorList)){
         if (is_null($op)){
-          $op = '';
+            $op = '';
         }
         $this->having = $field . ' > ' . ($this->escape($op, $escape));
-      }
-      else{
+        }
+        else{
         if (is_null($val)){
-          $val = '';
+            $val = '';
         }
         $this->having = $field . ' ' . $op . ' ' . ($this->escape($val, $escape));
-      }
-      return $this;
+        }
+        return $this;
     }
 
     /**
@@ -659,12 +659,12 @@ 
      * @return object  the current DatabaseQueryBuilder instance        
      */
     public function insert($data = array(), $escape = true){
-      $columns = array_keys($data);
-      $column = implode(', ', $columns);
-      $val = implode(', ', ($escape ? array_map(array($this, 'escape'), $data) : $data));
+        $columns = array_keys($data);
+        $column = implode(', ', $columns);
+        $val = implode(', ', ($escape ? array_map(array($this, 'escape'), $data) : $data));
 
-      $this->query = 'INSERT INTO ' . $this->from . ' (' . $column . ') VALUES (' . $val . ')';
-      return $this;
+        $this->query = 'INSERT INTO ' . $this->from . ' (' . $column . ') VALUES (' . $val . ')';
+        return $this;
     }
 
     /**
@@ -674,25 +674,25 @@ 
      * @return object  the current DatabaseQueryBuilder instance 
      */
     public function update($data = array(), $escape = true){
-      $query = 'UPDATE ' . $this->from . ' SET ';
-      $values = array();
-      foreach ($data as $column => $val){
+        $query = 'UPDATE ' . $this->from . ' SET ';
+        $values = array();
+        foreach ($data as $column => $val){
         $values[] = $column . ' = ' . ($this->escape($val, $escape));
-      }
-      $query .= implode(', ', $values);
-      if (! empty($this->where)){
+        }
+        $query .= implode(', ', $values);
+        if (! empty($this->where)){
         $query .= ' WHERE ' . $this->where;
-      }
+        }
 
-      if (! empty($this->orderBy)){
+        if (! empty($this->orderBy)){
         $query .= ' ORDER BY ' . $this->orderBy;
-      }
+        }
 
-      if (! empty($this->limit)){
+        if (! empty($this->limit)){
         $query .= ' LIMIT ' . $this->limit;
-      }
-      $this->query = $query;
-      return $this;
+        }
+        $this->query = $query;
+        return $this;
     }
 
     /**
@@ -700,25 +700,25 @@ 
      * @return object  the current DatabaseQueryBuilder instance 
      */
     public function delete(){
-    	$query = 'DELETE FROM ' . $this->from;
-      $isTruncate = $query;
-    	if (! empty($this->where)){
-  		  $query .= ' WHERE ' . $this->where;
-    	}
+        $query = 'DELETE FROM ' . $this->from;
+        $isTruncate = $query;
+        if (! empty($this->where)){
+            $query .= ' WHERE ' . $this->where;
+        }
 
-    	if (! empty($this->orderBy)){
-    	  $query .= ' ORDER BY ' . $this->orderBy;
-      }
+        if (! empty($this->orderBy)){
+            $query .= ' ORDER BY ' . $this->orderBy;
+        }
 
-    	if (! empty($this->limit)){
-    		$query .= ' LIMIT ' . $this->limit;
-      }
+        if (! empty($this->limit)){
+            $query .= ' LIMIT ' . $this->limit;
+        }
 
-  		if ($isTruncate == $query && $this->driver != 'sqlite'){  
-      	$query = 'TRUNCATE TABLE ' . $this->from;
-  		}
-	   $this->query = $query;
-	   return $this;
+            if ($isTruncate == $query && $this->driver != 'sqlite'){  
+            $query = 'TRUNCATE TABLE ' . $this->from;
+            }
+        $this->query = $query;
+        return $this;
     }
 
     /**
@@ -728,7 +728,7 @@ 
      * @return mixed       the data after escaped or the same data if not
      */
     public function escape($data, $escaped = true){
-      return $escaped 
+        return $escaped 
                     ? $this->getPdo()->quote(trim($data)) 
                     : $data; 
     }
@@ -739,126 +739,126 @@ 
      * @return string
      */
     public function getQuery(){
-  	  //INSERT, UPDATE, DELETE already set it, if is the SELECT we need set it now
-  	  if(empty($this->query)){
-  		  $query = 'SELECT ' . $this->select . ' FROM ' . $this->from;
-  		  if (! empty($this->join)){
-          $query .= $this->join;
-  		  }
+        //INSERT, UPDATE, DELETE already set it, if is the SELECT we need set it now
+        if(empty($this->query)){
+            $query = 'SELECT ' . $this->select . ' FROM ' . $this->from;
+            if (! empty($this->join)){
+            $query .= $this->join;
+            }
   		  
-  		  if (! empty($this->where)){
-          $query .= ' WHERE ' . $this->where;
-  		  }
+            if (! empty($this->where)){
+            $query .= ' WHERE ' . $this->where;
+            }
 
-  		  if (! empty($this->groupBy)){
-          $query .= ' GROUP BY ' . $this->groupBy;
-  		  }
+            if (! empty($this->groupBy)){
+            $query .= ' GROUP BY ' . $this->groupBy;
+            }
 
-  		  if (! empty($this->having)){
-          $query .= ' HAVING ' . $this->having;
-  		  }
+            if (! empty($this->having)){
+            $query .= ' HAVING ' . $this->having;
+            }
 
-  		  if (! empty($this->orderBy)){
-  			  $query .= ' ORDER BY ' . $this->orderBy;
-  		  }
+            if (! empty($this->orderBy)){
+                $query .= ' ORDER BY ' . $this->orderBy;
+            }
 
-  		  if (! empty($this->limit)){
-          $query .= ' LIMIT ' . $this->limit;
-  		  }
-  		  $this->query = $query;
-  	  }
-      return $this->query;
+            if (! empty($this->limit)){
+            $query .= ' LIMIT ' . $this->limit;
+            }
+            $this->query = $query;
+        }
+        return $this->query;
     }
 
 	
-	 /**
-     * Return the PDO instance
-     * @return object
-     */
+        /**
+         * Return the PDO instance
+         * @return object
+         */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
      * Set the PDO instance
      * @param PDO $pdo the pdo object
-	   * @return object DatabaseQueryBuilder
+     * @return object DatabaseQueryBuilder
      */
     public function setPdo(PDO $pdo = null){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
 	
-   /**
-   * Return the database table prefix
-   * @return string
-   */
+    /**
+     * Return the database table prefix
+     * @return string
+     */
     public function getPrefix(){
-      return $this->prefix;
+        return $this->prefix;
     }
 
     /**
      * Set the database table prefix
      * @param string $prefix the new prefix
-	   * @return object DatabaseQueryBuilder
+     * @return object DatabaseQueryBuilder
      */
     public function setPrefix($prefix){
-      $this->prefix = $prefix;
-      return $this;
+        $this->prefix = $prefix;
+        return $this;
     }
 	
-	   /**
-     * Return the database driver
-     * @return string
-     */
+        /**
+         * Return the database driver
+         * @return string
+         */
     public function getDriver(){
-      return $this->driver;
+        return $this->driver;
     }
 
     /**
      * Set the database driver
      * @param string $driver the new driver
-	   * @return object DatabaseQueryBuilder
+     * @return object DatabaseQueryBuilder
      */
     public function setDriver($driver){
-      $this->driver = $driver;
-      return $this;
+        $this->driver = $driver;
+        return $this;
     }
 	
-	   /**
-     * Reset the DatabaseQueryBuilder class attributs to the initial values before each query.
-	   * @return object  the current DatabaseQueryBuilder instance 
-     */
+        /**
+         * Reset the DatabaseQueryBuilder class attributs to the initial values before each query.
+         * @return object  the current DatabaseQueryBuilder instance 
+         */
     public function reset(){
-      $this->select   = '*';
-      $this->from     = null;
-      $this->where    = null;
-      $this->limit    = null;
-      $this->orderBy  = null;
-      $this->groupBy  = null;
-      $this->having   = null;
-      $this->join     = null;
-      $this->query    = null;
-      return $this;
-    }
-
-	   /**
-     * Get the SQL HAVING clause when operator argument is an array
-     * @see DatabaseQueryBuilder::having
-     *
-     * @return string
-     */
+        $this->select   = '*';
+        $this->from     = null;
+        $this->where    = null;
+        $this->limit    = null;
+        $this->orderBy  = null;
+        $this->groupBy  = null;
+        $this->having   = null;
+        $this->join     = null;
+        $this->query    = null;
+        return $this;
+    }
+
+        /**
+         * Get the SQL HAVING clause when operator argument is an array
+         * @see DatabaseQueryBuilder::having
+         *
+         * @return string
+         */
     protected function getHavingStrIfOperatorIsArray($field, $op = null, $escape = true){
         $x = explode('?', $field);
         $w = '';
         foreach($x as $k => $v){
-  	      if (!empty($v)){
+            if (!empty($v)){
             if (! isset($op[$k])){
-              $op[$k] = '';
+                $op[$k] = '';
+            }
+                $w .= $v . (isset($op[$k]) ? $this->escape($op[$k], $escape) : '');
+            }
             }
-  	      	$w .= $v . (isset($op[$k]) ? $this->escape($op[$k], $escape) : '');
-  	      }
-      	}
         return $w;
     }
 
@@ -870,35 +870,35 @@ 
      * @return string
      */
     protected function getWhereStrIfIsArray(array $where, $type = '', $andOr = 'AND', $escape = true){
-      $_where = array();
-      foreach ($where as $column => $data){
+        $_where = array();
+        foreach ($where as $column => $data){
         if (is_null($data)){
-          $data = '';
+            $data = '';
         }
         $_where[] = $type . $column . ' = ' . ($this->escape($data, $escape));
-      }
-      $where = implode(' '.$andOr.' ', $_where);
-      return $where;
+        }
+        $where = implode(' '.$andOr.' ', $_where);
+        return $where;
     }
 
-     /**
-     * Get the SQL WHERE clause when operator argument is an array
-     * @see DatabaseQueryBuilder::where
-     *
-     * @return string
-     */
+        /**
+         * Get the SQL WHERE clause when operator argument is an array
+         * @see DatabaseQueryBuilder::where
+         *
+         * @return string
+         */
     protected function getWhereStrIfOperatorIsArray($where, array $op, $type = '', $escape = true){
-     $x = explode('?', $where);
-     $w = '';
-      foreach($x as $k => $v){
+        $x = explode('?', $where);
+        $w = '';
+        foreach($x as $k => $v){
         if (! empty($v)){
             if (isset($op[$k]) && is_null($op[$k])){
-              $op[$k] = '';
+                $op[$k] = '';
             }
             $w .= $type . $v . (isset($op[$k]) ? ($this->escape($op[$k], $escape)) : '');
         }
-      }
-      return $w;
+        }
+        return $w;
     }
 
     /**
@@ -908,53 +908,53 @@ 
      * @return string
      */
     protected function getWhereStrForOperator($where, $op = null, $val = null, $type = '', $escape = true){
-       $w = '';
-       if (! in_array((string)$op, $this->operatorList)){
-          if (is_null($op)){
+        $w = '';
+        if (! in_array((string)$op, $this->operatorList)){
+            if (is_null($op)){
             $op = '';
-          }
-          $w = $type . $where . ' = ' . ($this->escape($op, $escape));
+            }
+            $w = $type . $where . ' = ' . ($this->escape($op, $escape));
         } else {
-          if (is_null($val)){
+            if (is_null($val)){
             $val = '';
-          }
-          $w = $type . $where . $op . ($this->escape($val, $escape));
+            }
+            $w = $type . $where . $op . ($this->escape($val, $escape));
         }
         return $w;
-      }
-
-      /**
-       * Set the $this->where property 
-       * @param string $whereStr the WHERE clause string
-       * @param  string  $andOr the separator type used 'AND', 'OR', etc.
-       */
-      protected function setWhereStr($whereStr, $andOr = 'AND'){
+        }
+
+        /**
+         * Set the $this->where property 
+         * @param string $whereStr the WHERE clause string
+         * @param  string  $andOr the separator type used 'AND', 'OR', etc.
+         */
+        protected function setWhereStr($whereStr, $andOr = 'AND'){
         if (empty($this->where)){
-          $this->where = $whereStr;
+            $this->where = $whereStr;
         } else {
-          if (substr(trim($this->where), -1) == '('){
+            if (substr(trim($this->where), -1) == '('){
             $this->where = $this->where . ' ' . $whereStr;
-          } else {
+            } else {
             $this->where = $this->where . ' '.$andOr.' ' . $whereStr;
-          }
+            }
+        }
         }
-      }
 
 
-	 /**
-     * Set the SQL SELECT for function MIN, MAX, SUM, AVG, COUNT, AVG
-     * @param  string $clause the clause type like MIN, MAX, etc.
-     * @see  DatabaseQueryBuilder::min
-     * @see  DatabaseQueryBuilder::max
-     * @see  DatabaseQueryBuilder::sum
-     * @see  DatabaseQueryBuilder::count
-     * @see  DatabaseQueryBuilder::avg
-     * @return object
-     */
+        /**
+         * Set the SQL SELECT for function MIN, MAX, SUM, AVG, COUNT, AVG
+         * @param  string $clause the clause type like MIN, MAX, etc.
+         * @see  DatabaseQueryBuilder::min
+         * @see  DatabaseQueryBuilder::max
+         * @see  DatabaseQueryBuilder::sum
+         * @see  DatabaseQueryBuilder::count
+         * @see  DatabaseQueryBuilder::avg
+         * @return object
+         */
     protected function select_min_max_sum_count_avg($clause, $field, $name = null){
-      $clause = strtoupper($clause);
-      $func = $clause . '(' . $field . ')' . (!is_null($name) ? ' AS ' . $name : '');
-      $this->select = ($this->select == '*' ? $func : $this->select . ', ' . $func);
-      return $this;
+        $clause = strtoupper($clause);
+        $func = $clause . '(' . $field . ')' . (!is_null($name) ? ' AS ' . $name : '');
+        $this->select = ($this->select == '*' ? $func : $this->select . ', ' . $func);
+        return $this;
     }
 }

Spacing +140 added lines, -140 removed lines

@@ -23,94 +23,94 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class DatabaseQueryBuilder{
+  class DatabaseQueryBuilder {
   	/**
   	 * The SQL SELECT statment
   	 * @var string
   	*/
-  	private $select              = '*';
+  	private $select = '*';
   	
   	/**
   	 * The SQL FROM statment
   	 * @var string
   	*/
-      private $from              = null;
+      private $from = null;
   	
   	/**
   	 * The SQL WHERE statment
   	 * @var string
   	*/
-      private $where               = null;
+      private $where = null;
   	
   	/**
   	 * The SQL LIMIT statment
   	 * @var string
   	*/
-      private $limit               = null;
+      private $limit = null;
   	
   	/**
   	 * The SQL JOIN statment
   	 * @var string
   	*/
-      private $join                = null;
+      private $join = null;
   	
   	/**
   	 * The SQL ORDER BY statment
   	 * @var string
   	*/
-      private $orderBy             = null;
+      private $orderBy = null;
   	
   	/**
   	 * The SQL GROUP BY statment
   	 * @var string
   	*/
-      private $groupBy             = null;
+      private $groupBy = null;
   	
   	/**
   	 * The SQL HAVING statment
   	 * @var string
   	*/
-      private $having              = null;
+      private $having = null;
   	
   	/**
   	 * The full SQL query statment after build for each command
   	 * @var string
   	*/
-      private $query               = null;
+      private $query = null;
   	
   	/**
   	 * The list of SQL valid operators
   	 * @var array
   	*/
-    private $operatorList        = array('=','!=','<','>','<=','>=','<>');
+    private $operatorList = array('=', '!=', '<', '>', '<=', '>=', '<>');
   	
 	
 	/**
 	 * The prefix used in each database table
 	 * @var string
 	*/
-    private $prefix              = null;
+    private $prefix = null;
     
 
     /**
   	 * The PDO instance
   	 * @var object
   	*/
-    private $pdo                 = null;
+    private $pdo = null;
 	
   	/**
   	 * The database driver name used
   	 * @var string
   	*/
-  	private $driver              = null;
+  	private $driver = null;
   	
 	
     /**
      * Construct new DatabaseQueryBuilder
      * @param object $pdo the PDO object
      */
-    public function __construct(PDO $pdo = null){
-        if (is_object($pdo)){
+    public function __construct(PDO $pdo = null) {
+        if (is_object($pdo)) {
           $this->setPdo($pdo);
         }
     }
@@ -120,10 +120,10 @@ 
      * @param  string|array $table the table name or array of table list
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function from($table){
-	  if (is_array($table)){
+    public function from($table) {
+	  if (is_array($table)) {
         $froms = '';
-        foreach($table as $key){
+        foreach ($table as $key) {
           $froms .= $this->getPrefix() . $key . ', ';
         }
         $this->from = rtrim($froms, ', ');
@@ -138,7 +138,7 @@ 
      * @param  string|array $fields the field name or array of field list
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function select($fields){
+    public function select($fields) {
       $select = (is_array($fields) ? implode(', ', $fields) : $fields);
       $this->select = (($this->select == '*' || empty($this->select)) ? $select : $this->select . ', ' . $select);
       return $this;
@@ -149,7 +149,7 @@ 
      * @param  string $field the field name to distinct
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function distinct($field){
+    public function distinct($field) {
       $distinct = ' DISTINCT ' . $field;
       $this->select = (($this->select == '*' || empty($this->select)) ? $distinct : $this->select . ', ' . $distinct);
       return $this;
@@ -161,7 +161,7 @@ 
      * @param  string $name  if is not null represent the alias used for this field in the result
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function count($field = '*', $name = null){
+    public function count($field = '*', $name = null) {
       return $this->select_min_max_sum_count_avg('COUNT', $field, $name);
     }
     
@@ -171,7 +171,7 @@ 
      * @param  string $name  if is not null represent the alias used for this field in the result
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function min($field, $name = null){
+    public function min($field, $name = null) {
       return $this->select_min_max_sum_count_avg('MIN', $field, $name);
     }
 
@@ -181,7 +181,7 @@ 
      * @param  string $name  if is not null represent the alias used for this field in the result
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function max($field, $name = null){
+    public function max($field, $name = null) {
       return $this->select_min_max_sum_count_avg('MAX', $field, $name);
     }
 
@@ -191,7 +191,7 @@ 
      * @param  string $name  if is not null represent the alias used for this field in the result
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function sum($field, $name = null){
+    public function sum($field, $name = null) {
       return $this->select_min_max_sum_count_avg('SUM', $field, $name);
     }
 
@@ -201,7 +201,7 @@ 
      * @param  string $name  if is not null represent the alias used for this field in the result
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function avg($field, $name = null){
+    public function avg($field, $name = null) {
       return $this->select_min_max_sum_count_avg('AVG', $field, $name);
     }
 
@@ -215,18 +215,18 @@ 
      * @param  string $type   the type of join (INNER, LEFT, RIGHT)
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function join($table, $field1 = null, $op = null, $field2 = null, $type = ''){
+    public function join($table, $field1 = null, $op = null, $field2 = null, $type = '') {
       $on = $field1;
       $table = $this->getPrefix() . $table;
-      if (! is_null($op)){
-        $on = (! in_array($op, $this->operatorList) 
+      if (!is_null($op)) {
+        $on = (!in_array($op, $this->operatorList) 
 													? ($this->getPrefix() . $field1 . ' = ' . $this->getPrefix() . $op) 
 													: ($this->getPrefix() . $field1 . ' ' . $op . ' ' . $this->getPrefix() . $field2));
       }
-      if (empty($this->join)){
+      if (empty($this->join)) {
         $this->join = ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
       }
-      else{
+      else {
         $this->join = $this->join . ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
       }
       return $this;
@@ -237,7 +237,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function innerJoin($table, $field1, $op = null, $field2 = ''){
+    public function innerJoin($table, $field1, $op = null, $field2 = '') {
       return $this->join($table, $field1, $op, $field2, 'INNER ');
     }
 
@@ -246,7 +246,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function leftJoin($table, $field1, $op = null, $field2 = ''){
+    public function leftJoin($table, $field1, $op = null, $field2 = '') {
       return $this->join($table, $field1, $op, $field2, 'LEFT ');
 	}
 
@@ -255,7 +255,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function rightJoin($table, $field1, $op = null, $field2 = ''){
+    public function rightJoin($table, $field1, $op = null, $field2 = '') {
       return $this->join($table, $field1, $op, $field2, 'RIGHT ');
     }
 
@@ -264,7 +264,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function fullOuterJoin($table, $field1, $op = null, $field2 = ''){
+    public function fullOuterJoin($table, $field1, $op = null, $field2 = '') {
     	return $this->join($table, $field1, $op, $field2, 'FULL OUTER ');
     }
 
@@ -273,7 +273,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function leftOuterJoin($table, $field1, $op = null, $field2 = ''){
+    public function leftOuterJoin($table, $field1, $op = null, $field2 = '') {
       return $this->join($table, $field1, $op, $field2, 'LEFT OUTER ');
     }
 
@@ -282,7 +282,7 @@ 
      * @see  DatabaseQueryBuilder::join()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function rightOuterJoin($table, $field1, $op = null, $field2 = ''){
+    public function rightOuterJoin($table, $field1, $op = null, $field2 = '') {
       return $this->join($table, $field1, $op, $field2, 'RIGHT OUTER ');
     }
 
@@ -292,13 +292,13 @@ 
      * @param  string $andOr the separator type used 'AND', 'OR', etc.
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function whereIsNull($field, $andOr = 'AND'){
-      if (is_array($field)){
-        foreach($field as $f){
+    public function whereIsNull($field, $andOr = 'AND') {
+      if (is_array($field)) {
+        foreach ($field as $f) {
         	$this->whereIsNull($f, $andOr);
         }
       } else {
-          $this->setWhereStr($field.' IS NULL ', $andOr);
+          $this->setWhereStr($field . ' IS NULL ', $andOr);
       }
       return $this;
     }
@@ -309,13 +309,13 @@ 
      * @param  string $andOr the separator type used 'AND', 'OR', etc.
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function whereIsNotNull($field, $andOr = 'AND'){
-      if (is_array($field)){
-        foreach($field as $f){
+    public function whereIsNotNull($field, $andOr = 'AND') {
+      if (is_array($field)) {
+        foreach ($field as $f) {
           $this->whereIsNotNull($f, $andOr);
         }
       } else {
-          $this->setWhereStr($field.' IS NOT NULL ', $andOr);
+          $this->setWhereStr($field . ' IS NOT NULL ', $andOr);
       }
       return $this;
     }
@@ -330,13 +330,13 @@ 
      * @param  boolean $escape whether to escape or not the $val
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function where($where, $op = null, $val = null, $type = '', $andOr = 'AND', $escape = true){
+    public function where($where, $op = null, $val = null, $type = '', $andOr = 'AND', $escape = true) {
       $whereStr = '';
-      if (is_array($where)){
+      if (is_array($where)) {
         $whereStr = $this->getWhereStrIfIsArray($where, $type, $andOr, $escape);
       }
-      else{
-        if (is_array($op)){
+      else {
+        if (is_array($op)) {
           $whereStr = $this->getWhereStrIfOperatorIsArray($where, $op, $type, $escape);
         } else {
           $whereStr = $this->getWhereStrForOperator($where, $op, $val, $type, $escape = true);
@@ -351,7 +351,7 @@ 
      * @see  DatabaseQueryBuilder::where()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orWhere($where, $op = null, $val = null, $escape = true){
+    public function orWhere($where, $op = null, $val = null, $escape = true) {
       return $this->where($where, $op, $val, '', 'OR', $escape);
     }
 
@@ -361,7 +361,7 @@ 
      * @see  DatabaseQueryBuilder::where()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notWhere($where, $op = null, $val = null, $escape = true){
+    public function notWhere($where, $op = null, $val = null, $escape = true) {
       return $this->where($where, $op, $val, 'NOT ', 'AND', $escape);
     }
 
@@ -370,7 +370,7 @@ 
      * @see  DatabaseQueryBuilder::where()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orNotWhere($where, $op = null, $val = null, $escape = true){
+    public function orNotWhere($where, $op = null, $val = null, $escape = true) {
     	return $this->where($where, $op, $val, 'NOT ', 'OR', $escape);
     }
 
@@ -380,11 +380,11 @@ 
      * @param  string $andOr the multiple conditions separator (AND, OR, etc.)
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function groupStart($type = '', $andOr = ' AND'){
-      if (empty($this->where)){
+    public function groupStart($type = '', $andOr = ' AND') {
+      if (empty($this->where)) {
         $this->where = $type . ' (';
       } else {
-          if (substr(trim($this->where), -1) == '('){
+          if (substr(trim($this->where), -1) == '(') {
             $this->where .= $type . ' (';
           } else {
           	$this->where .= $andOr . ' ' . $type . ' (';
@@ -398,7 +398,7 @@ 
      * @see  DatabaseQueryBuilder::groupStart()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notGroupStart(){
+    public function notGroupStart() {
       return $this->groupStart('NOT');
     }
 
@@ -407,7 +407,7 @@ 
      * @see  DatabaseQueryBuilder::groupStart()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orGroupStart(){
+    public function orGroupStart() {
       return $this->groupStart('', ' OR');
     }
 
@@ -416,7 +416,7 @@ 
      * @see  DatabaseQueryBuilder::groupStart()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orNotGroupStart(){
+    public function orNotGroupStart() {
       return $this->groupStart('NOT', ' OR');
     }
 
@@ -424,7 +424,7 @@ 
      * Close the parenthesis for the grouped SQL
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function groupEnd(){
+    public function groupEnd() {
       $this->where .= ')';
       return $this;
     }
@@ -438,10 +438,10 @@ 
      * @param  boolean $escape whether to escape or not the values
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function in($field, array $keys, $type = '', $andOr = 'AND', $escape = true){
+    public function in($field, array $keys, $type = '', $andOr = 'AND', $escape = true) {
       $_keys = array();
-      foreach ($keys as $k => $v){
-        if (is_null($v)){
+      foreach ($keys as $k => $v) {
+        if (is_null($v)) {
           $v = '';
         }
         $_keys[] = (is_numeric($v) ? $v : $this->escape($v, $escape));
@@ -457,7 +457,7 @@ 
      * @see  DatabaseQueryBuilder::in()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notIn($field, array $keys, $escape = true){
+    public function notIn($field, array $keys, $escape = true) {
       return $this->in($field, $keys, 'NOT ', 'AND', $escape);
     }
 
@@ -466,7 +466,7 @@ 
      * @see  DatabaseQueryBuilder::in()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orIn($field, array $keys, $escape = true){
+    public function orIn($field, array $keys, $escape = true) {
       return $this->in($field, $keys, '', 'OR', $escape);
     }
 
@@ -475,7 +475,7 @@ 
      * @see  DatabaseQueryBuilder::in()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orNotIn($field, array $keys, $escape = true){
+    public function orNotIn($field, array $keys, $escape = true) {
       return $this->in($field, $keys, 'NOT ', 'OR', $escape);
     }
 
@@ -489,11 +489,11 @@ 
      * @param  boolean $escape whether to escape or not the values
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function between($field, $value1, $value2, $type = '', $andOr = 'AND', $escape = true){
-      if (is_null($value1)){
+    public function between($field, $value1, $value2, $type = '', $andOr = 'AND', $escape = true) {
+      if (is_null($value1)) {
         $value1 = '';
       }
-      if (is_null($value2)){
+      if (is_null($value2)) {
         $value2 = '';
       }
       $whereStr = $field . ' ' . $type . ' BETWEEN ' . $this->escape($value1, $escape) . ' AND ' . $this->escape($value2, $escape);
@@ -506,7 +506,7 @@ 
      * @see  DatabaseQueryBuilder::between()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notBetween($field, $value1, $value2, $escape = true){
+    public function notBetween($field, $value1, $value2, $escape = true) {
       return $this->between($field, $value1, $value2, 'NOT ', 'AND', $escape);
     }
 
@@ -515,7 +515,7 @@ 
      * @see  DatabaseQueryBuilder::between()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orBetween($field, $value1, $value2, $escape = true){
+    public function orBetween($field, $value1, $value2, $escape = true) {
       return $this->between($field, $value1, $value2, '', 'OR', $escape);
     }
 
@@ -524,7 +524,7 @@ 
      * @see  DatabaseQueryBuilder::between()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orNotBetween($field, $value1, $value2, $escape = true){
+    public function orNotBetween($field, $value1, $value2, $escape = true) {
       return $this->between($field, $value1, $value2, 'NOT ', 'OR', $escape);
     }
 
@@ -537,8 +537,8 @@ 
      * @param  boolean $escape whether to escape or not the values
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function like($field, $data, $type = '', $andOr = 'AND', $escape = true){
-      if (empty($data)){
+    public function like($field, $data, $type = '', $andOr = 'AND', $escape = true) {
+      if (empty($data)) {
         $data = '';
       }
       $this->setWhereStr($field . ' ' . $type . ' LIKE ' . ($this->escape($data, $escape)), $andOr);
@@ -550,7 +550,7 @@ 
      * @see  DatabaseQueryBuilder::like()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orLike($field, $data, $escape = true){
+    public function orLike($field, $data, $escape = true) {
       return $this->like($field, $data, '', 'OR', $escape);
     }
 
@@ -559,7 +559,7 @@ 
      * @see  DatabaseQueryBuilder::like()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notLike($field, $data, $escape = true){
+    public function notLike($field, $data, $escape = true) {
       return $this->like($field, $data, 'NOT ', 'AND', $escape);
     }
 
@@ -568,7 +568,7 @@ 
      * @see  DatabaseQueryBuilder::like()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orNotLike($field, $data, $escape = true){
+    public function orNotLike($field, $data, $escape = true) {
       return $this->like($field, $data, 'NOT ', 'OR', $escape);
     }
 
@@ -579,14 +579,14 @@ 
      * @param  int $limitEnd the limit count
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function limit($limit, $limitEnd = null){
-      if (empty($limit)){
+    public function limit($limit, $limitEnd = null) {
+      if (empty($limit)) {
         $limit = 0;
       }
-      if (! is_null($limitEnd)){
+      if (!is_null($limitEnd)) {
         $this->limit = $limit . ', ' . $limitEnd;
       }
-      else{
+      else {
         $this->limit = $limit;
       }
       return $this;
@@ -598,11 +598,11 @@ 
      * @param  string $orderDir the order direction (ASC or DESC)
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orderBy($orderBy, $orderDir = ' ASC'){
-      if (stristr($orderBy, ' ') || $orderBy == 'rand()'){
+    public function orderBy($orderBy, $orderDir = ' ASC') {
+      if (stristr($orderBy, ' ') || $orderBy == 'rand()') {
         $this->orderBy = empty($this->orderBy) ? $orderBy : $this->orderBy . ', ' . $orderBy;
       }
-      else{
+      else {
         $this->orderBy = empty($this->orderBy) 
 						? ($orderBy . ' ' . strtoupper($orderDir)) 
 						: $this->orderBy . ', ' . $orderBy . ' ' . strtoupper($orderDir);
@@ -615,11 +615,11 @@ 
      * @param  string|array $field the field name used or array of field list
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function groupBy($field){
-      if (is_array($field)){
+    public function groupBy($field) {
+      if (is_array($field)) {
         $this->groupBy = implode(', ', $field);
       }
-      else{
+      else {
         $this->groupBy = $field;
       }
       return $this;
@@ -633,18 +633,18 @@ 
      * @param  boolean $escape whether to escape or not the values
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function having($field, $op = null, $val = null, $escape = true){
-      if (is_array($op)){
+    public function having($field, $op = null, $val = null, $escape = true) {
+      if (is_array($op)) {
         $this->having = $this->getHavingStrIfOperatorIsArray($field, $op, $escape);
       }
-      else if (! in_array($op, $this->operatorList)){
-        if (is_null($op)){
+      else if (!in_array($op, $this->operatorList)) {
+        if (is_null($op)) {
           $op = '';
         }
         $this->having = $field . ' > ' . ($this->escape($op, $escape));
       }
-      else{
-        if (is_null($val)){
+      else {
+        if (is_null($val)) {
           $val = '';
         }
         $this->having = $field . ' ' . $op . ' ' . ($this->escape($val, $escape));
@@ -658,7 +658,7 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return object  the current DatabaseQueryBuilder instance        
      */
-    public function insert($data = array(), $escape = true){
+    public function insert($data = array(), $escape = true) {
       $columns = array_keys($data);
       $column = implode(', ', $columns);
       $val = implode(', ', ($escape ? array_map(array($this, 'escape'), $data) : $data));
@@ -673,22 +673,22 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return object  the current DatabaseQueryBuilder instance 
      */
-    public function update($data = array(), $escape = true){
+    public function update($data = array(), $escape = true) {
       $query = 'UPDATE ' . $this->from . ' SET ';
       $values = array();
-      foreach ($data as $column => $val){
+      foreach ($data as $column => $val) {
         $values[] = $column . ' = ' . ($this->escape($val, $escape));
       }
       $query .= implode(', ', $values);
-      if (! empty($this->where)){
+      if (!empty($this->where)) {
         $query .= ' WHERE ' . $this->where;
       }
 
-      if (! empty($this->orderBy)){
+      if (!empty($this->orderBy)) {
         $query .= ' ORDER BY ' . $this->orderBy;
       }
 
-      if (! empty($this->limit)){
+      if (!empty($this->limit)) {
         $query .= ' LIMIT ' . $this->limit;
       }
       $this->query = $query;
@@ -699,22 +699,22 @@ 
      * Delete the record in database
      * @return object  the current DatabaseQueryBuilder instance 
      */
-    public function delete(){
+    public function delete() {
     	$query = 'DELETE FROM ' . $this->from;
       $isTruncate = $query;
-    	if (! empty($this->where)){
+    	if (!empty($this->where)) {
   		  $query .= ' WHERE ' . $this->where;
     	}
 
-    	if (! empty($this->orderBy)){
+    	if (!empty($this->orderBy)) {
     	  $query .= ' ORDER BY ' . $this->orderBy;
       }
 
-    	if (! empty($this->limit)){
+    	if (!empty($this->limit)) {
     		$query .= ' LIMIT ' . $this->limit;
       }
 
-  		if ($isTruncate == $query && $this->driver != 'sqlite'){  
+  		if ($isTruncate == $query && $this->driver != 'sqlite') {  
       	$query = 'TRUNCATE TABLE ' . $this->from;
   		}
 	   $this->query = $query;
@@ -727,7 +727,7 @@ 
      * @param boolean $escaped whether we can do escape of not 
      * @return mixed       the data after escaped or the same data if not
      */
-    public function escape($data, $escaped = true){
+    public function escape($data, $escaped = true) {
       return $escaped 
                     ? $this->getPdo()->quote(trim($data)) 
                     : $data; 
@@ -738,31 +738,31 @@ 
      * Return the current SQL query string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
   	  //INSERT, UPDATE, DELETE already set it, if is the SELECT we need set it now
-  	  if(empty($this->query)){
+  	  if (empty($this->query)) {
   		  $query = 'SELECT ' . $this->select . ' FROM ' . $this->from;
-  		  if (! empty($this->join)){
+  		  if (!empty($this->join)) {
           $query .= $this->join;
   		  }
   		  
-  		  if (! empty($this->where)){
+  		  if (!empty($this->where)) {
           $query .= ' WHERE ' . $this->where;
   		  }
 
-  		  if (! empty($this->groupBy)){
+  		  if (!empty($this->groupBy)) {
           $query .= ' GROUP BY ' . $this->groupBy;
   		  }
 
-  		  if (! empty($this->having)){
+  		  if (!empty($this->having)) {
           $query .= ' HAVING ' . $this->having;
   		  }
 
-  		  if (! empty($this->orderBy)){
+  		  if (!empty($this->orderBy)) {
   			  $query .= ' ORDER BY ' . $this->orderBy;
   		  }
 
-  		  if (! empty($this->limit)){
+  		  if (!empty($this->limit)) {
           $query .= ' LIMIT ' . $this->limit;
   		  }
   		  $this->query = $query;
@@ -775,7 +775,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -784,7 +784,7 @@ 
      * @param PDO $pdo the pdo object
 	   * @return object DatabaseQueryBuilder
      */
-    public function setPdo(PDO $pdo = null){
+    public function setPdo(PDO $pdo = null) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -793,7 +793,7 @@ 
    * Return the database table prefix
    * @return string
    */
-    public function getPrefix(){
+    public function getPrefix() {
       return $this->prefix;
     }
 
@@ -802,7 +802,7 @@ 
      * @param string $prefix the new prefix
 	   * @return object DatabaseQueryBuilder
      */
-    public function setPrefix($prefix){
+    public function setPrefix($prefix) {
       $this->prefix = $prefix;
       return $this;
     }
@@ -811,7 +811,7 @@ 
      * Return the database driver
      * @return string
      */
-    public function getDriver(){
+    public function getDriver() {
       return $this->driver;
     }
 
@@ -820,7 +820,7 @@ 
      * @param string $driver the new driver
 	   * @return object DatabaseQueryBuilder
      */
-    public function setDriver($driver){
+    public function setDriver($driver) {
       $this->driver = $driver;
       return $this;
     }
@@ -829,7 +829,7 @@ 
      * Reset the DatabaseQueryBuilder class attributs to the initial values before each query.
 	   * @return object  the current DatabaseQueryBuilder instance 
      */
-    public function reset(){
+    public function reset() {
       $this->select   = '*';
       $this->from     = null;
       $this->where    = null;
@@ -848,12 +848,12 @@ 
      *
      * @return string
      */
-    protected function getHavingStrIfOperatorIsArray($field, $op = null, $escape = true){
+    protected function getHavingStrIfOperatorIsArray($field, $op = null, $escape = true) {
         $x = explode('?', $field);
         $w = '';
-        foreach($x as $k => $v){
-  	      if (!empty($v)){
-            if (! isset($op[$k])){
+        foreach ($x as $k => $v) {
+  	      if (!empty($v)) {
+            if (!isset($op[$k])) {
               $op[$k] = '';
             }
   	      	$w .= $v . (isset($op[$k]) ? $this->escape($op[$k], $escape) : '');
@@ -869,15 +869,15 @@ 
      *
      * @return string
      */
-    protected function getWhereStrIfIsArray(array $where, $type = '', $andOr = 'AND', $escape = true){
+    protected function getWhereStrIfIsArray(array $where, $type = '', $andOr = 'AND', $escape = true) {
       $_where = array();
-      foreach ($where as $column => $data){
-        if (is_null($data)){
+      foreach ($where as $column => $data) {
+        if (is_null($data)) {
           $data = '';
         }
         $_where[] = $type . $column . ' = ' . ($this->escape($data, $escape));
       }
-      $where = implode(' '.$andOr.' ', $_where);
+      $where = implode(' ' . $andOr . ' ', $_where);
       return $where;
     }
 
@@ -887,12 +887,12 @@ 
      *
      * @return string
      */
-    protected function getWhereStrIfOperatorIsArray($where, array $op, $type = '', $escape = true){
+    protected function getWhereStrIfOperatorIsArray($where, array $op, $type = '', $escape = true) {
      $x = explode('?', $where);
      $w = '';
-      foreach($x as $k => $v){
-        if (! empty($v)){
-            if (isset($op[$k]) && is_null($op[$k])){
+      foreach ($x as $k => $v) {
+        if (!empty($v)) {
+            if (isset($op[$k]) && is_null($op[$k])) {
               $op[$k] = '';
             }
             $w .= $type . $v . (isset($op[$k]) ? ($this->escape($op[$k], $escape)) : '');
@@ -907,15 +907,15 @@ 
      *
      * @return string
      */
-    protected function getWhereStrForOperator($where, $op = null, $val = null, $type = '', $escape = true){
+    protected function getWhereStrForOperator($where, $op = null, $val = null, $type = '', $escape = true) {
        $w = '';
-       if (! in_array((string)$op, $this->operatorList)){
-          if (is_null($op)){
+       if (!in_array((string) $op, $this->operatorList)) {
+          if (is_null($op)) {
             $op = '';
           }
           $w = $type . $where . ' = ' . ($this->escape($op, $escape));
         } else {
-          if (is_null($val)){
+          if (is_null($val)) {
             $val = '';
           }
           $w = $type . $where . $op . ($this->escape($val, $escape));
@@ -928,14 +928,14 @@ 
        * @param string $whereStr the WHERE clause string
        * @param  string  $andOr the separator type used 'AND', 'OR', etc.
        */
-      protected function setWhereStr($whereStr, $andOr = 'AND'){
-        if (empty($this->where)){
+      protected function setWhereStr($whereStr, $andOr = 'AND') {
+        if (empty($this->where)) {
           $this->where = $whereStr;
         } else {
-          if (substr(trim($this->where), -1) == '('){
+          if (substr(trim($this->where), -1) == '(') {
             $this->where = $this->where . ' ' . $whereStr;
           } else {
-            $this->where = $this->where . ' '.$andOr.' ' . $whereStr;
+            $this->where = $this->where . ' ' . $andOr . ' ' . $whereStr;
           }
         }
       }
@@ -951,7 +951,7 @@ 
      * @see  DatabaseQueryBuilder::avg
      * @return object
      */
-    protected function select_min_max_sum_count_avg($clause, $field, $name = null){
+    protected function select_min_max_sum_count_avg($clause, $field, $name = null) {
       $clause = strtoupper($clause);
       $func = $clause . '(' . $field . ')' . (!is_null($name) ? ' AS ' . $name : '');
       $this->select = ($this->select == '*' ? $func : $this->select . ', ' . $func);

Braces +7 added lines, -14 removed lines

@@ -225,8 +225,7 @@ 
       }
       if (empty($this->join)){
         $this->join = ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
-      }
-      else{
+      } else{
         $this->join = $this->join . ' ' . $type . 'JOIN' . ' ' . $table . ' ON ' . $on;
       }
       return $this;
@@ -334,8 +333,7 @@ 
       $whereStr = '';
       if (is_array($where)){
         $whereStr = $this->getWhereStrIfIsArray($where, $type, $andOr, $escape);
-      }
-      else{
+      } else{
         if (is_array($op)){
           $whereStr = $this->getWhereStrIfOperatorIsArray($where, $op, $type, $escape);
         } else {
@@ -585,8 +583,7 @@ 
       }
       if (! is_null($limitEnd)){
         $this->limit = $limit . ', ' . $limitEnd;
-      }
-      else{
+      } else{
         $this->limit = $limit;
       }
       return $this;
@@ -601,8 +598,7 @@ 
     public function orderBy($orderBy, $orderDir = ' ASC'){
       if (stristr($orderBy, ' ') || $orderBy == 'rand()'){
         $this->orderBy = empty($this->orderBy) ? $orderBy : $this->orderBy . ', ' . $orderBy;
-      }
-      else{
+      } else{
         $this->orderBy = empty($this->orderBy) 
 						? ($orderBy . ' ' . strtoupper($orderDir)) 
 						: $this->orderBy . ', ' . $orderBy . ' ' . strtoupper($orderDir);
@@ -618,8 +614,7 @@ 
     public function groupBy($field){
       if (is_array($field)){
         $this->groupBy = implode(', ', $field);
-      }
-      else{
+      } else{
         $this->groupBy = $field;
       }
       return $this;
@@ -636,14 +631,12 @@ 
     public function having($field, $op = null, $val = null, $escape = true){
       if (is_array($op)){
         $this->having = $this->getHavingStrIfOperatorIsArray($field, $op, $escape);
-      }
-      else if (! in_array($op, $this->operatorList)){
+      } else if (! in_array($op, $this->operatorList)){
         if (is_null($op)){
           $op = '';
         }
         $this->having = $field . ' > ' . ($this->escape($op, $escape));
-      }
-      else{
+      } else{
         if (is_null($val)){
           $val = '';
         }

core/classes/database/DatabaseQueryRunner.php

Indentation +166 added lines, -166 removed lines

@@ -1,90 +1,90 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
-  class DatabaseQueryRunner{
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class DatabaseQueryRunner{
       
     /**
-	* The logger instance
-	* @var object
-	*/
+     * The logger instance
+     * @var object
+     */
     private $logger            = null;
     
-  	/**
-  	 * The last query result
-  	 * @var object
-  	*/
-  	private $queryResult       = null;
+        /**
+         * The last query result
+         * @var object
+         */
+        private $queryResult       = null;
   	
-  	/**
-    * The benchmark instance
-    * @var object
-    */
+        /**
+         * The benchmark instance
+         * @var object
+         */
     private $benchmarkInstance = null;
     
     /**
-	 * The SQL query statment to execute
-	 * @var string
-	*/
+     * The SQL query statment to execute
+     * @var string
+     */
     private $query             = null;
     
     /**
-	 * Indicate if we need return result as list (boolean) 
+     * Indicate if we need return result as list (boolean) 
      * or the data used to replace the placeholder (array)
-	 * @var array|boolean
-	 */
-     private $all               = true;
+     * @var array|boolean
+     */
+        private $all               = true;
      
      
-     /**
-	   * Indicate if we need return result as array or not
-     * @var boolean
-	   */
-     private $returnAsArray     = true;
+        /**
+         * Indicate if we need return result as array or not
+         * @var boolean
+         */
+        private $returnAsArray     = true;
      
-     /**
-     * The last PDOStatment instance
-     * @var object
-     */
-     private $pdoStatment       = null;
+        /**
+         * The last PDOStatment instance
+         * @var object
+         */
+        private $pdoStatment       = null;
      
-     /**
-  	 * The error returned for the last query
-  	 * @var string
-  	 */
-     private $error             = null;
+        /**
+         * The error returned for the last query
+         * @var string
+         */
+        private $error             = null;
 	
     /**
      * The PDO instance
      * @var object
-    */
+     */
     private $pdo                = null;
   
     /**
      * The database driver name used
      * @var string
-    */
+     */
     private $driver             = null;
 
 
@@ -98,7 +98,7 @@ 
      */
     public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
         if (is_object($pdo)){
-          $this->pdo = $pdo;
+            $this->pdo = $pdo;
         }
         $this->query = $query;
         $this->returnAsList = $returnAsList;
@@ -116,16 +116,16 @@ 
         //reset instance
         $this->reset();
        
-       //for database query execution time
+        //for database query execution time
         $benchmarkMarkerKey = $this->getBenchmarkKey();
         if (! is_object($this->benchmarkInstance)){
-          $this->benchmarkInstance = & class_loader('Benchmark');
+            $this->benchmarkInstance = & class_loader('Benchmark');
         }
         
         $this->logger->info(
-                          'Execute SQL query [' . $this->query . '], return type: ' 
-                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
-                          . ($this->returnAsList ? 'YES':'NO')
+                            'Execute SQL query [' . $this->query . '], return type: ' 
+                            . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
+                            . ($this->returnAsList ? 'YES':'NO')
                         );
 
         $this->benchmarkInstance->mark('DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')');                
@@ -136,101 +136,101 @@ 
         $responseTime = $this->benchmarkInstance->elapsedTime(
                                                                 'DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')', 
                                                                 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')'
-                                                              );
-		    //TODO use the configuration value for the high response time currently is 1 second
+                                                                );
+            //TODO use the configuration value for the high response time currently is 1 second
         if ($responseTime >= 1 ){
             $this->logger->warning(
                                     'High response time while processing database query [' . $this->query . ']. 
                                      The response time is [' .$responseTime. '] sec.'
-                                  );
+                                    );
         }
 		
         if ($this->pdoStatment !== false){
-          $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
-          if($isSqlSELECTQuery){
-              $this->setResultForSelect();              
-          }
-          else{
-              $this->setResultForNonSelect();
-          }
-          return $this->queryResult;
+            $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
+            if($isSqlSELECTQuery){
+                $this->setResultForSelect();              
+            }
+            else{
+                $this->setResultForNonSelect();
+            }
+            return $this->queryResult;
         }
         $this->setQueryRunnerError();
     }
 	
-   /**
-   * Return the result for SELECT query
-   * @see DatabaseQueryRunner::execute
-   */
+    /**
+     * Return the result for SELECT query
+     * @see DatabaseQueryRunner::execute
+     */
     protected function setResultForSelect(){
-      //if need return all result like list of record
-      $result = null;
-      $numRows = 0;
-      $fetchMode = PDO::FETCH_OBJ;
-      if($this->returnAsArray){
+        //if need return all result like list of record
+        $result = null;
+        $numRows = 0;
+        $fetchMode = PDO::FETCH_OBJ;
+        if($this->returnAsArray){
         $fetchMode = PDO::FETCH_ASSOC;
-      }
-      if ($this->returnAsList){
-          $result = $this->pdoStatment->fetchAll($fetchMode);
-      }
-      else{
-          $result = $this->pdoStatment->fetch($fetchMode);
-      }
-      //Sqlite and pgsql always return 0 when using rowCount()
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+        }
+        if ($this->returnAsList){
+            $result = $this->pdoStatment->fetchAll($fetchMode);
+        }
+        else{
+            $result = $this->pdoStatment->fetch($fetchMode);
+        }
+        //Sqlite and pgsql always return 0 when using rowCount()
+        if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $numRows = count($result);  
-      }
-      else{
+        }
+        else{
         $numRows = $this->pdoStatment->rowCount(); 
-      }
-      if(! is_object($this->queryResult)){
-          $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
-      }
-      $this->queryResult->setResult($result);
-      $this->queryResult->setNumRows($numRows);
+        }
+        if(! is_object($this->queryResult)){
+            $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
+        }
+        $this->queryResult->setResult($result);
+        $this->queryResult->setNumRows($numRows);
     }
 
     /**
-   * Return the result for non SELECT query
-   * @see DatabaseQueryRunner::execute
-   */
+     * Return the result for non SELECT query
+     * @see DatabaseQueryRunner::execute
+     */
     protected function setResultForNonSelect(){
-      //Sqlite and pgsql always return 0 when using rowCount()
-      $result = false;
-      $numRows = 0;
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+        //Sqlite and pgsql always return 0 when using rowCount()
+        $result = false;
+        $numRows = 0;
+        if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
-      }
-      else{
-          //to test the result for the query like UPDATE, INSERT, DELETE
-          $result  = $this->pdoStatment->rowCount() >= 0; 
-          $numRows = $this->pdoStatment->rowCount(); 
-      }
-      if(! is_object($this->queryResult)){
-          $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
-      }
-      $this->queryResult->setResult($result);
-      $this->queryResult->setNumRows($numRows);
+        }
+        else{
+            //to test the result for the query like UPDATE, INSERT, DELETE
+            $result  = $this->pdoStatment->rowCount() >= 0; 
+            $numRows = $this->pdoStatment->rowCount(); 
+        }
+        if(! is_object($this->queryResult)){
+            $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
+        }
+        $this->queryResult->setResult($result);
+        $this->queryResult->setNumRows($numRows);
     }
 
 
-	/**
+    /**
      * Return the benchmark instance
      * @return Benchmark
      */
     public function getBenchmark(){
-      return $this->benchmarkInstance;
+        return $this->benchmarkInstance;
     }
 
     /**
      * Set the benchmark instance
      * @param Benchmark $benchmark the benchmark object
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setBenchmark($benchmark){
-      $this->benchmarkInstance = $benchmark;
-      return $this;
+        $this->benchmarkInstance = $benchmark;
+        return $this;
     }
     
     /**
@@ -239,18 +239,18 @@ 
      * @return object DatabaseQueryResult
      */
     public function getQueryResult(){
-      return $this->queryResult;
+        return $this->queryResult;
     }
 
     /**
      * Set the database query result instance
      * @param object $queryResult the query result
      *
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setQueryResult(DatabaseQueryResult $queryResult){
-      $this->queryResult = $queryResult;
-      return $this;
+        $this->queryResult = $queryResult;
+        return $this;
     }
     
     /**
@@ -258,17 +258,17 @@ 
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
     
     /**
@@ -276,7 +276,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
     
     /**
@@ -285,8 +285,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setQuery($query){
-       $this->query = $query;
-       return $this;
+        $this->query = $query;
+        return $this;
     }
     
     /**
@@ -295,8 +295,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnType($returnType){
-       $this->returnAsList = $returnType;
-       return $this;
+        $this->returnAsList = $returnType;
+        return $this;
     }
     
     /**
@@ -305,8 +305,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnAsArray($status = true){
-       $this->returnAsArray = $status;
-       return $this;
+        $this->returnAsArray = $status;
+        return $this;
     }
     
     /**
@@ -314,7 +314,7 @@ 
      * @return string
      */
     public function getQueryError(){
-      return $this->error;
+        return $this->error;
     }
 
     /**
@@ -322,7 +322,7 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
@@ -331,16 +331,16 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setPdo(PDO $pdo = null){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
   
-     /**
-     * Return the database driver
-     * @return string
-     */
+        /**
+         * Return the database driver
+         * @return string
+         */
     public function getDriver(){
-      return $this->driver;
+        return $this->driver;
     }
 
     /**
@@ -349,8 +349,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setDriver($driver){
-      $this->driver = $driver;
-      return $this;
+        $this->driver = $driver;
+        return $this;
     }
     
     /**
@@ -359,18 +359,18 @@ 
      *  @return string
      */
     protected function getBenchmarkKey(){
-      return md5($this->query . $this->returnAsList . $this->returnAsArray);
+        return md5($this->query . $this->returnAsList . $this->returnAsArray);
     }
     
     /**
      * Set error for database query execution
      */
     protected function setQueryRunnerError(){
-      $error = $this->pdo->errorInfo();
-      $this->error = isset($error[2]) ? $error[2] : '';
-      $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
-	  //show error message
-      show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error');
+        $error = $this->pdo->errorInfo();
+        $this->error = isset($error[2]) ? $error[2] : '';
+        $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
+        //show error message
+        show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error');
     }
     
     /**
@@ -378,19 +378,19 @@ 
      * @param object $logger the Log instance if not null
      */
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::DatabaseQueryRunner');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::DatabaseQueryRunner');
+        }
     }
     
     
     /**
-    * Reset the instance before run each query
-    */
+     * Reset the instance before run each query
+     */
     private function reset(){
         $this->error = null;
         $this->pdoStatment = null;

Spacing +54 added lines, -54 removed lines

@@ -23,19 +23,19 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class DatabaseQueryRunner{
+  class DatabaseQueryRunner {
       
     /**
 	* The logger instance
 	* @var object
 	*/
-    private $logger            = null;
+    private $logger = null;
     
   	/**
   	 * The last query result
   	 * @var object
   	*/
-  	private $queryResult       = null;
+  	private $queryResult = null;
   	
   	/**
     * The benchmark instance
@@ -47,45 +47,45 @@ 
 	 * The SQL query statment to execute
 	 * @var string
 	*/
-    private $query             = null;
+    private $query = null;
     
     /**
 	 * Indicate if we need return result as list (boolean) 
      * or the data used to replace the placeholder (array)
 	 * @var array|boolean
 	 */
-     private $all               = true;
+     private $all = true;
      
      
      /**
 	   * Indicate if we need return result as array or not
      * @var boolean
 	   */
-     private $returnAsArray     = true;
+     private $returnAsArray = true;
      
      /**
      * The last PDOStatment instance
      * @var object
      */
-     private $pdoStatment       = null;
+     private $pdoStatment = null;
      
      /**
   	 * The error returned for the last query
   	 * @var string
   	 */
-     private $error             = null;
+     private $error = null;
 	
     /**
      * The PDO instance
      * @var object
     */
-    private $pdo                = null;
+    private $pdo = null;
   
     /**
      * The database driver name used
      * @var string
     */
-    private $driver             = null;
+    private $driver = null;
 
 
 	
@@ -96,8 +96,8 @@ 
      * @param boolean $returnAsList if need return as list or just one row
      * @param boolean $returnAsArray whether to return the result as array or not
      */
-    public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
-        if (is_object($pdo)){
+    public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false) {
+        if (is_object($pdo)) {
           $this->pdo = $pdo;
         }
         $this->query = $query;
@@ -112,20 +112,20 @@ 
      * 
      * @return object|void
      */
-    public function execute(){
+    public function execute() {
         //reset instance
         $this->reset();
        
        //for database query execution time
         $benchmarkMarkerKey = $this->getBenchmarkKey();
-        if (! is_object($this->benchmarkInstance)){
+        if (!is_object($this->benchmarkInstance)) {
           $this->benchmarkInstance = & class_loader('Benchmark');
         }
         
         $this->logger->info(
                           'Execute SQL query [' . $this->query . '], return type: ' 
-                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
-                          . ($this->returnAsList ? 'YES':'NO')
+                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') . ', return as list: ' 
+                          . ($this->returnAsList ? 'YES' : 'NO')
                         );
 
         $this->benchmarkInstance->mark('DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')');                
@@ -138,19 +138,19 @@ 
                                                                 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')'
                                                               );
 		    //TODO use the configuration value for the high response time currently is 1 second
-        if ($responseTime >= 1 ){
+        if ($responseTime >= 1) {
             $this->logger->warning(
                                     'High response time while processing database query [' . $this->query . ']. 
-                                     The response time is [' .$responseTime. '] sec.'
+                                     The response time is [' .$responseTime . '] sec.'
                                   );
         }
 		
-        if ($this->pdoStatment !== false){
+        if ($this->pdoStatment !== false) {
           $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
-          if($isSqlSELECTQuery){
+          if ($isSqlSELECTQuery) {
               $this->setResultForSelect();              
           }
-          else{
+          else {
               $this->setResultForNonSelect();
           }
           return $this->queryResult;
@@ -162,28 +162,28 @@ 
    * Return the result for SELECT query
    * @see DatabaseQueryRunner::execute
    */
-    protected function setResultForSelect(){
+    protected function setResultForSelect() {
       //if need return all result like list of record
       $result = null;
       $numRows = 0;
       $fetchMode = PDO::FETCH_OBJ;
-      if($this->returnAsArray){
+      if ($this->returnAsArray) {
         $fetchMode = PDO::FETCH_ASSOC;
       }
-      if ($this->returnAsList){
+      if ($this->returnAsList) {
           $result = $this->pdoStatment->fetchAll($fetchMode);
       }
-      else{
+      else {
           $result = $this->pdoStatment->fetch($fetchMode);
       }
       //Sqlite and pgsql always return 0 when using rowCount()
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+      if (in_array($this->driver, array('sqlite', 'pgsql'))) {
         $numRows = count($result);  
       }
-      else{
+      else {
         $numRows = $this->pdoStatment->rowCount(); 
       }
-      if(! is_object($this->queryResult)){
+      if (!is_object($this->queryResult)) {
           $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
       }
       $this->queryResult->setResult($result);
@@ -194,20 +194,20 @@ 
    * Return the result for non SELECT query
    * @see DatabaseQueryRunner::execute
    */
-    protected function setResultForNonSelect(){
+    protected function setResultForNonSelect() {
       //Sqlite and pgsql always return 0 when using rowCount()
       $result = false;
       $numRows = 0;
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+      if (in_array($this->driver, array('sqlite', 'pgsql'))) {
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
       }
-      else{
+      else {
           //to test the result for the query like UPDATE, INSERT, DELETE
           $result  = $this->pdoStatment->rowCount() >= 0; 
           $numRows = $this->pdoStatment->rowCount(); 
       }
-      if(! is_object($this->queryResult)){
+      if (!is_object($this->queryResult)) {
           $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
       }
       $this->queryResult->setResult($result);
@@ -219,7 +219,7 @@ 
      * Return the benchmark instance
      * @return Benchmark
      */
-    public function getBenchmark(){
+    public function getBenchmark() {
       return $this->benchmarkInstance;
     }
 
@@ -228,7 +228,7 @@ 
      * @param Benchmark $benchmark the benchmark object
 	 * @return object DatabaseQueryRunner
      */
-    public function setBenchmark($benchmark){
+    public function setBenchmark($benchmark) {
       $this->benchmarkInstance = $benchmark;
       return $this;
     }
@@ -238,7 +238,7 @@ 
      *
      * @return object DatabaseQueryResult
      */
-    public function getQueryResult(){
+    public function getQueryResult() {
       return $this->queryResult;
     }
 
@@ -248,7 +248,7 @@ 
      *
 	 * @return object DatabaseQueryRunner
      */
-    public function setQueryResult(DatabaseQueryResult $queryResult){
+    public function setQueryResult(DatabaseQueryResult $queryResult) {
       $this->queryResult = $queryResult;
       return $this;
     }
@@ -257,7 +257,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -266,7 +266,7 @@ 
      * @param Log $logger the log object
 	 * @return object DatabaseQueryRunner
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -275,7 +275,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
       return $this->query;
     }
     
@@ -284,7 +284,7 @@ 
      * @param string $query the SQL query to set
      * @return object DatabaseQueryRunner
      */
-    public function setQuery($query){
+    public function setQuery($query) {
        $this->query = $query;
        return $this;
     }
@@ -294,7 +294,7 @@ 
      * @param boolean $returnType
      * @return object DatabaseQueryRunner
      */
-    public function setReturnType($returnType){
+    public function setReturnType($returnType) {
        $this->returnAsList = $returnType;
        return $this;
     }
@@ -304,7 +304,7 @@ 
      * @param boolean $status the status if true will return as array
      * @return object DatabaseQueryRunner
      */
-    public function setReturnAsArray($status = true){
+    public function setReturnAsArray($status = true) {
        $this->returnAsArray = $status;
        return $this;
     }
@@ -313,7 +313,7 @@ 
      * Return the error for last query execution
      * @return string
      */
-    public function getQueryError(){
+    public function getQueryError() {
       return $this->error;
     }
 
@@ -321,7 +321,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -330,7 +330,7 @@ 
      * @param PDO $pdo the pdo object
      * @return object DatabaseQueryRunner
      */
-    public function setPdo(PDO $pdo = null){
+    public function setPdo(PDO $pdo = null) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -339,7 +339,7 @@ 
      * Return the database driver
      * @return string
      */
-    public function getDriver(){
+    public function getDriver() {
       return $this->driver;
     }
 
@@ -348,7 +348,7 @@ 
      * @param string $driver the new driver
      * @return object DatabaseQueryRunner
      */
-    public function setDriver($driver){
+    public function setDriver($driver) {
       $this->driver = $driver;
       return $this;
     }
@@ -358,14 +358,14 @@ 
      * 
      *  @return string
      */
-    protected function getBenchmarkKey(){
+    protected function getBenchmarkKey() {
       return md5($this->query . $this->returnAsList . $this->returnAsArray);
     }
     
     /**
      * Set error for database query execution
      */
-    protected function setQueryRunnerError(){
+    protected function setQueryRunnerError() {
       $error = $this->pdo->errorInfo();
       $this->error = isset($error[2]) ? $error[2] : '';
       $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
@@ -377,12 +377,12 @@ 
      * Set the Log instance using argument or create new instance
      * @param object $logger the Log instance if not null
      */
-    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) {
+      if ($logger !== null) {
         $this->logger = $logger;
       }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
+      else {
+          $this->logger = & class_loader('Log', 'classes');
           $this->logger->setLogger('Library::DatabaseQueryRunner');
       }
     }
@@ -391,7 +391,7 @@ 
     /**
     * Reset the instance before run each query
     */
-    private function reset(){
+    private function reset() {
         $this->error = null;
         $this->pdoStatment = null;
     }

Braces +5 added lines, -10 removed lines

@@ -149,8 +149,7 @@ 
           $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
           if($isSqlSELECTQuery){
               $this->setResultForSelect();              
-          }
-          else{
+          } else{
               $this->setResultForNonSelect();
           }
           return $this->queryResult;
@@ -172,15 +171,13 @@ 
       }
       if ($this->returnAsList){
           $result = $this->pdoStatment->fetchAll($fetchMode);
-      }
-      else{
+      } else{
           $result = $this->pdoStatment->fetch($fetchMode);
       }
       //Sqlite and pgsql always return 0 when using rowCount()
       if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $numRows = count($result);  
-      }
-      else{
+      } else{
         $numRows = $this->pdoStatment->rowCount(); 
       }
       if(! is_object($this->queryResult)){
@@ -201,8 +198,7 @@ 
       if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
-      }
-      else{
+      } else{
           //to test the result for the query like UPDATE, INSERT, DELETE
           $result  = $this->pdoStatment->rowCount() >= 0; 
           $numRows = $this->pdoStatment->rowCount(); 
@@ -380,8 +376,7 @@ 
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
       if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
+      } else{
           $this->logger =& class_loader('Log', 'classes');
           $this->logger->setLogger('Library::DatabaseQueryRunner');
       }

core/classes/database/Database.php

Indentation +325 added lines, -325 removed lines

@@ -1,119 +1,119 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
-  class Database{
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class Database{
 	
-  	/**
-  	 * The PDO instance
-  	 * @var object
-  	*/
+        /**
+         * The PDO instance
+         * @var object
+         */
     private $pdo                 = null;
     
-  	/**
-  	 * The database name used for the application
-  	 * @var string
-  	*/
-	  private $databaseName        = null;
+        /**
+         * The database name used for the application
+         * @var string
+         */
+        private $databaseName        = null;
 	
-  	/**
-  	 * The number of rows returned by the last query
-  	 * @var int
-  	*/
+        /**
+         * The number of rows returned by the last query
+         * @var int
+         */
     private $numRows             = 0;
 	
-  	/**
-  	 * The last insert id for the primary key column that have auto increment or sequence
-  	 * @var mixed
-  	*/
+        /**
+         * The last insert id for the primary key column that have auto increment or sequence
+         * @var mixed
+         */
     private $insertId            = null;
 	
-  	/**
-  	 * The full SQL query statment after build for each command
-  	 * @var string
-  	*/
+        /**
+         * The full SQL query statment after build for each command
+         * @var string
+         */
     private $query               = null;
 	
-  	/**
-  	 * The result returned for the last query
-  	 * @var mixed
-  	*/
+        /**
+         * The result returned for the last query
+         * @var mixed
+         */
     private $result              = array();
 	
-  	/**
-  	 * The cache default time to live in second. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
-  	private $cacheTtl             = 0;
+        /**
+         * The cache default time to live in second. 0 means no need to use the cache feature
+         * @var int
+         */
+        private $cacheTtl             = 0;
 	
-  	/**
-  	 * The cache current time to live. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
+        /**
+         * The cache current time to live. 0 means no need to use the cache feature
+         * @var int
+         */
     private $temporaryCacheTtl   = 0;
 	
-  	/**
-  	 * The number of executed query for the current request
-  	 * @var int
-  	*/
+        /**
+         * The number of executed query for the current request
+         * @var int
+         */
     private $queryCount          = 0;
 	
-  	/**
-  	 * The default data to be used in the statments query INSERT, UPDATE
-  	 * @var array
-  	*/
+        /**
+         * The default data to be used in the statments query INSERT, UPDATE
+         * @var array
+         */
     private $data                = array();
 	
-  	/**
-  	 * The database configuration
-  	 * @var array
-  	*/
+        /**
+         * The database configuration
+         * @var array
+         */
     private $config              = array();
 	
-  	/**
-  	 * The logger instance
-  	 * @var object
-  	 */
+        /**
+         * The logger instance
+         * @var object
+         */
     private $logger              = null;
 
     /**
-    * The cache instance
-    * @var object
-    */
+     * The cache instance
+     * @var object
+     */
     private $cacheInstance       = null;
 
     
-  	/**
-    * The DatabaseQueryBuilder instance
-    * @var object
-    */
+        /**
+         * The DatabaseQueryBuilder instance
+         * @var object
+         */
     private $queryBuilder        = null;
     
     /**
-    * The DatabaseQueryRunner instance
-    * @var object
-    */
+     * The DatabaseQueryRunner instance
+     * @var object
+     */
     private $queryRunner         = null;
 
 
@@ -125,8 +125,8 @@ 
         //Set Log instance to use
         $this->setLoggerFromParamOrCreateNewInstance(null);
 		
-    		//Set DatabaseQueryBuilder instance to use
-    		$this->setQueryBuilderFromParamOrCreateNewInstance(null);
+            //Set DatabaseQueryBuilder instance to use
+            $this->setQueryBuilderFromParamOrCreateNewInstance(null);
 
         //Set DatabaseQueryRunner instance to use
         $this->setQueryRunnerFromParamOrCreateNewInstance(null);
@@ -143,22 +143,22 @@ 
      * @return bool 
      */
     public function connect(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         try{
             $this->pdo = new PDO($this->getDsnFromDriver(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
-          }
-          catch (PDOException $e){
+            }
+            catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 
@@ -167,7 +167,7 @@ 
      * @return int
      */
     public function numRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
@@ -175,7 +175,7 @@ 
      * @return mixed
      */
     public function insertId(){
-      return $this->insertId;
+        return $this->insertId;
     }
 
 
@@ -186,13 +186,13 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function get($returnSQLQueryOrResultType = false){
-      $this->getQueryBuilder()->limit(1);
-      $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+        $this->getQueryBuilder()->limit(1);
+        $query = $this->getAll(true);
+        if ($returnSQLQueryOrResultType === true){
         return $query;
-      } else {
+        } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
-      }
+        }
     }
 
     /**
@@ -202,11 +202,11 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function getAll($returnSQLQueryOrResultType = false){
-	   $query = $this->getQueryBuilder()->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
-      	return $query;
-      }
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
+        $query = $this->getQueryBuilder()->getQuery();
+        if ($returnSQLQueryOrResultType === true){
+            return $query;
+        }
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
     }
 
     /**
@@ -216,19 +216,19 @@ 
      * @return mixed          the insert id of the new record or null
      */
     public function insert($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+        if (empty($data) && $this->getData()){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
-      }
-      $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
-      $result = $this->query($query);
-      if ($result){
+        }
+        $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
+        $result = $this->query($query);
+        if ($result){
         $this->insertId = $this->pdo->lastInsertId();
-		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
+            //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
         return ! $this->insertId() ? true : $this->insertId();
-      }
-      return false;
+        }
+        return false;
     }
 
     /**
@@ -238,13 +238,13 @@ 
      * @return mixed          the update status
      */
     public function update($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+        if (empty($data) && $this->getData()){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
-      }
-      $query = $this->getQueryBuilder()->update($data, $escape)->getQuery();
-      return $this->query($query);
+        }
+        $query = $this->getQueryBuilder()->update($data, $escape)->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -252,8 +252,8 @@ 
      * @return mixed the delete status
      */
     public function delete(){
-		$query = $this->getQueryBuilder()->delete()->getQuery();
-    	return $this->query($query);
+        $query = $this->getQueryBuilder()->delete()->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -262,21 +262,21 @@ 
      * @return object        the current Database instance
      */
     public function setCache($ttl = 0){
-      if ($ttl > 0){
+        if ($ttl > 0){
         $this->cacheTtl = $ttl;
         $this->temporaryCacheTtl = $ttl;
-      }
-      return $this;
+        }
+        return $this;
     }
 	
-	/**
-	 * Enabled cache temporary for the current query not globally	
-	 * @param  integer $ttl the cache time to live in second
-	 * @return object        the current Database instance
-	 */
-  	public function cached($ttl = 0){
+    /**
+     * Enabled cache temporary for the current query not globally	
+     * @param  integer $ttl the cache time to live in second
+     * @return object        the current Database instance
+     */
+        public function cached($ttl = 0){
         if ($ttl > 0){
-          $this->temporaryCacheTtl = $ttl;
+            $this->temporaryCacheTtl = $ttl;
         }
         return $this;
     }
@@ -288,7 +288,7 @@ 
      * @return mixed       the data after escaped or the same data if not
      */
     public function escape($data, $escaped = true){
-      return $escaped ? 
+        return $escaped ? 
                       $this->pdo->quote(trim($data)) 
                       : $data; 
     }
@@ -298,7 +298,7 @@ 
      * @return int
      */
     public function queryCount(){
-      return $this->queryCount;
+        return $this->queryCount;
     }
 
     /**
@@ -306,7 +306,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
 
     /**
@@ -314,7 +314,7 @@ 
      * @return string
      */
     public function getDatabaseName(){
-      return $this->databaseName;
+        return $this->databaseName;
     }
 
     /**
@@ -322,17 +322,17 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
      * Set the PDO instance
      * @param object $pdo the pdo object
-	 * @return object Database
+     * @return object Database
      */
     public function setPdo(PDO $pdo){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
 
 
@@ -341,44 +341,44 @@ 
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object Database
+     * @return object Database
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
 
-     /**
-     * Return the cache instance
-     * @return CacheInterface
-     */
+        /**
+         * Return the cache instance
+         * @return CacheInterface
+         */
     public function getCacheInstance(){
-      return $this->cacheInstance;
+        return $this->cacheInstance;
     }
 
     /**
      * Set the cache instance
      * @param CacheInterface $cache the cache object
-	 * @return object Database
+     * @return object Database
      */
     public function setCacheInstance($cache){
-      $this->cacheInstance = $cache;
-      return $this;
+        $this->cacheInstance = $cache;
+        return $this;
     }
 	
 	
-	   /**
-     * Return the DatabaseQueryBuilder instance
-     * @return object DatabaseQueryBuilder
-     */
+        /**
+         * Return the DatabaseQueryBuilder instance
+         * @return object DatabaseQueryBuilder
+         */
     public function getQueryBuilder(){
-      return $this->queryBuilder;
+        return $this->queryBuilder;
     }
 
     /**
@@ -386,8 +386,8 @@ 
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
-      $this->queryBuilder = $queryBuilder;
-      return $this;
+        $this->queryBuilder = $queryBuilder;
+        return $this;
     }
     
     /**
@@ -395,7 +395,7 @@ 
      * @return object DatabaseQueryRunner
      */
     public function getQueryRunner(){
-      return $this->queryRunner;
+        return $this->queryRunner;
     }
 
     /**
@@ -403,8 +403,8 @@ 
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
-      $this->queryRunner = $queryRunner;
-      return $this;
+        $this->queryRunner = $queryRunner;
+        return $this;
     }
 
     /**
@@ -412,7 +412,7 @@ 
      * @return array
      */
     public function getData(){
-      return $this->data;
+        return $this->data;
     }
 
     /**
@@ -423,51 +423,51 @@ 
      * @return object        the current Database instance
      */
     public function setData($key, $value = null, $escape = true){
-  	  if(is_array($key)){
-    		foreach($key as $k => $v){
-    			$this->setData($k, $v, $escape);
-    		}	
-  	  } else {
+        if(is_array($key)){
+            foreach($key as $k => $v){
+                $this->setData($k, $v, $escape);
+            }	
+        } else {
         $this->data[$key] = $this->escape($value, $escape);
-  	  }
-      return $this;
+        }
+        return $this;
     }
 
-     /**
-     * Execute an SQL query
-     * @param  string  $query the query SQL string
-     * @param  boolean $returnAsList  indicate whether to return all record or just one row 
-     * @param  boolean $returnAsArray return the result as array or not
-     * @return mixed         the query result
-     */
+        /**
+         * Execute an SQL query
+         * @param  string  $query the query SQL string
+         * @param  boolean $returnAsList  indicate whether to return all record or just one row 
+         * @param  boolean $returnAsArray return the result as array or not
+         * @return mixed         the query result
+         */
     public function query($query, $returnAsList = true, $returnAsArray = false){
-      $this->reset();
-      $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
-      //If is the SELECT query
-      $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
+        $this->reset();
+        $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
+        //If is the SELECT query
+        $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
 
-      //cache expire time
-      $cacheExpire = $this->temporaryCacheTtl;
+        //cache expire time
+        $cacheExpire = $this->temporaryCacheTtl;
       
-      //return to the initial cache time
-      $this->temporaryCacheTtl = $this->cacheTtl;
+        //return to the initial cache time
+        $this->temporaryCacheTtl = $this->cacheTtl;
       
-      //config for cache
-      $cacheEnable = get_config('cache_enable');
+        //config for cache
+        $cacheEnable = get_config('cache_enable');
       
-      //the database cache content
-      $cacheContent = null;
+        //the database cache content
+        $cacheContent = null;
 
-      //if can use cache feature for this query
-      $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
+        //if can use cache feature for this query
+        $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
-          $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
-          $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
-      }
+        if ($dbCacheStatus && $isSqlSELECTQuery){
+            $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
+            $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
+        }
       
-      if ( !$cacheContent){
-  	   	//count the number of query execution to server
+        if ( !$cacheContent){
+                //count the number of query execution to server
         $this->queryCount++;
         
         $this->queryRunner->setQuery($query);
@@ -484,35 +484,35 @@ 
                                             $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray), 
                                             $this->result, 
                                             $cacheExpire
-                                          );
+                                            );
             if (! $this->result){
-              $this->logger->info('No result where found for the query [' . $query . ']');
+                $this->logger->info('No result where found for the query [' . $query . ']');
             }
-          }
+            }
+        }
+        } else if ($isSqlSELECTQuery){
+            $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+            $this->result = $cacheContent;
+            $this->numRows = count($this->result);
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
-          $this->result = $cacheContent;
-          $this->numRows = count($this->result);
-      }
-      return $this->result;
+        return $this->result;
     }
 	
 	
-	 /**
-	 * Return the database configuration
-	 * @return array
-	 */
-  	public  function getDatabaseConfiguration(){
-  	  return $this->config;
-  	}
-
-   /**
-    * Setting the database configuration using the configuration file and additional configuration from param
-    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-    * @param boolean $useConfigFile whether to use database configuration file
-	  * @return object Database
-    */
+        /**
+         * Return the database configuration
+         * @return array
+         */
+        public  function getDatabaseConfiguration(){
+        return $this->config;
+        }
+
+    /**
+     * Setting the database configuration using the configuration file and additional configuration from param
+     * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+     * @param boolean $useConfigFile whether to use database configuration file
+     * @return object Database
+     */
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
         $db = array();
         if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
@@ -525,50 +525,50 @@ 
         
         //default configuration
         $config = array(
-          'driver' => 'mysql',
-          'username' => 'root',
-          'password' => '',
-          'database' => '',
-          'hostname' => 'localhost',
-          'charset' => 'utf8',
-          'collation' => 'utf8_general_ci',
-          'prefix' => '',
-          'port' => ''
+            'driver' => 'mysql',
+            'username' => 'root',
+            'password' => '',
+            'database' => '',
+            'hostname' => 'localhost',
+            'charset' => 'utf8',
+            'collation' => 'utf8_general_ci',
+            'prefix' => '',
+            'port' => ''
         );
 		
-    	$config = array_merge($config, $db);
-    	//determine the port using the hostname like localhost:3307
-      //hostname will be "localhost", and port "3307"
-      $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
-  		  $config['hostname'] = $p[0];
-  		  $config['port'] = $p[1];
-  		}
+        $config = array_merge($config, $db);
+        //determine the port using the hostname like localhost:3307
+        //hostname will be "localhost", and port "3307"
+        $p = explode(':', $config['hostname']);
+        if (count($p) >= 2){
+            $config['hostname'] = $p[0];
+            $config['port'] = $p[1];
+            }
 		
-		 $this->databaseName = $config['database'];
-		 $this->config = $config;
-		 $this->logger->info(
-								'The database configuration are listed below: ' 
-								. stringfy_vars(array_merge(
-															$this->config, 
-															array('password' => string_hidden($this->config['password']))
-												))
-							);
+            $this->databaseName = $config['database'];
+            $this->config = $config;
+            $this->logger->info(
+                                'The database configuration are listed below: ' 
+                                . stringfy_vars(array_merge(
+                                                            $this->config, 
+                                                            array('password' => string_hidden($this->config['password']))
+                                                ))
+                            );
 	  
-		 //Now connect to the database
-		 $this->connect();
+            //Now connect to the database
+            $this->connect();
 		 
-     //do update of QueryRunner and Builder
-     $this->updateQueryBuilderAndRunnerProperties();
+        //do update of QueryRunner and Builder
+        $this->updateQueryBuilderAndRunnerProperties();
 
-		 return $this;
+            return $this;
     }
 
     /**
      * Close the connexion
      */
     public function close(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
     /**
@@ -576,18 +576,18 @@ 
      * @return void
      */
     protected function updateQueryBuilderAndRunnerProperties(){
-       //update queryBuilder with some properties needed
-     if(is_object($this->queryBuilder)){
+        //update queryBuilder with some properties needed
+        if(is_object($this->queryBuilder)){
         $this->queryBuilder->setDriver($this->config['driver']);
         $this->queryBuilder->setPrefix($this->config['prefix']);
         $this->queryBuilder->setPdo($this->pdo);
-     }
+        }
 
-      //update queryRunner with some properties needed
-     if(is_object($this->queryRunner)){
+        //update queryRunner with some properties needed
+        if(is_object($this->queryRunner)){
         $this->queryRunner->setDriver($this->config['driver']);
         $this->queryRunner->setPdo($this->pdo);
-     }
+        }
     }
 	
 
@@ -596,24 +596,24 @@ 
      * @return string the DSN string
      */
     protected function getDsnFromDriver(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         $driver = $config['driver'];
         $driverDsnMap = array(
-                              'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
-                                          . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '') 
-                                          . 'dbname=' . $config['database'],
-                              'pgsql' => 'pgsql:host=' . $config['hostname'] . ';' 
-                                          . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '')
-                                          . 'dbname=' . $config['database'],
-                              'sqlite' => 'sqlite:' . $config['database'],
-                              'oracle' => 'oci:dbname=' . $config['hostname'] 
+                                'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
+                                            . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '') 
+                                            . 'dbname=' . $config['database'],
+                                'pgsql' => 'pgsql:host=' . $config['hostname'] . ';' 
+                                            . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '')
+                                            . 'dbname=' . $config['database'],
+                                'sqlite' => 'sqlite:' . $config['database'],
+                                'oracle' => 'oci:dbname=' . $config['hostname'] 
                                             . (($config['port']) != '' ? ':' . $config['port'] : '')
                                             . '/' . $config['database']
-                              );
+                                );
         return isset($driverDsnMap[$driver]) ? $driverDsnMap[$driver] : '';
-      }                   
-      return null;
+        }                   
+        return null;
     }
 
     /**
@@ -625,11 +625,11 @@ 
     protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
         if (! is_object($this->cacheInstance)){
-    			//can not call method with reference in argument
-    			//like $this->setCacheInstance(& get_instance()->cache);
-    			//use temporary variable
-    			$instance = & get_instance()->cache;
-    			$this->cacheInstance = $instance;
+                //can not call method with reference in argument
+                //like $this->setCacheInstance(& get_instance()->cache);
+                //use temporary variable
+                $instance = & get_instance()->cache;
+                $this->cacheInstance = $instance;
         }
         return $this->cacheInstance->get($cacheKey);
     }
@@ -641,87 +641,87 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
+        protected function setCacheContentForQuery($query, $key, $result, $expire){
         $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
         if (! is_object($this->cacheInstance)){
-  				//can not call method with reference in argument
-  				//like $this->setCacheInstance(& get_instance()->cache);
-  				//use temporary variable
-  				$instance = & get_instance()->cache;
-  				$this->cacheInstance = $instance;
-  			}
+                    //can not call method with reference in argument
+                    //like $this->setCacheInstance(& get_instance()->cache);
+                    //use temporary variable
+                    $instance = & get_instance()->cache;
+                    $this->cacheInstance = $instance;
+                }
         $this->cacheInstance->set($key, $result, $expire);
-     }
+        }
 
     
-	 /**
-     * Return the cache key for the given query
-     * @see Database::query
-     * 
-     *  @return string
-     */
+        /**
+         * Return the cache key for the given query
+         * @see Database::query
+         * 
+         *  @return string
+         */
     protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
-      return md5($query . $returnAsList . $returnAsArray);
+        return md5($query . $returnAsList . $returnAsArray);
     }
     
-	   /**
-     * Set the Log instance using argument or create new instance
-     * @param object $logger the Log instance if not null
-     */
+        /**
+         * Set the Log instance using argument or create new instance
+         * @param object $logger the Log instance if not null
+         */
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::Database');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Database');
+        }
     }
 	
-   /**
-   * Set the DatabaseQueryBuilder instance using argument or create new instance
-   * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
-   */
-	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
-	  if ($queryBuilder !== null){
+    /**
+     * Set the DatabaseQueryBuilder instance using argument or create new instance
+     * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
+     */
+    protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
+        if ($queryBuilder !== null){
         $this->queryBuilder = $queryBuilder;
-	  }
-	  else{
-		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
-	  }
-	}
-
-  /**
-   * Set the DatabaseQueryRunner instance using argument or create new instance
-   * @param object $queryRunner the DatabaseQueryRunner instance if not null
-   */
-  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
+        }
+        else{
+            $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
+        }
+    }
+
+    /**
+     * Set the DatabaseQueryRunner instance using argument or create new instance
+     * @param object $queryRunner the DatabaseQueryRunner instance if not null
+     */
+    protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
     if ($queryRunner !== null){
         $this->queryRunner = $queryRunner;
     }
     else{
-      $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+        $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+    }
     }
-  }
 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
     private function reset(){
-	   //query builder reset
-      $this->getQueryBuilder()->reset();
-      $this->numRows  = 0;
-      $this->insertId = null;
-      $this->query    = null;
-      $this->result   = array();
-      $this->data     = array();
+        //query builder reset
+        $this->getQueryBuilder()->reset();
+        $this->numRows  = 0;
+        $this->insertId = null;
+        $this->query    = null;
+        $this->result   = array();
+        $this->data     = array();
     }
 
     /**
      * The class destructor
      */
     public function __destruct(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
 }

Spacing +94 added lines, -94 removed lines

@@ -23,105 +23,105 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class Database{
+  class Database {
 	
   	/**
   	 * The PDO instance
   	 * @var object
   	*/
-    private $pdo                 = null;
+    private $pdo = null;
     
   	/**
   	 * The database name used for the application
   	 * @var string
   	*/
-	  private $databaseName        = null;
+	  private $databaseName = null;
 	
   	/**
   	 * The number of rows returned by the last query
   	 * @var int
   	*/
-    private $numRows             = 0;
+    private $numRows = 0;
 	
   	/**
   	 * The last insert id for the primary key column that have auto increment or sequence
   	 * @var mixed
   	*/
-    private $insertId            = null;
+    private $insertId = null;
 	
   	/**
   	 * The full SQL query statment after build for each command
   	 * @var string
   	*/
-    private $query               = null;
+    private $query = null;
 	
   	/**
   	 * The result returned for the last query
   	 * @var mixed
   	*/
-    private $result              = array();
+    private $result = array();
 	
   	/**
   	 * The cache default time to live in second. 0 means no need to use the cache feature
   	 * @var int
   	*/
-  	private $cacheTtl             = 0;
+  	private $cacheTtl = 0;
 	
   	/**
   	 * The cache current time to live. 0 means no need to use the cache feature
   	 * @var int
   	*/
-    private $temporaryCacheTtl   = 0;
+    private $temporaryCacheTtl = 0;
 	
   	/**
   	 * The number of executed query for the current request
   	 * @var int
   	*/
-    private $queryCount          = 0;
+    private $queryCount = 0;
 	
   	/**
   	 * The default data to be used in the statments query INSERT, UPDATE
   	 * @var array
   	*/
-    private $data                = array();
+    private $data = array();
 	
   	/**
   	 * The database configuration
   	 * @var array
   	*/
-    private $config              = array();
+    private $config = array();
 	
   	/**
   	 * The logger instance
   	 * @var object
   	 */
-    private $logger              = null;
+    private $logger = null;
 
     /**
     * The cache instance
     * @var object
     */
-    private $cacheInstance       = null;
+    private $cacheInstance = null;
 
     
   	/**
     * The DatabaseQueryBuilder instance
     * @var object
     */
-    private $queryBuilder        = null;
+    private $queryBuilder = null;
     
     /**
     * The DatabaseQueryRunner instance
     * @var object
     */
-    private $queryRunner         = null;
+    private $queryRunner = null;
 
 
     /**
      * Construct new database
      * @param array $overwriteConfig the config to overwrite with the config set in database.php
      */
-    public function __construct($overwriteConfig = array()){
+    public function __construct($overwriteConfig = array()) {
         //Set Log instance to use
         $this->setLoggerFromParamOrCreateNewInstance(null);
 		
@@ -142,17 +142,17 @@ 
      * This is used to connect to database
      * @return bool 
      */
-    public function connect(){
+    public function connect() {
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
-        try{
+      if (!empty($config)) {
+        try {
             $this->pdo = new PDO($this->getDsnFromDriver(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
           }
-          catch (PDOException $e){
+          catch (PDOException $e) {
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -166,7 +166,7 @@ 
      * Return the number of rows returned by the current query
      * @return int
      */
-    public function numRows(){
+    public function numRows() {
       return $this->numRows;
     }
 
@@ -174,7 +174,7 @@ 
      * Return the last insert id value
      * @return mixed
      */
-    public function insertId(){
+    public function insertId() {
       return $this->insertId;
     }
 
@@ -185,10 +185,10 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function get($returnSQLQueryOrResultType = false){
+    public function get($returnSQLQueryOrResultType = false) {
       $this->getQueryBuilder()->limit(1);
       $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+      if ($returnSQLQueryOrResultType === true) {
         return $query;
       } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
@@ -201,9 +201,9 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function getAll($returnSQLQueryOrResultType = false){
+    public function getAll($returnSQLQueryOrResultType = false) {
 	   $query = $this->getQueryBuilder()->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
+	   if ($returnSQLQueryOrResultType === true) {
       	return $query;
       }
       return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
@@ -215,18 +215,18 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the insert id of the new record or null
      */
-    public function insert($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+    public function insert($data = array(), $escape = true) {
+      if (empty($data) && $this->getData()) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
       }
       $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
       $result = $this->query($query);
-      if ($result){
+      if ($result) {
         $this->insertId = $this->pdo->lastInsertId();
 		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
-        return ! $this->insertId() ? true : $this->insertId();
+        return !$this->insertId() ? true : $this->insertId();
       }
       return false;
     }
@@ -237,8 +237,8 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the update status
      */
-    public function update($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+    public function update($data = array(), $escape = true) {
+      if (empty($data) && $this->getData()) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
@@ -251,7 +251,7 @@ 
      * Delete the record in database
      * @return mixed the delete status
      */
-    public function delete(){
+    public function delete() {
 		$query = $this->getQueryBuilder()->delete()->getQuery();
     	return $this->query($query);
     }
@@ -261,8 +261,8 @@ 
      * @param integer $ttl the cache time to live in second
      * @return object        the current Database instance
      */
-    public function setCache($ttl = 0){
-      if ($ttl > 0){
+    public function setCache($ttl = 0) {
+      if ($ttl > 0) {
         $this->cacheTtl = $ttl;
         $this->temporaryCacheTtl = $ttl;
       }
@@ -274,8 +274,8 @@ 
 	 * @param  integer $ttl the cache time to live in second
 	 * @return object        the current Database instance
 	 */
-  	public function cached($ttl = 0){
-        if ($ttl > 0){
+  	public function cached($ttl = 0) {
+        if ($ttl > 0) {
           $this->temporaryCacheTtl = $ttl;
         }
         return $this;
@@ -287,7 +287,7 @@ 
      * @param boolean $escaped whether we can do escape of not 
      * @return mixed       the data after escaped or the same data if not
      */
-    public function escape($data, $escaped = true){
+    public function escape($data, $escaped = true) {
       return $escaped ? 
                       $this->pdo->quote(trim($data)) 
                       : $data; 
@@ -297,7 +297,7 @@ 
      * Return the number query executed count for the current request
      * @return int
      */
-    public function queryCount(){
+    public function queryCount() {
       return $this->queryCount;
     }
 
@@ -305,7 +305,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
       return $this->query;
     }
 
@@ -313,7 +313,7 @@ 
      * Return the application database name
      * @return string
      */
-    public function getDatabaseName(){
+    public function getDatabaseName() {
       return $this->databaseName;
     }
 
@@ -321,7 +321,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -330,7 +330,7 @@ 
      * @param object $pdo the pdo object
 	 * @return object Database
      */
-    public function setPdo(PDO $pdo){
+    public function setPdo(PDO $pdo) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -340,7 +340,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -349,7 +349,7 @@ 
      * @param Log $logger the log object
 	 * @return object Database
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -358,7 +358,7 @@ 
      * Return the cache instance
      * @return CacheInterface
      */
-    public function getCacheInstance(){
+    public function getCacheInstance() {
       return $this->cacheInstance;
     }
 
@@ -367,7 +367,7 @@ 
      * @param CacheInterface $cache the cache object
 	 * @return object Database
      */
-    public function setCacheInstance($cache){
+    public function setCacheInstance($cache) {
       $this->cacheInstance = $cache;
       return $this;
     }
@@ -377,7 +377,7 @@ 
      * Return the DatabaseQueryBuilder instance
      * @return object DatabaseQueryBuilder
      */
-    public function getQueryBuilder(){
+    public function getQueryBuilder() {
       return $this->queryBuilder;
     }
 
@@ -385,7 +385,7 @@ 
      * Set the DatabaseQueryBuilder instance
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
-    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
+    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder) {
       $this->queryBuilder = $queryBuilder;
       return $this;
     }
@@ -394,7 +394,7 @@ 
      * Return the DatabaseQueryRunner instance
      * @return object DatabaseQueryRunner
      */
-    public function getQueryRunner(){
+    public function getQueryRunner() {
       return $this->queryRunner;
     }
 
@@ -402,7 +402,7 @@ 
      * Set the DatabaseQueryRunner instance
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
-    public function setQueryRunner(DatabaseQueryRunner $queryRunner){
+    public function setQueryRunner(DatabaseQueryRunner $queryRunner) {
       $this->queryRunner = $queryRunner;
       return $this;
     }
@@ -411,7 +411,7 @@ 
      * Return the data to be used for insert, update, etc.
      * @return array
      */
-    public function getData(){
+    public function getData() {
       return $this->data;
     }
 
@@ -422,9 +422,9 @@ 
      * @param boolean $escape whether to escape or not the $value
      * @return object        the current Database instance
      */
-    public function setData($key, $value = null, $escape = true){
-  	  if(is_array($key)){
-    		foreach($key as $k => $v){
+    public function setData($key, $value = null, $escape = true) {
+  	  if (is_array($key)) {
+    		foreach ($key as $k => $v) {
     			$this->setData($k, $v, $escape);
     		}	
   	  } else {
@@ -440,7 +440,7 @@ 
      * @param  boolean $returnAsArray return the result as array or not
      * @return mixed         the query result
      */
-    public function query($query, $returnAsList = true, $returnAsArray = false){
+    public function query($query, $returnAsList = true, $returnAsArray = false) {
       $this->reset();
       $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
       //If is the SELECT query
@@ -461,12 +461,12 @@ 
       //if can use cache feature for this query
       $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
+      if ($dbCacheStatus && $isSqlSELECTQuery) {
           $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
           $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
       }
       
-      if ( !$cacheContent){
+      if (!$cacheContent) {
   	   	//count the number of query execution to server
         $this->queryCount++;
         
@@ -475,23 +475,23 @@ 
         $this->queryRunner->setReturnAsArray($returnAsArray);
         
         $queryResult = $this->queryRunner->execute();
-        if (is_object($queryResult)){
+        if (is_object($queryResult)) {
             $this->result  = $queryResult->getResult();
             $this->numRows = $queryResult->getNumRows();
-            if ($isSqlSELECTQuery && $dbCacheStatus){
+            if ($isSqlSELECTQuery && $dbCacheStatus) {
                 $this->setCacheContentForQuery(
                                             $this->query, 
                                             $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray), 
                                             $this->result, 
                                             $cacheExpire
                                           );
-            if (! $this->result){
+            if (!$this->result) {
               $this->logger->info('No result where found for the query [' . $query . ']');
             }
           }
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+      } else if ($isSqlSELECTQuery) {
+          $this->logger->info('The result for query [' . $this->query . '] already cached use it');
           $this->result = $cacheContent;
           $this->numRows = count($this->result);
       }
@@ -503,7 +503,7 @@ 
 	 * Return the database configuration
 	 * @return array
 	 */
-  	public  function getDatabaseConfiguration(){
+  	public  function getDatabaseConfiguration() {
   	  return $this->config;
   	}
 
@@ -513,9 +513,9 @@ 
     * @param boolean $useConfigFile whether to use database configuration file
 	  * @return object Database
     */
-    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
         $db = array();
-        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')) {
             //here don't use require_once because somewhere user can create database instance directly
             require CONFIG_PATH . 'database.php';
         }
@@ -540,7 +540,7 @@ 
     	//determine the port using the hostname like localhost:3307
       //hostname will be "localhost", and port "3307"
       $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
+  	  if (count($p) >= 2) {
   		  $config['hostname'] = $p[0];
   		  $config['port'] = $p[1];
   		}
@@ -567,7 +567,7 @@ 
     /**
      * Close the connexion
      */
-    public function close(){
+    public function close() {
       $this->pdo = null;
     }
 
@@ -575,16 +575,16 @@ 
      * Update the DatabaseQueryBuilder and DatabaseQueryRunner properties
      * @return void
      */
-    protected function updateQueryBuilderAndRunnerProperties(){
+    protected function updateQueryBuilderAndRunnerProperties() {
        //update queryBuilder with some properties needed
-     if(is_object($this->queryBuilder)){
+     if (is_object($this->queryBuilder)) {
         $this->queryBuilder->setDriver($this->config['driver']);
         $this->queryBuilder->setPrefix($this->config['prefix']);
         $this->queryBuilder->setPdo($this->pdo);
      }
 
       //update queryRunner with some properties needed
-     if(is_object($this->queryRunner)){
+     if (is_object($this->queryRunner)) {
         $this->queryRunner->setDriver($this->config['driver']);
         $this->queryRunner->setPdo($this->pdo);
      }
@@ -595,9 +595,9 @@ 
      * This method is used to get the PDO DSN string using the configured driver
      * @return string the DSN string
      */
-    protected function getDsnFromDriver(){
+    protected function getDsnFromDriver() {
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+      if (!empty($config)) {
         $driver = $config['driver'];
         $driverDsnMap = array(
                               'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
@@ -622,9 +622,9 @@ 
      *      
      * @return mixed
      */
-    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray) {
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
-        if (! is_object($this->cacheInstance)){
+        if (!is_object($this->cacheInstance)) {
     			//can not call method with reference in argument
     			//like $this->setCacheInstance(& get_instance()->cache);
     			//use temporary variable
@@ -641,9 +641,9 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
-        $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
-        if (! is_object($this->cacheInstance)){
+     protected function setCacheContentForQuery($query, $key, $result, $expire) {
+        $this->logger->info('Save the result for query [' . $query . '] into cache for future use');
+        if (!is_object($this->cacheInstance)) {
   				//can not call method with reference in argument
   				//like $this->setCacheInstance(& get_instance()->cache);
   				//use temporary variable
@@ -660,7 +660,7 @@ 
      * 
      *  @return string
      */
-    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray) {
       return md5($query . $returnAsList . $returnAsArray);
     }
     
@@ -668,12 +668,12 @@ 
      * Set the Log instance using argument or create new instance
      * @param object $logger the Log instance if not null
      */
-    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) {
+      if ($logger !== null) {
         $this->logger = $logger;
       }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
+      else {
+          $this->logger = & class_loader('Log', 'classes');
           $this->logger->setLogger('Library::Database');
       }
     }
@@ -682,12 +682,12 @@ 
    * Set the DatabaseQueryBuilder instance using argument or create new instance
    * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
    */
-	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
-	  if ($queryBuilder !== null){
+	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null) {
+	  if ($queryBuilder !== null) {
         $this->queryBuilder = $queryBuilder;
 	  }
-	  else{
-		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
+	  else {
+		  $this->queryBuilder = & class_loader('DatabaseQueryBuilder', 'classes/database');
 	  }
 	}
 
@@ -695,19 +695,19 @@ 
    * Set the DatabaseQueryRunner instance using argument or create new instance
    * @param object $queryRunner the DatabaseQueryRunner instance if not null
    */
-  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
-    if ($queryRunner !== null){
+  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null) {
+    if ($queryRunner !== null) {
         $this->queryRunner = $queryRunner;
     }
-    else{
-      $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+    else {
+      $this->queryRunner = & class_loader('DatabaseQueryRunner', 'classes/database');
     }
   }
 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
-    private function reset(){
+    private function reset() {
 	   //query builder reset
       $this->getQueryBuilder()->reset();
       $this->numRows  = 0;
@@ -720,7 +720,7 @@ 
     /**
      * The class destructor
      */
-    public function __destruct(){
+    public function __destruct() {
       $this->pdo = null;
     }
 

Braces +4 added lines, -8 removed lines

@@ -151,8 +151,7 @@ 
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
-          }
-          catch (PDOException $e){
+          } catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -671,8 +670,7 @@ 
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
       if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
+      } else{
           $this->logger =& class_loader('Log', 'classes');
           $this->logger->setLogger('Library::Database');
       }
@@ -685,8 +683,7 @@ 
 	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
 	  if ($queryBuilder !== null){
         $this->queryBuilder = $queryBuilder;
-	  }
-	  else{
+	  } else{
 		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
 	  }
 	}
@@ -698,8 +695,7 @@ 
   protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
     if ($queryRunner !== null){
         $this->queryRunner = $queryRunner;
-    }
-    else{
+    } else{
       $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
     }
   }

core/classes/cache/FileCache.php

Indentation +295 added lines, -295 removed lines

@@ -1,318 +1,318 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class FileCache implements CacheInterface{
+    class FileCache implements CacheInterface{
 		
-		/**
-		 * Whether to enable compression of the cache data file.
-		 * @var boolean
-		 */
-		private $compressCacheData = true;
+        /**
+         * Whether to enable compression of the cache data file.
+         * @var boolean
+         */
+        private $compressCacheData = true;
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 		
 		
-		public function __construct(Log $logger = null){
-			if(! $this->isSupported()){
-				show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
-			}
-			/**
-	         * instance of the Log class
-	         */
-	        if(is_object($logger)){
-	          $this->logger = $logger;
-	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
-	            $this->logger->setLogger('Library::FileCache');
-	        }
+        public function __construct(Log $logger = null){
+            if(! $this->isSupported()){
+                show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
+            }
+            /**
+             * instance of the Log class
+             */
+            if(is_object($logger)){
+                $this->logger = $logger;
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::FileCache');
+            }
 			
-			//if Zlib extension is not loaded set compressCacheData to false
-			if(! extension_loaded('zlib')){
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-		}
+            //if Zlib extension is not loaded set compressCacheData to false
+            if(! extension_loaded('zlib')){
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+        }
 
-		/**
-		 * This is used to get the cache data using the key
-		 * @param  string $key the key to identify the cache data
-		 * @return mixed      the cache data if exists else return false
-		 */
-		public function get($key){
-			$this->logger->debug('Getting cache data for key ['. $key .']');
-			$filePath = $this->getFilePath($key);
-			if(! file_exists($filePath)){
-				$this->logger->info('No cache file found for the key ['. $key .'], return false');
-				return false;
-			}
-			$this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
-			$handle = fopen($filePath,'r');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			// Getting a shared lock 
-		    flock($handle, LOCK_SH);
-		    $data = file_get_contents($filePath);
-      		fclose($handle);
-      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-      		if (! $data) {
-      			$this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
-		         // If unserializing somehow didn't work out, we'll delete the file
-		         unlink($filePath);
-		         return false;
-	      	}
-	      	if (time() > $data['expire']) {
-	      		$this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
-		        // Unlinking when the file was expired
-		        unlink($filePath);
-		        return false;
-		     }
-		     else{
-		     	$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
-		     	return $data['data'];
-		     }
-		}
+        /**
+         * This is used to get the cache data using the key
+         * @param  string $key the key to identify the cache data
+         * @return mixed      the cache data if exists else return false
+         */
+        public function get($key){
+            $this->logger->debug('Getting cache data for key ['. $key .']');
+            $filePath = $this->getFilePath($key);
+            if(! file_exists($filePath)){
+                $this->logger->info('No cache file found for the key ['. $key .'], return false');
+                return false;
+            }
+            $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
+            $handle = fopen($filePath,'r');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            // Getting a shared lock 
+            flock($handle, LOCK_SH);
+            $data = file_get_contents($filePath);
+                fclose($handle);
+                $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                if (! $data) {
+                    $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
+                    // If unserializing somehow didn't work out, we'll delete the file
+                    unlink($filePath);
+                    return false;
+                }
+                if (time() > $data['expire']) {
+                    $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
+                // Unlinking when the file was expired
+                unlink($filePath);
+                return false;
+                }
+                else{
+                    $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
+                    return $data['data'];
+                }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0){
-			$expire = time() + $ttl;
-			$this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-			$filePath = $this->getFilePath($key);
-			$handle = fopen($filePath,'w');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
-			//Serializing along with the TTL
-		    $cacheData = serialize(array(
-									'mtime' => time(),
-									'expire' => $expire,
-									'data' => $data,
-									'ttl' => $ttl
-									)
-								);		   
-		    $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
-		    if(! $result){
-		    	$this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
-		    	fclose($handle);
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
-		    	fclose($handle);
-				chmod($filePath, 0640);
-				return true;
-		    }
-		}	
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0){
+            $expire = time() + $ttl;
+            $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+            $filePath = $this->getFilePath($key);
+            $handle = fopen($filePath,'w');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
+            //Serializing along with the TTL
+            $cacheData = serialize(array(
+                                    'mtime' => time(),
+                                    'expire' => $expire,
+                                    'data' => $data,
+                                    'ttl' => $ttl
+                                    )
+                                );		   
+            $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
+            if(! $result){
+                $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
+                fclose($handle);
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
+                fclose($handle);
+                chmod($filePath, 0640);
+                return true;
+            }
+        }	
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is delete, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] remove it');
-	      		unlink($filePath);
-				return true;
-			}
-		}
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is delete, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key){
+            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache file [' .$filePath. '] remove it');
+                    unlink($filePath);
+                return true;
+            }
+        }
 		
-		/**
-		 * Get the cache information for given key
-		 * @param  string $key the key for cache to get the information for
-		 * @return boolean|array    the cache information. The associative array and must contains the following information:
-		 * 'mtime' => creation time of the cache (Unix timestamp),
-		 * 'expire' => expiration time of the cache (Unix timestamp),
-		 * 'ttl' => the time to live of the cache in second
-		 */
-		public function getInfo($key){
-			$this->logger->debug('Getting of cache info for key [' .$key. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] check the validity');
-	      		$data = file_get_contents($filePath);
-				$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-				if(! $data){
-					$this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
-					return false;
-				}
-				else{
-					$this->logger->info('This cache data is OK check for expire');
-					if(isset($data['expire']) && $data['expire'] > time()){
-						$this->logger->info('This cache not yet expired return cache informations');
-						$info = array(
-							'mtime' => $data['mtime'],
-							'expire' => $data['expire'],
-							'ttl' => $data['ttl']
-							);
-						return $info;
-					}
-					else{
-						$this->logger->info('This cache already expired return false');
-						return false;
-					}
-				}
-			}
-		}
+        /**
+         * Get the cache information for given key
+         * @param  string $key the key for cache to get the information for
+         * @return boolean|array    the cache information. The associative array and must contains the following information:
+         * 'mtime' => creation time of the cache (Unix timestamp),
+         * 'expire' => expiration time of the cache (Unix timestamp),
+         * 'ttl' => the time to live of the cache in second
+         */
+        public function getInfo($key){
+            $this->logger->debug('Getting of cache info for key [' .$key. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache file [' .$filePath. '] check the validity');
+                    $data = file_get_contents($filePath);
+                $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                if(! $data){
+                    $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
+                    return false;
+                }
+                else{
+                    $this->logger->info('This cache data is OK check for expire');
+                    if(isset($data['expire']) && $data['expire'] > time()){
+                        $this->logger->info('This cache not yet expired return cache informations');
+                        $info = array(
+                            'mtime' => $data['mtime'],
+                            'expire' => $data['expire'],
+                            'ttl' => $data['ttl']
+                            );
+                        return $info;
+                    }
+                    else{
+                        $this->logger->info('This cache already expired return false');
+                        return false;
+                    }
+                }
+            }
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			$this->logger->debug('Deleting of expired cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					$data = file_get_contents($file);
-		      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-		      		if(! $data){
-		      			$this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
-		      		}
-		      		else if(time() > $data['expire']){
-		      			$this->logger->info('The cache data for file [' . $file . '] already expired remove it');
-		      			unlink($file);
-		      		}
-		      		else{
-		      			$this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
-		      		}
-				}
-			}
-		}	
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            $this->logger->debug('Deleting of expired cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    $data = file_get_contents($file);
+                        $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                        if(! $data){
+                            $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
+                        }
+                        else if(time() > $data['expire']){
+                            $this->logger->info('The cache data for file [' . $file . '] already expired remove it');
+                            unlink($file);
+                        }
+                        else{
+                            $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
+                        }
+                }
+            }
+        }	
 
-		/**
-		 * Remove all file from cache folder
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					unlink($file);
-				}
-			}
-		}
+        /**
+         * Remove all file from cache folder
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    unlink($file);
+                }
+            }
+        }
 	
-	    /**
-	     * @return boolean
-	     */
-	    public function isCompressCacheData(){
-	        return $this->compressCacheData;
-	    }
+        /**
+         * @return boolean
+         */
+        public function isCompressCacheData(){
+            return $this->compressCacheData;
+        }
 
-	    /**
-	     * @param boolean $compressCacheData
-	     *
-	     * @return object
-	     */
-	    public function setCompressCacheData($status = true){
-			//if Zlib extension is not loaded set compressCacheData to false
-			if($status === true && ! extension_loaded('zlib')){
+        /**
+         * @param boolean $compressCacheData
+         *
+         * @return object
+         */
+        public function setCompressCacheData($status = true){
+            //if Zlib extension is not loaded set compressCacheData to false
+            if($status === true && ! extension_loaded('zlib')){
 				
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-			else{
-				$this->compressCacheData = $status;
-			}
-			return $this;
-	    }
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+            else{
+                $this->compressCacheData = $status;
+            }
+            return $this;
+        }
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
+        }
 
-		/**
-	     * Return the Log instance
-	     * @return object
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
+        /**
+         * Return the Log instance
+         * @return object
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
 
-	    /**
-	     * Set the log instance
-	     * @param Log $logger the log object
-	     */
-	    public function setLogger(Log $logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
+        /**
+         * Set the log instance
+         * @param Log $logger the log object
+         */
+        public function setLogger(Log $logger){
+            $this->logger = $logger;
+            return $this;
+        }
 		
-		/**
-		* Get the cache file full path for the given key
-		*
-		* @param string $key the cache item key
-		* @return string the full cache file path for this key
-		*/
-		private function getFilePath($key){
-			return CACHE_PATH . md5($key) . '.cache';
-		}
-	}
+        /**
+         * Get the cache file full path for the given key
+         *
+         * @param string $key the cache item key
+         * @return string the full cache file path for this key
+         */
+        private function getFilePath($key){
+            return CACHE_PATH . md5($key) . '.cache';
+        }
+    }

Spacing +62 added lines, -62 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class FileCache implements CacheInterface{
+	class FileCache implements CacheInterface {
 		
 		/**
 		 * Whether to enable compression of the cache data file.
@@ -39,23 +39,23 @@ 
 		private $logger;
 		
 		
-		public function __construct(Log $logger = null){
-			if(! $this->isSupported()){
+		public function __construct(Log $logger = null) {
+			if (!$this->isSupported()) {
 				show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
 			}
 			/**
 	         * instance of the Log class
 	         */
-	        if(is_object($logger)){
+	        if (is_object($logger)) {
 	          $this->logger = $logger;
 	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
+	        else {
+	            $this->logger = & class_loader('Log', 'classes');
 	            $this->logger->setLogger('Library::FileCache');
 	        }
 			
 			//if Zlib extension is not loaded set compressCacheData to false
-			if(! extension_loaded('zlib')){
+			if (!extension_loaded('zlib')) {
 				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
 				$this->compressCacheData = false;
 			}
@@ -66,17 +66,17 @@ 
 		 * @param  string $key the key to identify the cache data
 		 * @return mixed      the cache data if exists else return false
 		 */
-		public function get($key){
-			$this->logger->debug('Getting cache data for key ['. $key .']');
+		public function get($key) {
+			$this->logger->debug('Getting cache data for key [' . $key . ']');
 			$filePath = $this->getFilePath($key);
-			if(! file_exists($filePath)){
-				$this->logger->info('No cache file found for the key ['. $key .'], return false');
+			if (!file_exists($filePath)) {
+				$this->logger->info('No cache file found for the key [' . $key . '], return false');
 				return false;
 			}
-			$this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
-			$handle = fopen($filePath,'r');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+			$this->logger->info('The cache file [' . $filePath . '] for the key [' . $key . '] exists, check if the cache data is valid');
+			$handle = fopen($filePath, 'r');
+			if (!is_resource($handle)) {
+				$this->logger->error('Can not open the file cache [' . $filePath . '] for the key [' . $key . '], return false');
 				return false;
 			}
 			// Getting a shared lock 
@@ -84,20 +84,20 @@ 
 		    $data = file_get_contents($filePath);
       		fclose($handle);
       		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-      		if (! $data) {
-      			$this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
+      		if (!$data) {
+      			$this->logger->error('Can not unserialize the cache data for the key [' . $key . '], return false');
 		         // If unserializing somehow didn't work out, we'll delete the file
 		         unlink($filePath);
 		         return false;
 	      	}
 	      	if (time() > $data['expire']) {
-	      		$this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
+	      		$this->logger->info('The cache data for the key [' . $key . '] already expired delete the cache file [' . $filePath . ']');
 		        // Unlinking when the file was expired
 		        unlink($filePath);
 		        return false;
 		     }
-		     else{
-		     	$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
+		     else {
+		     	$this->logger->info('The cache not yet expire, now return the cache data for key [' . $key . '], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
 		     	return $data['data'];
 		     }
 		}
@@ -110,13 +110,13 @@ 
 		 * @param integer $ttl  the cache life time
 		 * @return boolean true if success otherwise will return false
 		 */
-		public function set($key, $data, $ttl = 0){
+		public function set($key, $data, $ttl = 0) {
 			$expire = time() + $ttl;
-			$this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+			$this->logger->debug('Setting cache data for key [' . $key . '], time to live [' . $ttl . '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
 			$filePath = $this->getFilePath($key);
-			$handle = fopen($filePath,'w');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+			$handle = fopen($filePath, 'w');
+			if (!is_resource($handle)) {
+				$this->logger->error('Can not open the file cache [' . $filePath . '] for the key [' . $key . '], return false');
 				return false;
 			}
 			flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
@@ -129,13 +129,13 @@ 
 									)
 								);		   
 		    $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
-		    if(! $result){
-		    	$this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
+		    if (!$result) {
+		    	$this->logger->error('Can not write cache data into file [' . $filePath . '] for the key [' . $key . '], return false');
 		    	fclose($handle);
 		    	return false;
 		    }
-		    else{
-		    	$this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
+		    else {
+		    	$this->logger->info('Cache data saved into file [' . $filePath . '] for the key [' . $key . ']');
 		    	fclose($handle);
 				chmod($filePath, 0640);
 				return true;
@@ -149,16 +149,16 @@ 
 		 * @return boolean      true if the cache is delete, false if can't delete 
 		 * the cache or the cache with the given key not exist
 		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
+		public function delete($key) {
+			$this->logger->debug('Deleting of cache data for key [' . $key . ']');
 			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
+			$this->logger->info('The file path for the key [' . $key . '] is [' . $filePath . ']');
+			if (!file_exists($filePath)) {
 				$this->logger->info('This cache file does not exists skipping');
 				return false;
 			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] remove it');
+			else {
+				$this->logger->info('Found cache file [' . $filePath . '] remove it');
 	      		unlink($filePath);
 				return true;
 			}
@@ -172,25 +172,25 @@ 
 		 * 'expire' => expiration time of the cache (Unix timestamp),
 		 * 'ttl' => the time to live of the cache in second
 		 */
-		public function getInfo($key){
-			$this->logger->debug('Getting of cache info for key [' .$key. ']');
+		public function getInfo($key) {
+			$this->logger->debug('Getting of cache info for key [' . $key . ']');
 			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
+			$this->logger->info('The file path for the key [' . $key . '] is [' . $filePath . ']');
+			if (!file_exists($filePath)) {
 				$this->logger->info('This cache file does not exists skipping');
 				return false;
 			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] check the validity');
+			else {
+				$this->logger->info('Found cache file [' . $filePath . '] check the validity');
 	      		$data = file_get_contents($filePath);
 				$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-				if(! $data){
+				if (!$data) {
 					$this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
 					return false;
 				}
-				else{
+				else {
 					$this->logger->info('This cache data is OK check for expire');
-					if(isset($data['expire']) && $data['expire'] > time()){
+					if (isset($data['expire']) && $data['expire'] > time()) {
 						$this->logger->info('This cache not yet expired return cache informations');
 						$info = array(
 							'mtime' => $data['mtime'],
@@ -199,7 +199,7 @@ 
 							);
 						return $info;
 					}
-					else{
+					else {
 						$this->logger->info('This cache already expired return false');
 						return false;
 					}
@@ -211,26 +211,26 @@ 
 		/**
 		 * Used to delete expired cache data
 		 */
-		public function deleteExpiredCache(){
+		public function deleteExpiredCache() {
 			$this->logger->debug('Deleting of expired cache files');
 			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
+			if (!$list) {
 				$this->logger->info('No cache files were found skipping');
 			}
-			else{
+			else {
 				$this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
 				foreach ($list as $file) {
 					$this->logger->debug('Processing the cache file [' . $file . ']');
 					$data = file_get_contents($file);
 		      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-		      		if(! $data){
+		      		if (!$data) {
 		      			$this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
 		      		}
-		      		else if(time() > $data['expire']){
+		      		else if (time() > $data['expire']) {
 		      			$this->logger->info('The cache data for file [' . $file . '] already expired remove it');
 		      			unlink($file);
 		      		}
-		      		else{
+		      		else {
 		      			$this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
 		      		}
 				}
@@ -240,13 +240,13 @@ 
 		/**
 		 * Remove all file from cache folder
 		 */
-		public function clean(){
+		public function clean() {
 			$this->logger->debug('Deleting of all cache files');
 			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
+			if (!$list) {
 				$this->logger->info('No cache files were found skipping');
 			}
-			else{
+			else {
 				$this->logger->info('Found [' . count($list) . '] cache files to remove');
 				foreach ($list as $file) {
 					$this->logger->debug('Processing the cache file [' . $file . ']');
@@ -258,7 +258,7 @@ 
 	    /**
 	     * @return boolean
 	     */
-	    public function isCompressCacheData(){
+	    public function isCompressCacheData() {
 	        return $this->compressCacheData;
 	    }
 
@@ -267,14 +267,14 @@ 
 	     *
 	     * @return object
 	     */
-	    public function setCompressCacheData($status = true){
+	    public function setCompressCacheData($status = true) {
 			//if Zlib extension is not loaded set compressCacheData to false
-			if($status === true && ! extension_loaded('zlib')){
+			if ($status === true && !extension_loaded('zlib')) {
 				
 				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
 				$this->compressCacheData = false;
 			}
-			else{
+			else {
 				$this->compressCacheData = $status;
 			}
 			return $this;
@@ -285,7 +285,7 @@ 
 		 *
 		 * @return bool
 		 */
-		public function isSupported(){
+		public function isSupported() {
 			return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
 		}
 
@@ -293,7 +293,7 @@ 
 	     * Return the Log instance
 	     * @return object
 	     */
-	    public function getLogger(){
+	    public function getLogger() {
 	      return $this->logger;
 	    }
 
@@ -301,7 +301,7 @@ 
 	     * Set the log instance
 	     * @param Log $logger the log object
 	     */
-	    public function setLogger(Log $logger){
+	    public function setLogger(Log $logger) {
 	      $this->logger = $logger;
 	      return $this;
 	    }
@@ -312,7 +312,7 @@ 
 		* @param string $key the cache item key
 		* @return string the full cache file path for this key
 		*/
-		private function getFilePath($key){
+		private function getFilePath($key) {
 			return CACHE_PATH . md5($key) . '.cache';
 		}
 	}

core/classes/Router.php

Indentation +378 added lines, -378 removed lines

@@ -1,393 +1,393 @@ 
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Router {
+    class Router {
 		
-		/**
-		* @var array $pattern: The list of URIs to validate against
-		*/
-		private $pattern = array();
+        /**
+         * @var array $pattern: The list of URIs to validate against
+         */
+        private $pattern = array();
 
-		/**
-		* @var array $callback: The list of callback to call
-		*/
-		private $callback = array();
+        /**
+         * @var array $callback: The list of callback to call
+         */
+        private $callback = array();
 
-		/**
-		* @var string $uriTrim: The char to remove from the URIs
-		*/
-		protected $uriTrim = '/\^$';
+        /**
+         * @var string $uriTrim: The char to remove from the URIs
+         */
+        protected $uriTrim = '/\^$';
 
-		/**
-		 * The module name of the current request
-		 * @var string
-		 */
-		protected $module = null;
+        /**
+         * The module name of the current request
+         * @var string
+         */
+        protected $module = null;
 		
-		/**
-		 * The controller name of the current request
-		 * @var string
-		 */
-		protected $controller = null;
+        /**
+         * The controller name of the current request
+         * @var string
+         */
+        protected $controller = null;
 
-		/**
-		 * The controller path
-		 * @var string
-		 */
-		protected $controllerPath = null;
+        /**
+         * The controller path
+         * @var string
+         */
+        protected $controllerPath = null;
 
-		/**
-		 * The method name. The default value is "index"
-		 * @var string
-		 */
-		protected $method = 'index';
+        /**
+         * The method name. The default value is "index"
+         * @var string
+         */
+        protected $method = 'index';
 
-		/**
-		 * List of argument to pass to the method
-		 * @var array
-		 */
-		protected $args = array();
+        /**
+         * List of argument to pass to the method
+         * @var array
+         */
+        protected $args = array();
 
-		/**
-		 * List of routes configurations
-		 * @var array
-		 */
-		protected $routes = array();
+        /**
+         * List of routes configurations
+         * @var array
+         */
+        protected $routes = array();
 
-		/**
-		 * The segments array for the current request
-		 * @var array
-		 */
-		protected $segments;
+        /**
+         * The segments array for the current request
+         * @var array
+         */
+        protected $segments;
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 
-		/**
-		 * Construct the new Router instance
-		 */
-		public function __construct(){
-			$this->setLoggerFromParamOrCreateNewInstance(null);
+        /**
+         * Construct the new Router instance
+         */
+        public function __construct(){
+            $this->setLoggerFromParamOrCreateNewInstance(null);
 			
-			//loading routes for module
-			$moduleRouteList = array();
-			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
-				$moduleRouteList = $modulesRoutes;
-				unset($modulesRoutes);
-			}
-			$this->setRouteConfiguration($moduleRouteList);
-			$this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
+            //loading routes for module
+            $moduleRouteList = array();
+            $modulesRoutes = Module::getModulesRoutes();
+            if($modulesRoutes && is_array($modulesRoutes)){
+                $moduleRouteList = $modulesRoutes;
+                unset($modulesRoutes);
+            }
+            $this->setRouteConfiguration($moduleRouteList);
+            $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
 
-			//Set route parameters
-			$this->setRouteParams();
-		}
+            //Set route parameters
+            $this->setRouteParams();
+        }
 
-		/**
-		* Add the URI and callback to the list of URIs to validate
-		*
-		* @param string $uri the request URI
-		* @param object $callback the callback function
-		*/
-		public function add($uri, $callback) {
-			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
-				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
-			}
-			$this->pattern[] = $uri;
-			$this->callback[] = $callback;
-		}
+        /**
+         * Add the URI and callback to the list of URIs to validate
+         *
+         * @param string $uri the request URI
+         * @param object $callback the callback function
+         */
+        public function add($uri, $callback) {
+            $uri = trim($uri, $this->uriTrim);
+            if(in_array($uri, $this->pattern)){
+                $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
+            }
+            $this->pattern[] = $uri;
+            $this->callback[] = $callback;
+        }
 
-		/**
-		 * Get the module name
-		 * @return string
-		 */
-		public function getModule(){
-			return $this->module;
-		}
+        /**
+         * Get the module name
+         * @return string
+         */
+        public function getModule(){
+            return $this->module;
+        }
 		
-		/**
-		 * Get the controller name
-		 * @return string
-		 */
-		public function getController(){
-			return $this->controller;
-		}
+        /**
+         * Get the controller name
+         * @return string
+         */
+        public function getController(){
+            return $this->controller;
+        }
 
-		/**
-		 * Get the controller file path
-		 * @return string
-		 */
-		public function getControllerPath(){
-			return $this->controllerPath;
-		}
+        /**
+         * Get the controller file path
+         * @return string
+         */
+        public function getControllerPath(){
+            return $this->controllerPath;
+        }
 
-		/**
-		 * Get the controller method
-		 * @return string
-		 */
-		public function getMethod(){
-			return $this->method;
-		}
+        /**
+         * Get the controller method
+         * @return string
+         */
+        public function getMethod(){
+            return $this->method;
+        }
 
-		/**
-		 * Get the request arguments
-		 * @return array
-		 */
-		public function getArgs(){
-			return $this->args;
-		}
+        /**
+         * Get the request arguments
+         * @return array
+         */
+        public function getArgs(){
+            return $this->args;
+        }
 
-		/**
-		 * Get the URL segments array
-		 * @return array
-		 */
-		public function getSegments(){
-			return $this->segments;
-		}
+        /**
+         * Get the URL segments array
+         * @return array
+         */
+        public function getSegments(){
+            return $this->segments;
+        }
 
-		/**
-		 * Routing the request to the correspondant module/controller/method if exists
-		 * otherwise send 404 error.
-		 */
-		public function run() {
-			$benchmark =& class_loader('Benchmark');
-			$benchmark->mark('ROUTING_PROCESS_START');
-			$this->logger->debug('Routing process start ...');
-			$segment = $this->segments;
-			$baseUrl = get_config('base_url');
-			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
-				$this->logger->info('The request URI contains the front controller');
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			else{
-				$this->logger->info('The request URI does not contain the front controller');
-			}
-			$uri = implode('/', $segment);
-			$this->logger->info('The final Request URI is [' . $uri . ']' );
-			//generic routes
-			$pattern = array(':num', ':alpha', ':alnum', ':any');
-			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
-			$this->logger->debug('Begin to loop in the predefined routes configuration to check if the current request match');
-			// Cycle through the URIs stored in the array
-			foreach ($this->pattern as $index => $uriList) {
-				$uriList = str_ireplace($pattern, $replace, $uriList);
-				// Check for an existant matching URI
-				if (preg_match("#^$uriList$#", $uri, $args)) {
-					$this->logger->info('Route found for request URI [' . $uri . '] using the predefined configuration [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']');
-					array_shift($args);
-					//check if this contains an module
-					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
-						$this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
-						$this->module = $moduleControllerMethod[0];
-						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
-						$this->logger->info('The current request does not use the module');
-						$moduleControllerMethod = explode('@', $this->callback[$index]);
-					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
-							$this->controller = $moduleControllerMethod[0];	
-						}
-						if(isset($moduleControllerMethod[1])){
-							$this->method = $moduleControllerMethod[1];
-						}
-						$this->args = $args;
-					}
-					// stop here
-					break;
-				}
-			}
-			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->getController() && $this->getModule()){
-				$this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller');
-				$this->controller = $this->getModule();
-			}
-			//if can not determine the module/controller/method via the defined routes configuration we will use
-			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->getController()){
-				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
-				$nbSegment = count($segment);
-				//if segment is null so means no need to perform
-				if($nbSegment > 0){
-					//get the module list
-					$modules = Module::getModuleList();
-					//first check if no module
-					if(! $modules){
-						$this->logger->info('No module was loaded will skip the module checking');
-						//the application don't use module
-						//controller
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							array_shift($segment);
-						}
-						//method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//args
-						$this->args = $segment;
-					}
-					else{
-						$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-						if(in_array($segment[0], $modules)){
-							$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
-							$this->module = $segment[0];
-							array_shift($segment);
-							//check if the second arg is the controller from module
-							if(isset($segment[0])){
-								$this->controller = $segment[0];
-								//check if the request use the same module name and controller
-								$path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-								if(! $path){
-									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
-									$this->controller = $this->getModule();
-								}
-								else{
-									$this->controllerPath = $path;
-									array_shift($segment);
-								}
-							}
-							//check for method
-							if(isset($segment[0])){
-								$this->method = $segment[0];
-								array_shift($segment);
-							}
-							//the remaining is for args
-							$this->args = $segment;
-						}
-						else{
-							$this->logger->info('The current request information is not found in the module list');
-							//controller
-							if(isset($segment[0])){
-								$this->controller = $segment[0];
-								array_shift($segment);
-							}
-							//method
-							if(isset($segment[0])){
-								$this->method = $segment[0];
-								array_shift($segment);
-							}
-							//args
-							$this->args = $segment;
-						}
-					}
-				}
-			}
-			if(! $this->getController() && $this->getModule()){
-				$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
-				$this->controller = $this->getModule();
-			}
-			//did we set the controller, so set the controller path
-			if($this->getController() && ! $this->getControllerPath()){
-				$this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
-				//if it is the module controller
-				if($this->getModule()){
-					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-				}
-				else{
-					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
-				}
-			}
-			$controller = ucfirst($this->getController());
-			$this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
-			$classFilePath = $this->getControllerPath();
-			$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
-			$benchmark->mark('ROUTING_PROCESS_END');
-			$e404 = false;
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(! class_exists($controller, false)){
-					$e404 = true;
-					$this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
-					$controllerInstance = new $controller();
-					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
-						$e404 = true;
-						$this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
-						$this->logger->info('Routing data is set correctly now GO!');
-						call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
-						$obj = & get_instance();
-						//render the final page to user
-						$this->logger->info('Render the final output to the browser');
-						$obj->response->renderFinalPage();
-					}
-				}
-			}
-			else{
-				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
-				$e404 = true;
-			}
-			if($e404){
-				$response =& class_loader('Response', 'classes');
-				$response->send404();
-			}
-		}
+        /**
+         * Routing the request to the correspondant module/controller/method if exists
+         * otherwise send 404 error.
+         */
+        public function run() {
+            $benchmark =& class_loader('Benchmark');
+            $benchmark->mark('ROUTING_PROCESS_START');
+            $this->logger->debug('Routing process start ...');
+            $segment = $this->segments;
+            $baseUrl = get_config('base_url');
+            //check if the app is not in DOCUMENT_ROOT
+            if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            $this->logger->debug('Check if the request URI contains the front controller');
+            if(isset($segment[0]) && $segment[0] == SELF){
+                $this->logger->info('The request URI contains the front controller');
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            else{
+                $this->logger->info('The request URI does not contain the front controller');
+            }
+            $uri = implode('/', $segment);
+            $this->logger->info('The final Request URI is [' . $uri . ']' );
+            //generic routes
+            $pattern = array(':num', ':alpha', ':alnum', ':any');
+            $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
+            $this->logger->debug('Begin to loop in the predefined routes configuration to check if the current request match');
+            // Cycle through the URIs stored in the array
+            foreach ($this->pattern as $index => $uriList) {
+                $uriList = str_ireplace($pattern, $replace, $uriList);
+                // Check for an existant matching URI
+                if (preg_match("#^$uriList$#", $uri, $args)) {
+                    $this->logger->info('Route found for request URI [' . $uri . '] using the predefined configuration [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']');
+                    array_shift($args);
+                    //check if this contains an module
+                    $moduleControllerMethod = explode('#', $this->callback[$index]);
+                    if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+                        $this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
+                        $this->module = $moduleControllerMethod[0];
+                        $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
+                    }
+                    else{
+                        $this->logger->info('The current request does not use the module');
+                        $moduleControllerMethod = explode('@', $this->callback[$index]);
+                    }
+                    if(is_array($moduleControllerMethod)){
+                        if(isset($moduleControllerMethod[0])){
+                            $this->controller = $moduleControllerMethod[0];	
+                        }
+                        if(isset($moduleControllerMethod[1])){
+                            $this->method = $moduleControllerMethod[1];
+                        }
+                        $this->args = $args;
+                    }
+                    // stop here
+                    break;
+                }
+            }
+            //first if the controller is not set and the module is set use the module name as the controller
+            if(! $this->getController() && $this->getModule()){
+                $this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller');
+                $this->controller = $this->getModule();
+            }
+            //if can not determine the module/controller/method via the defined routes configuration we will use
+            //the URL like http://domain.com/module/controller/method/arg1/arg2
+            if(! $this->getController()){
+                $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
+                $nbSegment = count($segment);
+                //if segment is null so means no need to perform
+                if($nbSegment > 0){
+                    //get the module list
+                    $modules = Module::getModuleList();
+                    //first check if no module
+                    if(! $modules){
+                        $this->logger->info('No module was loaded will skip the module checking');
+                        //the application don't use module
+                        //controller
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            array_shift($segment);
+                        }
+                        //method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //args
+                        $this->args = $segment;
+                    }
+                    else{
+                        $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
+                        if(in_array($segment[0], $modules)){
+                            $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
+                            $this->module = $segment[0];
+                            array_shift($segment);
+                            //check if the second arg is the controller from module
+                            if(isset($segment[0])){
+                                $this->controller = $segment[0];
+                                //check if the request use the same module name and controller
+                                $path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
+                                if(! $path){
+                                    $this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
+                                    $this->controller = $this->getModule();
+                                }
+                                else{
+                                    $this->controllerPath = $path;
+                                    array_shift($segment);
+                                }
+                            }
+                            //check for method
+                            if(isset($segment[0])){
+                                $this->method = $segment[0];
+                                array_shift($segment);
+                            }
+                            //the remaining is for args
+                            $this->args = $segment;
+                        }
+                        else{
+                            $this->logger->info('The current request information is not found in the module list');
+                            //controller
+                            if(isset($segment[0])){
+                                $this->controller = $segment[0];
+                                array_shift($segment);
+                            }
+                            //method
+                            if(isset($segment[0])){
+                                $this->method = $segment[0];
+                                array_shift($segment);
+                            }
+                            //args
+                            $this->args = $segment;
+                        }
+                    }
+                }
+            }
+            if(! $this->getController() && $this->getModule()){
+                $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
+                $this->controller = $this->getModule();
+            }
+            //did we set the controller, so set the controller path
+            if($this->getController() && ! $this->getControllerPath()){
+                $this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
+                //if it is the module controller
+                if($this->getModule()){
+                    $this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
+                }
+                else{
+                    $this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
+                }
+            }
+            $controller = ucfirst($this->getController());
+            $this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
+            $classFilePath = $this->getControllerPath();
+            $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
+            $benchmark->mark('ROUTING_PROCESS_END');
+            $e404 = false;
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(! class_exists($controller, false)){
+                    $e404 = true;
+                    $this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+                }
+                else{
+                    $controllerInstance = new $controller();
+                    $controllerMethod = $this->getMethod();
+                    if(! method_exists($controllerInstance, $controllerMethod)){
+                        $e404 = true;
+                        $this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
+                    }
+                    else{
+                        $this->logger->info('Routing data is set correctly now GO!');
+                        call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
+                        $obj = & get_instance();
+                        //render the final page to user
+                        $this->logger->info('Render the final output to the browser');
+                        $obj->response->renderFinalPage();
+                    }
+                }
+            }
+            else{
+                $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
+                $e404 = true;
+            }
+            if($e404){
+                $response =& class_loader('Response', 'classes');
+                $response->send404();
+            }
+        }
 
-	/**
+    /**
      * Return the Log instance
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object
+     * @return object
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
 
     /**
-    * Setting the route configuration using the configuration file and additional configuration from param
-    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-    * @param boolean $useConfigFile whether to use route configuration file
-	* @return object
-    */
+     * Setting the route configuration using the configuration file and additional configuration from param
+     * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+     * @param boolean $useConfigFile whether to use route configuration file
+     * @return object
+     */
     public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
         $route = array();
         if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
@@ -395,45 +395,45 @@ 
         }
         $route = array_merge($route, $overwriteConfig);
         $this->routes = $route;
-		return $this;
+        return $this;
     }
 
     /**
      * Set the route paramaters using the configuration
      */
     protected function setRouteParams(){
-    	//adding route
-		foreach($this->routes as $pattern => $callback){
-			$this->add($pattern, $callback);
-		}
+        //adding route
+        foreach($this->routes as $pattern => $callback){
+            $this->add($pattern, $callback);
+        }
 		
-		//here use directly the variable $_SERVER
-		$uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
-		$this->logger->debug('Check if URL suffix is enabled in the configuration');
-		//remove url suffix from the request URI
-		$suffix = get_config('url_suffix');
-		if ($suffix) {
-			$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
-			$uri = str_ireplace($suffix, '', $uri);
-		} 
-		if (strpos($uri, '?') !== false){
-			$uri = substr($uri, 0, strpos($uri, '?'));
-		}
-		$uri = trim($uri, $this->uriTrim);
-		$this->segments = explode('/', $uri);
-	}
+        //here use directly the variable $_SERVER
+        $uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
+        $this->logger->debug('Check if URL suffix is enabled in the configuration');
+        //remove url suffix from the request URI
+        $suffix = get_config('url_suffix');
+        if ($suffix) {
+            $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+            $uri = str_ireplace($suffix, '', $uri);
+        } 
+        if (strpos($uri, '?') !== false){
+            $uri = substr($uri, 0, strpos($uri, '?'));
+        }
+        $uri = trim($uri, $this->uriTrim);
+        $this->segments = explode('/', $uri);
+    }
 
-	/**
+    /**
      * Set the Log instance using argument or create new instance
      * @param object $logger the Log instance if not null
      */
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::Router');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Router');
+        }
     }
 }

Spacing +60 added lines, -60 removed lines

@@ -92,13 +92,13 @@ 
 		/**
 		 * Construct the new Router instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$this->setLoggerFromParamOrCreateNewInstance(null);
 			
 			//loading routes for module
 			$moduleRouteList = array();
 			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
+			if ($modulesRoutes && is_array($modulesRoutes)) {
 				$moduleRouteList = $modulesRoutes;
 				unset($modulesRoutes);
 			}
@@ -117,7 +117,7 @@ 
 		*/
 		public function add($uri, $callback) {
 			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
+			if (in_array($uri, $this->pattern)) {
 				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
 			}
 			$this->pattern[] = $uri;
@@ -128,7 +128,7 @@ 
 		 * Get the module name
 		 * @return string
 		 */
-		public function getModule(){
+		public function getModule() {
 			return $this->module;
 		}
 		
@@ -136,7 +136,7 @@ 
 		 * Get the controller name
 		 * @return string
 		 */
-		public function getController(){
+		public function getController() {
 			return $this->controller;
 		}
 
@@ -144,7 +144,7 @@ 
 		 * Get the controller file path
 		 * @return string
 		 */
-		public function getControllerPath(){
+		public function getControllerPath() {
 			return $this->controllerPath;
 		}
 
@@ -152,7 +152,7 @@ 
 		 * Get the controller method
 		 * @return string
 		 */
-		public function getMethod(){
+		public function getMethod() {
 			return $this->method;
 		}
 
@@ -160,7 +160,7 @@ 
 		 * Get the request arguments
 		 * @return array
 		 */
-		public function getArgs(){
+		public function getArgs() {
 			return $this->args;
 		}
 
@@ -168,7 +168,7 @@ 
 		 * Get the URL segments array
 		 * @return array
 		 */
-		public function getSegments(){
+		public function getSegments() {
 			return $this->segments;
 		}
 
@@ -177,27 +177,27 @@ 
 		 * otherwise send 404 error.
 		 */
 		public function run() {
-			$benchmark =& class_loader('Benchmark');
+			$benchmark = & class_loader('Benchmark');
 			$benchmark->mark('ROUTING_PROCESS_START');
 			$this->logger->debug('Routing process start ...');
 			$segment = $this->segments;
 			$baseUrl = get_config('base_url');
 			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){
+			if (isset($segment[0]) && stripos($baseUrl, $segment[0]) != false) {
 				array_shift($segment);
 				$this->segments = $segment;
 			}
 			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
+			if (isset($segment[0]) && $segment[0] == SELF) {
 				$this->logger->info('The request URI contains the front controller');
 				array_shift($segment);
 				$this->segments = $segment;
 			}
-			else{
+			else {
 				$this->logger->info('The request URI does not contain the front controller');
 			}
 			$uri = implode('/', $segment);
-			$this->logger->info('The final Request URI is [' . $uri . ']' );
+			$this->logger->info('The final Request URI is [' . $uri . ']');
 			//generic routes
 			$pattern = array(':num', ':alpha', ':alnum', ':any');
 			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
@@ -211,20 +211,20 @@ 
 					array_shift($args);
 					//check if this contains an module
 					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
-						$this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
+					if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) {
+						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
 					}
-					else{
+					else {
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
+					if (is_array($moduleControllerMethod)) {
+						if (isset($moduleControllerMethod[0])) {
 							$this->controller = $moduleControllerMethod[0];	
 						}
-						if(isset($moduleControllerMethod[1])){
+						if (isset($moduleControllerMethod[1])) {
 							$this->method = $moduleControllerMethod[1];
 						}
 						$this->args = $args;
@@ -234,73 +234,73 @@ 
 				}
 			}
 			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->getController() && $this->getModule()){
+			if (!$this->getController() && $this->getModule()) {
 				$this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller');
 				$this->controller = $this->getModule();
 			}
 			//if can not determine the module/controller/method via the defined routes configuration we will use
 			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->getController()){
+			if (!$this->getController()) {
 				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
 				$nbSegment = count($segment);
 				//if segment is null so means no need to perform
-				if($nbSegment > 0){
+				if ($nbSegment > 0) {
 					//get the module list
 					$modules = Module::getModuleList();
 					//first check if no module
-					if(! $modules){
+					if (!$modules) {
 						$this->logger->info('No module was loaded will skip the module checking');
 						//the application don't use module
 						//controller
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->controller = $segment[0];
 							array_shift($segment);
 						}
 						//method
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->method = $segment[0];
 							array_shift($segment);
 						}
 						//args
 						$this->args = $segment;
 					}
-					else{
+					else {
 						$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-						if(in_array($segment[0], $modules)){
+						if (in_array($segment[0], $modules)) {
 							$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
 							$this->module = $segment[0];
 							array_shift($segment);
 							//check if the second arg is the controller from module
-							if(isset($segment[0])){
+							if (isset($segment[0])) {
 								$this->controller = $segment[0];
 								//check if the request use the same module name and controller
 								$path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-								if(! $path){
+								if (!$path) {
 									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
 									$this->controller = $this->getModule();
 								}
-								else{
+								else {
 									$this->controllerPath = $path;
 									array_shift($segment);
 								}
 							}
 							//check for method
-							if(isset($segment[0])){
+							if (isset($segment[0])) {
 								$this->method = $segment[0];
 								array_shift($segment);
 							}
 							//the remaining is for args
 							$this->args = $segment;
 						}
-						else{
+						else {
 							$this->logger->info('The current request information is not found in the module list');
 							//controller
-							if(isset($segment[0])){
+							if (isset($segment[0])) {
 								$this->controller = $segment[0];
 								array_shift($segment);
 							}
 							//method
-							if(isset($segment[0])){
+							if (isset($segment[0])) {
 								$this->method = $segment[0];
 								array_shift($segment);
 							}
@@ -310,18 +310,18 @@ 
 					}
 				}
 			}
-			if(! $this->getController() && $this->getModule()){
+			if (!$this->getController() && $this->getModule()) {
 				$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
 				$this->controller = $this->getModule();
 			}
 			//did we set the controller, so set the controller path
-			if($this->getController() && ! $this->getControllerPath()){
+			if ($this->getController() && !$this->getControllerPath()) {
 				$this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
 				//if it is the module controller
-				if($this->getModule()){
+				if ($this->getModule()) {
 					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
 				}
-				else{
+				else {
 					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
 				}
 			}
@@ -331,20 +331,20 @@ 
 			$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 			$benchmark->mark('ROUTING_PROCESS_END');
 			$e404 = false;
-			if(file_exists($classFilePath)){
+			if (file_exists($classFilePath)) {
 				require_once $classFilePath;
-				if(! class_exists($controller, false)){
+				if (!class_exists($controller, false)) {
 					$e404 = true;
-					$this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+					$this->logger->info('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']');
 				}
-				else{
+				else {
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
+					if (!method_exists($controllerInstance, $controllerMethod)) {
 						$e404 = true;
 						$this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
 					}
-					else{
+					else {
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
 						$obj = & get_instance();
@@ -354,12 +354,12 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
-			if($e404){
-				$response =& class_loader('Response', 'classes');
+			if ($e404) {
+				$response = & class_loader('Response', 'classes');
 				$response->send404();
 			}
 		}
@@ -368,7 +368,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -377,7 +377,7 @@ 
      * @param Log $logger the log object
 	 * @return object
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -388,9 +388,9 @@ 
     * @param boolean $useConfigFile whether to use route configuration file
 	* @return object
     */
-    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
         $route = array();
-        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')) {
             require_once CONFIG_PATH . 'routes.php';
         }
         $route = array_merge($route, $overwriteConfig);
@@ -401,9 +401,9 @@ 
     /**
      * Set the route paramaters using the configuration
      */
-    protected function setRouteParams(){
+    protected function setRouteParams() {
     	//adding route
-		foreach($this->routes as $pattern => $callback){
+		foreach ($this->routes as $pattern => $callback) {
 			$this->add($pattern, $callback);
 		}
 		
@@ -413,10 +413,10 @@ 
 		//remove url suffix from the request URI
 		$suffix = get_config('url_suffix');
 		if ($suffix) {
-			$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+			$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']');
 			$uri = str_ireplace($suffix, '', $uri);
 		} 
-		if (strpos($uri, '?') !== false){
+		if (strpos($uri, '?') !== false) {
 			$uri = substr($uri, 0, strpos($uri, '?'));
 		}
 		$uri = trim($uri, $this->uriTrim);
@@ -427,12 +427,12 @@ 
      * Set the Log instance using argument or create new instance
      * @param object $logger the Log instance if not null
      */
-    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) {
+      if ($logger !== null) {
         $this->logger = $logger;
       }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
+      else {
+          $this->logger = & class_loader('Log', 'classes');
           $this->logger->setLogger('Library::Router');
       }
     }

Braces +10 added lines, -20 removed lines

@@ -192,8 +192,7 @@ 
 				$this->logger->info('The request URI contains the front controller');
 				array_shift($segment);
 				$this->segments = $segment;
-			}
-			else{
+			} else{
 				$this->logger->info('The request URI does not contain the front controller');
 			}
 			$uri = implode('/', $segment);
@@ -215,8 +214,7 @@ 
 						$this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
+					} else{
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
@@ -263,8 +261,7 @@ 
 						}
 						//args
 						$this->args = $segment;
-					}
-					else{
+					} else{
 						$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
 						if(in_array($segment[0], $modules)){
 							$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
@@ -278,8 +275,7 @@ 
 								if(! $path){
 									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
 									$this->controller = $this->getModule();
-								}
-								else{
+								} else{
 									$this->controllerPath = $path;
 									array_shift($segment);
 								}
@@ -291,8 +287,7 @@ 
 							}
 							//the remaining is for args
 							$this->args = $segment;
-						}
-						else{
+						} else{
 							$this->logger->info('The current request information is not found in the module list');
 							//controller
 							if(isset($segment[0])){
@@ -320,8 +315,7 @@ 
 				//if it is the module controller
 				if($this->getModule()){
 					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-				}
-				else{
+				} else{
 					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
 				}
 			}
@@ -336,15 +330,13 @@ 
 				if(! class_exists($controller, false)){
 					$e404 = true;
 					$this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
+				} else{
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
 					if(! method_exists($controllerInstance, $controllerMethod)){
 						$e404 = true;
 						$this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
+					} else{
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
 						$obj = & get_instance();
@@ -353,8 +345,7 @@ 
 						$obj->response->renderFinalPage();
 					}
 				}
-			}
-			else{
+			} else{
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
@@ -430,8 +421,7 @@ 
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
       if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
+      } else{
           $this->logger =& class_loader('Log', 'classes');
           $this->logger->setLogger('Library::Router');
       }