tnhfw / tnh-fw

core/classes/Config.php

Indentation +175 added lines, -175 removed lines

@@ -1,190 +1,190 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Config{
+    class Config{
 		
-		/**
-		 * The list of loaded configuration
-		 * @var array
-		 */
-		private static $config = array();
+        /**
+         * The list of loaded configuration
+         * @var array
+         */
+        private static $config = array();
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * The signleton of the logger
-		 * @return Object the Log instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
-				$logger[0]->setLogger('Library::Config');
-				self::$logger = $logger[0];
-			}
-			return self::$logger;			
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                $logger = array();
+                $logger[0] =& class_loader('Log', 'classes');
+                $logger[0]->setLogger('Library::Config');
+                self::$logger = $logger[0];
+            }
+            return self::$logger;			
+        }
 
-		/**
-		 * Set the log instance for future use
-		 * @param Log $logger the log object
-		 * @return Log the log instance
-		 */
-		public static function setLogger($logger){
-			self::$logger = $logger;
-			return self::$logger;
-		}
+        /**
+         * Set the log instance for future use
+         * @param Log $logger the log object
+         * @return Log the log instance
+         */
+        public static function setLogger($logger){
+            self::$logger = $logger;
+            return self::$logger;
+        }
 
-		/**
-		 * Initialize the configuration by loading all the configuration from config file
-		 */
-		public static function init(){
-			$logger = static::getLogger();
-			$logger->debug('Initialization of the configuration');
-			self::$config = & load_configurations();
-			self::setBaseUrlUsingServerVar();
-			if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
-				$logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
-			}
-			$logger->info('Configuration initialized successfully');
-			$logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
-		}
+        /**
+         * Initialize the configuration by loading all the configuration from config file
+         */
+        public static function init(){
+            $logger = static::getLogger();
+            $logger->debug('Initialization of the configuration');
+            self::$config = & load_configurations();
+            self::setBaseUrlUsingServerVar();
+            if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
+                $logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
+            }
+            $logger->info('Configuration initialized successfully');
+            $logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
+        }
 
-		/**
-		 * Get the configuration item value
-		 * @param  string $item    the configuration item name to get
-		 * @param  mixed $default the default value to use if can not find the config item in the list
-		 * @return mixed          the config value if exist or the default value
-		 */
-		public static function get($item, $default = null){
-			$logger = static::getLogger();
-			if(array_key_exists($item, self::$config)){
-				return self::$config[$item];
-			}
-			$logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
-			return $default;
-		}
+        /**
+         * Get the configuration item value
+         * @param  string $item    the configuration item name to get
+         * @param  mixed $default the default value to use if can not find the config item in the list
+         * @return mixed          the config value if exist or the default value
+         */
+        public static function get($item, $default = null){
+            $logger = static::getLogger();
+            if(array_key_exists($item, self::$config)){
+                return self::$config[$item];
+            }
+            $logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
+            return $default;
+        }
 
-		/**
-		 * Set the configuration item value
-		 * @param string $item  the config item name to set
-		 * @param mixed $value the config item value
-		 */
-		public static function set($item, $value){
-			self::$config[$item] = $value;
-		}
+        /**
+         * Set the configuration item value
+         * @param string $item  the config item name to set
+         * @param mixed $value the config item value
+         */
+        public static function set($item, $value){
+            self::$config[$item] = $value;
+        }
 
-		/**
-		 * Get all the configuration values
-		 * @return array the config values
-		 */
-		public static function getAll(){
-			return self::$config;
-		}
+        /**
+         * Get all the configuration values
+         * @return array the config values
+         */
+        public static function getAll(){
+            return self::$config;
+        }
 
-		/**
-		 * Set the configuration values bu merged with the existing configuration
-		 * @param array $config the config values to add in the configuration list
-		 */
-		public static function setAll(array $config = array()){
-			self::$config = array_merge(self::$config, $config);
-		}
+        /**
+         * Set the configuration values bu merged with the existing configuration
+         * @param array $config the config values to add in the configuration list
+         */
+        public static function setAll(array $config = array()){
+            self::$config = array_merge(self::$config, $config);
+        }
 
-		/**
-		 * Delete the configuration item in the list
-		 * @param  string $item the config item name to be deleted
-		 * @return boolean true if the item exists and is deleted successfully otherwise will return false.
-		 */
-		public static function delete($item){
-			$logger = static::getLogger();
-			if(array_key_exists($item, self::$config)){
-				$logger->info('Delete config item ['.$item.']');
-				unset(self::$config[$item]);
-				return true;
-			}
-			else{
-				$logger->warning('Config item ['.$item.'] to be deleted does not exists');
-				return false;
-			}
-		}
+        /**
+         * Delete the configuration item in the list
+         * @param  string $item the config item name to be deleted
+         * @return boolean true if the item exists and is deleted successfully otherwise will return false.
+         */
+        public static function delete($item){
+            $logger = static::getLogger();
+            if(array_key_exists($item, self::$config)){
+                $logger->info('Delete config item ['.$item.']');
+                unset(self::$config[$item]);
+                return true;
+            }
+            else{
+                $logger->warning('Config item ['.$item.'] to be deleted does not exists');
+                return false;
+            }
+        }
 
-		/**
-		 * Load the configuration file. This an alias to Loader::config()
-		 * @param  string $config the config name to be loaded
-		 */
-		public static function load($config){
-			Loader::config($config);
-		}
+        /**
+         * Load the configuration file. This an alias to Loader::config()
+         * @param  string $config the config name to be loaded
+         */
+        public static function load($config){
+            Loader::config($config);
+        }
 
-		/**
-		 * Set the configuration for "base_url" if is not set in the configuration
-		 */
-		private static function setBaseUrlUsingServerVar(){
-			$logger = static::getLogger();
-			if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){
-				if(ENVIRONMENT == 'production'){
-					$logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
-				}
-				$baseUrl = null;
-				$protocol = 'http';
-				if(is_https()){
-					$protocol = 'https';
-				}
-				$protocol .='://';
+        /**
+         * Set the configuration for "base_url" if is not set in the configuration
+         */
+        private static function setBaseUrlUsingServerVar(){
+            $logger = static::getLogger();
+            if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){
+                if(ENVIRONMENT == 'production'){
+                    $logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
+                }
+                $baseUrl = null;
+                $protocol = 'http';
+                if(is_https()){
+                    $protocol = 'https';
+                }
+                $protocol .='://';
 
-				if (isset($_SERVER['SERVER_ADDR'])){
-					$baseUrl = $_SERVER['SERVER_ADDR'];
-					//check if the server is running under IPv6
-					if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
-						$baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
-					}
-					$serverPort = 80;
-					if (isset($_SERVER['SERVER_PORT'])) {
-						$serverPort = $_SERVER['SERVER_PORT'];
-					}
-					$port = '';
-					if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){
-						$port = ':'.$serverPort;
-					}
-					$baseUrl = $protocol . $baseUrl . $port . substr(
-																		$_SERVER['SCRIPT_NAME'], 
-																		0, 
-																		strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
-																	);
-				}
-				else{
-					$logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
-					$baseUrl = 'http://localhost/';
-				}
-				self::set('base_url', $baseUrl);
-			}
-			self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
-		}
-	}
+                if (isset($_SERVER['SERVER_ADDR'])){
+                    $baseUrl = $_SERVER['SERVER_ADDR'];
+                    //check if the server is running under IPv6
+                    if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
+                        $baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
+                    }
+                    $serverPort = 80;
+                    if (isset($_SERVER['SERVER_PORT'])) {
+                        $serverPort = $_SERVER['SERVER_PORT'];
+                    }
+                    $port = '';
+                    if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){
+                        $port = ':'.$serverPort;
+                    }
+                    $baseUrl = $protocol . $baseUrl . $port . substr(
+                                                                        $_SERVER['SCRIPT_NAME'], 
+                                                                        0, 
+                                                                        strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
+                                                                    );
+                }
+                else{
+                    $logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
+                    $baseUrl = 'http://localhost/';
+                }
+                self::set('base_url', $baseUrl);
+            }
+            self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
+        }
+    }

