tnhfw / tnh-fw

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';
+        }
+    }

Spacing +59 added lines, -59 removed lines

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

Braces +9 added lines, -18 removed lines

@@ -48,8 +48,7 @@ 
 	         */
 	        if(is_object($logger)){
 	          $this->logger = $logger;
-	        }
-	        else{
+	        } else{
 	            $this->logger =& class_loader('Log', 'classes');
 	            $this->logger->setLogger('Library::FileCache');
 	        }
@@ -95,8 +94,7 @@ 
 		        // Unlinking when the file was expired
 		        unlink($filePath);
 		        return false;
-		     }
-		     else{
+		     } 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'];
 		     }
@@ -133,8 +131,7 @@ 
 		    	$this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
 		    	fclose($handle);
 		    	return false;
-		    }
-		    else{
+		    } else{
 		    	$this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
 		    	fclose($handle);
 				chmod($filePath, 0640);
@@ -156,8 +153,7 @@ 
 			if(! file_exists($filePath)){
 				$this->logger->info('This cache file does not exists skipping');
 				return false;
-			}
-			else{
+			} else{
 				$this->logger->info('Found cache file [' .$filePath. '] remove it');
 	      		unlink($filePath);
 				return true;
@@ -210,8 +206,7 @@ 
 			$list = glob(CACHE_PATH . '*.cache');
 			if(! $list){
 				$this->logger->info('No cache files were found skipping');
-			}
-			else{
+			} else{
 				$this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
 				foreach ($list as $file) {
 					$this->logger->debug('Processing the cache file [' . $file . ']');
@@ -219,12 +214,10 @@ 
 		      		$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']){
+		      		} else if(time() > $data['expire']){
 		      			$this->logger->info('The cache data for file [' . $file . '] already expired remove it');
 		      			unlink($file);
-		      		}
-		      		else{
+		      		} else{
 		      			$this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
 		      		}
 				}
@@ -239,8 +232,7 @@ 
 			$list = glob(CACHE_PATH . '*.cache');
 			if(! $list){
 				$this->logger->info('No cache files were found skipping');
-			}
-			else{
+			} else{
 				$this->logger->info('Found [' . count($list) . '] cache files to remove');
 				foreach ($list as $file) {
 					$this->logger->debug('Processing the cache file [' . $file . ']');
@@ -267,8 +259,7 @@ 
 				
 				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
 				$this->compressCacheData = false;
-			}
-			else{
+			} else{
 				$this->compressCacheData = $status;
 			}
 			return $this;

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');
+            }
+        }
+    }

Spacing +76 added lines, -76 removed lines

@@ -96,13 +96,13 @@ 
 		/**
 		 * Construct the new Router instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$this->setLoggerFromParamOrCreateNewInstance(null);
 			
 			//loading routes for module
 			$moduleRouteList = array();
 			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
+			if ($modulesRoutes && is_array($modulesRoutes)) {
 				$moduleRouteList = $modulesRoutes;
 				unset($modulesRoutes);
 			}
@@ -117,7 +117,7 @@ 
 		 * Get the route patterns
 		 * @return array
 		 */
