tnhfw / tnh-fw

index.php

Indentation +235 added lines, -235 removed lines

@@ -1,267 +1,267 @@
 <?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.
+     */
 
-	/**
-	* 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);
+    /**
+     * 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);
 
-	/**
-	* 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);
 
-	/**
-	* The path to the application directory. 
-	*
-	* It contains your most often used files that is to say which contains your files of the application, 
-	* in MVC architecture (controllers, models, views).
-	*/
-	define('APPS_PATH', ROOT_PATH . 'classes' . DS);
+    /**
+     * The path to the application directory. 
+     *
+     * It contains your most often used files that is to say which contains your files of the application, 
+     * in MVC architecture (controllers, models, views).
+     */
+    define('APPS_PATH', ROOT_PATH . 'classes' . 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', ROOT_PATH . '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', ROOT_PATH . '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', 'development');
+    /**
+     * 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', 'development');
 
-	/* ---------------------------------------------------------------------------------- */
-	///////////////////////////////////////////////////////////////////////////////////////
-	/******************** DO NOT CHANGE THE LINES BELOW *********************************/
-	/////////////////////////////////////////////////////////////////////////////////////
+    /* ---------------------------------------------------------------------------------- */
+    ///////////////////////////////////////////////////////////////////////////////////////
+    /******************** DO NOT CHANGE THE LINES BELOW *********************************/
+    /////////////////////////////////////////////////////////////////////////////////////
 
-	switch (ENVIRONMENT) {
-		case 'development':
-			error_reporting(-1);
-			ini_set('display_errors', 1);
-		break;
-		case 'testing':
-		case 'production':
-			ini_set('display_errors', 0);
-			if (version_compare(PHP_VERSION, '5.3', '>=')) {
-				error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_STRICT & ~E_USER_NOTICE & ~E_USER_DEPRECATED);
-			}
-			else {
-				error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE);
-			}
-		break;
-		default:
-			header('HTTP/1.1 503 Service Unavailable.', TRUE, 503);
-			echo 'The application environment is not set correctly.';
-			exit(1);
-	}
+    switch (ENVIRONMENT) {
+        case 'development':
+            error_reporting(-1);
+            ini_set('display_errors', 1);
+        break;
+        case 'testing':
+        case 'production':
+            ini_set('display_errors', 0);
+            if (version_compare(PHP_VERSION, '5.3', '>=')) {
+                error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_STRICT & ~E_USER_NOTICE & ~E_USER_DEPRECATED);
+            }
+            else {
+                error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE);
+            }
+        break;
+        default:
+            header('HTTP/1.1 503 Service Unavailable.', TRUE, 503);
+            echo 'The application environment is not set correctly.';
+            exit(1);
+    }
 	
-	/**
-	* let's go.
-	* Everything is OK now we launch our application.
-	*/
-	require_once CORE_PATH . 'bootstrap.php';
\ No newline at end of file
+    /**
+     * let's go.
+     * Everything is OK now we launch our application.
+     */
+    require_once CORE_PATH . 'bootstrap.php';
\ No newline at end of file

Braces +1 added lines, -2 removed lines

@@ -249,8 +249,7 @@
 			ini_set('display_errors', 0);
 			if (version_compare(PHP_VERSION, '5.3', '>=')) {
 				error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED & ~E_STRICT & ~E_USER_NOTICE & ~E_USER_DEPRECATED);
-			}
-			else {
+			} else {
 				error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE);
 			}
 		break;

core/classes/Module.php

Indentation +225 added lines, -225 removed lines

@@ -22,251 +22,251 @@
      * 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 Module extends BaseStaticClass {
+    class Module extends BaseStaticClass {
 		
-		/**
-		 * list of loaded module
-		 * @var array
-		 */
-		private static $list = array();
+        /**
+         * list of loaded module
+         * @var array
+         */
+        private static $list = array();
 
-		/**
-		 * Initialise the module list by scanning the directory MODULE_PATH
-		 */
-		public function init(){
-			$logger = self::getLogger();
-			$logger->debug('Check if the application contains the modules ...');
-			$moduleDir = opendir(MODULE_PATH);
-			if (is_resource($moduleDir)){
-				while(($module = readdir($moduleDir)) !== false){
-					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
-						self::$list[] = $module;
-					} else{
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
-					}
-				}
-				closedir($moduleDir);
-			}
-			ksort(self::$list);
+        /**
+         * Initialise the module list by scanning the directory MODULE_PATH
+         */
+        public function init(){
+            $logger = self::getLogger();
+            $logger->debug('Check if the application contains the modules ...');
+            $moduleDir = opendir(MODULE_PATH);
+            if (is_resource($moduleDir)){
+                while(($module = readdir($moduleDir)) !== false){
+                    if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
+                        self::$list[] = $module;
+                    } else{
+                        $logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
+                    }
+                }
+                closedir($moduleDir);
+            }
+            ksort(self::$list);
 			
-			if (! empty(self::$list)){
-				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
-			}
-		}
+            if (! empty(self::$list)){
+                $logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
+            }
+        }
 		
 
-		/**
-		 * Add new module in the list
-		 * @param string $name the name of the module
-		 *
-		 * @return object the current instance
-		 */
-		public function add($name) {
-			self::$list[] = $name;
-			return $this;
-		}
+        /**
+         * Add new module in the list
+         * @param string $name the name of the module
+         *
+         * @return object the current instance
+         */
+        public function add($name) {
+            self::$list[] = $name;
+            return $this;
+        }
 		
-		/**
-		 * Get the list of the custom autoload configuration from module if exists
-		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
-		 */
-		public static function getModulesAutoloadConfig() {
-			$logger = self::getLogger();
-			if (empty(self::$list)) {
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$autoloads = array();
-			$autoloads['libraries'] = array();
-			$autoloads['config']    = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			$autoloads['languages'] = array();
+        /**
+         * Get the list of the custom autoload configuration from module if exists
+         * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
+         */
+        public static function getModulesAutoloadConfig() {
+            $logger = self::getLogger();
+            if (empty(self::$list)) {
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $autoloads = array();
+            $autoloads['libraries'] = array();
+            $autoloads['config']    = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            $autoloads['languages'] = array();
 			
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
-				if (file_exists($file)) {
-					$autoload = array();
-					require_once $file;
-					if (!empty($autoload) && is_array($autoload)) {
-						$autoloads = array_merge_recursive($autoloads, $autoload);
-						unset($autoload);
-					}
-				}
-			}
-			return $autoloads;
-		}
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
+                if (file_exists($file)) {
+                    $autoload = array();
+                    require_once $file;
+                    if (!empty($autoload) && is_array($autoload)) {
+                        $autoloads = array_merge_recursive($autoloads, $autoload);
+                        unset($autoload);
+                    }
+                }
+            }
+            return $autoloads;
+        }
 