core/classes/cache/FileCache.php

Indentation +289 added lines, -289 removed lines

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

core/classes/Router.php

Indentation +610 added lines, -610 removed lines

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

core/classes/Security.php

Indentation +147 added lines, -147 removed lines

@@ -1,157 +1,157 @@
 <?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{
+    class Security{
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * Get the logger singleton instance
-		 * @return Log the logger instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Security');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * Get the logger singleton instance
+         * @return Log the logger instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Security');
+            }
+            return self::$logger[0];
+        }
 
 
-		/**
-		 * 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');
+            }
+            }
+    }

core/classes/database/DatabaseQueryBuilder.php

Indentation +388 added lines, -388 removed lines

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

core/classes/database/Database.php

Indentation +329 added lines, -329 removed lines

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

core/classes/Response.php

Indentation +401 added lines, -401 removed lines

@@ -1,441 +1,441 @@
 <?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 Response{
+    class Response{
 
-		/**
-		 * The list of request header to send with response
-		 * @var array
-		 */
-		private static $headers = array();
+        /**
+         * The list of request header to send with response
+         * @var array
+         */
+        private static $headers = array();
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 		
-		/**
-		 * The final page content to display to user
-		 * @var string
-		 */
-		private $_pageRender = null;
+        /**
+         * The final page content to display to user
+         * @var string
+         */
+        private $_pageRender = null;
 		
-		/**
-		 * The current request URL
-		 * @var string
-		 */
-		private $_currentUrl = null;
+        /**
+         * The current request URL
+         * @var string
+         */
+        private $_currentUrl = null;
 		
-		/**
-		 * The current request URL cache key
-		 * @var string
-		 */
-		private $_currentUrlCacheKey = null;
+        /**
+         * The current request URL cache key
+         * @var string
+         */
+        private $_currentUrlCacheKey = null;
 		
-		/**
-		* Whether we can compress the output using Gzip
-		* @var boolean
-		*/
-		private static $_canCompressOutput = false;
+        /**
+         * Whether we can compress the output using Gzip
+         * @var boolean
+         */
+        private static $_canCompressOutput = false;
 		
-		/**
-		 * Construct new response instance
-		 */
-		public function __construct(){
-			$currentUrl = '';
-			if (! empty($_SERVER['REQUEST_URI'])){
-				$currentUrl = $_SERVER['REQUEST_URI'];
-			}
-			if (! empty($_SERVER['QUERY_STRING'])){
-				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
-			}
-			$this->_currentUrl =  $currentUrl;
+        /**
+         * Construct new response instance
+         */
+        public function __construct(){
+            $currentUrl = '';
+            if (! empty($_SERVER['REQUEST_URI'])){
+                $currentUrl = $_SERVER['REQUEST_URI'];
+            }
+            if (! empty($_SERVER['QUERY_STRING'])){
+                $currentUrl .= '?' . $_SERVER['QUERY_STRING'];
+            }
+            $this->_currentUrl =  $currentUrl;
 					
-			$this->_currentUrlCacheKey = md5($this->_currentUrl);
+            $this->_currentUrlCacheKey = md5($this->_currentUrl);
 			
-			self::$_canCompressOutput = get_config('compress_output')
-										  && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
-										  && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
-										  && extension_loaded('zlib')
-										  && (bool) ini_get('zlib.output_compression') === false;
-		}
+            self::$_canCompressOutput = get_config('compress_output')
+                                          && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
+                                          && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
+                                          && extension_loaded('zlib')
+                                          && (bool) ini_get('zlib.output_compression') === false;
+        }
 
-		/**
-		 * Get the logger singleton instance
-		 * @return Log the logger instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Response');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * Get the logger singleton instance
+         * @return Log the logger instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Response');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * Send the HTTP Response headers
-		 * @param  integer $httpCode the HTTP status code
-		 * @param  array   $headers   the additional headers to add to the existing headers list
-		 */
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
-			set_http_status_header($httpCode);
-			self::setHeaders($headers);
-			if(! headers_sent()){
-				foreach(self::getHeaders() as $key => $value){
-					header($key .': '.$value);
-				}
-			}
-		}
+        /**
+         * Send the HTTP Response headers
+         * @param  integer $httpCode the HTTP status code
+         * @param  array   $headers   the additional headers to add to the existing headers list
+         */
+        public static function sendHeaders($httpCode = 200, array $headers = array()){
+            set_http_status_header($httpCode);
+            self::setHeaders($headers);
+            if(! headers_sent()){
+                foreach(self::getHeaders() as $key => $value){
+                    header($key .': '.$value);
+                }
+            }
+        }
 
-		/**
-		 * Get the list of the headers
-		 * @return array the headers list
-		 */
-		public static function getHeaders(){
-			return self::$headers;
-		}
+        /**
+         * Get the list of the headers
+         * @return array the headers list
+         */
+        public static function getHeaders(){
+            return self::$headers;
+        }
 
-		/**
-		 * Get the header value for the given name
-		 * @param  string $name the header name
-		 * @return string       the header value
-		 */
-		public static function getHeader($name){
-			return array_key_exists($name, self::$headers) ? self::$headers[$name] : null;
-		}
+        /**
+         * Get the header value for the given name
+         * @param  string $name the header name
+         * @return string       the header value
+         */
+        public static function getHeader($name){
+            return array_key_exists($name, self::$headers) ? self::$headers[$name] : null;
+        }
 
 
-		/**
-		 * Set the header value for the specified name
-		 * @param string $name  the header name
-		 * @param string $value the header value to be set
-		 */
-		public static function setHeader($name, $value){
-			self::$headers[$name] = $value;
-		}
+        /**
+         * Set the header value for the specified name
+         * @param string $name  the header name
+         * @param string $value the header value to be set
+         */
+        public static function setHeader($name, $value){
+            self::$headers[$name] = $value;
+        }
 
-		/**
-		 * Set the headers using array
-		 * @param array $headers the list of the headers to set. 
-		 * Note: this will merge with the existing headers
-		 */
-		public static function setHeaders(array $headers){
-			self::$headers = array_merge(self::getHeaders(), $headers);
-		}
+        /**
+         * Set the headers using array
+         * @param array $headers the list of the headers to set. 
+         * Note: this will merge with the existing headers
+         */
+        public static function setHeaders(array $headers){
+            self::$headers = array_merge(self::getHeaders(), $headers);
+        }
 		
-		/**
-		 * Redirect user in the specified page
-		 * @param  string $path the URL or URI to be redirect to
-		 */
-		public static function redirect($path = ''){
-			$logger = self::getLogger();
-			$url = Url::site_url($path);
-			$logger->info('Redirect to URL [' .$url. ']');
-			if(! headers_sent()){
-				header('Location: '.$url);
-				exit;
-			}
-			else{
-				echo '<script>
+        /**
+         * Redirect user in the specified page
+         * @param  string $path the URL or URI to be redirect to
+         */
+        public static function redirect($path = ''){
+            $logger = self::getLogger();
+            $url = Url::site_url($path);
+            $logger->info('Redirect to URL [' .$url. ']');
+            if(! headers_sent()){
+                header('Location: '.$url);
+                exit;
+            }
+            else{
+                echo '<script>
 						location.href = "'.$url.'";
 					</script>';
-			}
-		}
+            }
+        }
 