-		public function getPattern(){
+		public function getPattern() {
 			return $this->pattern;
 		}
 
@@ -125,7 +125,7 @@ 
 		 * Get the route callbacks
 		 * @return array
 		 */
-		public function getCallback(){
+		public function getCallback() {
 			return $this->callback;
 		}
 
@@ -133,7 +133,7 @@ 
 		 * Get the module name
 		 * @return string
 		 */
-		public function getModule(){
+		public function getModule() {
 			return $this->module;
 		}
 		
@@ -141,7 +141,7 @@ 
 		 * Get the controller name
 		 * @return string
 		 */
-		public function getController(){
+		public function getController() {
 			return $this->controller;
 		}
 
@@ -149,7 +149,7 @@ 
 		 * Get the controller file path
 		 * @return string
 		 */
-		public function getControllerPath(){
+		public function getControllerPath() {
 			return $this->controllerPath;
 		}
 
@@ -157,7 +157,7 @@ 
 		 * Get the controller method
 		 * @return string
 		 */
-		public function getMethod(){
+		public function getMethod() {
 			return $this->method;
 		}
 
@@ -165,7 +165,7 @@ 
 		 * Get the request arguments
 		 * @return array
 		 */
-		public function getArgs(){
+		public function getArgs() {
 			return $this->args;
 		}
 
@@ -173,7 +173,7 @@ 
 		 * Get the URL segments array
 		 * @return array
 		 */
-		public function getSegments(){
+		public function getSegments() {
 			return $this->segments;
 		}
 
@@ -181,7 +181,7 @@ 
 	     * Return the Log instance
 	     * @return Log
 	     */
-	    public function getLogger(){
+	    public function getLogger() {
 	      return $this->logger;
 	    }
 
@@ -190,7 +190,7 @@ 
 	     * @param Log $logger the log object
 		 * @return object
 	     */
-	    public function setLogger($logger){
+	    public function setLogger($logger) {
 	      $this->logger = $logger;
 	      return $this;
 	    }
@@ -199,7 +199,7 @@ 
 		 * Get the route URI
 		 * @return string
 		 */
-		public function getRouteUri(){
+		public function getRouteUri() {
 			return $this->uri;
 		}
 
@@ -213,7 +213,7 @@ 
 		*/
 		public function add($uri, $callback) {
 			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
+			if (in_array($uri, $this->pattern)) {
 				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
 			}
 			$this->pattern[] = $uri;
@@ -229,8 +229,8 @@ 
 		* @return object the current instance
 		*/
 		public function removeRoute($uri) {
-			$index  = array_search($uri, $this->pattern, true);
-			if($index !== false){
+			$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]);
@@ -258,26 +258,26 @@ 
 	     * @param string $uri the route URI, if is empty will determine automatically
 	     * @return object
 	     */
-	    public function setRouteUri($uri = ''){
+	    public function setRouteUri($uri = '') {
 	    	$routeUri = '';
-	    	if(! empty($uri)){
+	    	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])){
+			else if (IS_CLI && isset($_SERVER['argv'][1])) {
 				$routeUri = $_SERVER['argv'][1];
 			}
-			else if(isset($_SERVER['REQUEST_URI'])){
+			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 . ']' );
+				$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']');
 				$routeUri = str_ireplace($suffix, '', $routeUri);
 			} 
-			if (strpos($routeUri, '?') !== false){
+			if (strpos($routeUri, '?') !== false) {
 				$routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
 			}
 			$this->uri = trim($routeUri, $this->uriTrim);
@@ -290,8 +290,8 @@ 
 		 * 
 		 * @return object
 		 */
-		public function setRouteSegments(array $segments = array()){
-			if(! empty($segments)){
+		public function setRouteSegments(array $segments = array()) {
+			if (!empty($segments)) {
 				$this->segments = $segments;
 			} else if (!empty($this->uri)) {
 				$this->segments = explode('/', $this->uri);
@@ -299,12 +299,12 @@ 
 			$segment = $this->segments;
 			$baseUrl = get_config('base_url');
 			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
+			if (isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false) {
 				array_shift($segment);
 				$this->segments = $segment;
 			}
 			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
+			if (isset($segment[0]) && $segment[0] == SELF) {
 				$this->logger->info('The request URI contains the front controller');
 				array_shift($segment);
 				$this->segments = $segment;
@@ -324,7 +324,7 @@ 
 			
 			//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){
+			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();
@@ -340,14 +340,14 @@ 
 		 * Routing the request to the correspondant module/controller/method if exists
 		 * otherwise send 404 error.
 		 */
-	    public function processRequest(){
+	    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) . ']' );
+			$this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']');
 
 	    	//determine the route parameters information
 	    	$this->determineRouteParamsInformation();
@@ -358,20 +358,20 @@ 
 	    	$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)){
+			if (file_exists($classFilePath)) {
 				require_once $classFilePath;
-				if(! class_exists($controller, false)){
+				if (!class_exists($controller, false)) {
 					$e404 = true;
-					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+					$this->logger->warning('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']');
 				}
-				else{
+				else {
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
+					if (!method_exists($controllerInstance, $controllerMethod)) {
 						$e404 = true;
 						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
 					}
-					else{
+					else {
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
 						//render the final page to user
@@ -380,16 +380,16 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
-			if($e404){
-				if(IS_CLI){
+			if ($e404) {
+				if (IS_CLI) {
 					set_http_status_header(404);
 					echo 'Error 404: page not found.';
 				} else {
-					$response =& class_loader('Response', 'classes');
+					$response = & class_loader('Response', 'classes');
 					$response->send404();
 				}
 			}
@@ -402,15 +402,15 @@ 
 	    * @param boolean $useConfigFile whether to use route configuration file
 		* @return object
 	    */
-	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
 	        $route = array();
-	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')) {
 	            require_once CONFIG_PATH . 'routes.php';
 	        }
 	        $route = array_merge($route, $overwriteConfig);
 	        $this->routes = $route;
 	        //if route is empty remove all configuration
-	        if(empty($route)){
+	        if (empty($route)) {
 	        	$this->removeAllRoute();
 	        }
 			return $this;
@@ -420,7 +420,7 @@ 
 		 * Get the route configuration
 		 * @return array
 		 */
-		public function getRouteConfiguration(){
+		public function getRouteConfiguration() {
 			return $this->routes;
 		}
 
@@ -432,19 +432,19 @@ 
 	     *
 	     * @return object the current instance
 	     */
-	    public function setControllerFilePath($path = null){
-	    	if($path !== null){
+	    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){
+			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){
+				if ($this->module) {
 					$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-					if($path !== false){
+					if ($path !== false) {
 						$controllerPath = $path;
 					}
 				}
@@ -457,7 +457,7 @@ 
 	     * Determine the route parameters from route configuration
 	     * @return void
 	     */
-	    protected function determineRouteParamsFromConfig(){
+	    protected function determineRouteParamsFromConfig() {
 	    	$uri = implode('/', $this->segments);
 	    	/*
 	   		* Generics routes patterns
@@ -482,20 +482,20 @@ 
 					array_shift($args);
 					//check if this contains an module
 					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+					if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) {
 						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
 					}
-					else{
+					else {
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
+					if (is_array($moduleControllerMethod)) {
+						if (isset($moduleControllerMethod[0])) {
 							$this->controller = $moduleControllerMethod[0];	
 						}
-						if(isset($moduleControllerMethod[1])){
+						if (isset($moduleControllerMethod[1])) {
 							$this->method = $moduleControllerMethod[1];
 						}
 						$this->args = $args;
@@ -506,7 +506,7 @@ 
 			}
 
 			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->controller && $this->module){
+			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, 
@@ -520,67 +520,67 @@ 
 	     * Determine the route parameters using the server variable "REQUEST_URI"
 	     * @return void
 	     */
-	    protected function determineRouteParamsFromRequestUri(){
+	    protected function determineRouteParamsFromRequestUri() {
 	    	$segment = $this->segments;
 	    	$nbSegment = count($segment);
 			//if segment is null so means no need to perform
-			if($nbSegment > 0){
+			if ($nbSegment > 0) {
 				//get the module list
 				$modules = Module::getModuleList();
 				//first check if no module
-				if(empty($modules)){
+				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])){
+					if (isset($segment[0])) {
 						$this->controller = $segment[0];
 						array_shift($segment);
 					}
 					//method
-					if(isset($segment[0])){
+					if (isset($segment[0])) {
 						$this->method = $segment[0];
 						array_shift($segment);
 					}
 					//args
 					$this->args = $segment;
 				}
-				else{
+				else {
 					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-					if(in_array($segment[0], $modules)){
+					if (in_array($segment[0], $modules)) {
 						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
 						$this->module = $segment[0];
 						array_shift($segment);
 						//check if the second arg is the controller from module
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->controller = $segment[0];
 							//check if the request use the same module name and controller
 							$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-							if(! $path){
+							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{
+							else {
 								$this->controllerPath = $path;
 								array_shift($segment);
 							}
 						}
 						//check for method
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->method = $segment[0];
 							array_shift($segment);
 						}
 						//the remaining is for args
 						$this->args = $segment;
 					}
-					else{
+					else {
 						$this->logger->info('The current request information is not found in the module list');
 						//controller
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->controller = $segment[0];
 							array_shift($segment);
 						}
 						//method
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->method = $segment[0];
 							array_shift($segment);
 						}
@@ -588,7 +588,7 @@ 
 						$this->args = $segment;
 					}
 				}
-				if(! $this->controller && $this->module){
+				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;
 				}
@@ -600,9 +600,9 @@ 
 	     *
 	     * @return object the current instance
 	     */
-	    protected function setRouteConfigurationInfos(){
+	    protected function setRouteConfigurationInfos() {
 	    	//adding route
-			foreach($this->routes as $pattern => $callback){
+			foreach ($this->routes as $pattern => $callback) {
 				$this->add($pattern, $callback);
 			}
 			return $this;
@@ -612,12 +612,12 @@ 
 	     * Set the Log instance using argument or create new instance
 	     * @param object $logger the Log instance if not null
 	     */
-	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-	      if ($logger !== null){
+	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) {
+	      if ($logger !== null) {
 	        $this->logger = $logger;
 	      }
-	      else{
-	          $this->logger =& class_loader('Log', 'classes');
+	      else {
+	          $this->logger = & class_loader('Log', 'classes');
 	          $this->logger->setLogger('Library::Router');
 	      }
 	    }

Braces +9 added lines, -18 removed lines

@@ -266,8 +266,7 @@ 
 	    	//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'])){
+			} else if(isset($_SERVER['REQUEST_URI'])){
 				$routeUri = $_SERVER['REQUEST_URI'];
 			}
 			$this->logger->debug('Check if URL suffix is enabled in the configuration');
@@ -363,15 +362,13 @@ 
 				if(! class_exists($controller, false)){
 					$e404 = true;
 					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
+				} else{
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
 					if(! method_exists($controllerInstance, $controllerMethod)){
 						$e404 = true;
 						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
+					} else{
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
 						//render the final page to user
@@ -379,8 +376,7 @@ 
 						get_instance()->response->renderFinalPage();
 					}
 				}
-			}
-			else{
+			} else{
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
@@ -486,8 +482,7 @@ 
 						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
+					} else{
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
@@ -543,8 +538,7 @@ 
 					}
 					//args
 					$this->args = $segment;
-				}
-				else{
+				} else{
 					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
 					if(in_array($segment[0], $modules)){
 						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
@@ -558,8 +552,7 @@ 
 							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{
+							} else{
 								$this->controllerPath = $path;
 								array_shift($segment);
 							}
@@ -571,8 +564,7 @@ 
 						}
 						//the remaining is for args
 						$this->args = $segment;
-					}
-					else{
+					} else{
 						$this->logger->info('The current request information is not found in the module list');
 						//controller
 						if(isset($segment[0])){
@@ -615,8 +607,7 @@ 
 	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
 	      if ($logger !== null){
 	        $this->logger = $logger;
-	      }
-	      else{
+	      } else{
 	          $this->logger =& class_loader('Log', 'classes');
 	          $this->logger->setLogger('Library::Router');
 	      }

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');
+            }
+            }
+    }

Spacing +20 added lines, -20 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Security{
+	class Security {
 		
 		/**
 		 * The logger instance
@@ -36,9 +36,9 @@ 
 		 * 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');
+		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];
@@ -49,7 +49,7 @@ 
 		 * This method is used to generate the CSRF token
 		 * @return string the generated CSRF token
 		 */
-		public static function generateCSRF(){
+		public static function generateCSRF() {
 			$logger = self::getLogger();
 			$logger->debug('Generation of CSRF ...');
 			
@@ -57,14 +57,14 @@ 
 			$expire = get_config('csrf_expire', 60);
 			$keyExpire = 'csrf_expire';
 			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+			if (Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime) {
 				$logger->info('The CSRF token not yet expire just return it');
 				return Session::get($key);
 			}
-			else{
+			else {
 				$newTime = $currentTime + $expire;
 				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+				$logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . '], token [' . $token . ']');
 				Session::set($keyExpire, $newTime);
 				Session::set($key, $token);
 				return Session::get($key);
@@ -75,7 +75,7 @@ 
 		 * 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(){
+		public static function validateCSRF() {
 			$logger = self::getLogger();
 			$logger->debug('Validation of CSRF ...');
 				
@@ -83,8 +83,8 @@ 
 			$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->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;
 			}
@@ -93,11 +93,11 @@ 
 			//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');
+			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');
+			$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);
@@ -107,24 +107,24 @@ 
 		/**
 		 * This method is used to check the whitelist IP address access
 		 */
-		 public static function checkWhiteListIpAccess(){
+		 public static function checkWhiteListIpAccess() {
 			$logger = self::getLogger();
 			$logger->debug('Validation of the IP address access ...');
 			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
 			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
+			if ($isEnable) {
 				$logger->info('Whitelist IP access is enabled in the configuration');
 				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
+				if (!empty($list)) {
 					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
 					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+					if ((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)) {
 						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
 						//wildcard to access all ip address
 						return;
 					}
-					else{
+					else {
 						// go through all whitelisted ips
 						foreach ($list as $ipaddr) {
 							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
@@ -150,7 +150,7 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
 			}
 		 }

Braces +3 added lines, -6 removed lines

@@ -60,8 +60,7 @@ 
 			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
 				$logger->info('The CSRF token not yet expire just return it');
 				return Session::get($key);
-			}
-			else{
+			} else{
 				$newTime = $currentTime + $expire;
 				$token = sha1(uniqid()) . sha1(uniqid());
 				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
@@ -123,8 +122,7 @@ 
 						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
 						//wildcard to access all ip address
 						return;
-					}
-					else{
+					} else{
 						// go through all whitelisted ips
 						foreach ($list as $ipaddr) {
 							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
@@ -149,8 +147,7 @@ 
 						show_error('Access to this application is not allowed');
 					}
 				}
-			}
-			else{
+			} else{
 				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
 			}
 		 }

core/functions/function_string.php

Indentation +68 added lines, -68 removed lines

@@ -1,71 +1,71 @@
 <?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.
+     */
 
-	/**
-	 *  @file function_string.php
-	 *
-	 *  This file contains the definition of the functions relating to the processing of strings characters.
-	 *
-	 *  @package	core
-	 *  @author	Tony NGUEREZA
-	 *  @copyright	Copyright (c) 2017
-	 *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
-	 *  @link	http://www.iacademy.cf
-	 *  @version 1.0.0
-	 *  @since 1.0.0
-	 *  @filesource
-	 */
+    /**
+     *  @file function_string.php
+     *
+     *  This file contains the definition of the functions relating to the processing of strings characters.
+     *
+     *  @package	core
+     *  @author	Tony NGUEREZA
+     *  @copyright	Copyright (c) 2017
+     *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
+     *  @link	http://www.iacademy.cf
+     *  @version 1.0.0
+     *  @since 1.0.0
+     *  @filesource
+     */
 
-	if(! function_exists('get_random_string')){
-		/**
-		 * Generate a random string
-		 * @param  string $type the type of generation. It can take the values: "alpha" for alphabetic characters,
-		 * "alnum" for alpha-numeric characters and "num" for numbers.
-		 * By default it is "alnum".
-		 * @param  integer $length the length of the string to generate. By default it is 10.
-		 * @param  boolean $lower if we return the generated string in lowercase (true). By default it's false.
-		 * @return string the generated string.
-		 */
-		function get_random_string($type = 'alnum', $length = 10, $lower = false){
-			$chars = array(
-							'alpha' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
-							'alnum' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
-							'num' => '1234567890'
-						);
-			$str = null;
-			if(isset($chars[$type])){
-				$str = $chars[$type];
-			}
-			$random = null;
-			for($i = 0; $i < $length; $i++){
-				$random .= $str[mt_rand() % strlen($str)];
-			}
-			if($lower){
-				$random = strtolower($random);
-			}
-			return $random;
-		}
-	}
+    if(! function_exists('get_random_string')){
+        /**
+         * Generate a random string
+         * @param  string $type the type of generation. It can take the values: "alpha" for alphabetic characters,
+         * "alnum" for alpha-numeric characters and "num" for numbers.
+         * By default it is "alnum".
+         * @param  integer $length the length of the string to generate. By default it is 10.
+         * @param  boolean $lower if we return the generated string in lowercase (true). By default it's false.
+         * @return string the generated string.
+         */
+        function get_random_string($type = 'alnum', $length = 10, $lower = false){
+            $chars = array(
+                            'alpha' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
+                            'alnum' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
+                            'num' => '1234567890'
+                        );
+            $str = null;
+            if(isset($chars[$type])){
+                $str = $chars[$type];
+            }
+            $random = null;
+            for($i = 0; $i < $length; $i++){
+                $random .= $str[mt_rand() % strlen($str)];
+            }
+            if($lower){
+                $random = strtolower($random);
+            }
+            return $random;
+        }
+    }

Spacing +5 added lines, -5 removed lines

@@ -39,7 +39,7 @@ 
 	 *  @filesource
 	 */
 
-	if(! function_exists('get_random_string')){
+	if (!function_exists('get_random_string')) {
 		/**
 		 * Generate a random string
 		 * @param  string $type the type of generation. It can take the values: "alpha" for alphabetic characters,
@@ -49,21 +49,21 @@ 
 		 * @param  boolean $lower if we return the generated string in lowercase (true). By default it's false.
 		 * @return string the generated string.
 		 */
-		function get_random_string($type = 'alnum', $length = 10, $lower = false){
+		function get_random_string($type = 'alnum', $length = 10, $lower = false) {
 			$chars = array(
 							'alpha' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
 							'alnum' => 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890',
 							'num' => '1234567890'
 						);
 			$str = null;
-			if(isset($chars[$type])){
+			if (isset($chars[$type])) {
 				$str = $chars[$type];
 			}
 			$random = null;
-			for($i = 0; $i < $length; $i++){
+			for ($i = 0; $i < $length; $i++) {
 				$random .= $str[mt_rand() % strlen($str)];
 			}
-			if($lower){
+			if ($lower) {
 				$random = strtolower($random);
 			}
 			return $random;

core/classes/Loader.php

Braces +15 added lines, -30 removed lines

@@ -107,8 +107,7 @@ 
 			if ($moduleModelFilePath){
 				$logger->info('Found model [' . $class . '] from module [' .$module. '], the file path is [' .$moduleModelFilePath. '] we will used it');
 				$classFilePath = $moduleModelFilePath;
-			}
-			else{
+			} else{
 				$logger->info('Cannot find model [' . $class . '] from modules using the default location');
 			}
 			$logger->info('The model file path to be loaded is [' . $classFilePath . ']');
@@ -120,12 +119,10 @@ 
 					$obj->{$instance} = $c;
 					static::$loaded[$instance] = $class;
 					$logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
-				}
-				else{
+				} else{
 					show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
 				}
-			}
-			else{
+			} else{
 				show_error('Unable to find the model [' . $class . ']');
 			}
 		}
@@ -168,8 +165,7 @@ 
 				$libraryFilePath = CORE_LIBRARY_PATH . $file;
 				$class = ucfirst($class);
 				$logger->info('This library is a system library');
-			}
-			else{
+			} else{
 				$logger->info('This library is not a system library');	
 				//first check if this library is in the module
 				$libraryFilePath = self::getLibraryPathUsingModuleInfo($class);
@@ -214,8 +210,7 @@ 
 			if ($moduleFunctionPath){
 				$logger->info('Found helper [' . $function . '] from module [' .$module. '], the file path is [' .$moduleFunctionPath. '] we will used it');
 				$functionFilePath = $moduleFunctionPath;
-			}
-			else{
+			} else{
 				$logger->info('Cannot find helper [' . $function . '] from modules using the default location');
 			}
 			if (! $functionFilePath){
@@ -234,8 +229,7 @@ 
 				require_once $functionFilePath;
 				static::$loaded['function_' . $function] = $functionFilePath;
 				$logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
-			}
-			else{
+			} else{
 				show_error('Unable to find helper file [' . $file . ']');
 			}
 		}
@@ -268,8 +262,7 @@ 
 			if ($moduleConfigPath){
 				$logger->info('Found config [' . $filename . '] from module [' .$module. '], the file path is [' .$moduleConfigPath. '] we will used it');
 				$configFilePath = $moduleConfigPath;
-			}
-			else{
+			} else{
 				$logger->info('Cannot find config [' . $filename . '] from modules using the default location');
 			}
 			$logger->info('The config file path to be loaded is [' . $configFilePath . ']');
@@ -283,8 +276,7 @@ 
 					$logger->info('The custom application configuration loaded are listed below: ' . stringfy_vars($config));
 					unset($config);
 				}
-			}
-			else{
+			} else{
 				show_error('Unable to find config file ['. $configFilePath . ']');
 			}
 		}
@@ -323,8 +315,7 @@ 
 			if ($moduleLanguagePath){
 				$logger->info('Found language [' . $language . '] from module [' .$module. '], the file path is [' .$moduleLanguagePath. '] we will used it');
 				$languageFilePath = $moduleLanguagePath;
-			}
-			else{
+			} else{
 				$logger->info('Cannot find language [' . $language . '] from modules using the default location');
 			}
 			if (! $languageFilePath){
@@ -377,8 +368,7 @@ 
 					$module = $path[0];
 					$class = ucfirst($path[1]);
 				}
-			}
-			else{
+			} else{
 				$class = ucfirst($class);
 			}
 			if (! $module && !empty($obj->moduleName)){
@@ -499,8 +489,7 @@ 
 				if (isset($path[1])){
 					$instance = strtolower($path[1]);
 				}
-			}
-			else{
+			} else{
 				$instance = strtolower($class);
 			}
 			return $instance;
@@ -522,8 +511,7 @@ 
 			if ($moduleLibraryPath){
 				$logger->info('Found library [' . $class . '] from module [' .$module. '], the file path is [' .$moduleLibraryPath. '] we will used it');
 				$libraryFilePath = $moduleLibraryPath;
-			}
-			else{
+			} else{
 				$logger->info('Cannot find library [' . $class . '] from modules using the default location');
 			}
 			return $libraryFilePath;
@@ -547,12 +535,10 @@ 
 					$obj->{$instance} = $c;
 					static::$loaded[$instance] = $class;
 					$logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
-				}
-				else{
+				} else{
 					show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
 				}
-			}
-			else{
+			} else{
 				show_error('Unable to find library class [' . $class . ']');
 			}
 		}
@@ -578,8 +564,7 @@ 
 				}
 				static::$loaded['lang_' . $language] = $languageFilePath;
 				$logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
-			}
-			else{
+			} else{
 				show_error('Unable to find language [' . $language . ']');
 			}
 		}

Indentation +622 added lines, -622 removed lines

@@ -1,657 +1,657 @@
 <?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 Loader{
+    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 Loader{
 		
-		/**
-		 * List of loaded resources
-		 * @var array
-		 */
-		public static $loaded = array();
+        /**
+         * List of loaded resources
+         * @var array
+         */
+        public static $loaded = array();
 		
-		/**
-		 * The logger instance
-		 * @var object
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var object
+         */
+        private static $logger;
 
 
-		public function __construct(){
-			//add the resources already loaded during application bootstrap
-			//in the list to prevent duplicate or loading the resources again.
-			static::$loaded = class_loaded();
+        public function __construct(){
+            //add the resources already loaded during application bootstrap
+            //in the list to prevent duplicate or loading the resources again.
+            static::$loaded = class_loaded();
 			
-			//Load resources from autoload configuration
-			$this->loadResourcesFromAutoloadConfig();
-		}
+            //Load resources from autoload configuration
+            $this->loadResourcesFromAutoloadConfig();
+        }
 
-		/**
-		 * The signleton of the logger
-		 * @return object the Log instance
-		 */
-		public static function getLogger(){
-			if(self::$logger == null){
-				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
-				$logger[0]->setLogger('Library::Loader');
-				self::$logger = $logger[0];
-			}
-			return self::$logger;			
-		}
+        /**
+         * The signleton of the logger
+         * @return object the Log instance
+         */
+        public static function getLogger(){
+            if(self::$logger == null){
+                $logger = array();
+                $logger[0] =& class_loader('Log', 'classes');
+                $logger[0]->setLogger('Library::Loader');
+                self::$logger = $logger[0];
+            }
+            return self::$logger;			
+        }
 
-		/**
-		 * Set the log instance for future use
-		 * @param object $logger the log object
-		 * @return object the log instance
-		 */
-		public static function setLogger($logger){
-			self::$logger = $logger;
-			return self::$logger;
-		}
+        /**
+         * Set the log instance for future use
+         * @param object $logger the log object
+         * @return object the log instance
+         */
+        public static function setLogger($logger){
+            self::$logger = $logger;
+            return self::$logger;
+        }
 
 		
-		/**
-		 * Load the model class
-		 *
-		 * @param  string $class    the class name to be loaded
-		 * @param  string $instance the name of the instance to use in super object
-		 *
-		 * @return void
-		 */
-		public static function model($class, $instance = null){
-			$logger = static::getLogger();
-			$class = str_ireplace('.php', '', $class);
-			$class = trim($class, '/\\');
-			$file = ucfirst($class).'.php';
-			$logger->debug('Loading model [' . $class . '] ...');
-			//************
-			if (! $instance){
-				$instance = self::getModelLibraryInstanceName($class);
-			}
-			//****************
-			if (isset(static::$loaded[$instance])){
-				$logger->info('Model [' . $class . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$classFilePath = APPS_MODEL_PATH . $file;
-			//first check if this model is in the module
-			$logger->debug('Checking model [' . $class . '] from module list ...');
-			//check if the request class contains module name
-			$moduleInfo = self::getModuleInfoForModelLibrary($class);
-			$module = $moduleInfo['module'];
-			$class  = $moduleInfo['class'];
+        /**
+         * Load the model class
+         *
+         * @param  string $class    the class name to be loaded
+         * @param  string $instance the name of the instance to use in super object
+         *
+         * @return void
+         */
+        public static function model($class, $instance = null){
+            $logger = static::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = trim($class, '/\\');
+            $file = ucfirst($class).'.php';
+            $logger->debug('Loading model [' . $class . '] ...');
+            //************
+            if (! $instance){
+                $instance = self::getModelLibraryInstanceName($class);
+            }
+            //****************
+            if (isset(static::$loaded[$instance])){
+                $logger->info('Model [' . $class . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $classFilePath = APPS_MODEL_PATH . $file;
+            //first check if this model is in the module
+            $logger->debug('Checking model [' . $class . '] from module list ...');
+            //check if the request class contains module name
+            $moduleInfo = self::getModuleInfoForModelLibrary($class);
+            $module = $moduleInfo['module'];
+            $class  = $moduleInfo['class'];
 			
-			$moduleModelFilePath = Module::findModelFullPath($class, $module);
-			if ($moduleModelFilePath){
-				$logger->info('Found model [' . $class . '] from module [' .$module. '], the file path is [' .$moduleModelFilePath. '] we will used it');
-				$classFilePath = $moduleModelFilePath;
-			}
-			else{
-				$logger->info('Cannot find model [' . $class . '] from modules using the default location');
-			}
-			$logger->info('The model file path to be loaded is [' . $classFilePath . ']');
-			if (file_exists($classFilePath)){
-				require_once $classFilePath;
-				if (class_exists($class)){
-					$c = new $class();
-					$obj = & get_instance();
-					$obj->{$instance} = $c;
-					static::$loaded[$instance] = $class;
-					$logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
-				}
-				else{
-					show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
-				}
-			}
-			else{
-				show_error('Unable to find the model [' . $class . ']');
-			}
-		}
+            $moduleModelFilePath = Module::findModelFullPath($class, $module);
+            if ($moduleModelFilePath){
+                $logger->info('Found model [' . $class . '] from module [' .$module. '], the file path is [' .$moduleModelFilePath. '] we will used it');
+                $classFilePath = $moduleModelFilePath;
+            }
+            else{
+                $logger->info('Cannot find model [' . $class . '] from modules using the default location');
+            }
+            $logger->info('The model file path to be loaded is [' . $classFilePath . ']');
+            if (file_exists($classFilePath)){
+                require_once $classFilePath;
+                if (class_exists($class)){
+                    $c = new $class();
+                    $obj = & get_instance();
+                    $obj->{$instance} = $c;
+                    static::$loaded[$instance] = $class;
+                    $logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
+                }
+                else{
+                    show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
+                }
+            }
+            else{
+                show_error('Unable to find the model [' . $class . ']');
+            }
+        }
 
 		
-		/**
-		 * Load the library class
-		 *
-		 * @param  string $class    the library class name to be loaded
-		 * @param  string $instance the instance name to use in super object
-		 * @param mixed $params the arguments to pass to the constructor
-		 *
-		 * @return void
-		 */
-		public static function library($class, $instance = null, array $params = array()){
-			$logger = static::getLogger();
-			$class = str_ireplace('.php', '', $class);
-			$class = trim($class, '/\\');
-			$file = ucfirst($class) .'.php';
-			$logger->debug('Loading library [' . $class . '] ...');
-			if (! $instance){
-				$instance = self::getModelLibraryInstanceName($class);
-			}
-			if (isset(static::$loaded[$instance])){
-				$logger->info('Library [' . $class . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$obj = & get_instance();
-			//Check and load Database library
-			if (strtolower($class) == 'database'){
-				$logger->info('This is the Database library ...');
-				$obj->{$instance} = & class_loader('Database', 'classes/database', $params);
-				static::$loaded[$instance] = $class;
-				$logger->info('Library Database loaded successfully.');
-				return;
-			}
-			$libraryFilePath = null;
-			$logger->debug('Check if this is a system library ...');
-			if (file_exists(CORE_LIBRARY_PATH . $file)){
-				$libraryFilePath = CORE_LIBRARY_PATH . $file;
-				$class = ucfirst($class);
-				$logger->info('This library is a system library');
-			}
-			else{
-				$logger->info('This library is not a system library');	
-				//first check if this library is in the module
-				$libraryFilePath = self::getLibraryPathUsingModuleInfo($class);
-				//***************
-			}
-			if (! $libraryFilePath && file_exists(LIBRARY_PATH . $file)){
-				$libraryFilePath = LIBRARY_PATH . $file;
-			}
-			$logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
-			//*************************
-			self::loadLibrary($libraryFilePath, $class, $instance, $params);
-		}
+        /**
+         * Load the library class
+         *
+         * @param  string $class    the library class name to be loaded
+         * @param  string $instance the instance name to use in super object
+         * @param mixed $params the arguments to pass to the constructor
+         *
+         * @return void
+         */
+        public static function library($class, $instance = null, array $params = array()){
+            $logger = static::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = trim($class, '/\\');
+            $file = ucfirst($class) .'.php';
+            $logger->debug('Loading library [' . $class . '] ...');
+            if (! $instance){
+                $instance = self::getModelLibraryInstanceName($class);
+            }
+            if (isset(static::$loaded[$instance])){
+                $logger->info('Library [' . $class . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $obj = & get_instance();
+            //Check and load Database library
+            if (strtolower($class) == 'database'){
+                $logger->info('This is the Database library ...');
+                $obj->{$instance} = & class_loader('Database', 'classes/database', $params);
+                static::$loaded[$instance] = $class;
+                $logger->info('Library Database loaded successfully.');
+                return;
+            }
+            $libraryFilePath = null;
+            $logger->debug('Check if this is a system library ...');
+            if (file_exists(CORE_LIBRARY_PATH . $file)){
+                $libraryFilePath = CORE_LIBRARY_PATH . $file;
+                $class = ucfirst($class);
+                $logger->info('This library is a system library');
+            }
+            else{
+                $logger->info('This library is not a system library');	
+                //first check if this library is in the module
+                $libraryFilePath = self::getLibraryPathUsingModuleInfo($class);
+                //***************
+            }
+            if (! $libraryFilePath && file_exists(LIBRARY_PATH . $file)){
+                $libraryFilePath = LIBRARY_PATH . $file;
+            }
+            $logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
+            //*************************
+            self::loadLibrary($libraryFilePath, $class, $instance, $params);
+        }
 
-		/**
-		 * Load the helper
-		 *
-		 * @param  string $function the helper name to be loaded
-		 *
-		 * @return void
-		 */
-		public static function functions($function){
-			$logger = static::getLogger();
-			$function = str_ireplace('.php', '', $function);
-			$function = trim($function, '/\\');
-			$function = str_ireplace('function_', '', $function);
-			$file = 'function_'.$function.'.php';
-			$logger->debug('Loading helper [' . $function . '] ...');
-			if (isset(static::$loaded['function_' . $function])){
-				$logger->info('Helper [' . $function . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$functionFilePath = null;
-			//first check if this helper is in the module
-			$logger->debug('Checking helper [' . $function . '] from module list ...');
-			$moduleInfo = self::getModuleInfoForFunction($function);
-			$module    = $moduleInfo['module'];
-			$function  = $moduleInfo['function'];
-			if(! empty($moduleInfo['file'])){
-				$file = $moduleInfo['file'];
-			}
-			$moduleFunctionPath = Module::findFunctionFullPath($function, $module);
-			if ($moduleFunctionPath){
-				$logger->info('Found helper [' . $function . '] from module [' .$module. '], the file path is [' .$moduleFunctionPath. '] we will used it');
-				$functionFilePath = $moduleFunctionPath;
-			}
-			else{
-				$logger->info('Cannot find helper [' . $function . '] from modules using the default location');
-			}
-			if (! $functionFilePath){
-				$searchDir = array(FUNCTIONS_PATH, CORE_FUNCTIONS_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $file;
-					if (file_exists($filePath)){
-						$functionFilePath = $filePath;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The helper file path to be loaded is [' . $functionFilePath . ']');
-			if ($functionFilePath){
-				require_once $functionFilePath;
-				static::$loaded['function_' . $function] = $functionFilePath;
-				$logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
-			}
-			else{
-				show_error('Unable to find helper file [' . $file . ']');
-			}
-		}
+        /**
+         * Load the helper
+         *
+         * @param  string $function the helper name to be loaded
+         *
+         * @return void
+         */
+        public static function functions($function){
+            $logger = static::getLogger();
+            $function = str_ireplace('.php', '', $function);
+            $function = trim($function, '/\\');
+            $function = str_ireplace('function_', '', $function);
+            $file = 'function_'.$function.'.php';
+            $logger->debug('Loading helper [' . $function . '] ...');
+            if (isset(static::$loaded['function_' . $function])){
+                $logger->info('Helper [' . $function . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $functionFilePath = null;
+            //first check if this helper is in the module
+            $logger->debug('Checking helper [' . $function . '] from module list ...');
+            $moduleInfo = self::getModuleInfoForFunction($function);
+            $module    = $moduleInfo['module'];
+            $function  = $moduleInfo['function'];
+            if(! empty($moduleInfo['file'])){
+                $file = $moduleInfo['file'];
+            }
+            $moduleFunctionPath = Module::findFunctionFullPath($function, $module);
+            if ($moduleFunctionPath){
+                $logger->info('Found helper [' . $function . '] from module [' .$module. '], the file path is [' .$moduleFunctionPath. '] we will used it');
+                $functionFilePath = $moduleFunctionPath;
+            }
+            else{
+                $logger->info('Cannot find helper [' . $function . '] from modules using the default location');
+            }
+            if (! $functionFilePath){
+                $searchDir = array(FUNCTIONS_PATH, CORE_FUNCTIONS_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $file;
+                    if (file_exists($filePath)){
+                        $functionFilePath = $filePath;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The helper file path to be loaded is [' . $functionFilePath . ']');
+            if ($functionFilePath){
+                require_once $functionFilePath;
+                static::$loaded['function_' . $function] = $functionFilePath;
+                $logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
+            }
+            else{
+                show_error('Unable to find helper file [' . $file . ']');
+            }
+        }
 
-		/**
-		 * Load the configuration file
-		 *
-		 * @param  string $filename the configuration filename located at CONFIG_PATH or MODULE_PATH/config
-		 *
-		 * @return void
-		 */
-		public static function config($filename){
-			$logger = static::getLogger();
-			$filename = str_ireplace('.php', '', $filename);
-			$filename = trim($filename, '/\\');
-			$filename = str_ireplace('config_', '', $filename);
-			$file = 'config_'.$filename.'.php';
-			$logger->debug('Loading configuration [' . $filename . '] ...');
-			if (isset(static::$loaded['config_' . $filename])){
-				$logger->info('Configuration [' . $file . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$configFilePath = CONFIG_PATH . $file;
-			//first check if this config is in the module
-			$logger->debug('Checking config [' . $filename . '] from module list ...');
-			$moduleInfo = self::getModuleInfoForConfig($filename);
-			$module    = $moduleInfo['module'];
-			$filename  = $moduleInfo['filename'];
-			$moduleConfigPath = Module::findConfigFullPath($filename, $module);
-			if ($moduleConfigPath){
-				$logger->info('Found config [' . $filename . '] from module [' .$module. '], the file path is [' .$moduleConfigPath. '] we will used it');
-				$configFilePath = $moduleConfigPath;
-			}
-			else{
-				$logger->info('Cannot find config [' . $filename . '] from modules using the default location');
-			}
-			$logger->info('The config file path to be loaded is [' . $configFilePath . ']');
-			$config = array();
-			if (file_exists($configFilePath)){
-				require_once $configFilePath;
-				if (! empty($config) && is_array($config)){
-					Config::setAll($config);
-					static::$loaded['config_' . $filename] = $configFilePath;
-					$logger->info('Configuration [' . $configFilePath . '] loaded successfully.');
-					$logger->info('The custom application configuration loaded are listed below: ' . stringfy_vars($config));
-					unset($config);
-				}
-			}
-			else{
-				show_error('Unable to find config file ['. $configFilePath . ']');
-			}
-		}
+        /**
+         * Load the configuration file
+         *
+         * @param  string $filename the configuration filename located at CONFIG_PATH or MODULE_PATH/config
+         *
+         * @return void
+         */
+        public static function config($filename){
+            $logger = static::getLogger();
+            $filename = str_ireplace('.php', '', $filename);
+            $filename = trim($filename, '/\\');
+            $filename = str_ireplace('config_', '', $filename);
+            $file = 'config_'.$filename.'.php';
+            $logger->debug('Loading configuration [' . $filename . '] ...');
+            if (isset(static::$loaded['config_' . $filename])){
+                $logger->info('Configuration [' . $file . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $configFilePath = CONFIG_PATH . $file;
+            //first check if this config is in the module
+            $logger->debug('Checking config [' . $filename . '] from module list ...');
+            $moduleInfo = self::getModuleInfoForConfig($filename);
+            $module    = $moduleInfo['module'];
+            $filename  = $moduleInfo['filename'];
+            $moduleConfigPath = Module::findConfigFullPath($filename, $module);
+            if ($moduleConfigPath){
+                $logger->info('Found config [' . $filename . '] from module [' .$module. '], the file path is [' .$moduleConfigPath. '] we will used it');
+                $configFilePath = $moduleConfigPath;
+            }
+            else{
+                $logger->info('Cannot find config [' . $filename . '] from modules using the default location');
+            }
+            $logger->info('The config file path to be loaded is [' . $configFilePath . ']');
+            $config = array();
+            if (file_exists($configFilePath)){
+                require_once $configFilePath;
+                if (! empty($config) && is_array($config)){
+                    Config::setAll($config);
+                    static::$loaded['config_' . $filename] = $configFilePath;
+                    $logger->info('Configuration [' . $configFilePath . '] loaded successfully.');
+                    $logger->info('The custom application configuration loaded are listed below: ' . stringfy_vars($config));
+                    unset($config);
+                }
+            }
+            else{
+                show_error('Unable to find config file ['. $configFilePath . ']');
+            }
+        }
 
 
-		/**
-		 * Load the language
-		 *
-		 * @param  string $language the language name to be loaded
-		 *
-		 * @return void
-		 */
-		public static function lang($language){
-			$logger = static::getLogger();
-			$language = str_ireplace('.php', '', $language);
-			$language = trim($language, '/\\');
-			$language = str_ireplace('lang_', '', $language);
-			$file = 'lang_'.$language.'.php';
-			$logger->debug('Loading language [' . $language . '] ...');
-			if (isset(static::$loaded['lang_' . $language])){
-				$logger->info('Language [' . $language . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			//get the current language
-			$appLang = self::getAppLang();
-			$languageFilePath = null;
-			//first check if this language is in the module
-			$logger->debug('Checking language [' . $language . '] from module list ...');
-			$moduleInfo = self::getModuleInfoForLanguage($language);
-			$module    = $moduleInfo['module'];
-			$language  = $moduleInfo['language'];
-			if(! empty($moduleInfo['file'])){
-				$file = $moduleInfo['file'];
-			}
-			$moduleLanguagePath = Module::findLanguageFullPath($language, $module, $appLang);
-			if ($moduleLanguagePath){
-				$logger->info('Found language [' . $language . '] from module [' .$module. '], the file path is [' .$moduleLanguagePath. '] we will used it');
-				$languageFilePath = $moduleLanguagePath;
-			}
-			else{
-				$logger->info('Cannot find language [' . $language . '] from modules using the default location');
-			}
-			if (! $languageFilePath){
-				$searchDir = array(APP_LANG_PATH, CORE_LANG_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $appLang . DS . $file;
-					if (file_exists($filePath)){
-						$languageFilePath = $filePath;
-						//already found no need continue
-						break;
-					}
-				}
-			}
-			$logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
-			self::loadLanguage($languageFilePath, $language);
-		}
+        /**
+         * Load the language
+         *
+         * @param  string $language the language name to be loaded
+         *
+         * @return void
+         */
+        public static function lang($language){
+            $logger = static::getLogger();
+            $language = str_ireplace('.php', '', $language);
+            $language = trim($language, '/\\');
+            $language = str_ireplace('lang_', '', $language);
+            $file = 'lang_'.$language.'.php';
+            $logger->debug('Loading language [' . $language . '] ...');
+            if (isset(static::$loaded['lang_' . $language])){
+                $logger->info('Language [' . $language . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            //get the current language
+            $appLang = self::getAppLang();
+            $languageFilePath = null;
+            //first check if this language is in the module
+            $logger->debug('Checking language [' . $language . '] from module list ...');
+            $moduleInfo = self::getModuleInfoForLanguage($language);
+            $module    = $moduleInfo['module'];
+            $language  = $moduleInfo['language'];
+            if(! empty($moduleInfo['file'])){
+                $file = $moduleInfo['file'];
+            }
+            $moduleLanguagePath = Module::findLanguageFullPath($language, $module, $appLang);
+            if ($moduleLanguagePath){
+                $logger->info('Found language [' . $language . '] from module [' .$module. '], the file path is [' .$moduleLanguagePath. '] we will used it');
+                $languageFilePath = $moduleLanguagePath;
+            }
+            else{
+                $logger->info('Cannot find language [' . $language . '] from modules using the default location');
+            }
+            if (! $languageFilePath){
+                $searchDir = array(APP_LANG_PATH, CORE_LANG_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $appLang . DS . $file;
+                    if (file_exists($filePath)){
+                        $languageFilePath = $filePath;
+                        //already found no need continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
+            self::loadLanguage($languageFilePath, $language);
+        }
 
-		/**
-		 * Return the current app language by default will use the value from cookie 
-		 * if can not found will use the default value from configuration
-		 * @return string the app language like "en", "fr"
-		 */
-		protected static function getAppLang(){
-			//determine the current language
-			$appLang = get_config('default_language');
-			//if the language exists in the cookie use it
-			$cfgKey = get_config('language_cookie_name');
-			$objCookie = & class_loader('Cookie');
-			$cookieLang = $objCookie->get($cfgKey);
-			if ($cookieLang){
-				$appLang = $cookieLang;
-			}
-			return $appLang;
-		}
-		/**
-		 * Get the module information for the model and library to load
-		 * @param  string $class the full class name like moduleName/className, className,
-		 * @return array        the module information
-		 * array(
-		 * 	'module'=> 'module_name'
-		 * 	'class' => 'class_name'
-		 * )
-		 */
-		protected static function getModuleInfoForModelLibrary($class){
-			$module = null;
-			$obj = & get_instance();
-			if (strpos($class, '/') !== false){
-				$path = explode('/', $class);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$module = $path[0];
-					$class = ucfirst($path[1]);
-				}
-			}
-			else{
-				$class = ucfirst($class);
-			}
-			if (! $module && !empty($obj->moduleName)){
-				$module = $obj->moduleName;
-			}
-			return array(
-						'class' => $class,
-						'module' => $module
-					);
-		}
+        /**
+         * Return the current app language by default will use the value from cookie 
+         * if can not found will use the default value from configuration
+         * @return string the app language like "en", "fr"
+         */
+        protected static function getAppLang(){
+            //determine the current language
+            $appLang = get_config('default_language');
+            //if the language exists in the cookie use it
+            $cfgKey = get_config('language_cookie_name');
+            $objCookie = & class_loader('Cookie');
+            $cookieLang = $objCookie->get($cfgKey);
+            if ($cookieLang){
+                $appLang = $cookieLang;
+            }
+            return $appLang;
+        }
+        /**
+         * Get the module information for the model and library to load
+         * @param  string $class the full class name like moduleName/className, className,
+         * @return array        the module information
+         * array(
+         * 	'module'=> 'module_name'
+         * 	'class' => 'class_name'
+         * )
+         */
+        protected static function getModuleInfoForModelLibrary($class){
+            $module = null;
+            $obj = & get_instance();
+            if (strpos($class, '/') !== false){
+                $path = explode('/', $class);
+                if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $module = $path[0];
+                    $class = ucfirst($path[1]);
+                }
+            }
+            else{
+                $class = ucfirst($class);
+            }
+            if (! $module && !empty($obj->moduleName)){
+                $module = $obj->moduleName;
+            }
+            return array(
+                        'class' => $class,
+                        'module' => $module
+                    );
+        }
 
-		/**
-		 * Get the module information for the function to load
-		 * @param  string $function the function name like moduleName/functionName, functionName,
-		 * @return array        the module information
-		 * array(
-		 * 	'module'=> 'module_name'
-		 * 	'function' => 'function'
-		 * 	'file' => 'file'
-		 * )
-		 */
-		protected static function getModuleInfoForFunction($function){
-			$module = null;
-			$file = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if (strpos($function, '/') !== false){
-				$path = explode('/', $function);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$module = $path[0];
-					$function = 'function_' . $path[1];
-					$file = $path[0] . DS . $function.'.php';
-				}
-			}
-			if (! $module && !empty($obj->moduleName)){
-				$module = $obj->moduleName;
-			}
-			return array(
-						'function' => $function,
-						'module' => $module,
-						'file' => $file
-					);
-		}
+        /**
+         * Get the module information for the function to load
+         * @param  string $function the function name like moduleName/functionName, functionName,
+         * @return array        the module information
+         * array(
+         * 	'module'=> 'module_name'
+         * 	'function' => 'function'
+         * 	'file' => 'file'
+         * )
+         */
+        protected static function getModuleInfoForFunction($function){
+            $module = null;
+            $file = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if (strpos($function, '/') !== false){
+                $path = explode('/', $function);
+                if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $module = $path[0];
+                    $function = 'function_' . $path[1];
+                    $file = $path[0] . DS . $function.'.php';
+                }
+            }
+            if (! $module && !empty($obj->moduleName)){
+                $module = $obj->moduleName;
+            }
+            return array(
+                        'function' => $function,
+                        'module' => $module,
+                        'file' => $file
+                    );
+        }
 
-		/**
-		 * Get the module information for the language to load
-		 * @param  string $language the language name like moduleName/languageName, languageName,
-		 * @return array        the module information
-		 * array(
-		 * 	'module'=> 'module_name'
-		 * 	'language' => 'language'
-		 * 	'file' => 'file'
-		 * )
-		 */
-		protected static function getModuleInfoForLanguage($language){
-			$module = null;
-			$file = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if (strpos($language, '/') !== false){
-				$path = explode('/', $language);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$module = $path[0];
-					$language = 'lang_' . $path[1] . '.php';
-					$file = $path[0] . DS .$language;
-				}
-			}
-			if (! $module && !empty($obj->moduleName)){
-				$module = $obj->moduleName;
-			}
-			return array(
-						'language' => $language,
-						'module' => $module,
-						'file' => $file
-					);
-		}
+        /**
+         * Get the module information for the language to load
+         * @param  string $language the language name like moduleName/languageName, languageName,
+         * @return array        the module information
+         * array(
+         * 	'module'=> 'module_name'
+         * 	'language' => 'language'
+         * 	'file' => 'file'
+         * )
+         */
+        protected static function getModuleInfoForLanguage($language){
+            $module = null;
+            $file = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if (strpos($language, '/') !== false){
+                $path = explode('/', $language);
+                if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $module = $path[0];
+                    $language = 'lang_' . $path[1] . '.php';
+                    $file = $path[0] . DS .$language;
+                }
+            }
+            if (! $module && !empty($obj->moduleName)){
+                $module = $obj->moduleName;
+            }
+            return array(
+                        'language' => $language,
+                        'module' => $module,
+                        'file' => $file
+                    );
+        }
 
 
-		/**
-		 * Get the module information for the config to load
-		 * @param  string $filename the filename of the configuration file,
-		 * @return array        the module information
-		 * array(
-		 * 	'module'=> 'module_name'
-		 * 	'filename' => 'filename'
-		 * )
-		 */
-		protected static function getModuleInfoForConfig($filename){
-			$module = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if (strpos($filename, '/') !== false){
-				$path = explode('/', $filename);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$module = $path[0];
-					$filename = $path[1] . '.php';
-				}
-			}
-			if (! $module && !empty($obj->moduleName)){
-				$module = $obj->moduleName;
-			}
-			return array(
-						'filename' => $filename,
-						'module' => $module
-					);
-		}
+        /**
+         * Get the module information for the config to load
+         * @param  string $filename the filename of the configuration file,
+         * @return array        the module information
+         * array(
+         * 	'module'=> 'module_name'
+         * 	'filename' => 'filename'
+         * )
+         */
+        protected static function getModuleInfoForConfig($filename){
+            $module = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if (strpos($filename, '/') !== false){
+                $path = explode('/', $filename);
+                if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $module = $path[0];
+                    $filename = $path[1] . '.php';
+                }
+            }
+            if (! $module && !empty($obj->moduleName)){
+                $module = $obj->moduleName;
+            }
+            return array(
+                        'filename' => $filename,
+                        'module' => $module
+                    );
+        }
 
-		/**
-		 * Get the name of model or library instance if is null
-		 * @param  string $class the class name to determine the instance
-		 * @return string        the instance name
-		 */
-		protected static function getModelLibraryInstanceName($class){
-			//for module
-			$instance = null;
-			if (strpos($class, '/') !== false){
-				$path = explode('/', $class);
-				if (isset($path[1])){
-					$instance = strtolower($path[1]);
-				}
-			}
-			else{
-				$instance = strtolower($class);
-			}
-			return $instance;
-		}
+        /**
+         * Get the name of model or library instance if is null
+         * @param  string $class the class name to determine the instance
+         * @return string        the instance name
+         */
+        protected static function getModelLibraryInstanceName($class){
+            //for module
+            $instance = null;
+            if (strpos($class, '/') !== false){
+                $path = explode('/', $class);
+                if (isset($path[1])){
+                    $instance = strtolower($path[1]);
+                }
+            }
+            else{
+                $instance = strtolower($class);
+            }
+            return $instance;
+        }
 
-		/**
-		 * Get the library file path using the module information
-		 * @param  string $class the class name
-		 * @return string|null        the library file path otherwise null will be returned
-		 */
-		protected static function getLibraryPathUsingModuleInfo($class){
-			$logger = static::getLogger();
-			$libraryFilePath = null;
-			$logger->debug('Checking library [' . $class . '] from module list ...');
-			$moduleInfo = self::getModuleInfoForModelLibrary($class);
-			$module = $moduleInfo['module'];
-			$class  = $moduleInfo['class'];
-			$moduleLibraryPath = Module::findLibraryFullPath($class, $module);
-			if ($moduleLibraryPath){
-				$logger->info('Found library [' . $class . '] from module [' .$module. '], the file path is [' .$moduleLibraryPath. '] we will used it');
-				$libraryFilePath = $moduleLibraryPath;
-			}
-			else{
-				$logger->info('Cannot find library [' . $class . '] from modules using the default location');
-			}
-			return $libraryFilePath;
-		}
+        /**
+         * Get the library file path using the module information
+         * @param  string $class the class name
+         * @return string|null        the library file path otherwise null will be returned
+         */
+        protected static function getLibraryPathUsingModuleInfo($class){
+            $logger = static::getLogger();
+            $libraryFilePath = null;
+            $logger->debug('Checking library [' . $class . '] from module list ...');
+            $moduleInfo = self::getModuleInfoForModelLibrary($class);
+            $module = $moduleInfo['module'];
+            $class  = $moduleInfo['class'];
+            $moduleLibraryPath = Module::findLibraryFullPath($class, $module);
+            if ($moduleLibraryPath){
+                $logger->info('Found library [' . $class . '] from module [' .$module. '], the file path is [' .$moduleLibraryPath. '] we will used it');
+                $libraryFilePath = $moduleLibraryPath;
+            }
+            else{
+                $logger->info('Cannot find library [' . $class . '] from modules using the default location');
+            }
+            return $libraryFilePath;
+        }
 
-		/**
-		 * Load the library 
-		 * @param  string $libraryFilePath the file path of the library to load
-		 * @param  string $class           the class name
-		 * @param  string $instance        the instance
-		 * @param  array  $params          the parameter to use
-		 * @return void
-		 */
-		protected static function loadLibrary($libraryFilePath, $class, $instance, $params = array()){
-			if ($libraryFilePath){
-				$logger = static::getLogger();
-				require_once $libraryFilePath;
-				if (class_exists($class)){
-					$c = $params ? new $class($params) : new $class();
-					$obj = & get_instance();
-					$obj->{$instance} = $c;
-					static::$loaded[$instance] = $class;
-					$logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
-				}
-				else{
-					show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
-				}
-			}
-			else{
-				show_error('Unable to find library class [' . $class . ']');
-			}
-		}
+        /**
+         * Load the library 
+         * @param  string $libraryFilePath the file path of the library to load
+         * @param  string $class           the class name
+         * @param  string $instance        the instance
+         * @param  array  $params          the parameter to use
+         * @return void
+         */
+        protected static function loadLibrary($libraryFilePath, $class, $instance, $params = array()){
+            if ($libraryFilePath){
+                $logger = static::getLogger();
+                require_once $libraryFilePath;
+                if (class_exists($class)){
+                    $c = $params ? new $class($params) : new $class();
+                    $obj = & get_instance();
+                    $obj->{$instance} = $c;
+                    static::$loaded[$instance] = $class;
+                    $logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
+                }
+                else{
+                    show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
+                }
+            }
+            else{
+                show_error('Unable to find library class [' . $class . ']');
+            }
+        }
 
-		/**
-		 * Load the language 
-		 * @param  string $languageFilePath the file path of the language to load
-		 * @param  string $language           the language name
-		 * @return void
-		 */
-		protected static function loadLanguage($languageFilePath, $language){
-			if ($languageFilePath){
-				$logger = static::getLogger();
-				$lang = array();
-				require_once $languageFilePath;
-				if (! empty($lang) && is_array($lang)){
-					$logger->info('Language file  [' .$languageFilePath. '] contains the valid languages keys add them to language list');
-					//Note: may be here the class 'Lang' not yet loaded
-					$langObj =& class_loader('Lang', 'classes');
-					$langObj->addLangMessages($lang);
-					//free the memory
-					unset($lang);
-				}
-				static::$loaded['lang_' . $language] = $languageFilePath;
-				$logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
-			}
-			else{
-				show_error('Unable to find language [' . $language . ']');
-			}
-		}
+        /**
+         * Load the language 
+         * @param  string $languageFilePath the file path of the language to load
+         * @param  string $language           the language name
+         * @return void
+         */
+        protected static function loadLanguage($languageFilePath, $language){
+            if ($languageFilePath){
+                $logger = static::getLogger();
+                $lang = array();
+                require_once $languageFilePath;
+                if (! empty($lang) && is_array($lang)){
+                    $logger->info('Language file  [' .$languageFilePath. '] contains the valid languages keys add them to language list');
+                    //Note: may be here the class 'Lang' not yet loaded
+                    $langObj =& class_loader('Lang', 'classes');
+                    $langObj->addLangMessages($lang);
+                    //free the memory
+                    unset($lang);
+                }
+                static::$loaded['lang_' . $language] = $languageFilePath;
+                $logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
+            }
+            else{
+                show_error('Unable to find language [' . $language . ']');
+            }
+        }
 
-		/**
-		 * Get all the autoload using the configuration file
-		 * @return array
-		 */
-		private function getResourcesFromAutoloadConfig(){
-			$autoloads = array();
-			$autoloads['config']    = array();
-			$autoloads['languages'] = array();
-			$autoloads['libraries'] = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			//loading of the resources from autoload configuration file
-			if (file_exists(CONFIG_PATH . 'autoload.php')){
-				$autoload = array();
-				require_once CONFIG_PATH . 'autoload.php';
-				if (! empty($autoload) && is_array($autoload)){
-					$autoloads = array_merge($autoloads, $autoload);
-					unset($autoload);
-				}
-			}
-			//loading autoload configuration for modules
-			$modulesAutoloads = Module::getModulesAutoloadConfig();
-			if (! empty($modulesAutoloads) && is_array($modulesAutoloads)){
-				$autoloads = array_merge_recursive($autoloads, $modulesAutoloads);
-			}
-			return $autoloads;
-		}
+        /**
+         * Get all the autoload using the configuration file
+         * @return array
+         */
+        private function getResourcesFromAutoloadConfig(){
+            $autoloads = array();
+            $autoloads['config']    = array();
+            $autoloads['languages'] = array();
+            $autoloads['libraries'] = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            //loading of the resources from autoload configuration file
+            if (file_exists(CONFIG_PATH . 'autoload.php')){
+                $autoload = array();
+                require_once CONFIG_PATH . 'autoload.php';
+                if (! empty($autoload) && is_array($autoload)){
+                    $autoloads = array_merge($autoloads, $autoload);
+                    unset($autoload);
+                }
+            }
+            //loading autoload configuration for modules
+            $modulesAutoloads = Module::getModulesAutoloadConfig();
+            if (! empty($modulesAutoloads) && is_array($modulesAutoloads)){
+                $autoloads = array_merge_recursive($autoloads, $modulesAutoloads);
+            }
+            return $autoloads;
+        }
 
-		/**
-		 * Load the autoload configuration
-		 * @return void
-		 */
-		private function loadResourcesFromAutoloadConfig(){
-			$autoloads = array();
-			$autoloads['config']    = array();
-			$autoloads['languages'] = array();
-			$autoloads['libraries'] = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
+        /**
+         * Load the autoload configuration
+         * @return void
+         */
+        private function loadResourcesFromAutoloadConfig(){
+            $autoloads = array();
+            $autoloads['config']    = array();
+            $autoloads['languages'] = array();
+            $autoloads['libraries'] = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
 
-			$list = $this->getResourcesFromAutoloadConfig();
-			$autoloads = array_merge($autoloads, $list);
+            $list = $this->getResourcesFromAutoloadConfig();
+            $autoloads = array_merge($autoloads, $list);
 			
-			//config autoload
-			$this->loadAutoloadResourcesArray('config', $autoloads['config']);
+            //config autoload
+            $this->loadAutoloadResourcesArray('config', $autoloads['config']);
 			
-			//languages autoload
-			$this->loadAutoloadResourcesArray('lang', $autoloads['languages']);
+            //languages autoload
+            $this->loadAutoloadResourcesArray('lang', $autoloads['languages']);
 			
-			//libraries autoload
-			$this->loadAutoloadResourcesArray('library', $autoloads['libraries']);
+            //libraries autoload
+            $this->loadAutoloadResourcesArray('library', $autoloads['libraries']);
 
-			//models autoload
-			$this->loadAutoloadResourcesArray('model', $autoloads['models']);
+            //models autoload
+            $this->loadAutoloadResourcesArray('model', $autoloads['models']);
 			
-			//functions autoload
-			$this->loadAutoloadResourcesArray('functions', $autoloads['functions']);
-		}
+            //functions autoload
+            $this->loadAutoloadResourcesArray('functions', $autoloads['functions']);
+        }
 
-		/**
-		 * Load the resources autoload array
-		 * @param  string $method    this object method name to call
-		 * @param  array  $resources the resource to load
-		 * @return void            
-		 */
-		private function loadAutoloadResourcesArray($method, array $resources){
-			foreach ($resources as $name) {
-				$this->{$method}($name);
-			}
-		}
-	}
+        /**
+         * Load the resources autoload array
+         * @param  string $method    this object method name to call
+         * @param  array  $resources the resource to load
+         * @return void            
+         */
+        private function loadAutoloadResourcesArray($method, array $resources){
+            foreach ($resources as $name) {
+                $this->{$method}($name);
+            }
+        }
+    }

Spacing +105 added lines, -105 removed lines

@@ -23,7 +23,7 @@ 
 	 * along with this program; if not, write to the Free Software
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
-	class Loader{
+	class Loader {
 		
 		/**
 		 * List of loaded resources
@@ -38,7 +38,7 @@ 
 		private static $logger;
 
 
-		public function __construct(){
+		public function __construct() {
 			//add the resources already loaded during application bootstrap
 			//in the list to prevent duplicate or loading the resources again.
 			static::$loaded = class_loaded();
@@ -51,10 +51,10 @@ 
 		 * The signleton of the logger
 		 * @return object the Log instance
 		 */
-		public static function getLogger(){
-			if(self::$logger == null){
+		public static function getLogger() {
+			if (self::$logger == null) {
 				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
+				$logger[0] = & class_loader('Log', 'classes');
 				$logger[0]->setLogger('Library::Loader');
 				self::$logger = $logger[0];
 			}
@@ -66,7 +66,7 @@ 
 		 * @param object $logger the log object
 		 * @return object the log instance
 		 */
-		public static function setLogger($logger){
+		public static function setLogger($logger) {
 			self::$logger = $logger;
 			return self::$logger;
 		}
@@ -80,18 +80,18 @@ 
 		 *
 		 * @return void
 		 */
-		public static function model($class, $instance = null){
+		public static function model($class, $instance = null) {
 			$logger = static::getLogger();
 			$class = str_ireplace('.php', '', $class);
 			$class = trim($class, '/\\');
-			$file = ucfirst($class).'.php';
+			$file = ucfirst($class) . '.php';
 			$logger->debug('Loading model [' . $class . '] ...');
 			//************
-			if (! $instance){
+			if (!$instance) {
 				$instance = self::getModelLibraryInstanceName($class);
 			}
 			//****************
-			if (isset(static::$loaded[$instance])){
+			if (isset(static::$loaded[$instance])) {
 				$logger->info('Model [' . $class . '] already loaded no need to load it again, cost in performance');
 				return;
 			}
@@ -104,28 +104,28 @@ 
 			$class  = $moduleInfo['class'];
 			
 			$moduleModelFilePath = Module::findModelFullPath($class, $module);
-			if ($moduleModelFilePath){
-				$logger->info('Found model [' . $class . '] from module [' .$module. '], the file path is [' .$moduleModelFilePath. '] we will used it');
+			if ($moduleModelFilePath) {
+				$logger->info('Found model [' . $class . '] from module [' . $module . '], the file path is [' . $moduleModelFilePath . '] we will used it');
 				$classFilePath = $moduleModelFilePath;
 			}
-			else{
+			else {
 				$logger->info('Cannot find model [' . $class . '] from modules using the default location');
 			}
 			$logger->info('The model file path to be loaded is [' . $classFilePath . ']');
-			if (file_exists($classFilePath)){
+			if (file_exists($classFilePath)) {
 				require_once $classFilePath;
-				if (class_exists($class)){
+				if (class_exists($class)) {
 					$c = new $class();
 					$obj = & get_instance();
 					$obj->{$instance} = $c;
 					static::$loaded[$instance] = $class;
 					$logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
 				}
-				else{
-					show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
+				else {
+					show_error('The file ' . $classFilePath . ' exists but does not contain the class [' . $class . ']');
 				}
 			}
-			else{
+			else {
 				show_error('Unable to find the model [' . $class . ']');
 			}
 		}
@@ -140,22 +140,22 @@ 
 		 *
 		 * @return void
 		 */
-		public static function library($class, $instance = null, array $params = array()){
+		public static function library($class, $instance = null, array $params = array()) {
 			$logger = static::getLogger();
 			$class = str_ireplace('.php', '', $class);
 			$class = trim($class, '/\\');
-			$file = ucfirst($class) .'.php';
+			$file = ucfirst($class) . '.php';
 			$logger->debug('Loading library [' . $class . '] ...');
-			if (! $instance){
+			if (!$instance) {
 				$instance = self::getModelLibraryInstanceName($class);
 			}
-			if (isset(static::$loaded[$instance])){
+			if (isset(static::$loaded[$instance])) {
 				$logger->info('Library [' . $class . '] already loaded no need to load it again, cost in performance');
 				return;
 			}
 			$obj = & get_instance();
 			//Check and load Database library
-			if (strtolower($class) == 'database'){
+			if (strtolower($class) == 'database') {
 				$logger->info('This is the Database library ...');
 				$obj->{$instance} = & class_loader('Database', 'classes/database', $params);
 				static::$loaded[$instance] = $class;
@@ -164,18 +164,18 @@ 
 			}
 			$libraryFilePath = null;
 			$logger->debug('Check if this is a system library ...');
-			if (file_exists(CORE_LIBRARY_PATH . $file)){
+			if (file_exists(CORE_LIBRARY_PATH . $file)) {
 				$libraryFilePath = CORE_LIBRARY_PATH . $file;
 				$class = ucfirst($class);
 				$logger->info('This library is a system library');
 			}
-			else{
+			else {
 				$logger->info('This library is not a system library');	
 				//first check if this library is in the module
 				$libraryFilePath = self::getLibraryPathUsingModuleInfo($class);
 				//***************
 			}
-			if (! $libraryFilePath && file_exists(LIBRARY_PATH . $file)){
+			if (!$libraryFilePath && file_exists(LIBRARY_PATH . $file)) {
 				$libraryFilePath = LIBRARY_PATH . $file;
 			}
 			$logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
@@ -190,14 +190,14 @@ 
 		 *
 		 * @return void
 		 */
-		public static function functions($function){
+		public static function functions($function) {
 			$logger = static::getLogger();
 			$function = str_ireplace('.php', '', $function);
 			$function = trim($function, '/\\');
 			$function = str_ireplace('function_', '', $function);
-			$file = 'function_'.$function.'.php';
+			$file = 'function_' . $function . '.php';
 			$logger->debug('Loading helper [' . $function . '] ...');
-			if (isset(static::$loaded['function_' . $function])){
+			if (isset(static::$loaded['function_' . $function])) {
 				$logger->info('Helper [' . $function . '] already loaded no need to load it again, cost in performance');
 				return;
 			}
@@ -207,22 +207,22 @@ 
 			$moduleInfo = self::getModuleInfoForFunction($function);
 			$module    = $moduleInfo['module'];
 			$function  = $moduleInfo['function'];
-			if(! empty($moduleInfo['file'])){
+			if (!empty($moduleInfo['file'])) {
 				$file = $moduleInfo['file'];
 			}
 			$moduleFunctionPath = Module::findFunctionFullPath($function, $module);
-			if ($moduleFunctionPath){
-				$logger->info('Found helper [' . $function . '] from module [' .$module. '], the file path is [' .$moduleFunctionPath. '] we will used it');
+			if ($moduleFunctionPath) {
+				$logger->info('Found helper [' . $function . '] from module [' . $module . '], the file path is [' . $moduleFunctionPath . '] we will used it');
 				$functionFilePath = $moduleFunctionPath;
 			}
-			else{
+			else {
 				$logger->info('Cannot find helper [' . $function . '] from modules using the default location');
 			}
-			if (! $functionFilePath){
+			if (!$functionFilePath) {
 				$searchDir = array(FUNCTIONS_PATH, CORE_FUNCTIONS_PATH);
-				foreach($searchDir as $dir){
+				foreach ($searchDir as $dir) {
 					$filePath = $dir . $file;
-					if (file_exists($filePath)){
+					if (file_exists($filePath)) {
 						$functionFilePath = $filePath;
 						//is already found not to continue
 						break;
@@ -230,12 +230,12 @@ 
 				}
 			}
 			$logger->info('The helper file path to be loaded is [' . $functionFilePath . ']');
-			if ($functionFilePath){
+			if ($functionFilePath) {
 				require_once $functionFilePath;
 				static::$loaded['function_' . $function] = $functionFilePath;
 				$logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
 			}
-			else{
+			else {
 				show_error('Unable to find helper file [' . $file . ']');
 			}
 		}
@@ -247,14 +247,14 @@ 
 		 *
 		 * @return void
 		 */
-		public static function config($filename){
+		public static function config($filename) {
 			$logger = static::getLogger();
 			$filename = str_ireplace('.php', '', $filename);
 			$filename = trim($filename, '/\\');
 			$filename = str_ireplace('config_', '', $filename);
-			$file = 'config_'.$filename.'.php';
+			$file = 'config_' . $filename . '.php';
 			$logger->debug('Loading configuration [' . $filename . '] ...');
-			if (isset(static::$loaded['config_' . $filename])){
+			if (isset(static::$loaded['config_' . $filename])) {
 				$logger->info('Configuration [' . $file . '] already loaded no need to load it again, cost in performance');
 				return;
 			}
@@ -265,18 +265,18 @@ 
 			$module    = $moduleInfo['module'];
 			$filename  = $moduleInfo['filename'];
 			$moduleConfigPath = Module::findConfigFullPath($filename, $module);
-			if ($moduleConfigPath){
-				$logger->info('Found config [' . $filename . '] from module [' .$module. '], the file path is [' .$moduleConfigPath. '] we will used it');
+			if ($moduleConfigPath) {
+				$logger->info('Found config [' . $filename . '] from module [' . $module . '], the file path is [' . $moduleConfigPath . '] we will used it');
 				$configFilePath = $moduleConfigPath;
 			}
-			else{
+			else {
 				$logger->info('Cannot find config [' . $filename . '] from modules using the default location');
 			}
 			$logger->info('The config file path to be loaded is [' . $configFilePath . ']');
 			$config = array();
-			if (file_exists($configFilePath)){
+			if (file_exists($configFilePath)) {
 				require_once $configFilePath;
-				if (! empty($config) && is_array($config)){
+				if (!empty($config) && is_array($config)) {
 					Config::setAll($config);
 					static::$loaded['config_' . $filename] = $configFilePath;
 					$logger->info('Configuration [' . $configFilePath . '] loaded successfully.');
@@ -284,8 +284,8 @@ 
 					unset($config);
 				}
 			}
-			else{
-				show_error('Unable to find config file ['. $configFilePath . ']');
+			else {
+				show_error('Unable to find config file [' . $configFilePath . ']');
 			}
 		}
 
@@ -297,14 +297,14 @@ 
 		 *
 		 * @return void
 		 */
-		public static function lang($language){
+		public static function lang($language) {
 			$logger = static::getLogger();
 			$language = str_ireplace('.php', '', $language);
 			$language = trim($language, '/\\');
 			$language = str_ireplace('lang_', '', $language);
-			$file = 'lang_'.$language.'.php';
+			$file = 'lang_' . $language . '.php';
 			$logger->debug('Loading language [' . $language . '] ...');
-			if (isset(static::$loaded['lang_' . $language])){
+			if (isset(static::$loaded['lang_' . $language])) {
 				$logger->info('Language [' . $language . '] already loaded no need to load it again, cost in performance');
 				return;
 			}
@@ -316,22 +316,22 @@ 
 			$moduleInfo = self::getModuleInfoForLanguage($language);
 			$module    = $moduleInfo['module'];
 			$language  = $moduleInfo['language'];
-			if(! empty($moduleInfo['file'])){
+			if (!empty($moduleInfo['file'])) {
 				$file = $moduleInfo['file'];
 			}
 			$moduleLanguagePath = Module::findLanguageFullPath($language, $module, $appLang);
-			if ($moduleLanguagePath){
-				$logger->info('Found language [' . $language . '] from module [' .$module. '], the file path is [' .$moduleLanguagePath. '] we will used it');
+			if ($moduleLanguagePath) {
+				$logger->info('Found language [' . $language . '] from module [' . $module . '], the file path is [' . $moduleLanguagePath . '] we will used it');
 				$languageFilePath = $moduleLanguagePath;
 			}
-			else{
+			else {
 				$logger->info('Cannot find language [' . $language . '] from modules using the default location');
 			}
-			if (! $languageFilePath){
+			if (!$languageFilePath) {
 				$searchDir = array(APP_LANG_PATH, CORE_LANG_PATH);
-				foreach($searchDir as $dir){
+				foreach ($searchDir as $dir) {
 					$filePath = $dir . $appLang . DS . $file;
-					if (file_exists($filePath)){
+					if (file_exists($filePath)) {
 						$languageFilePath = $filePath;
 						//already found no need continue
 						break;
@@ -347,14 +347,14 @@ 
 		 * if can not found will use the default value from configuration
 		 * @return string the app language like "en", "fr"
 		 */
-		protected static function getAppLang(){
+		protected static function getAppLang() {
 			//determine the current language
 			$appLang = get_config('default_language');
 			//if the language exists in the cookie use it
 			$cfgKey = get_config('language_cookie_name');
 			$objCookie = & class_loader('Cookie');
 			$cookieLang = $objCookie->get($cfgKey);
-			if ($cookieLang){
+			if ($cookieLang) {
 				$appLang = $cookieLang;
 			}
 			return $appLang;
@@ -368,20 +368,20 @@ 
 		 * 	'class' => 'class_name'
 		 * )
 		 */
-		protected static function getModuleInfoForModelLibrary($class){
+		protected static function getModuleInfoForModelLibrary($class) {
 			$module = null;
 			$obj = & get_instance();
-			if (strpos($class, '/') !== false){
+			if (strpos($class, '/') !== false) {
 				$path = explode('/', $class);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+				if (isset($path[0]) && in_array($path[0], Module::getModuleList())) {
 					$module = $path[0];
 					$class = ucfirst($path[1]);
 				}
 			}
-			else{
+			else {
 				$class = ucfirst($class);
 			}
-			if (! $module && !empty($obj->moduleName)){
+			if (!$module && !empty($obj->moduleName)) {
 				$module = $obj->moduleName;
 			}
 			return array(
@@ -400,20 +400,20 @@ 
 		 * 	'file' => 'file'
 		 * )
 		 */
-		protected static function getModuleInfoForFunction($function){
+		protected static function getModuleInfoForFunction($function) {
 			$module = null;
 			$file = null;
 			$obj = & get_instance();
 			//check if the request class contains module name
-			if (strpos($function, '/') !== false){
+			if (strpos($function, '/') !== false) {
 				$path = explode('/', $function);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+				if (isset($path[0]) && in_array($path[0], Module::getModuleList())) {
 					$module = $path[0];
 					$function = 'function_' . $path[1];
-					$file = $path[0] . DS . $function.'.php';
+					$file = $path[0] . DS . $function . '.php';
 				}
 			}
-			if (! $module && !empty($obj->moduleName)){
+			if (!$module && !empty($obj->moduleName)) {
 				$module = $obj->moduleName;
 			}
 			return array(
@@ -433,20 +433,20 @@ 
 		 * 	'file' => 'file'
 		 * )
 		 */
-		protected static function getModuleInfoForLanguage($language){
+		protected static function getModuleInfoForLanguage($language) {
 			$module = null;
 			$file = null;
 			$obj = & get_instance();
 			//check if the request class contains module name
-			if (strpos($language, '/') !== false){
+			if (strpos($language, '/') !== false) {
 				$path = explode('/', $language);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+				if (isset($path[0]) && in_array($path[0], Module::getModuleList())) {
 					$module = $path[0];
 					$language = 'lang_' . $path[1] . '.php';
-					$file = $path[0] . DS .$language;
+					$file = $path[0] . DS . $language;
 				}
 			}
-			if (! $module && !empty($obj->moduleName)){
+			if (!$module && !empty($obj->moduleName)) {
 				$module = $obj->moduleName;
 			}
 			return array(
@@ -466,18 +466,18 @@ 
 		 * 	'filename' => 'filename'
 		 * )
 		 */
-		protected static function getModuleInfoForConfig($filename){
+		protected static function getModuleInfoForConfig($filename) {
 			$module = null;
 			$obj = & get_instance();
 			//check if the request class contains module name
-			if (strpos($filename, '/') !== false){
+			if (strpos($filename, '/') !== false) {
 				$path = explode('/', $filename);
-				if (isset($path[0]) && in_array($path[0], Module::getModuleList())){
+				if (isset($path[0]) && in_array($path[0], Module::getModuleList())) {
 					$module = $path[0];
 					$filename = $path[1] . '.php';
 				}
 			}
-			if (! $module && !empty($obj->moduleName)){
+			if (!$module && !empty($obj->moduleName)) {
 				$module = $obj->moduleName;
 			}
 			return array(
@@ -491,16 +491,16 @@ 
 		 * @param  string $class the class name to determine the instance
 		 * @return string        the instance name
 		 */
-		protected static function getModelLibraryInstanceName($class){
+		protected static function getModelLibraryInstanceName($class) {
 			//for module
 			$instance = null;
-			if (strpos($class, '/') !== false){
+			if (strpos($class, '/') !== false) {
 				$path = explode('/', $class);
-				if (isset($path[1])){
+				if (isset($path[1])) {
 					$instance = strtolower($path[1]);
 				}
 			}
-			else{
+			else {
 				$instance = strtolower($class);
 			}
 			return $instance;
@@ -511,7 +511,7 @@ 
 		 * @param  string $class the class name
 		 * @return string|null        the library file path otherwise null will be returned
 		 */
-		protected static function getLibraryPathUsingModuleInfo($class){
+		protected static function getLibraryPathUsingModuleInfo($class) {
 			$logger = static::getLogger();
 			$libraryFilePath = null;
 			$logger->debug('Checking library [' . $class . '] from module list ...');
@@ -519,11 +519,11 @@ 
 			$module = $moduleInfo['module'];
 			$class  = $moduleInfo['class'];
 			$moduleLibraryPath = Module::findLibraryFullPath($class, $module);
-			if ($moduleLibraryPath){
-				$logger->info('Found library [' . $class . '] from module [' .$module. '], the file path is [' .$moduleLibraryPath. '] we will used it');
+			if ($moduleLibraryPath) {
+				$logger->info('Found library [' . $class . '] from module [' . $module . '], the file path is [' . $moduleLibraryPath . '] we will used it');
 				$libraryFilePath = $moduleLibraryPath;
 			}
-			else{
+			else {
 				$logger->info('Cannot find library [' . $class . '] from modules using the default location');
 			}
 			return $libraryFilePath;
@@ -537,22 +537,22 @@ 
 		 * @param  array  $params          the parameter to use
 		 * @return void
 		 */
-		protected static function loadLibrary($libraryFilePath, $class, $instance, $params = array()){
-			if ($libraryFilePath){
+		protected static function loadLibrary($libraryFilePath, $class, $instance, $params = array()) {
+			if ($libraryFilePath) {
 				$logger = static::getLogger();
 				require_once $libraryFilePath;
-				if (class_exists($class)){
+				if (class_exists($class)) {
 					$c = $params ? new $class($params) : new $class();
 					$obj = & get_instance();
 					$obj->{$instance} = $c;
 					static::$loaded[$instance] = $class;
 					$logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
 				}
-				else{
-					show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
+				else {
+					show_error('The file ' . $libraryFilePath . ' exists but does not contain the class ' . $class);
 				}
 			}
-			else{
+			else {
 				show_error('Unable to find library class [' . $class . ']');
 			}
 		}
@@ -563,15 +563,15 @@ 
 		 * @param  string $language           the language name
 		 * @return void
 		 */
-		protected static function loadLanguage($languageFilePath, $language){
-			if ($languageFilePath){
+		protected static function loadLanguage($languageFilePath, $language) {
+			if ($languageFilePath) {
 				$logger = static::getLogger();
 				$lang = array();
 				require_once $languageFilePath;
-				if (! empty($lang) && is_array($lang)){
-					$logger->info('Language file  [' .$languageFilePath. '] contains the valid languages keys add them to language list');
+				if (!empty($lang) && is_array($lang)) {
+					$logger->info('Language file  [' . $languageFilePath . '] contains the valid languages keys add them to language list');
 					//Note: may be here the class 'Lang' not yet loaded
-					$langObj =& class_loader('Lang', 'classes');
+					$langObj = & class_loader('Lang', 'classes');
 					$langObj->addLangMessages($lang);
 					//free the memory
 					unset($lang);
@@ -579,7 +579,7 @@ 
 				static::$loaded['lang_' . $language] = $languageFilePath;
 				$logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
 			}
-			else{
+			else {
 				show_error('Unable to find language [' . $language . ']');
 			}
 		}
@@ -588,7 +588,7 @@ 
 		 * Get all the autoload using the configuration file
 		 * @return array
 		 */
-		private function getResourcesFromAutoloadConfig(){
+		private function getResourcesFromAutoloadConfig() {
 			$autoloads = array();
 			$autoloads['config']    = array();
 			$autoloads['languages'] = array();
@@ -596,17 +596,17 @@ 
 			$autoloads['models']    = array();
 			$autoloads['functions'] = array();
 			//loading of the resources from autoload configuration file
-			if (file_exists(CONFIG_PATH . 'autoload.php')){
+			if (file_exists(CONFIG_PATH . 'autoload.php')) {
 				$autoload = array();
 				require_once CONFIG_PATH . 'autoload.php';
-				if (! empty($autoload) && is_array($autoload)){
+				if (!empty($autoload) && is_array($autoload)) {
 					$autoloads = array_merge($autoloads, $autoload);
 					unset($autoload);
 				}
 			}
 			//loading autoload configuration for modules
 			$modulesAutoloads = Module::getModulesAutoloadConfig();
-			if (! empty($modulesAutoloads) && is_array($modulesAutoloads)){
+			if (!empty($modulesAutoloads) && is_array($modulesAutoloads)) {
 				$autoloads = array_merge_recursive($autoloads, $modulesAutoloads);
 			}
 			return $autoloads;
@@ -616,7 +616,7 @@ 
 		 * Load the autoload configuration
 		 * @return void
 		 */
-		private function loadResourcesFromAutoloadConfig(){
+		private function loadResourcesFromAutoloadConfig() {
 			$autoloads = array();
 			$autoloads['config']    = array();
 			$autoloads['languages'] = array();
@@ -649,7 +649,7 @@ 
 		 * @param  array  $resources the resource to load
 		 * @return void            
 		 */
-		private function loadAutoloadResourcesArray($method, array $resources){
+		private function loadAutoloadResourcesArray($method, array $resources) {
 			foreach ($resources as $name) {
 				$this->{$method}($name);
 			}

config/config.php

Indentation +273 added lines, -273 removed lines

@@ -1,337 +1,337 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework created using the concept of codeigniter with bootstrap twitter
-	 *
-	 * 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 created using the concept of codeigniter with bootstrap twitter
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	/**
-	* This file contains the main configuration of your application
-	* web address, front controller, error logging, session parameters, CSRF, Cache, 
-	* Whitelist IP access, etc.
-	*/
+    /**
+     * This file contains the main configuration of your application
+     * web address, front controller, error logging, session parameters, CSRF, Cache, 
+     * Whitelist IP access, etc.
+     */
 	
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* Basic configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/**
-	* The web address of your application.
-	*
-	* The address of your application or website terminated by a slash.
-	* You can use a domain name or IP address, for example:
-	*
-	* $config['base_url'] = 'http://www.mysite.com';
-	* or
-	* $config['base_url'] = 'http://198.15.25.12';
-	*
-	* If this value is empty, we try to determine it automatically by using 
-	* the server variables "SERVER_ADDR" or "SCRIPT_NAME",
-	* we recommend that you specify this value for a server in production this may reduce the performance of your application.
-	*/
-	$config['base_url'] = '';
+    /**
+     * The web address of your application.
+     *
+     * The address of your application or website terminated by a slash.
+     * You can use a domain name or IP address, for example:
+     *
+     * $config['base_url'] = 'http://www.mysite.com';
+     * or
+     * $config['base_url'] = 'http://198.15.25.12';
+     *
+     * If this value is empty, we try to determine it automatically by using 
+     * the server variables "SERVER_ADDR" or "SCRIPT_NAME",
+     * we recommend that you specify this value for a server in production this may reduce the performance of your application.
+     */
+    $config['base_url'] = '';
 	
-	/**
-	* The front controller
-	*
-	* This represents the name of the file called by the application during the loading 
-	* process generally the file "index.php". 
-	* If your webserver supports the url rewrite module, then you can leave this value empty. 
-	* You will find a sample file to hide this file in the url inside the root folder of your 
-	* application "htaccess.txt" for the apache web server just rename it to ".htaccess"
-	* 
-	* Without the rewrite module url enabled, leave this value to "index.php", in this case your urls look like:
-	*
-	* http://www.yoursite.com/index.php/controller/method
-	* 
-	* otherwise if the module is available and activated you can put this value empty and your urls look like:
-	*
-	* http://www.yoursite.com/controller/method
-	*
-	*/
-	$config['front_controller'] = 'index.php';
+    /**
+     * The front controller
+     *
+     * This represents the name of the file called by the application during the loading 
+     * process generally the file "index.php". 
+     * If your webserver supports the url rewrite module, then you can leave this value empty. 
+     * You will find a sample file to hide this file in the url inside the root folder of your 
+     * application "htaccess.txt" for the apache web server just rename it to ".htaccess"
+     * 
+     * Without the rewrite module url enabled, leave this value to "index.php", in this case your urls look like:
+     *
+     * http://www.yoursite.com/index.php/controller/method
+     * 
+     * otherwise if the module is available and activated you can put this value empty and your urls look like:
+     *
+     * http://www.yoursite.com/controller/method
+     *
+     */
+    $config['front_controller'] = 'index.php';
 	
-	/**
-	 *  Url suffix
-	 */
-	$config['url_suffix'] = '';
+    /**
+     *  Url suffix
+     */
+    $config['url_suffix'] = '';
 	
-	/**
-	 *  site charset
-	 */
-	$config['charset'] = 'UTF-8';
+    /**
+     *  site charset
+     */
+    $config['charset'] = 'UTF-8';
 	
-	/**
-	* Compress the output before send to browser
-	*
-	* Enables Gzip output compression for faster page loads.  When enabled,
-	* the Response class will test whether your server supports Gzip.
-	* Even if it does, however, not all browsers support compression
-	* so enable only if you are reasonably sure your visitors can handle it.
-	*
-	* This is only used if "zlib.output_compression" is turned off in your php configuration.
-	* Please do not use it together with httpd-level output compression.
-	*
-	* IMPORTANT NOTE:  If you are getting a blank page when compression is enabled it
-	* means you are prematurely outputting something to your browser. It could
-	* even be a line of whitespace at the end of one of your scripts. For
-	* compression to work, nothing can be sent before the output buffer is called
-	* by the Response class.  Do not 'echo' any values with compression enabled.
-	*/
-	$config['compress_output'] = false;
+    /**
+     * Compress the output before send to browser
+     *
+     * Enables Gzip output compression for faster page loads.  When enabled,
+     * the Response class will test whether your server supports Gzip.
+     * Even if it does, however, not all browsers support compression
+     * so enable only if you are reasonably sure your visitors can handle it.
+     *
+     * This is only used if "zlib.output_compression" is turned off in your php configuration.
+     * Please do not use it together with httpd-level output compression.
+     *
+     * IMPORTANT NOTE:  If you are getting a blank page when compression is enabled it
+     * means you are prematurely outputting something to your browser. It could
+     * even be a line of whitespace at the end of one of your scripts. For
+     * compression to work, nothing can be sent before the output buffer is called
+     * by the Response class.  Do not 'echo' any values with compression enabled.
+     */
+    $config['compress_output'] = false;
 
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* Language configuration section
 	+------------------------------------------------------------------+
 	*/
-	/**
-	 * list of available supported language
-	 * array(
-	 * 		'lang_key' => 'human readable'
-	 * )
-	 */
-	$config['languages'] = array('en' => 'english');
+    /**
+     * list of available supported language
+     * array(
+     * 		'lang_key' => 'human readable'
+     * )
+     */
+    $config['languages'] = array('en' => 'english');
 
-	/**
-	 * the default language to use if can not find the client language
-	 * need match with the array key of the supported languages
-	 */
-	$config['default_language'] = 'en'; //en = english, fr = french
+    /**
+     * the default language to use if can not find the client language
+     * need match with the array key of the supported languages
+     */
+    $config['default_language'] = 'en'; //en = english, fr = french
 
-	/**
-	 * the name of cookie used to store the client language
-	 */
-	$config['language_cookie_name'] = 'cookie_lang';
+    /**
+     * the name of cookie used to store the client language
+     */
+    $config['language_cookie_name'] = 'cookie_lang';
 
 
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* Logs configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/** 
-	* The log level
-	*
-	* The valid level are: OFF, NONE, FATAL, ERROR, WARNING, WARN, INFO, DEBUG, ALL
-	*
-	* 'OFF' or 'NONE' = do not save log
-	* 'FATAL' = enable log for fatal level and above (FATAL)
-	* 'ERROR' = enable log for error level and above (ERROR, FATAL)
-	* 'WARNING' or WARN = enable log for warning level and above (WARNING, ERROR, FATAL)
-	* 'INFO' = enable log for info level and above (INFO, WARNING, ERROR, FATAL)
-	* 'DEBUG' = enable log for debug level and above (DEBUG, INFO, WARNING, ERROR, FATAL)
-	* 'ALL' = enable log for all level
-	*
-	* The default value is NONE if the config value is: null, '', 0, false
-	* 
-	* Note: in production environment it's recommand to set the log level to 'WARNING' if not in small
-	* of time the log file size will increase very fast and will cost the application performance
-	* and also the filesystem usage of your server.
-	*/
-	$config['log_level'] = 'NONE';
+    /** 
+     * The log level
+     *
+     * The valid level are: OFF, NONE, FATAL, ERROR, WARNING, WARN, INFO, DEBUG, ALL
+     *
+     * 'OFF' or 'NONE' = do not save log
+     * 'FATAL' = enable log for fatal level and above (FATAL)
+     * 'ERROR' = enable log for error level and above (ERROR, FATAL)
+     * 'WARNING' or WARN = enable log for warning level and above (WARNING, ERROR, FATAL)
+     * 'INFO' = enable log for info level and above (INFO, WARNING, ERROR, FATAL)
+     * 'DEBUG' = enable log for debug level and above (DEBUG, INFO, WARNING, ERROR, FATAL)
+     * 'ALL' = enable log for all level
+     *
+     * The default value is NONE if the config value is: null, '', 0, false
+     * 
+     * Note: in production environment it's recommand to set the log level to 'WARNING' if not in small
+     * of time the log file size will increase very fast and will cost the application performance
+     * and also the filesystem usage of your server.
+     */
+    $config['log_level'] = 'NONE';
 
 
-	/**
-	* The path to log directory
-	* 
-	* The path that the log data will be saved ending with de "/" or "\", leave empty if you
-	* want use the default configuration
-	* warning : if set, this directory must exist and will be writable and owned by the web server
-	* else the default value will be used i.e the constant LOG_PATH
-	* for security raison this directory must be outside of the document root of your
-	* website.
-	*/	
-	$config['log_save_path'] = '';
+    /**
+     * The path to log directory
+     * 
+     * The path that the log data will be saved ending with de "/" or "\", leave empty if you
+     * want use the default configuration
+     * warning : if set, this directory must exist and will be writable and owned by the web server
+     * else the default value will be used i.e the constant LOG_PATH
+     * for security raison this directory must be outside of the document root of your
+     * website.
+     */	
+    $config['log_save_path'] = '';
 	
-	/**
-	* The logger name to use for the log
-	* 
-	* If this config is set so means only log message with this or these logger(s) will be saved
-	*
-	* Example:
-	* $config['log_logger_name'] = array('MY_LOGGER1', 'MY_LOGGER2'); //only log message with MY_LOGGER1 or MY_LOGGER2 will be saved in file.
-	*/	
-	$config['log_logger_name'] = array();
+    /**
+     * The logger name to use for the log
+     * 
+     * If this config is set so means only log message with this or these logger(s) will be saved
+     *
+     * Example:
+     * $config['log_logger_name'] = array('MY_LOGGER1', 'MY_LOGGER2'); //only log message with MY_LOGGER1 or MY_LOGGER2 will be saved in file.
+     */	
+    $config['log_logger_name'] = array();
 	
 	
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* Session configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/**
-	* The session name 
-	*
-	* By default is PHPSESSID. this must be alpha-numerical characters
-	*/
-	$config['session_name'] = 'PHPSESSID';
+    /**
+     * The session name 
+     *
+     * By default is PHPSESSID. this must be alpha-numerical characters
+     */
+    $config['session_name'] = 'PHPSESSID';
 	
-	/**
-	* Session save path
-	*
-	* The path that the session data will be saved, leave empty if you
-	* want use the default configuration in the php.ini
-	* warning : if set, this directory must exist and will be writable and owned by the web server
-	* for security raison this directory must be outside of the document root of your
-	* website.
-	* Note: if the session handler is "database" the session_save_path is the model name to use
-	*/
-	$config['session_save_path'] = '';
+    /**
+     * Session save path
+     *
+     * The path that the session data will be saved, leave empty if you
+     * want use the default configuration in the php.ini
+     * warning : if set, this directory must exist and will be writable and owned by the web server
+     * for security raison this directory must be outside of the document root of your
+     * website.
+     * Note: if the session handler is "database" the session_save_path is the model name to use
+     */
+    $config['session_save_path'] = '';
 
-	/**
-	* Session handler
-	*
-	* The session handler that we will use to manage the session.
-	* currently the possible values are "files", "database".
-	*/
-	$config['session_handler'] = 'files';
+    /**
+     * Session handler
+     *
+     * The session handler that we will use to manage the session.
+     * currently the possible values are "files", "database".
+     */
+    $config['session_handler'] = 'files';
 	
-	/**
-	* Session secret
-	*
-	* This is used to hash the session data if the config "session_handler" is set to "database"
-	* warning : do not change this value until you already set
-	* for security raison use the very complicated value include $%)@^&^\''\'\'
-	* NOTE: this value is an base64 so you need use the tool that generate it, like
-	*  PHP function base64_encode()
-	*/
-	$config['session_secret'] = '';
+    /**
+     * Session secret
+     *
+     * This is used to hash the session data if the config "session_handler" is set to "database"
+     * warning : do not change this value until you already set
+     * for security raison use the very complicated value include $%)@^&^\''\'\'
+     * NOTE: this value is an base64 so you need use the tool that generate it, like
+     *  PHP function base64_encode()
+     */
+    $config['session_secret'] = '';
 
-	/**
-	 * number of second that consider the session already expire
-	 */
-	$config['session_inactivity_time'] = 600; //in second
+    /**
+     * number of second that consider the session already expire
+     */
+    $config['session_inactivity_time'] = 600; //in second
 
-	/**
-	* Session cookie lifetime
-	*
-	* The cookie lifetime that the session will be dropped in seconds, leave 0 if you want
-	* the cookie expire after the browser is closed
-	*/
-	$config['session_cookie_lifetime'] = 0;
+    /**
+     * Session cookie lifetime
+     *
+     * The cookie lifetime that the session will be dropped in seconds, leave 0 if you want
+     * the cookie expire after the browser is closed
+     */
+    $config['session_cookie_lifetime'] = 0;
 	
-	/**
-	* Session cookie path
-	*
-	* The path to your website that the cookie is available "/" means all path is available
-	* example : /mysubdirectory => available in http://www.mysite.com/mysubdirectory
-	*/
-	$config['session_cookie_path'] = '/';
+    /**
+     * Session cookie path
+     *
+     * The path to your website that the cookie is available "/" means all path is available
+     * example : /mysubdirectory => available in http://www.mysite.com/mysubdirectory
+     */
+    $config['session_cookie_path'] = '/';
 	
-	/** 
-	* Session cookie domain
-	*
-	* The domain of your website that the cookie is available if you want the cookie is available
-	* in all your subdomain use this dot before the domain name for example ".mysite.com".
-	* leave empty if you want use the default configuration
-	*/
-	$config['session_cookie_domain'] = '';
+    /** 
+     * Session cookie domain
+     *
+     * The domain of your website that the cookie is available if you want the cookie is available
+     * in all your subdomain use this dot before the domain name for example ".mysite.com".
+     * leave empty if you want use the default configuration
+     */
+    $config['session_cookie_domain'] = '';
 	
-	/**
-	* Session cookie secure
-	* 
-	* If your website use SSL i.e https, you set "true" for this configuration, so the cookie
-	* is available only if the website use the secure connection else set this value to "false"
-	*/
-	$config['session_cookie_secure'] = false;
+    /**
+     * Session cookie secure
+     * 
+     * If your website use SSL i.e https, you set "true" for this configuration, so the cookie
+     * is available only if the website use the secure connection else set this value to "false"
+     */
+    $config['session_cookie_secure'] = false;
 	
 
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* CSRF configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/**
-	 * CSRF status
-	 *
-	 * if you would to use the CSRF (that we recommand you), set this key to true
-	 */
-	$config['csrf_enable'] = false;
+    /**
+     * CSRF status
+     *
+     * if you would to use the CSRF (that we recommand you), set this key to true
+     */
+    $config['csrf_enable'] = false;
 
-	/**
-	 * CSRF key
-	 *
-	 * the key used to store the csrf data
-	 */
-	$config['csrf_key'] = 'csrf_key';
+    /**
+     * CSRF key
+     *
+     * the key used to store the csrf data
+     */
+    $config['csrf_key'] = 'csrf_key';
 
-	/**
-	 * CSRF expire
-	 *
-	 * expire time in seconds of the CSRF data
-	 */
-	$config['csrf_expire'] = 120;
+    /**
+     * CSRF expire
+     *
+     * expire time in seconds of the CSRF data
+     */
+    $config['csrf_expire'] = 120;
 	
 	
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* Cache configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/**
-	 * Cache status
-	 *
-	 * If you would to use the cache functionnality set this value to true
-	 */
-	$config['cache_enable'] = false;
+    /**
+     * Cache status
+     *
+     * If you would to use the cache functionnality set this value to true
+     */
+    $config['cache_enable'] = false;
 	
-	/**
-	 * Cache Time To Live
-	 *
-	 * expire time in seconds of the cache data
-	 */
-	$config['cache_ttl'] = 120; //in second
+    /**
+     * Cache Time To Live
+     *
+     * expire time in seconds of the cache data
+     */
+    $config['cache_ttl'] = 120; //in second
 
-	/**
-	* Cache handler class
-	*
-	* The cache handler class inside (CORE_CLASSES_CACHE_PATH, LIBRARY_PATH) directories that implements 
-	* the interface "CacheInterface" that we will use to manage the cache.
-	* currently the possible values are "FileCache", "ApcCache".
-	*/
-	$config['cache_handler'] = 'FileCache';
+    /**
+     * Cache handler class
+     *
+     * The cache handler class inside (CORE_CLASSES_CACHE_PATH, LIBRARY_PATH) directories that implements 
+     * the interface "CacheInterface" that we will use to manage the cache.
+     * currently the possible values are "FileCache", "ApcCache".
+     */
+    $config['cache_handler'] = 'FileCache';
 	
 	
-	/*+---------------------------------------------------------------+
+    /*+---------------------------------------------------------------+
 	* White list IP access configuration section
 	+------------------------------------------------------------------+
 	*/
 	
-	/**
-	 * White list ip status
-	 *
-	 * if you would to use the white list ip access, set this key to true
-	 */
-	$config['white_list_ip_enable'] = false;
+    /**
+     * White list ip status
+     *
+     * if you would to use the white list ip access, set this key to true
+     */
+    $config['white_list_ip_enable'] = false;
 	
-	/**
-	 * White listed ip addresses
-	 *
-	 * add the allowed ip address list to access this application.
-	 * You can use the wildcard address
-	 * @example: '18.90.09.*', '10.*.*.*', '*'
-	 * 
-	 */
-	$config['white_list_ip_addresses'] = array('127.0.0.1', '::1');
+    /**
+     * White listed ip addresses
+     *
+     * add the allowed ip address list to access this application.
+     * You can use the wildcard address
+     * @example: '18.90.09.*', '10.*.*.*', '*'
+     * 
+     */
+    $config['white_list_ip_addresses'] = array('127.0.0.1', '::1');
 
-	
\ No newline at end of file
+    
\ No newline at end of file

core/classes/database/Database.php

Indentation +356 added lines, -356 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;
 
 
@@ -126,7 +126,7 @@ 
         //Set Log instance to use
         $this->setLoggerFromParamOrCreate(null);
 		
-    		//Set DatabaseQueryBuilder instance to use
+            //Set DatabaseQueryBuilder instance to use
         $this->setDependencyInstanceFromParamOrCreate('queryBuilder', null, 'DatabaseQueryBuilder', 'classes/database');
        
         //Set DatabaseQueryRunner instance to use
@@ -144,8 +144,8 @@ 
      * @return bool 
      */
     public function connect(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         try{
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
@@ -156,14 +156,14 @@ 
             $this->updateQueryBuilderAndRunnerProperties();
 
             return is_object($this->pdo);
-          }
-          catch (PDOException $e){
+            }
+            catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 
@@ -172,7 +172,7 @@ 
      * @return int
      */
     public function numRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
@@ -180,7 +180,7 @@ 
      * @return mixed
      */
     public function insertId(){
-      return $this->insertId;
+        return $this->insertId;
     }
 
 
@@ -191,13 +191,13 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function get($returnSQLQueryOrResultType = false){
-      $this->queryBuilder->limit(1);
-      $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+        $this->queryBuilder->limit(1);
+        $query = $this->getAll(true);
+        if ($returnSQLQueryOrResultType === true){
         return $query;
-      } else {
+        } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
-      }
+        }
     }
 
     /**
@@ -207,11 +207,11 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function getAll($returnSQLQueryOrResultType = false){
-	   $query = $this->queryBuilder->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
-      	return $query;
-      }
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
+        $query = $this->queryBuilder->getQuery();
+        if ($returnSQLQueryOrResultType === true){
+            return $query;
+        }
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
     }
 
     /**
@@ -221,19 +221,19 @@ 
      * @return mixed          the insert id of the new record or null
      */
     public function insert($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->insert($data, $escape)->getQuery();
-      $result = $this->query($query);
-      if ($result){
+        }
+        $query = $this->queryBuilder->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;
     }
 
     /**
@@ -243,13 +243,13 @@ 
      * @return mixed          the update status
      */
     public function update($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->update($data, $escape)->getQuery();
-      return $this->query($query);
+        }
+        $query = $this->queryBuilder->update($data, $escape)->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -257,8 +257,8 @@ 
      * @return mixed the delete status
      */
     public function delete(){
-		  $query = $this->queryBuilder->delete()->getQuery();
-    	return $this->query($query);
+            $query = $this->queryBuilder->delete()->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -267,17 +267,17 @@ 
      * @return object        the current Database instance
      */
     public function setCache($ttl = 0){
-      $this->cacheTtl = $ttl;
-      $this->temporaryCacheTtl = $ttl;
-      return $this;
+        $this->cacheTtl = $ttl;
+        $this->temporaryCacheTtl = $ttl;
+        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){
         $this->temporaryCacheTtl = $ttl;
         return $this;
     }
@@ -290,11 +290,11 @@ 
      * need escaped
      */
     public function escape($data, $escaped = true){
-      $data = trim($data);
-      if($escaped){
+        $data = trim($data);
+        if($escaped){
         return $this->pdo->quote($data);
-      }
-      return $data; 
+        }
+        return $data; 
     }
 
     /**
@@ -302,7 +302,7 @@ 
      * @return int
      */
     public function queryCount(){
-      return $this->queryCount;
+        return $this->queryCount;
     }
 
     /**
@@ -310,7 +310,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
 
     /**
@@ -318,7 +318,7 @@ 
      * @return string
      */
     public function getDatabaseName(){
-      return $this->databaseName;
+        return $this->databaseName;
     }
 
     /**
@@ -326,17 +326,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;
     }
 
 
@@ -345,44 +345,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;
     }
 
     /**
@@ -390,8 +390,8 @@ 
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
-      $this->queryBuilder = $queryBuilder;
-      return $this;
+        $this->queryBuilder = $queryBuilder;
+        return $this;
     }
     
     /**
@@ -399,7 +399,7 @@ 
      * @return object DatabaseQueryRunner
      */
     public function getQueryRunner(){
-      return $this->queryRunner;
+        return $this->queryRunner;
     }
 
     /**
@@ -407,8 +407,8 @@ 
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
-      $this->queryRunner = $queryRunner;
-      return $this;
+        $this->queryRunner = $queryRunner;
+        return $this;
     }
 
     /**
@@ -416,7 +416,7 @@ 
      * @return array
      */
     public function getData(){
-      return $this->data;
+        return $this->data;
     }
 
     /**
@@ -427,62 +427,62 @@ 
      * @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++;
         
         $queryResult = $this->queryRunner->setQuery($query)
-                                          ->setReturnType($returnAsList)
-                                          ->setReturnAsArray($returnAsArray)
-                                          ->execute();
+                                            ->setReturnType($returnAsList)
+                                            ->setReturnAsArray($returnAsArray)
+                                            ->execute();
 
         if (!is_object($queryResult)){
-          $this->result = false;
-          $this->numRows = 0;
-          return $this->result;
+            $this->result = false;
+            $this->numRows = 0;
+            return $this->result;
         }
         $this->result  = $queryResult->getResult();
         $this->numRows = $queryResult->getNumRows();
@@ -490,72 +490,72 @@ 
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
-          $this->result = $cacheContent;
-          $this->numRows = count($this->result);
-      }
-      return $this->result;
-    }
-
-   /**
-    * 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
-    * @param boolean $autoConnect whether to connect to database after set the configuration
-	  * @return object Database
-    */
+        } 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;
+    }
+
+    /**
+     * 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
+     * @param boolean $autoConnect whether to connect to database after set the configuration
+     * @return object Database
+     */
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
-      $db = array();
-      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
-          //here don't use require_once because somewhere user can create database instance directly
-          require CONFIG_PATH . 'database.php';
-      }
+        $db = array();
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
+            //here don't use require_once because somewhere user can create database instance directly
+            require CONFIG_PATH . 'database.php';
+        }
       
-      //merge with the parameter  
-      $db = array_merge($db, $overwriteConfig);
+        //merge with the parameter  
+        $db = array_merge($db, $overwriteConfig);
       
-      //get the default configuration
-      $config = $this->getDatabaseDefaultConfiguration();
+        //get the default configuration
+        $config = $this->getDatabaseDefaultConfiguration();
 		  
-    	$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']))
-												))
-							);
-  	  if($autoConnect){
-    		 //Now connect to the database
-    		 $this->connect();
-  		}
-		 return $this;
-    }
-
-    /**
-   * Return the database configuration
-   * @return array
-   */
+            $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']))
+                                                ))
+                            );
+        if($autoConnect){
+                //Now connect to the database
+                $this->connect();
+            }
+            return $this;
+    }
+
+    /**
+     * Return the database configuration
+     * @return array
+     */
     public  function getDatabaseConfiguration(){
-      return $this->config;
+        return $this->config;
     }
 
     /**
      * Close the connexion
      */
     public function close(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
     /**
@@ -563,16 +563,16 @@ 
      * @return array
      */
     protected function getDatabaseDefaultConfiguration(){
-      return array(
-              'driver' => '',
-              'username' => '',
-              'password' => '',
-              'database' => '',
-              'hostname' => 'localhost',
-              'charset' => 'utf8',
-              'collation' => 'utf8_general_ci',
-              'prefix' => '',
-              'port' => ''
+        return array(
+                'driver' => '',
+                'username' => '',
+                'password' => '',
+                'database' => '',
+                'hostname' => 'localhost',
+                'charset' => 'utf8',
+                'collation' => 'utf8_general_ci',
+                'prefix' => '',
+                'port' => ''
             );
     }
 
@@ -581,18 +581,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);
+        }
     }
 	
 
@@ -601,21 +601,21 @@ 
      * @return string|null the DSN string or null if can not find it
      */
     protected function getDsnValueFromConfig(){
-      $dsn = null;
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $dsn = null;
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         $driver = $config['driver'];
         $driverDsnMap = array(
-                              'mysql'  => $this->getDsnValueForDriver('mysql'),
-                              'pgsql'  => $this->getDsnValueForDriver('pgsql'),
-                              'sqlite' => $this->getDsnValueForDriver('sqlite'),
-                              'oracle' => $this->getDsnValueForDriver('oracle')
-                              );
+                                'mysql'  => $this->getDsnValueForDriver('mysql'),
+                                'pgsql'  => $this->getDsnValueForDriver('pgsql'),
+                                'sqlite' => $this->getDsnValueForDriver('sqlite'),
+                                'oracle' => $this->getDsnValueForDriver('oracle')
+                                );
         if (isset($driverDsnMap[$driver])){
-          $dsn = $driverDsnMap[$driver];
+            $dsn = $driverDsnMap[$driver];
         }
-      }    
-      return $dsn;
+        }    
+        return $dsn;
     }
 
     /**
@@ -624,32 +624,32 @@ 
      * @return string|null         the dsn name
      */
     protected function getDsnValueForDriver($driver){
-      $dsn = '';
-      $config = $this->getDatabaseConfiguration();
-      if (empty($config)){
+        $dsn = '';
+        $config = $this->getDatabaseConfiguration();
+        if (empty($config)){
         return null;
-      }
-      switch ($driver) {
+        }
+        switch ($driver) {
         case 'mysql':
         case 'pgsql':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = 'port=' . $config['port'] . ';';
-          }
-          $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
-          break;
+            }
+            $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
+            break;
         case 'sqlite':
           $dsn = 'sqlite:' . $config['database'];
-          break;
-          case 'oracle':
+            break;
+            case 'oracle':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = ':' . $config['port'];
-          }
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
-          break;
-      }
-      return $dsn;
+            }
+            $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
+            break;
+        }
+        return $dsn;
     }
 
     /**
@@ -661,11 +661,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);
     }
@@ -677,80 +677,80 @@ 
      * @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);
-    }
-
-     /**
-     * Set the dependencies instance using argument or create new instance if is null
-     * @param string $name this class property name.
-     * @param object $instance the instance. If is not null will use it
-     * otherwise will create new instance.
-     * @param string $loadClassName the name of class to load using class_loader function.
-     * @param string $loadClassPath the path of class to load using class_loader function.
-     *
-     * @return object this current instance
-     */
+        return md5($query . $returnAsList . $returnAsArray);
+    }
+
+        /**
+         * Set the dependencies instance using argument or create new instance if is null
+         * @param string $name this class property name.
+         * @param object $instance the instance. If is not null will use it
+         * otherwise will create new instance.
+         * @param string $loadClassName the name of class to load using class_loader function.
+         * @param string $loadClassPath the path of class to load using class_loader function.
+         *
+         * @return object this current instance
+         */
     protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
-      if ($instance !== null){
+        if ($instance !== null){
         $this->{$name} = $instance;
         return $this;
-      }
-      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
-      return $this;
+        }
+        $this->{$name} =& class_loader($loadClassName, $loadClassePath);
+        return $this;
     }
     
-	   /**
-     * Set the Log instance using argument or create new instance
-     * @param object $logger the Log instance if not null
-     *
-     * @return object this current instance
-     */
+        /**
+         * Set the Log instance using argument or create new instance
+         * @param object $logger the Log instance if not null
+         *
+         * @return object this current instance
+         */
     protected function setLoggerFromParamOrCreate(Log $logger = null){
-      $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
-      if ($logger === null){
+        $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
+        if ($logger === null){
         $this->logger->setLogger('Library::Database');
-      }
-      return $this;
+        }
+        return $this;
     }
 	
     /**
      * Reset the database class attributs to the initail values before each query.
      */
     private function reset(){
-	   //query builder reset
-      $this->queryBuilder->reset();
-      $this->numRows  = 0;
-      $this->insertId = null;
-      $this->query    = null;
-      $this->result   = array();
-      $this->data     = array();
+        //query builder reset
+        $this->queryBuilder->reset();
+        $this->numRows  = 0;
+        $this->insertId = null;
+        $this->query    = null;
+        $this->result   = array();
+        $this->data     = array();
     }
 
     /**
      * The class destructor
      */
     public function __destruct(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
 }

Spacing +93 added lines, -93 removed lines

@@ -23,98 +23,98 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class Database{
+  class Database {
 	
   	/**
   	 * The PDO instance
   	 * @var object
   	*/
-    private $pdo                 = null;
+    private $pdo = null;
     
   	/**
   	 * The database name used for the application
   	 * @var string
   	*/
-	  private $databaseName        = null;
+	  private $databaseName = null;
 	
   	/**
   	 * The number of rows returned by the last query
   	 * @var int
   	*/
-    private $numRows             = 0;
+    private $numRows = 0;
 	
   	/**
   	 * The last insert id for the primary key column that have auto increment or sequence
   	 * @var mixed
   	*/
-    private $insertId            = null;
+    private $insertId = null;
 	
   	/**
   	 * The full SQL query statment after build for each command
   	 * @var string
   	*/
-    private $query               = null;
+    private $query = null;
 	
   	/**
   	 * The result returned for the last query
   	 * @var mixed
   	*/
-    private $result              = array();
+    private $result = array();
 	
   	/**
   	 * The cache default time to live in second. 0 means no need to use the cache feature
   	 * @var int
   	*/
-  	private $cacheTtl             = 0;
+  	private $cacheTtl = 0;
 	
   	/**
   	 * The cache current time to live. 0 means no need to use the cache feature
   	 * @var int
   	*/
-    private $temporaryCacheTtl   = 0;
+    private $temporaryCacheTtl = 0;
 	
   	/**
   	 * The number of executed query for the current request
   	 * @var int
   	*/
-    private $queryCount          = 0;
+    private $queryCount = 0;
 	
   	/**
   	 * The default data to be used in the statments query INSERT, UPDATE
   	 * @var array
   	*/
-    private $data                = array();
+    private $data = array();
 	
   	/**
   	 * The database configuration
   	 * @var array
   	*/
-    private $config              = array();
+    private $config = array();
 	
   	/**
   	 * The logger instance
   	 * @var object
   	 */
-    private $logger              = null;
+    private $logger = null;
 
     /**
     * The cache instance
     * @var object
     */
-    private $cacheInstance       = null;
+    private $cacheInstance = null;
 
     
   	/**
     * The DatabaseQueryBuilder instance
     * @var object
     */
-    private $queryBuilder        = null;
+    private $queryBuilder = null;
     
     /**
     * The DatabaseQueryRunner instance
     * @var object
     */
-    private $queryRunner         = null;
+    private $queryRunner = null;
 
 
     /**
@@ -122,7 +122,7 @@ 
      * @param array $overwriteConfig the config to overwrite with the config set in database.php
      * @param boolean $autoConnect whether to connect to database automatically
      */
-    public function __construct($overwriteConfig = array(), $autoConnect = true){
+    public function __construct($overwriteConfig = array(), $autoConnect = true) {
         //Set Log instance to use
         $this->setLoggerFromParamOrCreate(null);
 		
@@ -143,10 +143,10 @@ 
      * This is used to connect to database
      * @return bool 
      */
-    public function connect(){
+    public function connect() {
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
-        try{
+      if (!empty($config)) {
+        try {
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
@@ -157,7 +157,7 @@ 
 
             return is_object($this->pdo);
           }
-          catch (PDOException $e){
+          catch (PDOException $e) {
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -171,7 +171,7 @@ 
      * Return the number of rows returned by the current query
      * @return int
      */
-    public function numRows(){
+    public function numRows() {
       return $this->numRows;
     }
 
@@ -179,7 +179,7 @@ 
      * Return the last insert id value
      * @return mixed
      */
-    public function insertId(){
+    public function insertId() {
       return $this->insertId;
     }
 
@@ -190,10 +190,10 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function get($returnSQLQueryOrResultType = false){
+    public function get($returnSQLQueryOrResultType = false) {
       $this->queryBuilder->limit(1);
       $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+      if ($returnSQLQueryOrResultType === true) {
         return $query;
       } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
@@ -206,9 +206,9 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function getAll($returnSQLQueryOrResultType = false){
+    public function getAll($returnSQLQueryOrResultType = false) {
 	   $query = $this->queryBuilder->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
+	   if ($returnSQLQueryOrResultType === true) {
       	return $query;
       }
       return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
@@ -220,18 +220,18 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the insert id of the new record or null
      */
-    public function insert($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+    public function insert($data = array(), $escape = true) {
+      if (empty($data) && !empty($this->data)) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
       }
       $query = $this->queryBuilder->insert($data, $escape)->getQuery();
       $result = $this->query($query);
-      if ($result){
+      if ($result) {
         $this->insertId = $this->pdo->lastInsertId();
 		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
-        return ! ($this->insertId) ? true : $this->insertId;
+        return !($this->insertId) ? true : $this->insertId;
       }
       return false;
     }
@@ -242,8 +242,8 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the update status
      */
-    public function update($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+    public function update($data = array(), $escape = true) {
+      if (empty($data) && !empty($this->data)) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
@@ -256,7 +256,7 @@ 
      * Delete the record in database
      * @return mixed the delete status
      */
-    public function delete(){
+    public function delete() {
 		  $query = $this->queryBuilder->delete()->getQuery();
     	return $this->query($query);
     }
@@ -266,7 +266,7 @@ 
      * @param integer $ttl the cache time to live in second
      * @return object        the current Database instance
      */
-    public function setCache($ttl = 0){
+    public function setCache($ttl = 0) {
       $this->cacheTtl = $ttl;
       $this->temporaryCacheTtl = $ttl;
       return $this;
@@ -277,7 +277,7 @@ 
 	 * @param  integer $ttl the cache time to live in second
 	 * @return object        the current Database instance
 	 */
-  	public function cached($ttl = 0){
+  	public function cached($ttl = 0) {
         $this->temporaryCacheTtl = $ttl;
         return $this;
     }
@@ -289,9 +289,9 @@ 
      * @return mixed       the data after escaped or the same data if no
      * need escaped
      */
-    public function escape($data, $escaped = true){
+    public function escape($data, $escaped = true) {
       $data = trim($data);
-      if($escaped){
+      if ($escaped) {
         return $this->pdo->quote($data);
       }
       return $data; 
@@ -301,7 +301,7 @@ 
      * Return the number query executed count for the current request
      * @return int
      */
-    public function queryCount(){
+    public function queryCount() {
       return $this->queryCount;
     }
 
@@ -309,7 +309,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
       return $this->query;
     }
 
@@ -317,7 +317,7 @@ 
      * Return the application database name
      * @return string
      */
-    public function getDatabaseName(){
+    public function getDatabaseName() {
       return $this->databaseName;
     }
 
@@ -325,7 +325,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -334,7 +334,7 @@ 
      * @param object $pdo the pdo object
 	 * @return object Database
      */
-    public function setPdo(PDO $pdo){
+    public function setPdo(PDO $pdo) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -344,7 +344,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -353,7 +353,7 @@ 
      * @param Log $logger the log object
 	 * @return object Database
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -362,7 +362,7 @@ 
      * Return the cache instance
      * @return CacheInterface
      */
-    public function getCacheInstance(){
+    public function getCacheInstance() {
       return $this->cacheInstance;
     }
 
@@ -371,7 +371,7 @@ 
      * @param CacheInterface $cache the cache object
 	 * @return object Database
      */
-    public function setCacheInstance($cache){
+    public function setCacheInstance($cache) {
       $this->cacheInstance = $cache;
       return $this;
     }
@@ -381,7 +381,7 @@ 
      * Return the DatabaseQueryBuilder instance
      * @return object DatabaseQueryBuilder
      */
-    public function getQueryBuilder(){
+    public function getQueryBuilder() {
       return $this->queryBuilder;
     }
 
@@ -389,7 +389,7 @@ 
      * Set the DatabaseQueryBuilder instance
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
-    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
+    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder) {
       $this->queryBuilder = $queryBuilder;
       return $this;
     }
@@ -398,7 +398,7 @@ 
      * Return the DatabaseQueryRunner instance
      * @return object DatabaseQueryRunner
      */
-    public function getQueryRunner(){
+    public function getQueryRunner() {
       return $this->queryRunner;
     }
 
@@ -406,7 +406,7 @@ 
      * Set the DatabaseQueryRunner instance
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
-    public function setQueryRunner(DatabaseQueryRunner $queryRunner){
+    public function setQueryRunner(DatabaseQueryRunner $queryRunner) {
       $this->queryRunner = $queryRunner;
       return $this;
     }
@@ -415,7 +415,7 @@ 
      * Return the data to be used for insert, update, etc.
      * @return array
      */
-    public function getData(){
+    public function getData() {
       return $this->data;
     }
 
@@ -426,9 +426,9 @@ 
      * @param boolean $escape whether to escape or not the $value
      * @return object        the current Database instance
      */
-    public function setData($key, $value = null, $escape = true){
-  	  if (is_array($key)){
-    		foreach($key as $k => $v){
+    public function setData($key, $value = null, $escape = true) {
+  	  if (is_array($key)) {
+    		foreach ($key as $k => $v) {
     			$this->setData($k, $v, $escape);
     		}	
   	  } else {
@@ -444,7 +444,7 @@ 
      * @param  boolean $returnAsArray return the result as array or not
      * @return mixed         the query result
      */
-    public function query($query, $returnAsList = true, $returnAsArray = false){
+    public function query($query, $returnAsList = true, $returnAsArray = false) {
       $this->reset();
       $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
       //If is the SELECT query
@@ -465,12 +465,12 @@ 
       //if can use cache feature for this query
       $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
+      if ($dbCacheStatus && $isSqlSELECTQuery) {
           $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
           $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
       }
       
-      if (!$cacheContent){
+      if (!$cacheContent) {
   	   	//count the number of query execution to server
         $this->queryCount++;
         
@@ -479,19 +479,19 @@ 
                                           ->setReturnAsArray($returnAsArray)
                                           ->execute();
 
-        if (!is_object($queryResult)){
+        if (!is_object($queryResult)) {
           $this->result = false;
           $this->numRows = 0;
           return $this->result;
         }
         $this->result  = $queryResult->getResult();
         $this->numRows = $queryResult->getNumRows();
-        if ($isSqlSELECTQuery && $dbCacheStatus){
+        if ($isSqlSELECTQuery && $dbCacheStatus) {
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+      } else if ($isSqlSELECTQuery) {
+          $this->logger->info('The result for query [' . $this->query . '] already cached use it');
           $this->result = $cacheContent;
           $this->numRows = count($this->result);
       }
@@ -505,9 +505,9 @@ 
     * @param boolean $autoConnect whether to connect to database after set the configuration
 	  * @return object Database
     */
-    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
+    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false) {
       $db = array();
-      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
+      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')) {
           //here don't use require_once because somewhere user can create database instance directly
           require CONFIG_PATH . 'database.php';
       }
@@ -522,7 +522,7 @@ 
     	//determine the port using the hostname like localhost:3307
       //hostname will be "localhost", and port "3307"
       $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
+  	  if (count($p) >= 2) {
   		  $config['hostname'] = $p[0];
   		  $config['port'] = $p[1];
   		}
@@ -536,7 +536,7 @@ 
 															array('password' => string_hidden($this->config['password']))
 												))
 							);
-  	  if($autoConnect){
+  	  if ($autoConnect) {
     		 //Now connect to the database
     		 $this->connect();
   		}
@@ -547,14 +547,14 @@ 
    * Return the database configuration
    * @return array
    */
-    public  function getDatabaseConfiguration(){
+    public  function getDatabaseConfiguration() {
       return $this->config;
     }
 
     /**
      * Close the connexion
      */
-    public function close(){
+    public function close() {
       $this->pdo = null;
     }
 
@@ -562,7 +562,7 @@ 
      * Return the database default configuration
      * @return array
      */
-    protected function getDatabaseDefaultConfiguration(){
+    protected function getDatabaseDefaultConfiguration() {
       return array(
               'driver' => '',
               'username' => '',
@@ -580,16 +580,16 @@ 
      * Update the DatabaseQueryBuilder and DatabaseQueryRunner properties
      * @return void
      */
-    protected function updateQueryBuilderAndRunnerProperties(){
+    protected function updateQueryBuilderAndRunnerProperties() {
        //update queryBuilder with some properties needed
-     if (is_object($this->queryBuilder)){
+     if (is_object($this->queryBuilder)) {
         $this->queryBuilder->setDriver($this->config['driver'])
                            ->setPrefix($this->config['prefix'])
                            ->setPdo($this->pdo);
      }
 
       //update queryRunner with some properties needed
-     if (is_object($this->queryRunner)){
+     if (is_object($this->queryRunner)) {
         $this->queryRunner->setDriver($this->config['driver'])
                           ->setPdo($this->pdo);
      }
@@ -600,10 +600,10 @@ 
      * This method is used to get the PDO DSN string using the configured driver
      * @return string|null the DSN string or null if can not find it
      */
-    protected function getDsnValueFromConfig(){
+    protected function getDsnValueFromConfig() {
       $dsn = null;
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+      if (!empty($config)) {
         $driver = $config['driver'];
         $driverDsnMap = array(
                               'mysql'  => $this->getDsnValueForDriver('mysql'),
@@ -611,7 +611,7 @@ 
                               'sqlite' => $this->getDsnValueForDriver('sqlite'),
                               'oracle' => $this->getDsnValueForDriver('oracle')
                               );
-        if (isset($driverDsnMap[$driver])){
+        if (isset($driverDsnMap[$driver])) {
           $dsn = $driverDsnMap[$driver];
         }
       }    
@@ -623,17 +623,17 @@ 
      * @param  string $driver the driver name
      * @return string|null         the dsn name
      */
-    protected function getDsnValueForDriver($driver){
+    protected function getDsnValueForDriver($driver) {
       $dsn = '';
       $config = $this->getDatabaseConfiguration();
-      if (empty($config)){
+      if (empty($config)) {
         return null;
       }
       switch ($driver) {
         case 'mysql':
         case 'pgsql':
           $port = '';
-          if (! empty($config['port'])) {
+          if (!empty($config['port'])) {
             $port = 'port=' . $config['port'] . ';';
           }
           $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
@@ -643,10 +643,10 @@ 
           break;
           case 'oracle':
           $port = '';
-          if (! empty($config['port'])) {
+          if (!empty($config['port'])) {
             $port = ':' . $config['port'];
           }
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
+          $dsn = 'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
           break;
       }
       return $dsn;
@@ -658,9 +658,9 @@ 
      *      
      * @return mixed
      */
-    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray) {
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
-        if (! is_object($this->cacheInstance)){
+        if (!is_object($this->cacheInstance)) {
     			//can not call method with reference in argument
     			//like $this->setCacheInstance(& get_instance()->cache);
     			//use temporary variable
@@ -677,9 +677,9 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
-        $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
-        if (! is_object($this->cacheInstance)){
+     protected function setCacheContentForQuery($query, $key, $result, $expire) {
+        $this->logger->info('Save the result for query [' . $query . '] into cache for future use');
+        if (!is_object($this->cacheInstance)) {
   				//can not call method with reference in argument
   				//like $this->setCacheInstance(& get_instance()->cache);
   				//use temporary variable
@@ -696,7 +696,7 @@ 
      * 
      *  @return string
      */
-    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray) {
       return md5($query . $returnAsList . $returnAsArray);
     }
 
@@ -710,12 +710,12 @@ 
      *
      * @return object this current instance
      */
-    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
-      if ($instance !== null){
+    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes') {
+      if ($instance !== null) {
         $this->{$name} = $instance;
         return $this;
       }
-      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
+      $this->{$name} = & class_loader($loadClassName, $loadClassePath);
       return $this;
     }
     
@@ -725,9 +725,9 @@ 
      *
      * @return object this current instance
      */
-    protected function setLoggerFromParamOrCreate(Log $logger = null){
+    protected function setLoggerFromParamOrCreate(Log $logger = null) {
       $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
-      if ($logger === null){
+      if ($logger === null) {
         $this->logger->setLogger('Library::Database');
       }
       return $this;
@@ -736,7 +736,7 @@ 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
-    private function reset(){
+    private function reset() {
 	   //query builder reset
       $this->queryBuilder->reset();
       $this->numRows  = 0;
@@ -749,7 +749,7 @@ 
     /**
      * The class destructor
      */
-    public function __destruct(){
+    public function __destruct() {
       $this->pdo = null;
     }
 

Braces +1 added lines, -2 removed lines

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

core/libraries/Pagination.php

Indentation +42 added lines, -42 removed lines

@@ -1,32 +1,32 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
     class Pagination{
         
-		/**
+        /**
          * The list of loaded config
          * @var array
          */
@@ -49,13 +49,13 @@ 
                 if (empty($config) || ! is_array($config)){
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
                 }
-				else{
-					$config = array_merge($config, $overwriteConfig);
-					$this->config = $config;
+                else{
+                    $config = array_merge($config, $overwriteConfig);
+                    $this->config = $config;
                     //put it gobally
-					Config::setAll($config);
-					unset($config);
-				}
+                    Config::setAll($config);
+                    unset($config);
+                }
             }
             else{
                 show_error('Unable to find the pagination configuration file');
@@ -92,11 +92,11 @@ 
             return $this->paginationQueryString;
         }
 
-         /**
-         * Set the value of the pagination query string
-         * @param string $paginationQueryString the new value
-         * @return object
-         */
+            /**
+             * Set the value of the pagination query string
+             * @param string $paginationQueryString the new value
+             * @return object
+             */
         public function setPaginationQueryString($paginationQueryString){
             $this->paginationQueryString = $paginationQueryString;
             return $this;
@@ -113,7 +113,7 @@ 
             $queryString = Url::queryString();
             $currentUrl = Url::current();
             $query = '';
-             if ($queryString == ''){
+                if ($queryString == ''){
                 $query = '?' . $pageQueryName . '=';
             }
             else{
@@ -146,7 +146,7 @@ 
          */
         public function getLink($totalRows, $currentPageNumber){
             $numberOfLink = $this->config['nb_link'];
-			$numberOfRowPerPage = $this->config['pagination_per_page'];
+            $numberOfRowPerPage = $this->config['pagination_per_page'];
             if (empty($this->paginationQueryString)){
                 //determine the pagination query string value
                 $this->determinePaginationQueryStringValue();
@@ -159,8 +159,8 @@ 
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
 			
             if ($currentPageNumber <= 0){
-				$currentPageNumber = 1;
-			}
+                $currentPageNumber = 1;
+            }
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
                 return $navbar;
             }
@@ -185,7 +185,7 @@ 
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
             }
             else if ($currentPageNumber == $numberOfPage){
-               $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
+                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
             return $navbar;
@@ -253,8 +253,8 @@ 
                 }
             }
             $navbar .= $this->config['next_open']
-                         . '<a href="' . $query . ($currentPageNumber + 1) . '">' 
-                         . $this->config['next_text'] . '</a>' . $this->config['next_close'];
+                            . '<a href="' . $query . ($currentPageNumber + 1) . '">' 
+                            . $this->config['next_text'] . '</a>' . $this->config['next_close'];
             return $navbar;
         }
 

Spacing +46 added lines, -46 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-    class Pagination{
+    class Pagination {
         
 		/**
          * The list of loaded config
@@ -42,14 +42,14 @@ 
          * Create an instance of pagination
          * @param array $overwriteConfig the list of configuration to overwrite the defined configuration in config_pagination.php
          */
-        public function __construct(array $overwriteConfig = array()){
-            if (file_exists(CONFIG_PATH . 'config_pagination.php')){
+        public function __construct(array $overwriteConfig = array()) {
+            if (file_exists(CONFIG_PATH . 'config_pagination.php')) {
                 $config = array();
                 require_once CONFIG_PATH . 'config_pagination.php';
-                if (empty($config) || ! is_array($config)){
+                if (empty($config) || !is_array($config)) {
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
                 }
-				else{
+				else {
 					$config = array_merge($config, $overwriteConfig);
 					$this->config = $config;
                     //put it gobally
@@ -57,7 +57,7 @@ 
 					unset($config);
 				}
             }
-            else{
+            else {
                 show_error('Unable to find the pagination configuration file');
             }
         }
@@ -68,8 +68,8 @@ 
          * config_pagination.php
          * @param array $config the configuration to overwrite
          */
-        public function setConfig(array $config = array()){
-            if (! empty($config)){
+        public function setConfig(array $config = array()) {
+            if (!empty($config)) {
                 $this->config = array_merge($this->config, $config);
                 Config::setAll($config);
             }
@@ -80,7 +80,7 @@ 
          * 
          * @return array
          */
-        public function getConfig(){
+        public function getConfig() {
             return $this->config;
         }
 
@@ -88,7 +88,7 @@ 
          * Return the value of the pagination query string
          * @return string
          */
-        public function getPaginationQueryString(){
+        public function getPaginationQueryString() {
             return $this->paginationQueryString;
         }
 
@@ -97,7 +97,7 @@ 
          * @param string $paginationQueryString the new value
          * @return object
          */
-        public function setPaginationQueryString($paginationQueryString){
+        public function setPaginationQueryString($paginationQueryString) {
             $this->paginationQueryString = $paginationQueryString;
             return $this;
         }
@@ -108,25 +108,25 @@ 
          * 
          * @return object
          */
-        public function determinePaginationQueryStringValue(){
+        public function determinePaginationQueryStringValue() {
             $pageQueryName = $this->config['page_query_string_name'];
             $queryString = Url::queryString();
             $currentUrl = Url::current();
             $query = '';
-             if ($queryString == ''){
+             if ($queryString == '') {
                 $query = '?' . $pageQueryName . '=';
             }
-            else{
+            else {
                 $tab = explode($pageQueryName . '=', $queryString);
                 $nb = count($tab);
-                if ($nb == 1){
+                if ($nb == 1) {
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
                 }
-                else{
-                    if ($tab[0] == ''){
+                else {
+                    if ($tab[0] == '') {
                         $query = '?' . $pageQueryName . '=';
                     }
-                    else{
+                    else {
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
                     }
                 }
@@ -144,10 +144,10 @@ 
          * 
          * @return string the pagination link
          */
-        public function getLink($totalRows, $currentPageNumber){
+        public function getLink($totalRows, $currentPageNumber) {
             $numberOfLink = $this->config['nb_link'];
 			$numberOfRowPerPage = $this->config['pagination_per_page'];
-            if (empty($this->paginationQueryString)){
+            if (empty($this->paginationQueryString)) {
                 //determine the pagination query string value
                 $this->determinePaginationQueryStringValue();
             }
@@ -158,7 +158,7 @@ 
             $numberOfLink = (int) $numberOfLink;
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
 			
-            if ($currentPageNumber <= 0){
+            if ($currentPageNumber <= 0) {
 				$currentPageNumber = 1;
 			}
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
@@ -173,18 +173,18 @@ 
          * @param  int $numberOfPage      the total number of page
          * @return string
          */
-        protected function buildPaginationNavbar($currentPageNumber, $numberOfPage){
+        protected function buildPaginationNavbar($currentPageNumber, $numberOfPage) {
             $values = $this->getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage);
             $begin = $values['begin'];
             $end   = $values['end'];
             $navbar = null;
-            if ($currentPageNumber == 1){
+            if ($currentPageNumber == 1) {
                 $navbar .= $this->buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber);
             }
-            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
+            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage) {
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
             }
-            else if ($currentPageNumber == $numberOfPage){
+            else if ($currentPageNumber == $numberOfPage) {
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -197,32 +197,32 @@ 
          * @param  int $numberOfPage      the total number of page
          * @return array                    the begin and end number
          */
-        protected function getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage){
+        protected function getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage) {
             $start = null;
             $begin = null;
             $end   = null;
             $numberOfLink = $this->config['nb_link'];
-            if ($numberOfLink % 2 == 0){
+            if ($numberOfLink % 2 == 0) {
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
                 $end   = $currentPageNumber + ($numberOfLink / 2);
             }
-            else{
+            else {
                 $start = $currentPageNumber - floor($numberOfLink / 2);
                 $end   = $currentPageNumber + floor($numberOfLink / 2);
             }
-            if ($start <= 1){
+            if ($start <= 1) {
                 $begin = 1;
                 $end   = $numberOfLink;
             }
-            else if ($start > 1 && $end < $numberOfPage){
+            else if ($start > 1 && $end < $numberOfPage) {
                 $begin = $start;
                 $end = $end;
             }
-            else{
+            else {
                 $begin = ($numberOfPage - $numberOfLink) + 1;
                 $end   = $numberOfPage;
             }
-            if ($numberOfPage <= $numberOfLink){
+            if ($numberOfPage <= $numberOfLink) {
                 $begin = 1;
                 $end = $numberOfPage;
             }
@@ -239,14 +239,14 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
                 }
-                else{
+                else {
                     $navbar .= $this->config['digit_open'] 
                             . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
                             . $this->config['digit_close'];
@@ -265,23 +265,23 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
             $navbar .= $this->config['previous_open'] 
                             . '<a href="' . $query . ($currentPageNumber - 1) . '">' 
                             . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
                 }
-                else{
+                else {
                     $navbar .= $this->config['digit_open'] 
-                                    . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' 
+                                    . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
                                     . $this->config['digit_close'];
                 }
             }
-            $navbar .= $this->config['next_open']."<a href='$query".($currentPageNumber + 1)."'>".$this->config['next_text']."</a>".$this->config['next_close'];
+            $navbar .= $this->config['next_open'] . "<a href='$query" . ($currentPageNumber + 1) . "'>" . $this->config['next_text'] . "</a>" . $this->config['next_close'];
             return $navbar;
         }
 
@@ -292,19 +292,19 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
             $navbar .= $this->config['previous_open'] 
                         . '<a href="' . $query . ($currentPageNumber - 1) . '">' 
                         . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] 
                                 . $currentPageNumber 
                                 . $this->config['active_link_close'];
                 }
-                else{
+                else {
                     $navbar .= $this->config['digit_open'] 
                                 . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
                                 . $this->config['digit_close'];

Braces +13 added lines, -26 removed lines

@@ -48,16 +48,14 @@ 
                 require_once CONFIG_PATH . 'config_pagination.php';
                 if (empty($config) || ! is_array($config)){
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
-                }
-				else{
+                } else{
 					$config = array_merge($config, $overwriteConfig);
 					$this->config = $config;
                     //put it gobally
 					Config::setAll($config);
 					unset($config);
 				}
-            }
-            else{
+            } else{
                 show_error('Unable to find the pagination configuration file');
             }
         }
@@ -115,18 +113,15 @@ 
             $query = '';
              if ($queryString == ''){
                 $query = '?' . $pageQueryName . '=';
-            }
-            else{
+            } else{
                 $tab = explode($pageQueryName . '=', $queryString);
                 $nb = count($tab);
                 if ($nb == 1){
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
-                }
-                else{
+                } else{
                     if ($tab[0] == ''){
                         $query = '?' . $pageQueryName . '=';
-                    }
-                    else{
+                    } else{
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
                     }
                 }
@@ -180,11 +175,9 @@ 
             $navbar = null;
             if ($currentPageNumber == 1){
                 $navbar .= $this->buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber);
-            }
-            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
+            } else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
-            }
-            else if ($currentPageNumber == $numberOfPage){
+            } else if ($currentPageNumber == $numberOfPage){
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -205,20 +198,17 @@ 
             if ($numberOfLink % 2 == 0){
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
                 $end   = $currentPageNumber + ($numberOfLink / 2);
-            }
-            else{
+            } else{
                 $start = $currentPageNumber - floor($numberOfLink / 2);
                 $end   = $currentPageNumber + floor($numberOfLink / 2);
             }
             if ($start <= 1){
                 $begin = 1;
                 $end   = $numberOfLink;
-            }
-            else if ($start > 1 && $end < $numberOfPage){
+            } else if ($start > 1 && $end < $numberOfPage){
                 $begin = $start;
                 $end = $end;
-            }
-            else{
+            } else{
                 $begin = ($numberOfPage - $numberOfLink) + 1;
                 $end   = $numberOfPage;
             }
@@ -245,8 +235,7 @@ 
             for($i = $begin; $i <= $end; $i++){
                 if ($i == $currentPageNumber){
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] 
                             . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
                             . $this->config['digit_close'];
@@ -274,8 +263,7 @@ 
             for($i = $begin; $i <= $end; $i++){
                 if ($i == $currentPageNumber){
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] 
                                     . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' 
                                     . $this->config['digit_close'];
@@ -303,8 +291,7 @@ 
                     $navbar .= $this->config['active_link_open'] 
                                 . $currentPageNumber 
                                 . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] 
                                 . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
                                 . $this->config['digit_close'];

core/classes/Module.php

Indentation +284 added lines, -284 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
      * TNH Framework
      *
      * A simple PHP framework using HMVC architecture
@@ -22,308 +22,308 @@ 
      * You should have received a copy of the GNU General Public License
      * along with this program; if not, write to the Free Software
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-    */
+     */
    
-	class Module{
+    class Module{
 		
-		/**
-		 * list of loaded module
-		 * @var array
-		 */
-		private static $list = array();
+        /**
+         * list of loaded module
+         * @var array
+         */
+        private static $list = array();
 
-		/**
-		 * logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * 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){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Module');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Module');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * Initialise the module list by scanning the directory MODULE_PATH
-		 */
-		public function init(){
-			$logger = self::getLogger();
-			$logger->debug('Check if the application contains the modules ...');
-			$moduleDir = opendir(MODULE_PATH);
-			if(is_resource($moduleDir)){
-				while(($module = readdir($moduleDir)) !== false){
-					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
-						self::$list[] = $module;
-					}
-					else{
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
-					}
-				}
-				closedir($moduleDir);
-			}
-			ksort(self::$list);
+        /**
+         * Initialise the module list by scanning the directory MODULE_PATH
+         */
+        public function init(){
+            $logger = self::getLogger();
+            $logger->debug('Check if the application contains the modules ...');
+            $moduleDir = opendir(MODULE_PATH);
+            if(is_resource($moduleDir)){
+                while(($module = readdir($moduleDir)) !== false){
+                    if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
+                        self::$list[] = $module;
+                    }
+                    else{
+                        $logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
+                    }
+                }
+                closedir($moduleDir);
+            }
+            ksort(self::$list);
 			
-			if(self::hasModule()){
-				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
-			}
-		}
+            if(self::hasModule()){
+                $logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
+            }
+        }
 		
-		/**
-		 * Get the list of the custom autoload configuration from module if exists
-		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
-		 */
-		public static function getModulesAutoloadConfig(){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$autoloads = array();
-			$autoloads['libraries'] = array();
-			$autoloads['config']    = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			$autoloads['languages'] = array();
+        /**
+         * Get the list of the custom autoload configuration from module if exists
+         * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
+         */
+        public static function getModulesAutoloadConfig(){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $autoloads = array();
+            $autoloads['libraries'] = array();
+            $autoloads['config']    = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            $autoloads['languages'] = array();
 			
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
-				if(file_exists($file)){
-					$autoload = array();
-					require_once $file;
-					if(! empty($autoload) && is_array($autoload)){
-						$autoloads = array_merge_recursive($autoloads, $autoload);
-						unset($autoload);
-					}
-				}
-			}
-			return $autoloads;
-		}
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
+                if(file_exists($file)){
+                    $autoload = array();
+                    require_once $file;
+                    if(! empty($autoload) && is_array($autoload)){
+                        $autoloads = array_merge_recursive($autoloads, $autoload);
+                        unset($autoload);
+                    }
+                }
+            }
+            return $autoloads;
+        }
 
-		/**
-		 * Get the list of the custom routes configuration from module if exists
-		 * @return array|boolean the routes list or false if no module contains the routes configuration
-		 */
-		public static function getModulesRoutes(){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$routes = array();
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
-				if(file_exists($file)){
-					$route = array();
-					require_once $file;
-					if(! empty($route) && is_array($route)){
-						$routes = array_merge($routes, $route);
-						unset($route);
-					}
-				}
-			}
-			return $routes;
-		}
+        /**
+         * Get the list of the custom routes configuration from module if exists
+         * @return array|boolean the routes list or false if no module contains the routes configuration
+         */
+        public static function getModulesRoutes(){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $routes = array();
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
+                if(file_exists($file)){
+                    $route = array();
+                    require_once $file;
+                    if(! empty($route) && is_array($route)){
+                        $routes = array_merge($routes, $route);
+                        unset($route);
+                    }
+                }
+            }
+            return $routes;
+        }
 
 
-		/**
-		 * Check if in module list can have this controller
-		 * @param  string $class the controller class
-		 * @param  string $module  the module name
-		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
-		 */
-		public static function findControllerFullPath($class, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$class = str_ireplace('.php', '', $class);
-			$class = ucfirst($class);
-			$classFile = $class.'.php';
-			$logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
-			if(file_exists($filePath)){
-				$logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this controller
+         * @param  string $class the controller class
+         * @param  string $module  the module name
+         * @return boolean|string  false or null if no module have this controller, path the full path of the controller
+         */
+        public static function findControllerFullPath($class, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $class = str_ireplace('.php', '', $class);
+            $class = ucfirst($class);
+            $classFile = $class.'.php';
+            $logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
+            if(file_exists($filePath)){
+                $logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 
-		/**
-		 * Check if in module list can have this model
-		 * @param  string $class the model class
-		 * @param string $module the module name
-		 * @return boolean|string  false or null if no module have this model, return the full path of this model
-		 */
-		public static function findModelFullPath($class, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$class = str_ireplace('.php', '', $class);
-			$class = ucfirst($class);
-			$classFile = $class.'.php';
-			$logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
-			if(file_exists($filePath)){
-				$logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this model
+         * @param  string $class the model class
+         * @param string $module the module name
+         * @return boolean|string  false or null if no module have this model, return the full path of this model
+         */
+        public static function findModelFullPath($class, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $class = str_ireplace('.php', '', $class);
+            $class = ucfirst($class);
+            $classFile = $class.'.php';
+            $logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
+            if(file_exists($filePath)){
+                $logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 		
-		/**
-		 * Check if in module list can have this config
-		 * @param  string $configuration the config name
-		 * @param string $module the module name
-		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
-		 */
-		public static function findConfigFullPath($configuration, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$configuration = str_ireplace('.php', '', $configuration);
-			$file = $configuration.'.php';
-			$logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this config
+         * @param  string $configuration the config name
+         * @param string $module the module name
+         * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
+         */
+        public static function findConfigFullPath($configuration, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $configuration = str_ireplace('.php', '', $configuration);
+            $file = $configuration.'.php';
+            $logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
+            if(file_exists($filePath)){
+                $logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 
-		/**
-		 * Check if in module list can have this helper
-		 * @param  string $helper the helper name
-		 * @param string $module the module name
-		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
-		 */
-		public static function findFunctionFullPath($helper, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$helper = str_ireplace('.php', '', $helper);
-			$helper = str_ireplace('function_', '', $helper);
-			$file = 'function_'.$helper.'.php';
-			$logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
-			return false;
+        /**
+         * Check if in module list can have this helper
+         * @param  string $helper the helper name
+         * @param string $module the module name
+         * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
+         */
+        public static function findFunctionFullPath($helper, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $helper = str_ireplace('.php', '', $helper);
+            $helper = str_ireplace('function_', '', $helper);
+            $file = 'function_'.$helper.'.php';
+            $logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
+            if(file_exists($filePath)){
+                $logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
+            return false;
 			
-		}
+        }
 
 
-		/**
-		 * Check if in module list can have this library
-		 * @param  string $class the library name
-		 * @param string $module the module name
-		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
-		 */
-		public static function findLibraryFullPath($class, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$class = str_ireplace('.php', '', $class);
-			$file = $class.'.php';
-			$logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this library
+         * @param  string $class the library name
+         * @param string $module the module name
+         * @return boolean|string  false or null if no module have this library,  return the full path of this library
+         */
+        public static function findLibraryFullPath($class, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $class = str_ireplace('.php', '', $class);
+            $file = $class.'.php';
+            $logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
+            if(file_exists($filePath)){
+                $logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 
 
-		/**
-		 * Check if in module list can have this view
-		 * @param  string $view the view path
-		 * @param string $module the module name to check
-		 * @return boolean|string  false or null if no module have this view, path the full path of the view
-		 */
-		public static function findViewFullPath($view, $module = null){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$view = str_ireplace('.php', '', $view);
-			$view = trim($view, '/\\');
-			$view = str_ireplace('/', DS, $view);
-			$viewFile = $view . '.php';
-			$logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
-			if(file_exists($filePath)){
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this view
+         * @param  string $view the view path
+         * @param string $module the module name to check
+         * @return boolean|string  false or null if no module have this view, path the full path of the view
+         */
+        public static function findViewFullPath($view, $module = null){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $view = str_ireplace('.php', '', $view);
+            $view = trim($view, '/\\');
+            $view = str_ireplace('/', DS, $view);
+            $viewFile = $view . '.php';
+            $logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
+            if(file_exists($filePath)){
+                $logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 
-		/**
-		 * Check if in module list can have this language
-		 * @param  string $language the language name
-		 * @param string $module the module name
-		 * @param string $appLang the application language like 'en', 'fr'
-		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
-		 */
-		public static function findLanguageFullPath($language, $module = null, $appLang){
-			$logger = self::getLogger();
-			if(! self::hasModule()){
-				$logger->info('No module was loaded skiping.');
-				return false;
-			}
-			$language = str_ireplace('.php', '', $language);
-			$language = str_ireplace('lang_', '', $language);
-			$file = 'lang_'.$language.'.php';
-			$logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
-			$filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
-				return $filePath;
-			}
-			$logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
-			return false;
-		}
+        /**
+         * Check if in module list can have this language
+         * @param  string $language the language name
+         * @param string $module the module name
+         * @param string $appLang the application language like 'en', 'fr'
+         * @return boolean|string  false or null if no module have this language,  return the full path of this language
+         */
+        public static function findLanguageFullPath($language, $module = null, $appLang){
+            $logger = self::getLogger();
+            if(! self::hasModule()){
+                $logger->info('No module was loaded skiping.');
+                return false;
+            }
+            $language = str_ireplace('.php', '', $language);
+            $language = str_ireplace('lang_', '', $language);
+            $file = 'lang_'.$language.'.php';
+            $logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
+            $filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
+            if(file_exists($filePath)){
+                $logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
+            return false;
+        }
 
-		/**
-		 * Get the list of module loaded
-		 * @return array the module list
-		 */
-		public static function getModuleList(){
-			return self::$list;
-		}
+        /**
+         * Get the list of module loaded
+         * @return array the module list
+         */
+        public static function getModuleList(){
+            return self::$list;
+        }
 
-		/**
-		 * Check if the application has an module
-		 * @return boolean
-		 */
-		public static function hasModule(){
-			return !empty(self::$list);
-		}
+        /**
+         * Check if the application has an module
+         * @return boolean
+         */
+        public static function hasModule(){
+            return !empty(self::$list);
+        }
 
-	}
+    }

Spacing +69 added lines, -69 removed lines

@@ -24,7 +24,7 @@ 
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
     */
    
-	class Module{
+	class Module {
 		
 		/**
 		 * list of loaded module
@@ -42,9 +42,9 @@ 
 		 * The signleton of the logger
 		 * @return Object the Log instance
 		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
+		private static function getLogger() {
+			if (self::$logger == null) {
+				self::$logger[0] = & class_loader('Log', 'classes');
 				self::$logger[0]->setLogger('Library::Module');
 			}
 			return self::$logger[0];
@@ -53,24 +53,24 @@ 
 		/**
 		 * Initialise the module list by scanning the directory MODULE_PATH
 		 */
-		public function init(){
+		public function init() {
 			$logger = self::getLogger();
 			$logger->debug('Check if the application contains the modules ...');
 			$moduleDir = opendir(MODULE_PATH);
-			if(is_resource($moduleDir)){
-				while(($module = readdir($moduleDir)) !== false){
-					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
+			if (is_resource($moduleDir)) {
+				while (($module = readdir($moduleDir)) !== false) {
+					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)) {
 						self::$list[] = $module;
 					}
-					else{
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
+					else {
+						$logger->info('Skipping [' . $module . '], may be this is not a directory or does not exists or is invalid name');
 					}
 				}
 				closedir($moduleDir);
 			}
 			ksort(self::$list);
 			
-			if(self::hasModule()){
+			if (self::hasModule()) {
 				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
 			}
 		}
@@ -79,9 +79,9 @@ 
 		 * Get the list of the custom autoload configuration from module if exists
 		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
 		 */
-		public static function getModulesAutoloadConfig(){
+		public static function getModulesAutoloadConfig() {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skipping.');
 				return false;
 			}
@@ -94,10 +94,10 @@ 
 			
 			foreach (self::$list as $module) {
 				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
-				if(file_exists($file)){
+				if (file_exists($file)) {
 					$autoload = array();
 					require_once $file;
-					if(! empty($autoload) && is_array($autoload)){
+					if (!empty($autoload) && is_array($autoload)) {
 						$autoloads = array_merge_recursive($autoloads, $autoload);
 						unset($autoload);
 					}
@@ -110,19 +110,19 @@ 
 		 * Get the list of the custom routes configuration from module if exists
 		 * @return array|boolean the routes list or false if no module contains the routes configuration
 		 */
-		public static function getModulesRoutes(){
+		public static function getModulesRoutes() {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skipping.');
 				return false;
 			}
 			$routes = array();
 			foreach (self::$list as $module) {
 				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
-				if(file_exists($file)){
+				if (file_exists($file)) {
 					$route = array();
 					require_once $file;
-					if(! empty($route) && is_array($route)){
+					if (!empty($route) && is_array($route)) {
 						$routes = array_merge($routes, $route);
 						unset($route);
 					}
@@ -138,22 +138,22 @@ 
 		 * @param  string $module  the module name
 		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
 		 */
-		public static function findControllerFullPath($class, $module = null){
+		public static function findControllerFullPath($class, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$class = str_ireplace('.php', '', $class);
 			$class = ucfirst($class);
-			$classFile = $class.'.php';
-			$logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
+			$classFile = $class . '.php';
+			$logger->debug('Checking the controller [' . $class . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
-			if(file_exists($filePath)){
-				$logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found controller [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
+			$logger->info('Controller [' . $class . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 
@@ -163,22 +163,22 @@ 
 		 * @param string $module the module name
 		 * @return boolean|string  false or null if no module have this model, return the full path of this model
 		 */
-		public static function findModelFullPath($class, $module = null){
+		public static function findModelFullPath($class, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$class = str_ireplace('.php', '', $class);
 			$class = ucfirst($class);
-			$classFile = $class.'.php';
-			$logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
+			$classFile = $class . '.php';
+			$logger->debug('Checking model [' . $class . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
-			if(file_exists($filePath)){
-				$logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found model [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
+			$logger->info('Model [' . $class . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 		
@@ -188,21 +188,21 @@ 
 		 * @param string $module the module name
 		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
 		 */
-		public static function findConfigFullPath($configuration, $module = null){
+		public static function findConfigFullPath($configuration, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$configuration = str_ireplace('.php', '', $configuration);
-			$file = $configuration.'.php';
-			$logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
+			$file = $configuration . '.php';
+			$logger->debug('Checking configuration [' . $configuration . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found configuration [' . $configuration . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
+			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 
@@ -212,22 +212,22 @@ 
 		 * @param string $module the module name
 		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
 		 */
-		public static function findFunctionFullPath($helper, $module = null){
+		public static function findFunctionFullPath($helper, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$helper = str_ireplace('.php', '', $helper);
 			$helper = str_ireplace('function_', '', $helper);
-			$file = 'function_'.$helper.'.php';
-			$logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
+			$file = 'function_' . $helper . '.php';
+			$logger->debug('Checking helper [' . $helper . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found helper [' . $helper . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
+			$logger->info('Helper [' . $helper . '] does not exist in the module [' . $module . ']');
 			return false;
 			
 		}
@@ -239,21 +239,21 @@ 
 		 * @param string $module the module name
 		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
 		 */
-		public static function findLibraryFullPath($class, $module = null){
+		public static function findLibraryFullPath($class, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$class = str_ireplace('.php', '', $class);
-			$file = $class.'.php';
-			$logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
+			$file = $class . '.php';
+			$logger->debug('Checking library [' . $class . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found library [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
+			$logger->info('Library [' . $class . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 
@@ -264,9 +264,9 @@ 
 		 * @param string $module the module name to check
 		 * @return boolean|string  false or null if no module have this view, path the full path of the view
 		 */
-		public static function findViewFullPath($view, $module = null){
+		public static function findViewFullPath($view, $module = null) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
@@ -274,13 +274,13 @@ 
 			$view = trim($view, '/\\');
 			$view = str_ireplace('/', DS, $view);
 			$viewFile = $view . '.php';
-			$logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
+			$logger->debug('Checking view [' . $view . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
-			if(file_exists($filePath)){
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found view [' . $view . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
+			$logger->info('View [' . $view . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 
@@ -291,22 +291,22 @@ 
 		 * @param string $appLang the application language like 'en', 'fr'
 		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
 		 */
-		public static function findLanguageFullPath($language, $module = null, $appLang){
+		public static function findLanguageFullPath($language, $module = null, $appLang) {
 			$logger = self::getLogger();
-			if(! self::hasModule()){
+			if (!self::hasModule()) {
 				$logger->info('No module was loaded skiping.');
 				return false;
 			}
 			$language = str_ireplace('.php', '', $language);
 			$language = str_ireplace('lang_', '', $language);
-			$file = 'lang_'.$language.'.php';
-			$logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
+			$file = 'lang_' . $language . '.php';
+			$logger->debug('Checking language [' . $language . '] in module [' . $module . '] ...');
 			$filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
-			if(file_exists($filePath)){
-				$logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
+			if (file_exists($filePath)) {
+				$logger->info('Found language [' . $language . '] in module [' . $module . '], the file path is [' . $filePath . ']');
 				return $filePath;
 			}
-			$logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
+			$logger->info('Language [' . $language . '] does not exist in the module [' . $module . ']');
 			return false;
 		}
 
@@ -314,7 +314,7 @@ 
 		 * Get the list of module loaded
 		 * @return array the module list
 		 */
-		public static function getModuleList(){
+		public static function getModuleList() {
 			return self::$list;
 		}
 
@@ -322,7 +322,7 @@ 
 		 * Check if the application has an module
 		 * @return boolean
 		 */
-		public static function hasModule(){
+		public static function hasModule() {
 			return !empty(self::$list);
 		}
 

Braces +1 added lines, -2 removed lines

@@ -61,8 +61,7 @@
 				while(($module = readdir($moduleDir)) !== false){
 					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
 						self::$list[] = $module;
-					}
-					else{
+					} else{
 						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
 					}
 				}