-		/**
-		 * Get the list of the custom routes configuration from module if exists
-		 * @return array|boolean the routes list or false if no module contains the routes configuration
-		 */
-		public static function getModulesRoutesConfig() {
-			$logger = self::getLogger();
-			if (empty(self::$list)) {
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$routes = array();
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
-				if (file_exists($file)) {
-					$route = array();
-					require_once $file;
-					if (!empty($route) && is_array($route)) {
-						$routes = array_merge($routes, $route);
-						unset($route);
-					}
-				}
-			}
-			return $routes;
-		}
+        /**
+         * Get the list of the custom routes configuration from module if exists
+         * @return array|boolean the routes list or false if no module contains the routes configuration
+         */
+        public static function getModulesRoutesConfig() {
+            $logger = self::getLogger();
+            if (empty(self::$list)) {
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $routes = array();
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
+                if (file_exists($file)) {
+                    $route = array();
+                    require_once $file;
+                    if (!empty($route) && is_array($route)) {
+                        $routes = array_merge($routes, $route);
+                        unset($route);
+                    }
+                }
+            }
+            return $routes;
+        }
 
 
-		/**
-		 * Check if in module list can have this controller
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
-		 */
-		public static function findControllerFullPath($class, $module = null) {
-			return self::findClassInModuleFullFilePath($class, $module, 'controllers');
-		}
+        /**
+         * Check if in module list can have this controller
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this controller, path the full path of the controller
+         */
+        public static function findControllerFullPath($class, $module = null) {
+            return self::findClassInModuleFullFilePath($class, $module, 'controllers');
+        }
 
-		/**
-		 * Check if in module list can have this model
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this model, return the full path of this model
-		 */
-		public static function findModelFullPath($class, $module = null) {
-			return self::findClassInModuleFullFilePath($class, $module, 'models');
-		}
+        /**
+         * Check if in module list can have this model
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this model, return the full path of this model
+         */
+        public static function findModelFullPath($class, $module = null) {
+            return self::findClassInModuleFullFilePath($class, $module, 'models');
+        }
 
-		/**
-		 * Check if in module list can have this library
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
-		 */
-		public static function findLibraryFullPath($class, $module = null) {
-			return self::findClassInModuleFullFilePath($class, $module, 'libraries');
-		}
+        /**
+         * Check if in module list can have this library
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this library,  return the full path of this library
+         */
+        public static function findLibraryFullPath($class, $module = null) {
+            return self::findClassInModuleFullFilePath($class, $module, 'libraries');
+        }
 
 		
-		/**
-		 * Check if in module list can have this config
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
-		 */
-		public static function findConfigFullPath($configuration, $module = null) {
-			return self::findNonClassInModuleFullFilePath($configuration, $module, 'config');
-		}
+        /**
+         * Check if in module list can have this config
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
+         */
+        public static function findConfigFullPath($configuration, $module = null) {
+            return self::findNonClassInModuleFullFilePath($configuration, $module, 'config');
+        }
 
-		/**
-		 * Check if in module list can have this helper
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
-		 */
-		public static function findFunctionFullPath($helper, $module = null) {
-			return self::findNonClassInModuleFullFilePath($helper, $module, 'functions');
-		}
+        /**
+         * Check if in module list can have this helper
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
+         */
+        public static function findFunctionFullPath($helper, $module = null) {
+            return self::findNonClassInModuleFullFilePath($helper, $module, 'functions');
+        }
 
-		/**
-		 * Check if in module list can have this view
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this view, path the full path of the view
-		 */
-		public static function findViewFullPath($view, $module = null) {
-			return self::findNonClassInModuleFullFilePath($view, $module, 'views');
-		}
+        /**
+         * Check if in module list can have this view
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this view, path the full path of the view
+         */
+        public static function findViewFullPath($view, $module = null) {
+            return self::findNonClassInModuleFullFilePath($view, $module, 'views');
+        }
 
-		/**
-		 * Check if in module list can have this language
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
-		 */
-		public static function findLanguageFullPath($language, $appLang, $module = null) {
-			return self::findNonClassInModuleFullFilePath($language, $module, 'lang', $appLang);
-		}
+        /**
+         * Check if in module list can have this language
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this language,  return the full path of this language
+         */
+        public static function findLanguageFullPath($language, $appLang, $module = null) {
+            return self::findNonClassInModuleFullFilePath($language, $module, 'lang', $appLang);
+        }
 
-		/**
-		 * Get the list of module loaded
-		 * @return array the module list
-		 */
-		public static function getModuleList() {
-			return self::$list;
-		}
+        /**
+         * Get the list of module loaded
+         * @return array the module list
+         */
+        public static function getModuleList() {
+            return self::$list;
+        }
 
-		/**
-		 * Check if the application has an module
-		 * @return boolean
-		 */
-		public static function hasModule() {
-			return !empty(self::$list);
-		}
+        /**
+         * Check if the application has an module
+         * @return boolean
+         */
+        public static function hasModule() {
+            return !empty(self::$list);
+        }
 
-		/**
-		 * Check if in module list can have the model, controller, library
-		 * @param  string $class the class name of library, model, controller
-		 * @param string $module the module name
-		 * @param string $type the name of the type "controllers", "libraries", "models"
-		 * @return boolean|string  false or null if no module 
-		 * have this class, return the full path of the class
-		 */
-		protected static function findClassInModuleFullFilePath($class, $module, $type) {
-			$logger = self::getLogger();
-		    $class = str_ireplace('.php', '', $class);
-		    $class = ucfirst($class);
-		    $classFile = $class . '.php';
-		    $logger->debug('Checking the class [' . $class . '] in module [' . $module . '] for [' . $type . '] ...');
-		    $filePath = MODULE_PATH . $module . DS . $type . DS . $classFile;
-		    if (file_exists($filePath)) {
-		        $logger->info('Found class [' . $class . '] in module [' . $module . '] for [' . $type . '] the file path is [' . $filePath . ']');
-		        return $filePath;
-		    }
-		    $logger->info('Class [' . $class . '] does not exist in the module [' . $module . '] for [' . $type . ']');
-		    return false;
-		}
+        /**
+         * Check if in module list can have the model, controller, library
+         * @param  string $class the class name of library, model, controller
+         * @param string $module the module name
+         * @param string $type the name of the type "controllers", "libraries", "models"
+         * @return boolean|string  false or null if no module 
+         * have this class, return the full path of the class
+         */
+        protected static function findClassInModuleFullFilePath($class, $module, $type) {
+            $logger = self::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = ucfirst($class);
+            $classFile = $class . '.php';
+            $logger->debug('Checking the class [' . $class . '] in module [' . $module . '] for [' . $type . '] ...');
+            $filePath = MODULE_PATH . $module . DS . $type . DS . $classFile;
+            if (file_exists($filePath)) {
+                $logger->info('Found class [' . $class . '] in module [' . $module . '] for [' . $type . '] the file path is [' . $filePath . ']');
+                return $filePath;
+            }
+            $logger->info('Class [' . $class . '] does not exist in the module [' . $module . '] for [' . $type . ']');
+            return false;
+        }
 