-		/**
-		 * Render the view to display later or return the content
-		 * @param  string  $view   the view name or path
-		 * @param  array|object   $data   the variable data to use in the view
-		 * @param  boolean $return whether to return the view generated content or display it directly
-		 * @return void|string          if $return is true will return the view content otherwise
-		 * will display the view content.
-		 */
-		public function render($view, $data = null, $return = false){
-			$logger = self::getLogger();
-			//convert data to an array
-			$data = ! is_array($data) ? (array) $data : $data;
-			$view = str_ireplace('.php', '', $view);
-			$view = trim($view, '/\\');
-			$viewFile = $view . '.php';
-			$path = APPS_VIEWS_PATH . $viewFile;
+        /**
+         * Render the view to display later or return the content
+         * @param  string  $view   the view name or path
+         * @param  array|object   $data   the variable data to use in the view
+         * @param  boolean $return whether to return the view generated content or display it directly
+         * @return void|string          if $return is true will return the view content otherwise
+         * will display the view content.
+         */
+        public function render($view, $data = null, $return = false){
+            $logger = self::getLogger();
+            //convert data to an array
+            $data = ! is_array($data) ? (array) $data : $data;
+            $view = str_ireplace('.php', '', $view);
+            $view = trim($view, '/\\');
+            $viewFile = $view . '.php';
+            $path = APPS_VIEWS_PATH . $viewFile;
 			
-			//super instance
-			$obj = & get_instance();
+            //super instance
+            $obj = & get_instance();
 			
-			if(Module::hasModule()){
-				//check in module first
-				$logger->debug('Checking the view [' . $view . '] from module list ...');
-				$mod = null;
-				//check if the request class contains module name
-				if(strpos($view, '/') !== false){
-					$viewPath = explode('/', $view);
-					if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
-						$mod = $viewPath[0];
-						array_shift($viewPath);
-						$view = implode('/', $viewPath);
-						$viewFile = $view . '.php';
-					}
-				}
-				if(! $mod && !empty($obj->moduleName)){
-					$mod = $obj->moduleName;
-				}
-				if($mod){
-					$moduleViewPath = Module::findViewFullPath($view, $mod);
-					if($moduleViewPath){
-						$path = $moduleViewPath;
-						$logger->info('Found view [' . $view . '] in module [' .$mod. '], the file path is [' .$moduleViewPath. '] we will used it');
-					}
-					else{
-						$logger->info('Cannot find view [' . $view . '] in module [' .$mod. '] using the default location');
-					}
-				}
-				else{
-					$logger->info('The current request does not use module using the default location.');
-				}
-			}
-			$logger->info('The view file path to be loaded is [' . $path . ']');
-			$found = false;
-			if(file_exists($path)){
-				foreach(get_object_vars($obj) as $key => $value){
-					if(! isset($this->{$key})){
-						$this->{$key} = & $obj->{$key};
-					}
-				}
-				ob_start();
-				extract($data);
-				//need use require() instead of require_once because can load this view many time
-				require $path;
-				$content = ob_get_clean();
-				if($return){
-					return $content;
-				}
-				$this->_pageRender .= $content;
-				$found = true;
-			}
-			if(! $found){
-				show_error('Unable to find view [' .$view . ']');
-			}
-		}
+            if(Module::hasModule()){
+                //check in module first
+                $logger->debug('Checking the view [' . $view . '] from module list ...');
+                $mod = null;
+                //check if the request class contains module name
+                if(strpos($view, '/') !== false){
+                    $viewPath = explode('/', $view);
+                    if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
+                        $mod = $viewPath[0];
+                        array_shift($viewPath);
+                        $view = implode('/', $viewPath);
+                        $viewFile = $view . '.php';
+                    }
+                }
+                if(! $mod && !empty($obj->moduleName)){
+                    $mod = $obj->moduleName;
+                }
+                if($mod){
+                    $moduleViewPath = Module::findViewFullPath($view, $mod);
+                    if($moduleViewPath){
+                        $path = $moduleViewPath;
+                        $logger->info('Found view [' . $view . '] in module [' .$mod. '], the file path is [' .$moduleViewPath. '] we will used it');
+                    }
+                    else{
+                        $logger->info('Cannot find view [' . $view . '] in module [' .$mod. '] using the default location');
+                    }
+                }
+                else{
+                    $logger->info('The current request does not use module using the default location.');
+                }
+            }
+            $logger->info('The view file path to be loaded is [' . $path . ']');
+            $found = false;
+            if(file_exists($path)){
+                foreach(get_object_vars($obj) as $key => $value){
+                    if(! isset($this->{$key})){
+                        $this->{$key} = & $obj->{$key};
+                    }
+                }
+                ob_start();
+                extract($data);
+                //need use require() instead of require_once because can load this view many time
+                require $path;
+                $content = ob_get_clean();
+                if($return){
+                    return $content;
+                }
+                $this->_pageRender .= $content;
+                $found = true;
+            }
+            if(! $found){
+                show_error('Unable to find view [' .$view . ']');
+            }
+        }
 		