-		/**
-		 * Check if in module list can have the config, view, helper, language
-		 * @param string $name the name of config, view, helper, language
-		 * @param string $module the module name
-		 * @param string $type the name of the type "config", "functions", "views", "lang"
-		 * @param string|null $appLang the application language. This is use only when $type = "lang"
-		 * @return boolean|string  false or null if no module 
-		 * have this resource, return the full path of the resource
-		 */
-		protected static function findNonClassInModuleFullFilePath($name, $module, $type, $appLang = null) {
-		    $logger = self::getLogger();
-		    $name = str_ireplace('.php', '', $name);
-		    $file = $name . '.php';
-		    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		    switch ($type) {
-		        case 'functions':
-		            $name = str_ireplace('function_', '', $name);
-		            $file = 'function_' . $name . '.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		        break;
-		        case 'views':
-		            $name = trim($name, '/\\');
-		            $name = str_ireplace('/', DS, $name);
-		            $file = $name . '.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		        break;
-		        case 'lang':
-		            $name = str_ireplace('lang_', '', $name);
-		            $file = 'lang_' . $name . '.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $appLang . DS . $file;
-		        break;
-		    }
-		    $logger->debug('Checking resource [' . $name . '] in module [' . $module . '] for [' . $type . '] ...');
-		    if (file_exists($filePath)) {
-		        $logger->info('Found resource [' . $name . '] in module [' . $module . '] for [' . $type . '] the file path is [' . $filePath . ']');
-		        return $filePath;
-		    }
-		    $logger->info('Resource [' . $name . '] does not exist in the module [' . $module . '] for [' . $type . ']');
-		    return false;
-		}
+        /**
+         * Check if in module list can have the config, view, helper, language
+         * @param string $name the name of config, view, helper, language
+         * @param string $module the module name
+         * @param string $type the name of the type "config", "functions", "views", "lang"
+         * @param string|null $appLang the application language. This is use only when $type = "lang"
+         * @return boolean|string  false or null if no module 
+         * have this resource, return the full path of the resource
+         */
+        protected static function findNonClassInModuleFullFilePath($name, $module, $type, $appLang = null) {
+            $logger = self::getLogger();
+            $name = str_ireplace('.php', '', $name);
+            $file = $name . '.php';
+            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+            switch ($type) {
+                case 'functions':
+                    $name = str_ireplace('function_', '', $name);
+                    $file = 'function_' . $name . '.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+                break;
+                case 'views':
+                    $name = trim($name, '/\\');
+                    $name = str_ireplace('/', DS, $name);
+                    $file = $name . '.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+                break;
+                case 'lang':
+                    $name = str_ireplace('lang_', '', $name);
+                    $file = 'lang_' . $name . '.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $appLang . DS . $file;
+                break;
+            }
+            $logger->debug('Checking resource [' . $name . '] in module [' . $module . '] for [' . $type . '] ...');
+            if (file_exists($filePath)) {
+                $logger->info('Found resource [' . $name . '] in module [' . $module . '] for [' . $type . '] the file path is [' . $filePath . ']');
+                return $filePath;
+            }
+            $logger->info('Resource [' . $name . '] does not exist in the module [' . $module . '] for [' . $type . ']');
+            return false;
+        }
 
-	}
+    }

Spacing +7 added lines, -7 removed lines

@@ -35,23 +35,23 @@
 		/**
 		 * Initialise the module list by scanning the directory MODULE_PATH
 		 */
-		public function init(){
+		public function init() {
 			$logger = self::getLogger();
 			$logger->debug('Check if the application contains the modules ...');
 			$moduleDir = opendir(MODULE_PATH);
-			if (is_resource($moduleDir)){
-				while(($module = readdir($moduleDir)) !== false){
-					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
+			if (is_resource($moduleDir)) {
+				while (($module = readdir($moduleDir)) !== false) {
+					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)) {
 						self::$list[] = $module;
-					} else{
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
+					} else {
+						$logger->info('Skipping [' . $module . '], may be this is not a directory or does not exists or is invalid name');
 					}
 				}
 				closedir($moduleDir);
 			}
 			ksort(self::$list);
 			
-			if (! empty(self::$list)){
+			if (!empty(self::$list)) {
 				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
 			}
 		}

core/classes/EventInfo.php

Indentation +56 added lines, -56 removed lines

@@ -1,63 +1,63 @@
 <?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.
+     */
 
-	/**
-	 * This class represent the event detail to dispatch to correspond listener
-	 */
-	class EventInfo {
+    /**
+     * This class represent the event detail to dispatch to correspond listener
+     */
+    class EventInfo {
 		
-		/**
-		 * The event name
-		 * @var string
-		 */
-		public $name;
+        /**
+         * The event name
+         * @var string
+         */
+        public $name;
 
-		/**
-		 * The event data to send to the listeners
-		 * @var mixed
-		 */
-		public $payload;
+        /**
+         * The event data to send to the listeners
+         * @var mixed
+         */
+        public $payload;
 
-		/**
-		 * If the listeners need return the event after treatment or not, false means no need
-		 * return true need return the event. 
-		 * @var boolean
-		 */
-		public $returnBack;
+        /**
+         * If the listeners need return the event after treatment or not, false means no need
+         * return true need return the event. 
+         * @var boolean
+         */
+        public $returnBack;
 
-		/**
-		 * This variable indicates if need stop the event propagation
-		 * @var boolean
-		 */
-		public $stop;
+        /**
+         * This variable indicates if need stop the event propagation
+         * @var boolean
+         */
+        public $stop;
 		
-		public function __construct($name, $payload = array(), $returnBack = false, $stop = false) {
-			$this->name = $name;
-			$this->payload = $payload;
-			$this->returnBack = $returnBack;
-			$this->stop = $stop;
-		}
-	}
+        public function __construct($name, $payload = array(), $returnBack = false, $stop = false) {
+            $this->name = $name;
+            $this->payload = $payload;
+            $this->returnBack = $returnBack;
+            $this->stop = $stop;
+        }
+    }

core/classes/Security.php

Indentation +128 added lines, -128 removed lines

@@ -1,135 +1,135 @@
 <?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 Security extends BaseStaticClass {
+    class Security extends BaseStaticClass {
 
-		/**
-		 * This method is used to generate the CSRF token
-		 * @return string the generated CSRF token
-		 */
-		public static function generateCSRF() {
-			$logger = self::getLogger();
-			$logger->debug('Generation of CSRF ...');
+        /**
+         * This method is used to generate the CSRF token
+         * @return string the generated CSRF token
+         */
+        public static function generateCSRF() {
+            $logger = self::getLogger();
+            $logger->debug('Generation of CSRF ...');
 			
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
-				$logger->info('The CSRF token not yet expire just return it');
-				return Session::get($key);
-			} else{
-				$newTime = $currentTime + $expire;
-				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
-				Session::set($keyExpire, $newTime);
-				Session::set($key, $token);
-				return Session::get($key);
-			}
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+                $logger->info('The CSRF token not yet expire just return it');
+                return Session::get($key);
+            } else{
+                $newTime = $currentTime + $expire;
+                $token = sha1(uniqid()) . sha1(uniqid());
+                $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+                Session::set($keyExpire, $newTime);
+                Session::set($key, $token);
+                return Session::get($key);
+            }
+        }
 
-		/**
-		 * This method is used to check the CSRF if is valid, not yet expire, etc.
-		 * @return boolean true if valid, false if not valid
-		 */
-		public static function validateCSRF() {
-			$logger = self::getLogger();
-			$logger->debug('Validation of CSRF ...');
+        /**
+         * This method is used to check the CSRF if is valid, not yet expire, etc.
+         * @return boolean true if valid, false if not valid
+         */
+        public static function validateCSRF() {
+            $logger = self::getLogger();
+            $logger->debug('Validation of CSRF ...');
 				
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			$logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . ']');
-			if (!Session::exists($key) || Session::get($keyExpire) <= $currentTime) {
-				$logger->warning('The CSRF session data is not valide');
-				return false;
-			}
-			//perform form data
-			//need use request->query() for best retrieve
-			//super instance
-			$obj = & get_instance();
-			$token = $obj->request->query($key);
-			if (!$token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime) {
-				$logger->warning('The CSRF data [' . $token . '] is not valide may be attacker do his job');
-				return false;
-			}
-			$logger->info('The CSRF data [' . $token . '] is valide the form data is safe continue');
-			//remove the token from session
-			Session::clear($key);
-			Session::clear($keyExpire);
-			return true;
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            $logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . ']');
+            if (!Session::exists($key) || Session::get($keyExpire) <= $currentTime) {
+                $logger->warning('The CSRF session data is not valide');
+                return false;
+            }
+            //perform form data
+            //need use request->query() for best retrieve
+            //super instance
+            $obj = & get_instance();
+            $token = $obj->request->query($key);
+            if (!$token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime) {
+                $logger->warning('The CSRF data [' . $token . '] is not valide may be attacker do his job');
+                return false;
+            }
+            $logger->info('The CSRF data [' . $token . '] is valide the form data is safe continue');
+            //remove the token from session
+            Session::clear($key);
+            Session::clear($keyExpire);
+            return true;
+        }
 		
-		/**
-		 * This method is used to check the whitelist IP address access
-		 */
-		 public static function checkWhiteListIpAccess(){
-			$logger = self::getLogger();
-			$logger->debug('Validation of the IP address access ...');
-			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
-			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
-				$logger->info('Whitelist IP access is enabled in the configuration');
-				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
-					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
-					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
-					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
-						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
-						//wildcard to access all ip address
-						return;
-					} else{
-						// go through all whitelisted ips
-						foreach ($list as $ipaddr) {
-							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
-							$wildcardPosition = strpos($ipaddr, '*');
-							if ($wildcardPosition === false) {
-								// no wild card in whitelisted ip --continue searching
-								continue;
-							}
-							// cut ip at the position where we got the wild card on the whitelisted ip
-							// and add the wold card to get the same pattern
-							if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
-								// f.e. we got
-								//  ip "127.0.0.1"
-								//  whitelisted ip "127.0.*"
-								// then we compared "127.0.*" with "127.0.*"
-								// return success
-								$logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
-								return;
-							}
-						}
-						$logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
-						show_error('Access to this application is not allowed');
-					}
-				}
-			} else{
-				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
-			}
-		 }
-	}
+        /**
+         * This method is used to check the whitelist IP address access
+         */
+            public static function checkWhiteListIpAccess(){
+            $logger = self::getLogger();
+            $logger->debug('Validation of the IP address access ...');
+            $logger->debug('Check if whitelist IP access is enabled in the configuration ...');
+            $isEnable = get_config('white_list_ip_enable', false);
+            if($isEnable){
+                $logger->info('Whitelist IP access is enabled in the configuration');
+                $list = get_config('white_list_ip_addresses', array());
+                if(! empty($list)){
+                    //Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
+                    require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+                    $ip = get_ip();
+                    if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+                        $logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
+                        //wildcard to access all ip address
+                        return;
+                    } else{
+                        // go through all whitelisted ips
+                        foreach ($list as $ipaddr) {
+                            // find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
+                            $wildcardPosition = strpos($ipaddr, '*');
+                            if ($wildcardPosition === false) {
+                                // no wild card in whitelisted ip --continue searching
+                                continue;
+                            }
+                            // cut ip at the position where we got the wild card on the whitelisted ip
+                            // and add the wold card to get the same pattern
+                            if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
+                                // f.e. we got
+                                //  ip "127.0.0.1"
+                                //  whitelisted ip "127.0.*"
+                                // then we compared "127.0.*" with "127.0.*"
+                                // return success
+                                $logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
+                                return;
+                            }
+                        }
+                        $logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
+                        show_error('Access to this application is not allowed');
+                    }
+                }
+            } else{
+                $logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
+            }
+            }
+    }

Spacing +9 added lines, -9 removed lines

@@ -38,13 +38,13 @@ 
 			$expire = get_config('csrf_expire', 60);
 			$keyExpire = 'csrf_expire';
 			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+			if (Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime) {
 				$logger->info('The CSRF token not yet expire just return it');
 				return Session::get($key);
-			} else{
+			} else {
 				$newTime = $currentTime + $expire;
 				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+				$logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . '], token [' . $token . ']');
 				Session::set($keyExpire, $newTime);
 				Session::set($key, $token);
 				return Session::get($key);
@@ -87,23 +87,23 @@ 
 		/**
 		 * This method is used to check the whitelist IP address access
 		 */