-		/**
-		* Send the final page output to user
-		*/
-		public function renderFinalPage(){
-			$logger = self::getLogger();
-			$obj = & get_instance();
-			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
-			$dispatcher = $obj->eventdispatcher;
-			$content = $this->_pageRender;
-			if(! $content){
-				$logger->warning('The final view content is empty.');
-				return;
-			}
-			//dispatch
-			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
-			$content = ! empty($event->payload) ? $event->payload : null;
-			if(empty($content)){
-				$logger->warning('The view content is empty after dispatch to event listeners.');
-			}
+        /**
+         * Send the final page output to user
+         */
+        public function renderFinalPage(){
+            $logger = self::getLogger();
+            $obj = & get_instance();
+            $cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
+            $dispatcher = $obj->eventdispatcher;
+            $content = $this->_pageRender;
+            if(! $content){
+                $logger->warning('The final view content is empty.');
+                return;
+            }
+            //dispatch
+            $event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
+            $content = ! empty($event->payload) ? $event->payload : null;
+            if(empty($content)){
+                $logger->warning('The view content is empty after dispatch to event listeners.');
+            }
 			
-			//check whether need save the page into cache.
-			if($cachePageStatus){
-				//current page URL
-				$url = $this->_currentUrl;
-				//Cache view Time to live in second
-				$viewCacheTtl = get_config('cache_ttl');
-				if (!empty($obj->view_cache_ttl)){
-					$viewCacheTtl = $obj->view_cache_ttl;
-				}
-				//the cache handler instance
-				$cacheInstance = $obj->cache;
-				//the current page cache key for identification
-				$cacheKey = $this->_currentUrlCacheKey;
+            //check whether need save the page into cache.
+            if($cachePageStatus){
+                //current page URL
+                $url = $this->_currentUrl;
+                //Cache view Time to live in second
+                $viewCacheTtl = get_config('cache_ttl');
+                if (!empty($obj->view_cache_ttl)){
+                    $viewCacheTtl = $obj->view_cache_ttl;
+                }
+                //the cache handler instance
+                $cacheInstance = $obj->cache;
+                //the current page cache key for identification
+                $cacheKey = $this->_currentUrlCacheKey;
 				
-				$logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
-				$cacheInstance->set($cacheKey, $content, $viewCacheTtl);
+                $logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
+                $cacheInstance->set($cacheKey, $content, $viewCacheTtl);
 				
-				//get the cache information to prepare header to send to browser
-				$cacheInfo = $cacheInstance->getInfo($cacheKey);
-				if($cacheInfo){
-					$lastModified = $cacheInfo['mtime'];
-					$expire = $cacheInfo['expire'];
-					$maxAge = $expire - time();
-					self::setHeader('Pragma', 'public');
-					self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-					self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-					self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
-				}
-			}
+                //get the cache information to prepare header to send to browser
+                $cacheInfo = $cacheInstance->getInfo($cacheKey);
+                if($cacheInfo){
+                    $lastModified = $cacheInfo['mtime'];
+                    $expire = $cacheInfo['expire'];
+                    $maxAge = $expire - time();
+                    self::setHeader('Pragma', 'public');
+                    self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
+                    self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
+                    self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
+                }
+            }
 			
-			// Parse out the elapsed time and memory usage,
-			// then swap the pseudo-variables with the data
-			$elapsedTime = $obj->benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
-			$memoryUsage	= round($obj->benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
-			$content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
+            // Parse out the elapsed time and memory usage,
+            // then swap the pseudo-variables with the data
+            $elapsedTime = $obj->benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
+            $memoryUsage	= round($obj->benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
+            $content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
 			
-			//compress the output if is available
-			$type = null;
-			if (self::$_canCompressOutput){
-				$type = 'ob_gzhandler';
-			}
-			ob_start($type);
-			self::sendHeaders(200);
-			echo $content;
-			ob_end_flush();
-		}
+            //compress the output if is available
+            $type = null;
+            if (self::$_canCompressOutput){
+                $type = 'ob_gzhandler';
+            }
+            ob_start($type);
+            self::sendHeaders(200);
+            echo $content;
+            ob_end_flush();
+        }
 		
-		/**
-		* Send the final page output to user if is cached
-		*/
-		public function renderFinalPageFromCache(&$cache){
-			$logger = self::getLogger();
-			$url = $this->_currentUrl;					
-			//the current page cache key for identification
-			$pageCacheKey = $this->_currentUrlCacheKey;
+        /**
+         * Send the final page output to user if is cached
+         */
+        public function renderFinalPageFromCache(&$cache){
+            $logger = self::getLogger();
+            $url = $this->_currentUrl;					
+            //the current page cache key for identification
+            $pageCacheKey = $this->_currentUrlCacheKey;
 			
-			$logger->debug('Checking if the page content for the URL [' . $url . '] is cached ...');
-			//get the cache information to prepare header to send to browser
-			$cacheInfo = $cache->getInfo($pageCacheKey);
-			if($cacheInfo){
-				$lastModified = $cacheInfo['mtime'];
-				$expire = $cacheInfo['expire'];
-				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
-				self::setHeader('Pragma', 'public');
-				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
-					$logger->info('The cache page content is not yet expire for the URL [' . $url . '] send 304 header to browser');
-					self::sendHeaders(304);
-					return;
-				}
-				$logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $url . '] send cache headers to tell the browser');
-				self::sendHeaders(200);
-				//get the cache content
-				$content = $cache->get($pageCacheKey);
-				if($content){
-					$logger->info('The page content for the URL [' . $url . '] already cached just display it');
-					//load benchmark class
-					$benchmark = & class_loader('Benchmark');
+            $logger->debug('Checking if the page content for the URL [' . $url . '] is cached ...');
+            //get the cache information to prepare header to send to browser
+            $cacheInfo = $cache->getInfo($pageCacheKey);
+            if($cacheInfo){
+                $lastModified = $cacheInfo['mtime'];
+                $expire = $cacheInfo['expire'];
+                $maxAge = $expire - $_SERVER['REQUEST_TIME'];
+                self::setHeader('Pragma', 'public');
+                self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
+                self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
+                self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
+                if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
+                    $logger->info('The cache page content is not yet expire for the URL [' . $url . '] send 304 header to browser');
+                    self::sendHeaders(304);
+                    return;
+                }
+                $logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $url . '] send cache headers to tell the browser');
+                self::sendHeaders(200);
+                //get the cache content
+                $content = $cache->get($pageCacheKey);
+                if($content){
+                    $logger->info('The page content for the URL [' . $url . '] already cached just display it');
+                    //load benchmark class
+                    $benchmark = & class_loader('Benchmark');
 					
-					// Parse out the elapsed time and memory usage,
-					// then swap the pseudo-variables with the data
-					$elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
-					$memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
-					$content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
+                    // Parse out the elapsed time and memory usage,
+                    // then swap the pseudo-variables with the data
+                    $elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
+                    $memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
+                    $content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
 					
-					///display the final output
-					//compress the output if is available
-					$type = null;
-					if (self::$_canCompressOutput){
-						$type = 'ob_gzhandler';
-					}
-					ob_start($type);
-					echo $content;
-					ob_end_flush();
-					return;
-				}
-				else{
-					$logger->info('The page cache content for the URL [' . $url . '] is not valid may be already expired');
-					$cache->delete($pageCacheKey);
-				}
+                    ///display the final output
+                    //compress the output if is available
+                    $type = null;
+                    if (self::$_canCompressOutput){
+                        $type = 'ob_gzhandler';
+                    }
+                    ob_start($type);
+                    echo $content;
+                    ob_end_flush();
+                    return;
+                }
+                else{
+                    $logger->info('The page cache content for the URL [' . $url . '] is not valid may be already expired');
+                    $cache->delete($pageCacheKey);
+                }
 				
-			}
-		}
+            }
+        }
 		
-		/**
-		* Get the final page to be rendered
-		* @return string
-		*/
-		public function getFinalPageRendered(){
-			return $this->_pageRender;
-		}
+        /**
+         * Get the final page to be rendered
+         * @return string
+         */
+        public function getFinalPageRendered(){
+            return $this->_pageRender;
+        }
 
-		/**
-		 * Send the HTTP 404 error if can not found the 
-		 * routing information for the current request
-		 */
-		public static function send404(){
-			/********* for logs **************/
-			//can't use $obj = & get_instance()  here because the global super object will be available until
-			//the main controller is loaded even for Loader::library('xxxx');
-			$logger = self::getLogger();
-			$request =& class_loader('Request', 'classes');
-			$userAgent =& class_loader('Browser');
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
+        /**
+         * Send the HTTP 404 error if can not found the 
+         * routing information for the current request
+         */
+        public static function send404(){
+            /********* for logs **************/
+            //can't use $obj = & get_instance()  here because the global super object will be available until
+            //the main controller is loaded even for Loader::library('xxxx');
+            $logger = self::getLogger();
+            $request =& class_loader('Request', 'classes');
+            $userAgent =& class_loader('Browser');
+            $browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
 			
-			//here can't use Loader::functions just include the helper manually
-			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+            //here can't use Loader::functions just include the helper manually
+            require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 
-			$str = '[404 page not found] : ';
-			$str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
-			$logger->error($str);
-			/***********************************/
-			$path = CORE_VIEWS_PATH . '404.php';
-			if(file_exists($path)){
-				//compress the output if is available
-				$type = null;
-				if (self::$_canCompressOutput){
-					$type = 'ob_gzhandler';
-				}
-				ob_start($type);
-				require_once $path;
-				$output = ob_get_clean();
-				self::sendHeaders(404);
-				echo $output;
-			}
-			else{
-				show_error('The 404 view [' .$path. '] does not exist');
-			}
-		}
+            $str = '[404 page not found] : ';
+            $str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
+            $logger->error($str);
+            /***********************************/
+            $path = CORE_VIEWS_PATH . '404.php';
+            if(file_exists($path)){
+                //compress the output if is available
+                $type = null;
+                if (self::$_canCompressOutput){
+                    $type = 'ob_gzhandler';
+                }
+                ob_start($type);
+                require_once $path;
+                $output = ob_get_clean();
+                self::sendHeaders(404);
+                echo $output;
+            }
+            else{
+                show_error('The 404 view [' .$path. '] does not exist');
+            }
+        }
 
-		/**
-		 * Display the error to user
-		 * @param  array  $data the error information
-		 */
-		public static function sendError(array $data = array()){
-			$path = CORE_VIEWS_PATH . 'errors.php';
-			if(file_exists($path)){
-				//compress the output if is available
-				$type = null;
-				if (self::$_canCompressOutput){
-					$type = 'ob_gzhandler';
-				}
-				ob_start($type);
-				extract($data);
-				require_once $path;
-				$output = ob_get_clean();
-				self::sendHeaders(503);
-				echo $output;
-			}
-			else{
-				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
-				set_http_status_header(503);
-				echo 'The error view [' . $path . '] does not exist';
-			}
-		}
-	}
+        /**
+         * Display the error to user
+         * @param  array  $data the error information
+         */
+        public static function sendError(array $data = array()){
+            $path = CORE_VIEWS_PATH . 'errors.php';
+            if(file_exists($path)){
+                //compress the output if is available
+                $type = null;
+                if (self::$_canCompressOutput){
+                    $type = 'ob_gzhandler';
+                }
+                ob_start($type);
+                extract($data);
+                require_once $path;
+                $output = ob_get_clean();
+                self::sendHeaders(503);
+                echo $output;
+            }
+            else{
+                //can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
+                set_http_status_header(503);
+                echo 'The error view [' . $path . '] does not exist';
+            }
+        }
+    }

core/classes/Log.php

Indentation +251 added lines, -251 removed lines