-		 public static function checkWhiteListIpAccess(){
+		 public static function checkWhiteListIpAccess() {
 			$logger = self::getLogger();
 			$logger->debug('Validation of the IP address access ...');
 			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
 			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
+			if ($isEnable) {
 				$logger->info('Whitelist IP access is enabled in the configuration');
 				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
+				if (!empty($list)) {
 					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
 					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+					if ((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)) {
 						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
 						//wildcard to access all ip address
 						return;
-					} else{
+					} else {
 						// go through all whitelisted ips
 						foreach ($list as $ipaddr) {
 							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
@@ -128,7 +128,7 @@ 
 						show_error('Access to this application is not allowed');
 					}
 				}
-			} else{
+			} else {
 				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
 			}
 		 }

core/classes/database/DatabaseQueryResult.php

Spacing +6 added lines, -6 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;
   	
     
         /**
@@ -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 +41 added lines, -41 removed lines

@@ -216,19 +216,19 @@ 
      * @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;
     }
 
     /**
@@ -330,18 +330,18 @@ 
      * @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);
+            $whereStr = $this->getWhereStrForOperator($where, $op, $val, $type, $escape);
         }
-      }
-      $this->setWhereStr($whereStr, $andOr);
-      return $this;
+        }
+        $this->setWhereStr($whereStr, $andOr);
+        return $this;
     }
 
     /**
@@ -578,15 +578,15 @@ 
      * @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;
     }
 
     /**
@@ -596,14 +596,14 @@ 
      * @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;
     }
 
     /**
@@ -612,12 +612,12 @@ 
      * @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;
     }
 
     /**
@@ -629,20 +629,20 @@ 
      * @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;
     }
 
     /**

Spacing +141 added lines, -141 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,17 +215,17 @@ 
      * @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;
@@ -236,7 +236,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 ');
     }
 
@@ -245,7 +245,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 ');
     }
 
@@ -254,7 +254,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 ');
     }
 
@@ -263,7 +263,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 ');
     }
 
@@ -272,7 +272,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 ');
     }
 
@@ -281,7 +281,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 ');
     }
 
@@ -291,13 +291,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;
     }
@@ -308,13 +308,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;
     }
@@ -329,12 +329,12 @@ 
      * @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);
@@ -349,7 +349,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);
     }
 
@@ -359,7 +359,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);
     }
 
@@ -368,7 +368,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);
     }
 
@@ -378,11 +378,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 . ' (';
@@ -396,7 +396,7 @@ 
      * @see  DatabaseQueryBuilder::groupStart()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function notGroupStart(){
+    public function notGroupStart() {
         return $this->groupStart('NOT');
     }
 
@@ -405,7 +405,7 @@ 
      * @see  DatabaseQueryBuilder::groupStart()
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function orGroupStart(){
+    public function orGroupStart() {
         return $this->groupStart('', ' OR');
     }
 
@@ -414,7 +414,7 @@ 
          * @see  DatabaseQueryBuilder::groupStart()
          * @return object        the current DatabaseQueryBuilder instance
          */
-    public function orNotGroupStart(){
+    public function orNotGroupStart() {
         return $this->groupStart('NOT', ' OR');
     }
 
@@ -422,7 +422,7 @@ 
      * Close the parenthesis for the grouped SQL
      * @return object        the current DatabaseQueryBuilder instance
      */
-    public function groupEnd(){
+    public function groupEnd() {
         $this->where .= ')';
         return $this;
     }
@@ -436,10 +436,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));
@@ -455,7 +455,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);
     }
 
@@ -464,7 +464,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);
     }
 
@@ -473,7 +473,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);
     }
 
@@ -487,11 +487,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);
@@ -504,7 +504,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);
     }
 
@@ -513,7 +513,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);
     }
 
@@ -522,7 +522,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);
     }
 
@@ -535,8 +535,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);
@@ -548,7 +548,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);
     }
 
@@ -557,7 +557,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);
     }
 
@@ -566,7 +566,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);
     }
 
@@ -577,13 +577,13 @@ 
      * @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;
@@ -595,10 +595,10 @@ 
      * @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);
@@ -611,10 +611,10 @@ 
      * @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;
@@ -628,16 +628,16 @@ 
      * @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));
@@ -651,7 +651,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));
@@ -666,22 +666,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;
@@ -692,22 +692,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;
@@ -720,9 +720,9 @@ 
      * @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) {
         $data = trim($data);
-        if($escaped){
+        if ($escaped) {
         return $this->pdo->quote($data);
         }
         return $data;  
@@ -733,31 +733,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;
@@ -770,7 +770,7 @@ 
          * Return the PDO instance
          * @return object
          */
-    public function getPdo(){
+    public function getPdo() {
         return $this->pdo;
     }
 
@@ -779,7 +779,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;
     }
@@ -788,7 +788,7 @@ 
      * Return the database table prefix
      * @return string
      */
-    public function getPrefix(){
+    public function getPrefix() {
         return $this->prefix;
     }
 
@@ -797,7 +797,7 @@ 
      * @param string $prefix the new prefix
      * @return object DatabaseQueryBuilder
      */
-    public function setPrefix($prefix){
+    public function setPrefix($prefix) {
         $this->prefix = $prefix;
         return $this;
     }
@@ -806,7 +806,7 @@ 
          * Return the database driver
          * @return string
          */
-    public function getDriver(){
+    public function getDriver() {
         return $this->driver;
     }
 
@@ -815,7 +815,7 @@ 
      * @param string $driver the new driver
      * @return object DatabaseQueryBuilder
      */
-    public function setDriver($driver){
+    public function setDriver($driver) {
         $this->driver = $driver;
         return $this;
     }
@@ -824,7 +824,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;
@@ -843,12 +843,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) : '');
@@ -864,15 +864,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;
     }
 
@@ -882,12 +882,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)) : '');
@@ -902,15 +902,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));
@@ -923,14 +923,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;
             }
         }
         }
@@ -946,7 +946,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);

core/classes/database/DatabaseQueryRunner.php

Indentation +63 added lines, -63 removed lines

@@ -128,97 +128,97 @@ 
         $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;
     }
     
     /**
@@ -348,18 +348,18 @@ 
      * @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 +46 added lines, -46 removed lines

@@ -23,14 +23,14 @@ 
      * 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 extends BaseClass{
+    class DatabaseQueryRunner extends BaseClass {
       
    
         /**
          * The last query result
          * @var object
          */
-        private $queryResult       = null;
+        private $queryResult = null;
   	
         /**
          * The benchmark instance
@@ -42,45 +42,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 $returnAsList     = true;
+        private $returnAsList = 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;
 
 
 	
@@ -91,9 +91,9 @@ 
      * @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){
+    public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false) {
         parent::__construct();
-        if (is_object($pdo)){
+        if (is_object($pdo)) {
             $this->pdo = $pdo;
         }
         $this->query         = $query;
@@ -108,13 +108,13 @@ 
      * 
      * @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');
         }
         
@@ -130,18 +130,18 @@ 
                                                                 '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;
@@ -153,26 +153,26 @@ 
    * 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);
@@ -183,19 +183,19 @@ 
    * 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);
@@ -226,7 +226,7 @@ 
      *
      * @return object DatabaseQueryResult
      */
-    public function getQueryResult(){
+    public function getQueryResult() {
         return $this->queryResult;
     }
 
@@ -236,7 +236,7 @@ 
      *
      * @return object DatabaseQueryRunner
      */
-    public function setQueryResult(DatabaseQueryResult $queryResult){
+    public function setQueryResult(DatabaseQueryResult $queryResult) {
         $this->queryResult = $queryResult;
         return $this;
     }
@@ -245,7 +245,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
         return $this->query;
     }
     
@@ -254,7 +254,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;
     }
@@ -264,7 +264,7 @@ 
      * @param boolean $returnType
      * @return object DatabaseQueryRunner
      */