@@ -1,279 +1,279 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Log{
+    class Log{
 		
-		/**
-		 * The defined constante for Log level
-		 */
-		const NONE = 99999999;
-		const FATAL = 500;
-		const ERROR = 400;
-		const WARNING = 300;
-		const INFO = 200;
-		const DEBUG = 100;
-		const ALL = -99999999;
+        /**
+         * The defined constante for Log level
+         */
+        const NONE = 99999999;
+        const FATAL = 500;
+        const ERROR = 400;
+        const WARNING = 300;
+        const INFO = 200;
+        const DEBUG = 100;
+        const ALL = -99999999;
 
-		/**
-		 * The logger name
-		 * @var string
-		 */
-		private $logger = 'ROOT_LOGGER';
+        /**
+         * The logger name
+         * @var string
+         */
+        private $logger = 'ROOT_LOGGER';
 		
-		/**
-		 * List of valid log level to be checked for the configuration
-		 * @var array
-		 */
-		private static $validConfigLevel = array('off', 'none', 'fatal', 'error', 'warning', 'warn', 'info', 'debug', 'all');
+        /**
+         * List of valid log level to be checked for the configuration
+         * @var array
+         */
+        private static $validConfigLevel = array('off', 'none', 'fatal', 'error', 'warning', 'warn', 'info', 'debug', 'all');
 
-		/**
-		 * Create new Log instance
-		 */
-		public function __construct(){
-		}
+        /**
+         * Create new Log instance
+         */
+        public function __construct(){
+        }
 
-		/**
-		 * Set the logger to identify each message in the log
-		 * @param string $logger the logger name
-		 */
-		public  function setLogger($logger){
-			$this->logger = $logger;
-		}
+        /**
+         * Set the logger to identify each message in the log
+         * @param string $logger the logger name
+         */
+        public  function setLogger($logger){
+            $this->logger = $logger;
+        }
 
-		/**
-		 * Save the fatal message in the log
-		 * @see Log::writeLog for more detail
-		 * @param  string $message the log message to save
-		 */
-		public function fatal($message){
-			$this->writeLog($message, self::FATAL);
-		} 
+        /**
+         * Save the fatal message in the log
+         * @see Log::writeLog for more detail
+         * @param  string $message the log message to save
+         */
+        public function fatal($message){
+            $this->writeLog($message, self::FATAL);
+        } 
 		
-		/**
-		 * Save the error message in the log
-		 * @see Log::writeLog for more detail
-		 * @param  string $message the log message to save
-		 */
-		public function error($message){
-			$this->writeLog($message, self::ERROR);
-		} 
+        /**
+         * Save the error message in the log
+         * @see Log::writeLog for more detail
+         * @param  string $message the log message to save
+         */
+        public function error($message){
+            $this->writeLog($message, self::ERROR);
+        } 
 
-		/**
-		 * Save the warning message in the log
-		 * @see Log::writeLog for more detail
-		 * @param  string $message the log message to save
-		 */
-		public function warning($message){
-			$this->writeLog($message, self::WARNING);
-		} 
+        /**
+         * Save the warning message in the log
+         * @see Log::writeLog for more detail
+         * @param  string $message the log message to save
+         */
+        public function warning($message){
+            $this->writeLog($message, self::WARNING);
+        } 
 		
-		/**
-		 * Save the info message in the log
-		 * @see Log::writeLog for more detail
-		 * @param  string $message the log message to save
-		 */
-		public function info($message){
-			$this->writeLog($message, self::INFO);
-		} 
+        /**
+         * Save the info message in the log
+         * @see Log::writeLog for more detail
+         * @param  string $message the log message to save
+         */
+        public function info($message){
+            $this->writeLog($message, self::INFO);
+        } 
 		
-		/**
-		 * Save the debug message in the log
-		 * @see Log::writeLog for more detail
-		 * @param  string $message the log message to save
-		 */
-		public function debug($message){
-			$this->writeLog($message, self::DEBUG);
-		} 
+        /**
+         * Save the debug message in the log
+         * @see Log::writeLog for more detail
+         * @param  string $message the log message to save
+         */
+        public function debug($message){
+            $this->writeLog($message, self::DEBUG);
+        } 
 		
 		
-		/**
-		 * Save the log message
-		 * @param  string $message the log message to be saved
-		 * @param  integer|string $level   the log level in integer or string format, if is string will convert into integer
-		 * to allow check the log level threshold.
-		 */
-		public function writeLog($message, $level = self::INFO){
-			$configLogLevel = get_config('log_level');
-			if(! $configLogLevel){
-				//so means no need log just stop here
-				return;
-			}
-			//check config log level
-			if(! self::isValidConfigLevel($configLogLevel)){
-				//NOTE: here need put the show_error() "logging" to false to prevent loop
-				show_error('Invalid config log level [' . $configLogLevel . '], the value must be one of the following: ' . implode(', ', array_map('strtoupper', self::$validConfigLevel)), $title = 'Log Config Error', $logging = false);	
-			}
+        /**
+         * Save the log message
+         * @param  string $message the log message to be saved
+         * @param  integer|string $level   the log level in integer or string format, if is string will convert into integer
+         * to allow check the log level threshold.
+         */
+        public function writeLog($message, $level = self::INFO){
+            $configLogLevel = get_config('log_level');
+            if(! $configLogLevel){
+                //so means no need log just stop here
+                return;
+            }
+            //check config log level
+            if(! self::isValidConfigLevel($configLogLevel)){
+                //NOTE: here need put the show_error() "logging" to false to prevent loop
+                show_error('Invalid config log level [' . $configLogLevel . '], the value must be one of the following: ' . implode(', ', array_map('strtoupper', self::$validConfigLevel)), $title = 'Log Config Error', $logging = false);	
+            }
 			
-			//check if config log_logger_name is set
-			if($this->logger){
-				$configLoggersName = get_config('log_logger_name', array());
-				if (!empty($configLoggersName)) {
-					//for best comparaison put all string to lowercase
-					$configLoggersName = array_map('strtolower', $configLoggersName);
-					if(! in_array(strtolower($this->logger), $configLoggersName)){
-						return;
-					}
-				}
-			}
+            //check if config log_logger_name is set
+            if($this->logger){
+                $configLoggersName = get_config('log_logger_name', array());
+                if (!empty($configLoggersName)) {
+                    //for best comparaison put all string to lowercase
+                    $configLoggersName = array_map('strtolower', $configLoggersName);
+                    if(! in_array(strtolower($this->logger), $configLoggersName)){
+                        return;
+                    }
+                }
+            }
 			
-			//if $level is not an integer
-			if(! is_numeric($level)){
-				$level = self::getLevelValue($level);
-			}
+            //if $level is not an integer
+            if(! is_numeric($level)){
+                $level = self::getLevelValue($level);
+            }
 			
-			//check if can logging regarding the log level config
-			$configLevel = self::getLevelValue($configLogLevel);
-			if($configLevel > $level){
-				//can't log
-				return;
-			}
-			//check log file and directory
-			$path = $this->checkAndSetLogFileDirectory();
-			//save the log data
-			$this->saveLogData($path, $level, $message);
-		}	
+            //check if can logging regarding the log level config
+            $configLevel = self::getLevelValue($configLogLevel);
+            if($configLevel > $level){
+                //can't log
+                return;
+            }
+            //check log file and directory
+            $path = $this->checkAndSetLogFileDirectory();
+            //save the log data
+            $this->saveLogData($path, $level, $message);
+        }	
 
-		/**
-		 * Save the log data into file
-		 * @param  string $path    the path of the log file
-		 * @param  int $level   the log level in numeric format
-		 * @param  string $message the log message to save
-		 * @return void
-		 */
-		public function saveLogData($path, $level, $message){
-			//may be at this time helper user_agent not yet included
-			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+        /**
+         * Save the log data into file
+         * @param  string $path    the path of the log file
+         * @param  int $level   the log level in numeric format
+         * @param  string $message the log message to save
+         * @return void
+         */
+        public function saveLogData($path, $level, $message){
+            //may be at this time helper user_agent not yet included
+            require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 			
-			///////////////////// date //////////////
-			$timestampWithMicro = microtime(true);
-			$microtime = sprintf('%06d', ($timestampWithMicro - floor($timestampWithMicro)) * 1000000);
-			$dateTime = new DateTime(date('Y-m-d H:i:s.' . $microtime, $timestampWithMicro));
-			$logDate = $dateTime->format('Y-m-d H:i:s.u'); 
-			//ip
-			$ip = get_ip();
-			//level name
-			$levelName = self::getLevelName($level);
+            ///////////////////// date //////////////
+            $timestampWithMicro = microtime(true);
+            $microtime = sprintf('%06d', ($timestampWithMicro - floor($timestampWithMicro)) * 1000000);
+            $dateTime = new DateTime(date('Y-m-d H:i:s.' . $microtime, $timestampWithMicro));
+            $logDate = $dateTime->format('Y-m-d H:i:s.u'); 
+            //ip
+            $ip = get_ip();
+            //level name
+            $levelName = self::getLevelName($level);
 			
-			//debug info
-			$dtrace = debug_backtrace();
-			$fileInfo = $dtrace[0]['file'] == __FILE__ ? $dtrace[1] : $dtrace[0];
+            //debug info
+            $dtrace = debug_backtrace();
+            $fileInfo = $dtrace[0]['file'] == __FILE__ ? $dtrace[1] : $dtrace[0];
 			
-			$str = $logDate . ' [' . str_pad($levelName, 7 /*warning len*/) . '] ' . ' [' . str_pad($ip, 15) . '] ' . $this->logger . ' : ' . $message . ' ' . '[' . $fileInfo['file'] . '::' . $fileInfo['line'] . ']' . "\n";
-			$fp = fopen($path, 'a+');
-			if(is_resource($fp)){
-				flock($fp, LOCK_EX); // exclusive lock, will get released when the file is closed
-				fwrite($fp, $str);
-				fclose($fp);
-			}
-		}	
+            $str = $logDate . ' [' . str_pad($levelName, 7 /*warning len*/) . '] ' . ' [' . str_pad($ip, 15) . '] ' . $this->logger . ' : ' . $message . ' ' . '[' . $fileInfo['file'] . '::' . $fileInfo['line'] . ']' . "\n";
+            $fp = fopen($path, 'a+');
+            if(is_resource($fp)){
+                flock($fp, LOCK_EX); // exclusive lock, will get released when the file is closed
+                fwrite($fp, $str);
+                fclose($fp);
+            }
+        }	
 
-		/**
-		 * Check the file and directory 
-		 * @return string the log file path
-		 */
-		protected function checkAndSetLogFileDirectory(){
-			$logSavePath = get_config('log_save_path');
-			if(! $logSavePath){
-				$logSavePath = LOGS_PATH;
-			}
+        /**
+         * Check the file and directory 
+         * @return string the log file path
+         */
+        protected function checkAndSetLogFileDirectory(){
+            $logSavePath = get_config('log_save_path');
+            if(! $logSavePath){
+                $logSavePath = LOGS_PATH;
+            }
 			
-			if(! is_dir($logSavePath) || !is_writable($logSavePath)){
-				//NOTE: here need put the show_error() "logging" to false to prevent loop
-				show_error('Error : the log dir does not exists or is not writable', $title = 'Log directory error', $logging = false);
-			}
+            if(! is_dir($logSavePath) || !is_writable($logSavePath)){
+                //NOTE: here need put the show_error() "logging" to false to prevent loop
+                show_error('Error : the log dir does not exists or is not writable', $title = 'Log directory error', $logging = false);
+            }
 			
-			$path = $logSavePath . 'logs-' . date('Y-m-d') . '.log';
-			if(! file_exists($path)){
-				touch($path);
-			}
-			return $path;
-		}
+            $path = $logSavePath . 'logs-' . date('Y-m-d') . '.log';
+            if(! file_exists($path)){
+                touch($path);
+            }
+            return $path;
+        }
 		
-		/**
-		 * Check if the given log level is valid
-		 *
-		 * @param  string  $level the log level
-		 *
-		 * @return boolean        true if the given log level is valid, false if not
-		 */
-		protected static function isValidConfigLevel($level){
-			$level = strtolower($level);
-			return in_array($level, self::$validConfigLevel);
-		}
+        /**
+         * Check if the given log level is valid
+         *
+         * @param  string  $level the log level
+         *
+         * @return boolean        true if the given log level is valid, false if not
+         */
+        protected static function isValidConfigLevel($level){
+            $level = strtolower($level);
+            return in_array($level, self::$validConfigLevel);
+        }
 
-		/**
-		 * Get the log level number for the given level string
-		 * @param  string $level the log level in string format
-		 * 
-		 * @return int        the log level in integer format using the predefinied constants
-		 */
-		protected static function getLevelValue($level){
-			$level = strtolower($level);
-			$levelMaps = array(
-				'fatal'   => self::FATAL,
-				'error'   => self::ERROR,
-				'warning' => self::WARNING,
-				'warn'    => self::WARNING,
-				'info'    => self::INFO,
-				'debug'   => self::DEBUG,
-				'all'     => self::ALL
-			);
-			//the default value is NONE, so means no need test for NONE
-			$value = self::NONE;
-			foreach ($levelMaps as $k => $v) {
-				if($level == $k){
-					$value = $v;
-					break;
-				}
-			}
-			return $value;
-		}
+        /**
+         * Get the log level number for the given level string
+         * @param  string $level the log level in string format
+         * 
+         * @return int        the log level in integer format using the predefinied constants
+         */
+        protected static function getLevelValue($level){
+            $level = strtolower($level);
+            $levelMaps = array(
+                'fatal'   => self::FATAL,
+                'error'   => self::ERROR,
+                'warning' => self::WARNING,
+                'warn'    => self::WARNING,
+                'info'    => self::INFO,
+                'debug'   => self::DEBUG,
+                'all'     => self::ALL
+            );
+            //the default value is NONE, so means no need test for NONE
+            $value = self::NONE;
+            foreach ($levelMaps as $k => $v) {
+                if($level == $k){
+                    $value = $v;
+                    break;
+                }
+            }
+            return $value;
+        }
 
-		/**
-		 * Get the log level string for the given log level integer
-		 * @param  integer $level the log level in integer format
-		 * @return string        the log level in string format
-		 */
-		protected static function getLevelName($level){
-			$levelMaps = array(
-				self::FATAL   => 'FATAL',
-				self::ERROR   => 'ERROR',
-				self::WARNING => 'WARNING',
-				self::INFO    => 'INFO',
-				self::DEBUG   => 'DEBUG'
-			);
-			$value = '';
-			foreach ($levelMaps as $k => $v) {
-				if($level == $k){
-					$value = $v;
-					break;
-				}
-			}
-			//no need for ALL
-			return $value;
-		}
+        /**
+         * Get the log level string for the given log level integer
+         * @param  integer $level the log level in integer format
+         * @return string        the log level in string format
+         */
+        protected static function getLevelName($level){
+            $levelMaps = array(
+                self::FATAL   => 'FATAL',
+                self::ERROR   => 'ERROR',
+                self::WARNING => 'WARNING',
+                self::INFO    => 'INFO',
+                self::DEBUG   => 'DEBUG'
+            );
+            $value = '';
+            foreach ($levelMaps as $k => $v) {
+                if($level == $k){
+                    $value = $v;
+                    break;
+                }
+            }
+            //no need for ALL
+            return $value;
+        }
 
-	}
+    }