-    public function setReturnType($returnType){
+    public function setReturnType($returnType) {
         $this->returnAsList = $returnType;
         return $this;
     }
@@ -274,7 +274,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;
     }
@@ -283,7 +283,7 @@ 
      * Return the error for last query execution
      * @return string
      */
-    public function getQueryError(){
+    public function getQueryError() {
         return $this->error;
     }
 
@@ -291,7 +291,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
         return $this->pdo;
     }
 
@@ -300,7 +300,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;
     }
@@ -309,7 +309,7 @@ 
          * Return the database driver
          * @return string
          */
-    public function getDriver(){
+    public function getDriver() {
         return $this->driver;
     }
 
@@ -318,7 +318,7 @@ 
      * @param string $driver the new driver
      * @return object DatabaseQueryRunner
      */
-    public function setDriver($driver){
+    public function setDriver($driver) {
         $this->driver = $driver;
         return $this;
     }
@@ -328,14 +328,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));
@@ -347,11 +347,11 @@ 
      * 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');
       }
     }

core/classes/database/Database.php

Indentation +4 added lines, -4 removed lines

@@ -149,13 +149,13 @@
             $this->updateQueryBuilderAndRunnerProperties();
 
             return is_object($this->pdo);
-          } catch (PDOException $e){
+            } catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 

Switch Indentation +11 added lines, -11 removed lines

@@ -603,17 +603,17 @@
         return null;
         }
         switch ($driver) {
-        case 'mysql':
-        case 'pgsql':
-          $port = '';
-            if (! empty($config['port'])) {
-            $port = 'port=' . $config['port'] . ';';
-            }
-            $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
-            break;
-        case 'sqlite':
-          $dsn = 'sqlite:' . $config['database'];
-            break;
+            case 'mysql':
+            case 'pgsql':
+              $port = '';
+                if (! empty($config['port'])) {
+                $port = 'port=' . $config['port'] . ';';
+                }
+                $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
+                break;
+            case 'sqlite':
+              $dsn = 'sqlite:' . $config['database'];
+                break;
             case 'oracle':
           $port = '';
             if (! empty($config['port'])) {

Spacing +84 added lines, -84 removed lines

@@ -23,92 +23,92 @@ 
      * 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 extends BaseClass{
+    class Database extends BaseClass {
 	
         /**
          * 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 cache instance
      * @var object
      */
-    private $cacheInstance       = null;
+    private $cacheInstance = null;
 
     
         /**
          * The DatabaseQueryBuilder instance
          * @var object
          */
-    protected $queryBuilder        = null;
+    protected $queryBuilder = null;
     
     /**
      * The DatabaseQueryRunner instance
      * @var object
      */
-    protected $queryRunner         = null;
+    protected $queryRunner = null;
 
 
     /**
@@ -136,10 +136,10 @@ 
      * 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->getDsnValueFromConfig(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
@@ -149,7 +149,7 @@ 
             $this->updateQueryBuilderAndRunnerProperties();
 
             return is_object($this->pdo);
-          } catch (PDOException $e){
+          } catch (PDOException $e) {
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -163,7 +163,7 @@ 
      * Return the number of rows returned by the current query
      * @return int
      */
-    public function numRows(){
+    public function numRows() {
         return $this->numRows;
     }
 
@@ -171,7 +171,7 @@ 
      * Return the last insert id value
      * @return mixed
      */
-    public function insertId(){
+    public function insertId() {
         return $this->insertId;
     }
 
@@ -182,10 +182,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->queryBuilder->limit(1);
         $query = $this->getAll(true);
-        if ($returnSQLQueryOrResultType === true){
+        if ($returnSQLQueryOrResultType === true) {
         return $query;
         } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
@@ -198,9 +198,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->queryBuilder->getQuery();
-        if ($returnSQLQueryOrResultType === true){
+        if ($returnSQLQueryOrResultType === true) {
             return $query;
         }
         return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
@@ -212,18 +212,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) && ! empty($this->data)){
+    public function insert($data = array(), $escape = true) {
+        if (empty($data) && !empty($this->data)) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
         }
         $query = $this->queryBuilder->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;
     }
@@ -234,8 +234,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) && ! empty($this->data)){
+    public function update($data = array(), $escape = true) {
+        if (empty($data) && !empty($this->data)) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
@@ -248,7 +248,7 @@ 
      * Delete the record in database
      * @return mixed the delete status
      */
-    public function delete(){
+    public function delete() {
             $query = $this->queryBuilder->delete()->getQuery();
         return $this->query($query);
     }
@@ -258,7 +258,7 @@ 
      * @param integer $ttl the cache time to live in second
      * @return object        the current Database instance
      */
-    public function setCache($ttl = 0){
+    public function setCache($ttl = 0) {
         $this->cacheTtl = $ttl;
         $this->temporaryCacheTtl = $ttl;
         return $this;
@@ -269,7 +269,7 @@ 
      * @param  integer $ttl the cache time to live in second
      * @return object        the current Database instance
      */
-        public function cached($ttl = 0){
+        public function cached($ttl = 0) {
         $this->temporaryCacheTtl = $ttl;
         return $this;
     }
@@ -281,9 +281,9 @@ 
      * @return mixed       the data after escaped or the same data if no
      * need escaped
      */
-    public function escape($data, $escaped = true){
+    public function escape($data, $escaped = true) {
         $data = trim($data);
-        if($escaped){
+        if ($escaped) {
         return $this->pdo->quote($data);
         }
         return $data; 
@@ -293,7 +293,7 @@ 
      * Return the number query executed count for the current request
      * @return int
      */
-    public function queryCount(){
+    public function queryCount() {
         return $this->queryCount;
     }
 
@@ -301,7 +301,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
         return $this->query;
     }
 
@@ -309,7 +309,7 @@ 
      * Return the application database name
      * @return string
      */
-    public function getDatabaseName(){
+    public function getDatabaseName() {
         return $this->databaseName;
     }
 
@@ -317,7 +317,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
         return $this->pdo;
     }
 
@@ -326,7 +326,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;
     }
@@ -335,7 +335,7 @@ 
          * Return the cache instance
          * @return CacheInterface
          */
-    public function getCacheInstance(){
+    public function getCacheInstance() {
         return $this->cacheInstance;
     }
 
@@ -344,7 +344,7 @@ 
      * @param CacheInterface $cache the cache object
      * @return object Database
      */
-    public function setCacheInstance($cache){
+    public function setCacheInstance($cache) {
         $this->cacheInstance = $cache;
         return $this;
     }
@@ -354,7 +354,7 @@ 
          * Return the DatabaseQueryBuilder instance
          * @return object DatabaseQueryBuilder
          */
-    public function getQueryBuilder(){
+    public function getQueryBuilder() {
         return $this->queryBuilder;
     }
 
@@ -362,7 +362,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;
     }
@@ -371,7 +371,7 @@ 
      * Return the DatabaseQueryRunner instance
      * @return object DatabaseQueryRunner
      */
-    public function getQueryRunner(){
+    public function getQueryRunner() {
         return $this->queryRunner;
     }
 
@@ -379,7 +379,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;
     }
@@ -388,7 +388,7 @@ 
      * Return the data to be used for insert, update, etc.
      * @return array
      */
-    public function getData(){
+    public function getData() {
         return $this->data;
     }
 
@@ -399,9 +399,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 {
@@ -417,7 +417,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
@@ -438,12 +438,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++;
         
@@ -452,19 +452,19 @@ 
                                             ->setReturnAsArray($returnAsArray)
                                             ->execute();
 
-        if (!is_object($queryResult)){
+        if (!is_object($queryResult)) {
             $this->result = false;
             $this->numRows = 0;
             return $this->result;
         }
         $this->result  = $queryResult->getResult();
         $this->numRows = $queryResult->getNumRows();
-        if ($isSqlSELECTQuery && $dbCacheStatus){
+        if ($isSqlSELECTQuery && $dbCacheStatus) {
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
         }
-        } 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);
         }
@@ -478,9 +478,9 @@ 
      * @param boolean $autoConnect whether to connect to database after set the configuration
      * @return object Database
      */
-    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
+    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false) {
         $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';
         }
@@ -495,7 +495,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];
             }
@@ -509,7 +509,7 @@ 
                                                             array('password' => string_hidden($this->config['password']))
                                                 ))
                             );
-        if($autoConnect){
+        if ($autoConnect) {
                 //Now connect to the database
                 $this->connect();
             }
@@ -520,14 +520,14 @@ 
      * Return the database configuration
      * @return array
      */
-    public  function getDatabaseConfiguration(){
+    public  function getDatabaseConfiguration() {
         return $this->config;
     }
 
     /**
      * Close the connexion
      */
-    public function close(){
+    public function close() {
         $this->pdo = null;
     }
 
@@ -535,7 +535,7 @@ 
      * Return the database default configuration
      * @return array
      */
-    protected function getDatabaseDefaultConfiguration(){
+    protected function getDatabaseDefaultConfiguration() {
         return array(
                 'driver' => '',
                 'username' => '',
@@ -553,16 +553,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'])
                             ->setPrefix($this->config['prefix'])
                             ->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'])
                             ->setPdo($this->pdo);
         }
@@ -573,10 +573,10 @@ 
      * This method is used to get the PDO DSN string using the configured driver
      * @return string|null the DSN string or null if can not find it
      */
-    protected function getDsnValueFromConfig(){
+    protected function getDsnValueFromConfig() {
         $dsn = null;
         $config = $this->getDatabaseConfiguration();
-        if (! empty($config)){
+        if (!empty($config)) {
         $driver = $config['driver'];
         $driverDsnMap = array(
                                 'mysql'  => $this->getDsnValueForDriver('mysql'),
@@ -584,7 +584,7 @@ 
                                 'sqlite' => $this->getDsnValueForDriver('sqlite'),
                                 'oracle' => $this->getDsnValueForDriver('oracle')
                                 );
-        if (isset($driverDsnMap[$driver])){
+        if (isset($driverDsnMap[$driver])) {
             $dsn = $driverDsnMap[$driver];
         }
         }    
@@ -596,17 +596,17 @@ 
      * @param  string $driver the driver name
      * @return string|null         the dsn name
      */
-    protected function getDsnValueForDriver($driver){
+    protected function getDsnValueForDriver($driver) {
         $dsn = '';
         $config = $this->getDatabaseConfiguration();
-        if (empty($config)){
+        if (empty($config)) {
         return null;
         }
         switch ($driver) {
         case 'mysql':
         case 'pgsql':
           $port = '';
-            if (! empty($config['port'])) {
+            if (!empty($config['port'])) {
             $port = 'port=' . $config['port'] . ';';
             }
             $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
@@ -616,10 +616,10 @@ 
             break;
             case 'oracle':
           $port = '';
-            if (! empty($config['port'])) {
+            if (!empty($config['port'])) {
             $port = ':' . $config['port'];
             }
-            $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
+            $dsn = 'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
             break;
         }
         return $dsn;
@@ -631,9 +631,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
@@ -650,9 +650,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
@@ -669,7 +669,7 @@ 
          * 
          *  @return string
          */
-    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray) {
         return md5($query . $returnAsList . $returnAsArray);
     }
 
@@ -677,7 +677,7 @@ 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
-    private function reset(){
+    private function reset() {
         //query builder reset
         $this->queryBuilder->reset();
         $this->numRows  = 0;
@@ -690,7 +690,7 @@ 
     /**
      * The class destructor
      */
-    public function __destruct(){
+    public function __destruct() {
         $this->pdo = null;
     }
 

core/classes/Session.php

Indentation +135 added lines, -135 removed lines

@@ -1,147 +1,147 @@
 <?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.
-	*/
-	class Session extends BaseStaticClass {
+    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 Session extends BaseStaticClass {
 		
-		/**
-		 * The session flash key to use
-		 * @const
-		 */
-		const SESSION_FLASH_KEY = 'session_flash';
+        /**
+         * The session flash key to use
+         * @const
+         */
+        const SESSION_FLASH_KEY = 'session_flash';
 
-		/**
-		 * Get the session item value
-		 * @param  string $item    the session item name to get
-		 * @param  mixed $default the default value to use if can not find the session item in the list
-		 * @return mixed          the session value if exist or the default value
-		 */
-		public static function get($item, $default = null) {
-			$logger = self::getLogger();
-			$logger->debug('Getting session data for item [' . $item . '] ...');
-			if (array_key_exists($item, $_SESSION)) {
-				$logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
-				return $_SESSION[$item];
-			}
-			$logger->warning('Cannot find session item [' . $item . '] using the default value [' . $default . ']');
-			return $default;
-		}
+        /**
+         * Get the session item value
+         * @param  string $item    the session item name to get
+         * @param  mixed $default the default value to use if can not find the session item in the list
+         * @return mixed          the session value if exist or the default value
+         */
+        public static function get($item, $default = null) {
+            $logger = self::getLogger();
+            $logger->debug('Getting session data for item [' . $item . '] ...');
+            if (array_key_exists($item, $_SESSION)) {
+                $logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
+                return $_SESSION[$item];
+            }
+            $logger->warning('Cannot find session item [' . $item . '] using the default value [' . $default . ']');
+            return $default;
+        }
 
-		/**
-		 * Set the session item value
-		 * @param string $item  the session item name to set
-		 * @param mixed $value the session item value
-		 */
-		public static function set($item, $value) {
-			$logger = self::getLogger();
-			$logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
-			$_SESSION[$item] = $value;
-		}
+        /**
+         * Set the session item value
+         * @param string $item  the session item name to set
+         * @param mixed $value the session item value
+         */
+        public static function set($item, $value) {
+            $logger = self::getLogger();
+            $logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
+            $_SESSION[$item] = $value;
+        }
 
-		/**
-		 * Get the session flash item value
-		 * @param  string $item    the session flash item name to get
-		 * @param  mixed $default the default value to use if can not find the session flash item in the list
-		 * @return mixed          the session flash value if exist or the default value
-		 */
-		public static function getFlash($item, $default = null){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			$return = array_key_exists($key, $_SESSION) ?
-			($_SESSION[$key]) : $default;
-			if(array_key_exists($key, $_SESSION)){
-				unset($_SESSION[$key]);
-			} else{
-				$logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
-			}
-			return $return;
-		}
+        /**
+         * Get the session flash item value
+         * @param  string $item    the session flash item name to get
+         * @param  mixed $default the default value to use if can not find the session flash item in the list
+         * @return mixed          the session flash value if exist or the default value
+         */
+        public static function getFlash($item, $default = null){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            $return = array_key_exists($key, $_SESSION) ?
+            ($_SESSION[$key]) : $default;
+            if(array_key_exists($key, $_SESSION)){
+                unset($_SESSION[$key]);
+            } else{
+                $logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
+            }
+            return $return;
+        }
 
-		/**
-		 * Check whether the given session flash item exists
-		 * @param  string  $item the session flash item name
-		 * @return boolean 
-		 */
-		public static function hasFlash($item) {
-			$key = self::SESSION_FLASH_KEY . '_' . $item;
-			return array_key_exists($key, $_SESSION);
-		}
+        /**
+         * Check whether the given session flash item exists
+         * @param  string  $item the session flash item name
+         * @return boolean 
+         */
+        public static function hasFlash($item) {
+            $key = self::SESSION_FLASH_KEY . '_' . $item;
+            return array_key_exists($key, $_SESSION);
+        }
 
-		/**
-		 * Set the session flash item value
-		 * @param string $item  the session flash item name to set
-		 * @param mixed $value the session flash item value
-		 */
-		public static function setFlash($item, $value) {
-			$key = self::SESSION_FLASH_KEY . '_' . $item;
-			$_SESSION[$key] = $value;
-		}
+        /**
+         * Set the session flash item value
+         * @param string $item  the session flash item name to set
+         * @param mixed $value the session flash item value
+         */
+        public static function setFlash($item, $value) {
+            $key = self::SESSION_FLASH_KEY . '_' . $item;
+            $_SESSION[$key] = $value;
+        }
 
-		/**
-		 * Clear the session item in the list
-		 * @param  string $item the session item name to be deleted
-		 */
-		public static function clear($item){
-			$logger = self::getLogger();
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Deleting of session for item ['.$item.' ]');
-				unset($_SESSION[$item]);
-			} else{
-				$logger->warning('Session item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session item in the list
+         * @param  string $item the session item name to be deleted
+         */
+        public static function clear($item){
+            $logger = self::getLogger();
+            if(array_key_exists($item, $_SESSION)){
+                $logger->info('Deleting of session for item ['.$item.' ]');
+                unset($_SESSION[$item]);
+            } else{
+                $logger->warning('Session item ['.$item.'] to be deleted does not exists');
+            }
+        }
 		
-		/**
-		 * Clear the session flash item in the list
-		 * @param  string $item the session flash item name to be deleted
-		 */
-		public static function clearFlash($item){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			if(array_key_exists($key, $_SESSION)){
-				$logger->info('Delete session flash for item ['.$item.']');
-				unset($_SESSION[$item]);
-			} else{
-				$logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session flash item in the list
+         * @param  string $item the session flash item name to be deleted
+         */
+        public static function clearFlash($item){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            if(array_key_exists($key, $_SESSION)){
+                $logger->info('Delete session flash for item ['.$item.']');
+                unset($_SESSION[$item]);
+            } else{
+                $logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
+            }
+        }
 
-		/**
-		 * Check whether the given session item exists
-		 * @param  string  $item the session item name
-		 * @return boolean 
-		 */
-		public static function exists($item) {
-			return array_key_exists($item, $_SESSION);
-		}
+        /**
+         * Check whether the given session item exists
+         * @param  string  $item the session item name
+         * @return boolean 
+         */
+        public static function exists($item) {
+            return array_key_exists($item, $_SESSION);
+        }
 
-		/**
-		 * Destroy all session data values
-		 */
-		public static function clearAll() {
-			session_unset();
-			session_destroy();
-		}
+        /**
+         * Destroy all session data values
+         */
+        public static function clearAll() {
+            session_unset();
+            session_destroy();
+        }
 
-	}
+    }

Spacing +16 added lines, -16 removed lines

@@ -65,15 +65,15 @@ 
 		 * @param  mixed $default the default value to use if can not find the session flash item in the list
 		 * @return mixed          the session flash value if exist or the default value
 		 */
-		public static function getFlash($item, $default = null){
+		public static function getFlash($item, $default = null) {
 			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
+			$key = self::SESSION_FLASH_KEY . '_' . $item;
 			$return = array_key_exists($key, $_SESSION) ?
 			($_SESSION[$key]) : $default;
-			if(array_key_exists($key, $_SESSION)){
+			if (array_key_exists($key, $_SESSION)) {
 				unset($_SESSION[$key]);
-			} else{
-				$logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
+			} else {
+				$logger->warning('Cannot find session flash item [' . $key . '] using the default value [' . $default . ']');
 			}
 			return $return;
 		}
@@ -102,13 +102,13 @@ 
 		 * Clear the session item in the list
 		 * @param  string $item the session item name to be deleted
 		 */
-		public static function clear($item){
+		public static function clear($item) {
 			$logger = self::getLogger();
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Deleting of session for item ['.$item.' ]');
+			if (array_key_exists($item, $_SESSION)) {
+				$logger->info('Deleting of session for item [' . $item . ' ]');
 				unset($_SESSION[$item]);
-			} else{
-				$logger->warning('Session item ['.$item.'] to be deleted does not exists');
+			} else {
+				$logger->warning('Session item [' . $item . '] to be deleted does not exists');
 			}
 		}
 		
@@ -116,14 +116,14 @@ 
 		 * Clear the session flash item in the list
 		 * @param  string $item the session flash item name to be deleted
 		 */
-		public static function clearFlash($item){
+		public static function clearFlash($item) {
 			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			if(array_key_exists($key, $_SESSION)){
-				$logger->info('Delete session flash for item ['.$item.']');
+			$key = self::SESSION_FLASH_KEY . '_' . $item;
+			if (array_key_exists($key, $_SESSION)) {
+				$logger->info('Delete session flash for item [' . $item . ']');
 				unset($_SESSION[$item]);
-			} else{
-				$logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
+			} else {
+				$logger->warning('Dession flash item [' . $item . '] to be deleted does not exists');
 			}
 		}