core/libraries/FormValidation.php

Indentation +94 added lines, -94 removed lines

@@ -22,10 +22,10 @@ 
      * 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 FormValidation{
+        class FormValidation{
 		 
         /**
          * The form validation status
@@ -60,7 +60,7 @@ 
          */
         protected $_eachErrorDelimiter   = array('<p class="error">', '</p>');
         
-		/**
+        /**
          * Indicated if need force the validation to be failed
          * @var boolean
          */
@@ -100,7 +100,7 @@ 
             $this->logger =& class_loader('Log', 'classes');
             $this->logger->setLogger('Library::FormValidation');
            
-		   //Load form validation language message
+            //Load form validation language message
             Loader::lang('form_validation');
             $obj = & get_instance();
             $this->_errorsMessages  = array(
@@ -162,13 +162,13 @@ 
         /**
          * Set the form validation data
          * @param array $data the values to be validated
-		 *
+         *
          * @return FormValidation Current instance of object.
          */
         public function setData(array $data){
             $this->logger->debug('Setting the form validation data, the values are: ' . stringfy_vars($data));
             $this->data = $data;
-			return $this;
+            return $this;
         }
 
         /**
@@ -179,11 +179,11 @@ 
             return $this->data;
         }
 
-		/**
-		* Get the validation function name to validate a rule
-		*
-		* @return string the function name
-		*/
+        /**
+         * Get the validation function name to validate a rule
+         *
+         * @return string the function name
+         */
         protected function _toCallCase($funcName, $prefix='_validate') {
             $funcName = strtolower($funcName);
             $finalFuncName = $prefix;
@@ -253,12 +253,12 @@ 
             $this->_forceFail = false;
 
             foreach ($this->getData() as $inputName => $inputVal) {
-    			if(is_array($this->data[$inputName])){
-    				$this->data[$inputName] = array_map('trim', $this->data[$inputName]);
-    			}
-    			else{
-    				$this->data[$inputName] = trim($this->data[$inputName]);
-    			}
+                if(is_array($this->data[$inputName])){
+                    $this->data[$inputName] = array_map('trim', $this->data[$inputName]);
+                }
+                else{
+                    $this->data[$inputName] = trim($this->data[$inputName]);
+                }
 
                 if (array_key_exists($inputName, $this->_rules)) {
                     foreach ($this->_parseRuleString($this->_rules[$inputName]) as $eachRule) {
@@ -274,7 +274,7 @@ 
          *
          * @param string $inputField Name of the field or the data key to add a rule to
          * @param string $ruleSets PIPE seperated string of rules
-		 *
+         *
          * @return FormValidation Current instance of object.
          */
         public function setRule($inputField, $inputLabel, $ruleSets) {
@@ -288,8 +288,8 @@ 
          * Takes an array of rules and uses setRule() to set them, accepts an array
          * of rule names rather than a pipe-delimited string as well.
          * @param array $ruleSets
-		 *
-		 * @return FormValidation Current instance of object.
+         *
+         * @return FormValidation Current instance of object.
          */
         public function setRules(array $ruleSets) {
             foreach ($ruleSets as $ruleSet) {
@@ -311,7 +311,7 @@ 
          * @param string $start Before block of errors gets displayed, HTML allowed.
          * @param string $end After the block of errors gets displayed, HTML allowed.
          *
-		 * @return FormValidation Current instance of object.
+         * @return FormValidation Current instance of object.
          */
         public function setErrorsDelimiter($start, $end) {
             $this->_allErrorsDelimiter[0] = $start;
@@ -326,7 +326,7 @@ 
          * @param string $start Displayed before each error.
          * @param string $end Displayed after each error.
          * 
-		 * @return FormValidation Current instance of object.
+         * @return FormValidation Current instance of object.
          */
         public function setErrorDelimiter($start, $end) {
             $this->_eachErrorDelimiter[0] = $start;
@@ -334,21 +334,21 @@ 
             return $this;
         }
 
-		/**
-		* Get the each errors delimiters
-		*
-		* @return array
-		*/
-    	public function getErrorDelimiter() {
+        /**
+         * Get the each errors delimiters
+         *
+         * @return array
+         */
+        public function getErrorDelimiter() {
             return $this->_eachErrorDelimiter;
         }
 
-		/**
-		* Get the all errors delimiters
-		*
-		* @return array
-		*/
-    	public function getErrorsDelimiter() {
+        /**
+         * Get the all errors delimiters
+         *
+         * @return array
+         */
+        public function getErrorsDelimiter() {
             return $this->_allErrorsDelimiter;
         }
 
@@ -386,7 +386,7 @@ 
          *
          * @param string $inputName The form input name or data key
          * @param string $errorMessage Error to display
-		 *
+         *
          * @return formValidation Current instance of the object
          */
         public function setCustomError($inputName, $errorMessage) {
@@ -423,17 +423,17 @@ 
          *
          * @param boolean $limit number of error to display or return
          * @param boolean $echo Whether or not the values are to be returned or displayed
-		 *
+         *
          * @return string Errors formatted for output
          */
         public function displayErrors($limit = null, $echo = true) {
             list($errorsStart, $errorsEnd) = $this->_allErrorsDelimiter;
             list($errorStart, $errorEnd) = $this->_eachErrorDelimiter;
             $errorOutput = $errorsStart;
-    		$i = 0;
+            $i = 0;
             if (!empty($this->_errors)) {
                 foreach ($this->_errors as $fieldName => $error) {
-        	    	if ($i === $limit) { 
+                    if ($i === $limit) { 
                         break; 
                     }
                     $errorOutput .= $errorStart;
@@ -461,7 +461,7 @@ 
          * Breaks up a PIPE seperated string of rules, and puts them into an array.
          *
          * @param string $ruleString String to be parsed.
-		 *
+         *
          * @return array Array of each value in original string.
          */
         protected function _parseRuleString($ruleString) {
@@ -474,10 +474,10 @@ 
                 $rule = '#regex\[\/(.*)\/([a-zA-Z0-9]?)\]#';
                 preg_match($rule, $ruleString, $regexRule);
                 $ruleStringTemp = preg_replace($rule, '', $ruleString);
-                 if(!empty($regexRule[0])){
-                     $ruleSets[] = $regexRule[0];
-                 }
-                 $ruleStringRegex = explode('|', $ruleStringTemp);
+                    if(!empty($regexRule[0])){
+                        $ruleSets[] = $regexRule[0];
+                    }
+                    $ruleStringRegex = explode('|', $ruleStringTemp);
                 foreach ($ruleStringRegex as $rule) {
                     $rule = trim($rule);
                     if($rule){
@@ -493,7 +493,7 @@ 
                 } else {
                     $ruleSets[] = $ruleString;
                 }
-             }
+                }
             return $ruleSets;
         }
 
@@ -501,7 +501,7 @@ 
          * Returns whether or not a field obtains the rule "required".
          *
          * @param string $fieldName Field to check if required.
-		 *
+         *
          * @return boolean Whether or not the field is required.
          */
         protected function _fieldIsRequired($fieldName) {
@@ -536,13 +536,13 @@ 
             return;
         }
 
-		/**
-		* Set error for the given field or key
-		*
-		* @param string $inputName the input or key name
-		* @param string $ruleName the rule name
-		* @param array|string $replacements
-		*/
+        /**
+         * Set error for the given field or key
+         *
+         * @param string $inputName the input or key name
+         * @param string $ruleName the rule name
+         * @param array|string $replacements
+         */
         protected function _setError($inputName, $ruleName, $replacements = array()) {
             $rulePhraseKeyParts = explode(',', $ruleName);
             $rulePhrase = null;
@@ -559,7 +559,7 @@ 
             }
             // Type cast to array in case it's a string
             $replacements = (array) $replacements;
-			$replacementCount = count($replacements);
+            $replacementCount = count($replacements);
             for ($i = 1; $i <= $replacementCount; $i++) {
                 $key = $i - 1;
                 $rulePhrase = str_replace('%' . $i, $replacements[$key], $rulePhrase);
@@ -577,11 +577,11 @@ 
          *
          * @param type $inputArg
          * @param string $callbackFunc
-		 *
+         *
          * @return mixed
          */
         protected function _runCallback($inputArg, $callbackFunc) {
-			return eval('return ' . $callbackFunc . '("' . $inputArg . '");');
+            return eval('return ' . $callbackFunc . '("' . $inputArg . '");');
         }
 
         /**
@@ -590,7 +590,7 @@ 
          * arguments.
          *
          * @param string $callbackFunc
-		 *
+         *
          * @return mixed
          */
         protected function _runEmptyCallback($callbackFunc) {
@@ -601,7 +601,7 @@ 
          * Gets a specific label of a specific field input name.
          *
          * @param string $inputName
-		 *
+         *
          * @return string
          */
         protected function _getLabel($inputName) {
@@ -614,7 +614,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("required")
          * @param  array  $ruleArgs  the rules argument
          */
-		protected function _validateRequired($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateRequired($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if(array_key_exists(1, $ruleArgs) && function_exists($ruleArgs[1])) {
                 $callbackReturn = $this->_runEmptyCallback($ruleArgs[1]);
@@ -622,8 +622,8 @@ 
                     $this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
                 }
             } 
-			else if($inputVal == '') {
-				$this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
+            else if($inputVal == '') {
+                $this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
             }
         }
 
@@ -647,10 +647,10 @@ 
          */
         protected function _validateCallback($inputName, $ruleName, array $ruleArgs) {
             if (function_exists($ruleArgs[1]) && !empty($this->data[$inputName])) {
-				$result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]);
-				if(! $result){
-					$this->_setError($inputName, $ruleName, array($this->_getLabel($inputName)));
-				}
+                $result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]);
+                if(! $result){
+                    $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName)));
+                }
             }
         }
 
@@ -682,7 +682,7 @@ 
                         continue;
                     }
                 } 
-				else{
+                else{
                     if ($inputVal == $doNotEqual) {
                         $this->_setError($inputName, $ruleName . ',string', array($this->_getLabel($inputName), $doNotEqual));
                         continue;
@@ -774,7 +774,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("less_than")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if ($inputVal >= $ruleArgs[1]) { 
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -790,7 +790,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("greater_than")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if ($inputVal <= $ruleArgs[1]) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -806,7 +806,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("numeric")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if (! is_numeric($inputVal)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -822,18 +822,18 @@ 
          * @param  string $ruleName  the rule name for this validation ("exists")
          * @param  array  $ruleArgs  the rules argument
          */
-		protected function _validateExists($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateExists($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		if (! is_object($this->databaseInstance)){
+            if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
                 if(isset($obj->database)){
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		list($table, $column) = explode('.', $ruleArgs[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-    			                                       ->where($column, $inputVal);
-    		$this->databaseInstance->get();
+            list($table, $column) = explode('.', $ruleArgs[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal);
+            $this->databaseInstance->get();
             if ($this->databaseInstance->numRows() <= 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
@@ -848,7 +848,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("is_unique")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
@@ -856,11 +856,11 @@ 
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		list($table, $column) = explode('.', $ruleArgs[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-    			                                      ->where($column, $inputVal);
-    		$this->databaseInstance->get();
-    		if ($this->databaseInstance->numRows() > 0) {
+            list($table, $column) = explode('.', $ruleArgs[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal);
+            $this->databaseInstance->get();
+            if ($this->databaseInstance->numRows() > 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
                 }
@@ -874,25 +874,25 @@ 
          * @param  string $ruleName  the rule name for this validation ("is_unique_update")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		if (! is_object($this->databaseInstance)){
+            if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
                 if(isset($obj->database)){
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		$data = explode(',', $ruleArgs[1]);
-    		if(count($data) < 2){
-    			return;
-    		}
-    		list($table, $column) = explode('.', $data[0]);
-    		list($field, $val)    = explode('=', $data[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-                                			          ->where($column, $inputVal)
-                                            		  ->where($field, '!=', trim($val));
+            $data = explode(',', $ruleArgs[1]);
+            if(count($data) < 2){
+                return;
+            }
+            list($table, $column) = explode('.', $data[0]);
+            list($field, $val)    = explode('=', $data[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal)
+                                                        ->where($field, '!=', trim($val));
             $this->databaseInstance->get();
-    		if ($this->databaseInstance->numRows() > 0) {
+            if ($this->databaseInstance->numRows() > 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
                 }
@@ -908,7 +908,7 @@ 
          */
         protected function _validateInList($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		$list = explode(',', $ruleArgs[1]);
+            $list = explode(',', $ruleArgs[1]);
             $list = array_map('trim', $list);
             if (! in_array($inputVal, $list)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -926,7 +926,7 @@ 
          */
         protected function _validateRegex($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		$regex = $ruleArgs[1];
+            $regex = $ruleArgs[1];
             if (! preg_match($regex, $inputVal)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;