tnhfw / tnh-fw

core/classes/cache/ApcCache.php

Indentation +194 added lines, -194 removed lines

@@ -1,215 +1,215 @@
 <?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 ApcCache implements CacheInterface{
+    class ApcCache implements CacheInterface{
 
-		/**
-		 * 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 APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
-			}
+        public function __construct(Log $logger = null){
+            if(! $this->isSupported()){
+                show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
+            }
 
-			/**
-	         * instance of the Log class
-	         */
-	        if(is_object($logger)){
-	          $this->logger = $logger;
-	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
-	            $this->logger->setLogger('Library::ApcCache');
-	        }
-		}
+            /**
+             * instance of the Log class
+             */
+            if(is_object($logger)){
+                $this->logger = $logger;
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::ApcCache');
+            }
+        }
 
-		/**
-		 * 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 .']');
-			$success = false;
-			$data = apc_fetch($key, $success);
-			if($success === false){
-				$this->logger->info('No cache found for the key ['. $key .'], return false');
-				return false;
-			}
-			else{
-				$cacheInfo = $this->_getCacheInfo($key);
-				$expire = time();
-				if($cacheInfo){
-					$expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
-				}
-				$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', $expire) . ']');
-				return $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 .']');
+            $success = false;
+            $data = apc_fetch($key, $success);
+            if($success === false){
+                $this->logger->info('No cache found for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $cacheInfo = $this->_getCacheInfo($key);
+                $expire = time();
+                if($cacheInfo){
+                    $expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
+                }
+                $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', $expire) . ']');
+                return $data;
+            }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data to be saved
-		 * @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) . ']');
-			$result = apc_store($key, $data, $ttl);
-			if($result === false){
-		    	$this->logger->error('Can not write cache data for the key ['. $key .'], return false');
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved for the key ['. $key .']');
-		    	return true;
-		    }
-		}
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data to be saved
+         * @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) . ']');
+            $result = apc_store($key, $data, $ttl);
+            if($result === false){
+                $this->logger->error('Can not write cache data for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved for the key ['. $key .']');
+                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 deleted, 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. ']');
-			$cacheInfo = $this->_getCacheInfo($key);
-			if($cacheInfo === false){
-				$this->logger->info('This cache data does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache data for the key [' .$key. '] remove it');
-	      		return apc_delete($key) === 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 deleted, 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. ']');
+            $cacheInfo = $this->_getCacheInfo($key);
+            if($cacheInfo === false){
+                $this->logger->info('This cache data does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache data for the key [' .$key. '] remove it');
+                    return apc_delete($key) === 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. ']');
-			$cacheInfos = $this->_getCacheInfo($key);
-			if($cacheInfos){
-				$data = array(
-							'mtime' => $cacheInfos['creation_time'],
-							'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
-							'ttl' => $cacheInfos['ttl']
-							);
-				return $data;
-			}
-			else{
-				$this->logger->info('This cache does not exists skipping');
-				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. ']');
+            $cacheInfos = $this->_getCacheInfo($key);
+            if($cacheInfos){
+                $data = array(
+                            'mtime' => $cacheInfos['creation_time'],
+                            'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
+                            'ttl' => $cacheInfos['ttl']
+                            );
+                return $data;
+            }
+            else{
+                $this->logger->info('This cache does not exists skipping');
+                return false;
+            }
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			//for APC[u] is done automatically
-			return true;
-		}
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            //for APC[u] is done automatically
+            return true;
+        }
 
-		/**
-		 * Remove all cache data
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache data');
-			$cacheInfos = apc_cache_info('user');
-			if(empty($cacheInfos['cache_list'])){
-				$this->logger->info('No cache data were found skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
-				return apc_clear_cache('user');
-			}
-		}
+        /**
+         * Remove all cache data
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache data');
+            $cacheInfos = apc_cache_info('user');
+            if(empty($cacheInfos['cache_list'])){
+                $this->logger->info('No cache data were found skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
+                return apc_clear_cache('user');
+            }
+        }
 		
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
+        }
 
-		/**
-	     * Return the Log instance
-	     * @return Log
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
+        /**
+         * Return the Log instance
+         * @return Log
+         */
+        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;
+        }
 		
-		/**
-		* Return the array of cache information
-		*
-		* @param string $key the cache key to get the cache information 
-		* @return boolean|array
-		*/
-		private function _getCacheInfo($key){
-			$caches = apc_cache_info('user');
-			if(! empty($caches['cache_list'])){
-				$cacheLists = $caches['cache_list'];
-				foreach ($cacheLists as $c){
-					if(isset($c['info']) && $c['info'] === $key){
-						return $c;
-					}
-				}
+        /**
+         * Return the array of cache information
+         *
+         * @param string $key the cache key to get the cache information 
+         * @return boolean|array
+         */
+        private function _getCacheInfo($key){
+            $caches = apc_cache_info('user');
+            if(! empty($caches['cache_list'])){
+                $cacheLists = $caches['cache_list'];
+                foreach ($cacheLists as $c){
+                    if(isset($c['info']) && $c['info'] === $key){
+                        return $c;
+                    }
+                }
 				
-			}
-			return false;
-		}
-	}
+            }
+            return false;
+        }
+    }

core/classes/cache/CacheInterface.php

Indentation +70 added lines, -70 removed lines

@@ -1,84 +1,84 @@
 <?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.
+     */
 	
-	interface CacheInterface{
+    interface CacheInterface{
 
-		/**
-		 * 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 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);
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data to be saved
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0);
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data to be saved
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0);
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is deleted, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key);
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is deleted, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key);
 		
 		
-		/**
-		 * 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);
+        /**
+         * 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);
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache();
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache();
 
-		/**
-		 * Remove all cache data
-		 */
-		public function clean();
+        /**
+         * Remove all cache data
+         */
+        public function clean();
 		
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported();
-	}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported();
+    }

core/classes/EventDispatcher.php

Indentation +169 added lines, -169 removed lines

@@ -1,182 +1,182 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	/**
-	 * This class represent the event dispatcher management, permit to record the listener and 
-	 * also to dispatch the event
-	 */
+    /**
+     * This class represent the event dispatcher management, permit to record the listener and 
+     * also to dispatch the event
+     */
 	
-	class EventDispatcher{
+    class EventDispatcher{
 		
-		/**
-		 * The list of the registered listeners
-		 * @var array
-		 */
-		private $listeners = array();
+        /**
+         * The list of the registered listeners
+         * @var array
+         */
+        private $listeners = array();
 		
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 
-		public function __construct(){
-			$this->logger =& class_loader('Log', 'classes');
-			$this->logger->setLogger('Library::EventDispatcher');
-		}
+        public function __construct(){
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::EventDispatcher');
+        }
 
-		/**
-		 * Register new listener
-		 * @param string   $eventName the name of the event to register for
-		 * @param callable $listener  the function or class method to receive the event information after dispatch
-		 */
-		public function addListener($eventName, callable $listener){
-			$this->logger->debug('Adding new event listener for the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']');
-			if(! isset($this->listeners[$eventName])){
-				$this->logger->info('This event does not have the registered event listener before, adding new one');
-				$this->listeners[$eventName] = array();
-			}
-			else{
-				$this->logger->info('This event already have the registered listener, add this listener to the list');
-			}
-			$this->listeners[$eventName][] = $listener;
-		}
+        /**
+         * Register new listener
+         * @param string   $eventName the name of the event to register for
+         * @param callable $listener  the function or class method to receive the event information after dispatch
+         */
+        public function addListener($eventName, callable $listener){
+            $this->logger->debug('Adding new event listener for the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']');
+            if(! isset($this->listeners[$eventName])){
+                $this->logger->info('This event does not have the registered event listener before, adding new one');
+                $this->listeners[$eventName] = array();
+            }
+            else{
+                $this->logger->info('This event already have the registered listener, add this listener to the list');
+            }
+            $this->listeners[$eventName][] = $listener;
+        }
 		
-		/**
-		 * Remove the event listener from list
-		 * @param  string   $eventName the event name
-		 * @param  callable $listener  the listener callback
-		 */
-		public function removeListener($eventName, callable $listener){
-			$this->logger->debug('Removing of the event listener, the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']');
-			if(isset($this->listeners[$eventName])){
-				$this->logger->info('This event have the listeners, check if this listener exists');
-				if(false !== $index = array_search($listener, $this->listeners[$eventName], true)){
-					$this->logger->info('Found the listener at index [' .$index. '] remove it');
-					unset($this->listeners[$eventName][$index]);
-				}
-				else{
-					$this->logger->info('Cannot found this listener in the event listener list');
-				}
-			}
-			else{
-				$this->logger->info('This event does not have this listener ignore remove');
-			}
-		}
+        /**
+         * Remove the event listener from list
+         * @param  string   $eventName the event name
+         * @param  callable $listener  the listener callback
+         */
+        public function removeListener($eventName, callable $listener){
+            $this->logger->debug('Removing of the event listener, the event name [' .$eventName. '], listener [' .stringfy_vars($listener). ']');
+            if(isset($this->listeners[$eventName])){
+                $this->logger->info('This event have the listeners, check if this listener exists');
+                if(false !== $index = array_search($listener, $this->listeners[$eventName], true)){
+                    $this->logger->info('Found the listener at index [' .$index. '] remove it');
+                    unset($this->listeners[$eventName][$index]);
+                }
+                else{
+                    $this->logger->info('Cannot found this listener in the event listener list');
+                }
+            }
+            else{
+                $this->logger->info('This event does not have this listener ignore remove');
+            }
+        }
 		
-		/**
-		 * Remove all the event listener. If event name is null will remove all listeners, else will just 
-		 * remove all listeners for this event
-		 * @param  string $eventName the event name
-		 */
-		public function removeAllListener($eventName = null){
-			$this->logger->debug('Removing of all event listener, the event name [' .$eventName. ']');
-			if($eventName !== null && isset($this->listeners[$eventName])){
-				$this->logger->info('The event name is set of exist in the listener just remove all event listener for this event');
-				unset($this->listeners[$eventName]);
-			}
-			else{
-				$this->logger->info('The event name is not set or does not exist in the listener, so remove all event listener');
-				$this->listeners = array();
-			}
-		}
+        /**
+         * Remove all the event listener. If event name is null will remove all listeners, else will just 
+         * remove all listeners for this event
+         * @param  string $eventName the event name
+         */
+        public function removeAllListener($eventName = null){
+            $this->logger->debug('Removing of all event listener, the event name [' .$eventName. ']');
+            if($eventName !== null && isset($this->listeners[$eventName])){
+                $this->logger->info('The event name is set of exist in the listener just remove all event listener for this event');
+                unset($this->listeners[$eventName]);
+            }
+            else{
+                $this->logger->info('The event name is not set or does not exist in the listener, so remove all event listener');
+                $this->listeners = array();
+            }
+        }
 		
-		/**
-		 * Get the list of listener for this event
-		 * @param string $eventName the event name
-		 * @return array the listeners for this event or empty array if this event does not contain any listener
-		 */
-		public function getListeners($eventName){
-			return isset($this->listeners[$eventName]) ? $this->listeners[$eventName] : array();
-		}
+        /**
+         * Get the list of listener for this event
+         * @param string $eventName the event name
+         * @return array the listeners for this event or empty array if this event does not contain any listener
+         */
+        public function getListeners($eventName){
+            return isset($this->listeners[$eventName]) ? $this->listeners[$eventName] : array();
+        }
 		
-		/**
-		 * Dispatch the event to the registered listeners.
-		 * @param  mixed|object $event the event information
-		 * @return void|object if event need return, will return the final EventInfo object.
-		 */	
-		public function dispatch($event){
-			if(! $event || !$event instanceof EventInfo){
-				$this->logger->info('The event is not set or is not an instance of "EventInfo" create the default "EventInfo" object to use instead of.');
-				$event = new EventInfo((string) $event);
-			}			
-			$this->logger->debug('Dispatch to the event listener, the event [' .stringfy_vars($event). ']');
-			if(isset($event->stop) && $event->stop){
-				$this->logger->info('This event need stopped, no need call any listener');
-				return;
-			}
-			if($event->returnBack){
-				$this->logger->info('This event need return back, return the result for future use');
-				return $this->dispatchToListerners($event);
-			}
-			else{
-				$this->logger->info('This event no need return back the result, just dispatch it');
-				$this->dispatchToListerners($event);
-			}
-		}
+        /**
+         * Dispatch the event to the registered listeners.
+         * @param  mixed|object $event the event information
+         * @return void|object if event need return, will return the final EventInfo object.
+         */	
+        public function dispatch($event){
+            if(! $event || !$event instanceof EventInfo){
+                $this->logger->info('The event is not set or is not an instance of "EventInfo" create the default "EventInfo" object to use instead of.');
+                $event = new EventInfo((string) $event);
+            }			
+            $this->logger->debug('Dispatch to the event listener, the event [' .stringfy_vars($event). ']');
+            if(isset($event->stop) && $event->stop){
+                $this->logger->info('This event need stopped, no need call any listener');
+                return;
+            }
+            if($event->returnBack){
+                $this->logger->info('This event need return back, return the result for future use');
+                return $this->dispatchToListerners($event);
+            }
+            else{
+                $this->logger->info('This event no need return back the result, just dispatch it');
+                $this->dispatchToListerners($event);
+            }
+        }
 		
-		/**
-		 * Dispatch the event to the registered listeners.
-		 * @param  object EventInfo $event  the event information
-		 * @return void|object if event need return, will return the final EventInfo instance.
-		 */	
-		private function dispatchToListerners(EventInfo $event){
-			$eBackup = $event;
-			$list = $this->getListeners($event->name);
-			if(empty($list)){
-				$this->logger->info('No event listener is registered for the event [' .$event->name. '] skipping.');
-				if($event->returnBack){
-					return $event;
-				}
-				return;
-			}
-			else{
-				$this->logger->info('Found the registered event listener for the event [' .$event->name. '] the list are: ' . stringfy_vars($list));
-			}
-			foreach($list as $listener){
-				if($eBackup->returnBack){
-					$returnedEvent = call_user_func_array($listener, array($event));
-					if($returnedEvent instanceof EventInfo){
-						$event = $returnedEvent;
-					}
-					else{
-						show_error('This event [' .$event->name. '] need you return the event object after processing');
-					}
-				}
-				else{
-					call_user_func_array($listener, array($event));
-				}
-				if($event->stop){
-					break;
-				}
-			}
-			//only test for original event may be during the flow some listeners change this parameter
-			if($eBackup->returnBack){
-				return $event;
-			}
-		}
-	}
+        /**
+         * Dispatch the event to the registered listeners.
+         * @param  object EventInfo $event  the event information
+         * @return void|object if event need return, will return the final EventInfo instance.
+         */	
+        private function dispatchToListerners(EventInfo $event){
+            $eBackup = $event;
+            $list = $this->getListeners($event->name);
+            if(empty($list)){
+                $this->logger->info('No event listener is registered for the event [' .$event->name. '] skipping.');
+                if($event->returnBack){
+                    return $event;
+                }
+                return;
+            }
+            else{
+                $this->logger->info('Found the registered event listener for the event [' .$event->name. '] the list are: ' . stringfy_vars($list));
+            }
+            foreach($list as $listener){
+                if($eBackup->returnBack){
+                    $returnedEvent = call_user_func_array($listener, array($event));
+                    if($returnedEvent instanceof EventInfo){
+                        $event = $returnedEvent;
+                    }
+                    else{
+                        show_error('This event [' .$event->name. '] need you return the event object after processing');
+                    }
+                }
+                else{
+                    call_user_func_array($listener, array($event));
+                }
+                if($event->stop){
+                    break;
+                }
+            }
+            //only test for original event may be during the flow some listeners change this parameter
+            if($eBackup->returnBack){
+                return $event;
+            }
+        }
+    }

core/classes/Loader.php

Indentation +496 added lines, -496 removed lines

@@ -1,521 +1,521 @@
 <?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 Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        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();
+        }
 
-		/**
-		 * 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::Loader');
-			}
-			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::Loader');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * 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){
-				//for module
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[1])){
-						$instance = strtolower($path[1]);
-					}
-				}
-				else{
-					$instance = strtolower($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 ...');
-			$searchModuleName = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($class, '/') !== false){
-				$path = explode('/', $class);
-				if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$searchModuleName = $path[0];
-					$class = ucfirst($path[1]);
-				}
-			}
-			else{
-				$class = ucfirst($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){
+                //for module
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[1])){
+                        $instance = strtolower($path[1]);
+                    }
+                }
+                else{
+                    $instance = strtolower($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 ...');
+            $searchModuleName = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($class, '/') !== false){
+                $path = explode('/', $class);
+                if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $searchModuleName = $path[0];
+                    $class = ucfirst($path[1]);
+                }
+            }
+            else{
+                $class = ucfirst($class);
+            }
 
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleModelFilePath = Module::findModelFullPath($class, $searchModuleName);
-			if($moduleModelFilePath){
-				$logger->info('Found model [' . $class . '] from module [' .$searchModuleName. '], 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 . ']');
-			}
-		}
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleModelFilePath = Module::findModelFullPath($class, $searchModuleName);
+            if($moduleModelFilePath){
+                $logger->info('Found model [' . $class . '] from module [' .$searchModuleName. '], 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){
-				//for module
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[1])){
-						$instance = strtolower($path[1]);
-					}
-				}
-				else{
-					$instance = strtolower($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();
-			//TODO for Database library
-			if(strtolower($class) == 'database'){
-				$logger->info('This is the Database library ...');
-				$dbInstance = & class_loader('Database', 'classes/database', $params);
-				$obj->{$instance} = $dbInstance;
-				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
-				$logger->debug('Checking library [' . $class . '] from module list ...');
-				$searchModuleName = null;
-				//check if the request class contains module name
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-						$searchModuleName = $path[0];
-						$class = ucfirst($path[1]);
-					}
-				}
-				else{
-					$class = ucfirst($class);
-				}
-				if(! $searchModuleName && !empty($obj->moduleName)){
-					$searchModuleName = $obj->moduleName;
-				}
-				$moduleLibraryPath = Module::findLibraryFullPath($class, $searchModuleName);
-				if($moduleLibraryPath){
-					$logger->info('Found library [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLibraryPath. '] we will used it');
-					$libraryFilePath = $moduleLibraryPath;
-				}
-				else{
-					$logger->info('Cannot find library [' . $class . '] from modules using the default location');
-				}
-			}
-			if(! $libraryFilePath){
-				$searchDir = array(LIBRARY_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $file;
-					if(file_exists($filePath)){
-						$libraryFilePath = $filePath;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
-			if($libraryFilePath){
-				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 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){
+                //for module
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[1])){
+                        $instance = strtolower($path[1]);
+                    }
+                }
+                else{
+                    $instance = strtolower($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();
+            //TODO for Database library
+            if(strtolower($class) == 'database'){
+                $logger->info('This is the Database library ...');
+                $dbInstance = & class_loader('Database', 'classes/database', $params);
+                $obj->{$instance} = $dbInstance;
+                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
+                $logger->debug('Checking library [' . $class . '] from module list ...');
+                $searchModuleName = null;
+                //check if the request class contains module name
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                        $searchModuleName = $path[0];
+                        $class = ucfirst($path[1]);
+                    }
+                }
+                else{
+                    $class = ucfirst($class);
+                }
+                if(! $searchModuleName && !empty($obj->moduleName)){
+                    $searchModuleName = $obj->moduleName;
+                }
+                $moduleLibraryPath = Module::findLibraryFullPath($class, $searchModuleName);
+                if($moduleLibraryPath){
+                    $logger->info('Found library [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLibraryPath. '] we will used it');
+                    $libraryFilePath = $moduleLibraryPath;
+                }
+                else{
+                    $logger->info('Cannot find library [' . $class . '] from modules using the default location');
+                }
+            }
+            if(! $libraryFilePath){
+                $searchDir = array(LIBRARY_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $file;
+                    if(file_exists($filePath)){
+                        $libraryFilePath = $filePath;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
+            if($libraryFilePath){
+                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 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 ...');
-			$searchModuleName = 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())){
-					$searchModuleName = $path[0];
-					$function = 'function_' . $path[1] . '.php';
-					$file = $path[0] . DS . 'function_'.$function.'.php';
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleFunctionPath = Module::findFunctionFullPath($function, $searchModuleName);
-			if($moduleFunctionPath){
-				$logger->info('Found helper [' . $function . '] from module [' .$searchModuleName. '], 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 ...');
+            $searchModuleName = 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())){
+                    $searchModuleName = $path[0];
+                    $function = 'function_' . $path[1] . '.php';
+                    $file = $path[0] . DS . 'function_'.$function.'.php';
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleFunctionPath = Module::findFunctionFullPath($function, $searchModuleName);
+            if($moduleFunctionPath){
+                $logger->info('Found helper [' . $function . '] from module [' .$searchModuleName. '], 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 ...');
-			$searchModuleName = 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())){
-					$searchModuleName = $path[0];
-					$filename = $path[1] . '.php';
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleConfigPath = Module::findConfigFullPath($filename, $searchModuleName);
-			if($moduleConfigPath){
-				$logger->info('Found config [' . $filename . '] from module [' .$searchModuleName. '], 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);
-				}
-			}
-			else{
-				show_error('Unable to find config file ['. $configFilePath . ']');
-			}
-			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);
-		}
+        /**
+         * 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 ...');
+            $searchModuleName = 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())){
+                    $searchModuleName = $path[0];
+                    $filename = $path[1] . '.php';
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleConfigPath = Module::findConfigFullPath($filename, $searchModuleName);
+            if($moduleConfigPath){
+                $logger->info('Found config [' . $filename . '] from module [' .$searchModuleName. '], 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);
+                }
+            }
+            else{
+                show_error('Unable to find config file ['. $configFilePath . ']');
+            }
+            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);
+        }
 
 
-		/**
-		 * 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;
-			}
-			//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;
-			}
-			$languageFilePath = null;
-			//first check if this language is in the module
-			$logger->debug('Checking language [' . $language . '] from module list ...');
-			$searchModuleName = 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())){
-					$searchModuleName = $path[0];
-					$language = 'lang_' . $path[1] . '.php';
-					$file = $path[0] . DS .$language;
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleLanguagePath = Module::findLanguageFullPath($language, $searchModuleName, $appLang);
-			if($moduleLanguagePath){
-				$logger->info('Found language [' . $language . '] from module [' .$searchModuleName. '], 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;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
-			if($languageFilePath){
-				$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 file [' . $file . ']');
-			}
-		}
+        /**
+         * 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;
+            }
+            //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;
+            }
+            $languageFilePath = null;
+            //first check if this language is in the module
+            $logger->debug('Checking language [' . $language . '] from module list ...');
+            $searchModuleName = 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())){
+                    $searchModuleName = $path[0];
+                    $language = 'lang_' . $path[1] . '.php';
+                    $file = $path[0] . DS .$language;
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleLanguagePath = Module::findLanguageFullPath($language, $searchModuleName, $appLang);
+            if($moduleLanguagePath){
+                $logger->info('Found language [' . $language . '] from module [' .$searchModuleName. '], 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;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
+            if($languageFilePath){
+                $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 file [' . $file . ']');
+            }
+        }
 
 
-		private function getResourcesFromAutoloadConfig(){
-			$autoloads = array();
-			$autoloads['config']    = array();
-			$autoloads['languages'] = array();
-			$autoloads['libraries'] = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			//loading of the resources in autoload.php 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;
-		}
+        private function getResourcesFromAutoloadConfig(){
+            $autoloads = array();
+            $autoloads['config']    = array();
+            $autoloads['languages'] = array();
+            $autoloads['libraries'] = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            //loading of the resources in autoload.php 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);
+            }
+        }
+    }

core/classes/Controller.php

Indentation +125 added lines, -125 removed lines

@@ -1,145 +1,145 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Controller{
+    class Controller{
 		
-		/**
-		 * The name of the module if this controller belong to an module
-		 * @var string
-		 */
-		public $moduleName = null;
+        /**
+         * The name of the module if this controller belong to an module
+         * @var string
+         */
+        public $moduleName = null;
 
-		/**
-		 * The singleton of the super object
-		 * @var Controller
-		 */
-		private static $instance;
+        /**
+         * The singleton of the super object
+         * @var Controller
+         */
+        private static $instance;
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		protected $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        protected $logger;
 
-		/**
-		 * Class constructor
-		 * @param object $logger the Log instance to use if is null will create one
-		 */
-		public function __construct(Log $logger = null){
-			//setting the Log instance
-			$this->setLoggerFromParamOrCreateNewInstance($logger);
+        /**
+         * Class constructor
+         * @param object $logger the Log instance to use if is null will create one
+         */
+        public function __construct(Log $logger = null){
+            //setting the Log instance
+            $this->setLoggerFromParamOrCreateNewInstance($logger);
 			
-			//instance of the super object
-			self::$instance = & $this;
+            //instance of the super object
+            self::$instance = & $this;
 			
-			//load the required resources
-			$this->loadRequiredResources();
+            //load the required resources
+            $this->loadRequiredResources();
 			
-			//set the cache using the configuration
-			$this->setCacheFromParamOrConfig(null);
+            //set the cache using the configuration
+            $this->setCacheFromParamOrConfig(null);
 			
-			//set application session configuration
-			$this->logger->debug('Setting PHP application session handler');
-			set_session_config();
+            //set application session configuration
+            $this->logger->debug('Setting PHP application session handler');
+            set_session_config();
 			
-			//set module using the router
-			$this->setModuleNameFromRouter();
+            //set module using the router
+            $this->setModuleNameFromRouter();
 
-			//dispatch the loaded instance of super controller event
-			$this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
-		}
+            //dispatch the loaded instance of super controller event
+            $this->eventdispatcher->dispatch('SUPER_CONTROLLER_CREATED');
+        }
 
 
-		/**
-		 * This is a very useful method it's used to get the super object instance
-		 * @return Controller the super object instance
-		 */
-		public static function &get_instance(){
-			return self::$instance;
-		}
+        /**
+         * This is a very useful method it's used to get the super object instance
+         * @return Controller the super object instance
+         */
+        public static function &get_instance(){
+            return self::$instance;
+        }
 
-		/**
-		 * This method is used to set the module name
-		 */
-		protected function setModuleNameFromRouter(){
-			//determine the current module
-			if(isset($this->router) && $this->router->getModule()){
-				$this->moduleName = $this->router->getModule();
-			}
-		}
+        /**
+         * This method is used to set the module name
+         */
+        protected function setModuleNameFromRouter(){
+            //determine the current module
+            if(isset($this->router) && $this->router->getModule()){
+                $this->moduleName = $this->router->getModule();
+            }
+        }
 
-		/**
-		 * Set the cache using the argument otherwise will use the configuration
-		 * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
-		 */
-		protected function setCacheFromParamOrConfig(CacheInterface $cache = null){
-			$this->logger->debug('Setting the cache handler instance');
-			//set cache handler instance
-			if(get_config('cache_enable', false)){
-				if ($cache !== null){
-					$this->cache = $cache;
-				} else if (isset($this->{strtolower(get_config('cache_handler'))})){
-					$this->cache = $this->{strtolower(get_config('cache_handler'))};
-					unset($this->{strtolower(get_config('cache_handler'))});
-				} 
-			}
-		}
+        /**
+         * Set the cache using the argument otherwise will use the configuration
+         * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
+         */
+        protected function setCacheFromParamOrConfig(CacheInterface $cache = null){
+            $this->logger->debug('Setting the cache handler instance');
+            //set cache handler instance
+            if(get_config('cache_enable', false)){
+                if ($cache !== null){
+                    $this->cache = $cache;
+                } else if (isset($this->{strtolower(get_config('cache_handler'))})){
+                    $this->cache = $this->{strtolower(get_config('cache_handler'))};
+                    unset($this->{strtolower(get_config('cache_handler'))});
+                } 
+            }
+        }
 
-		/**
-		 * 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('MainController');
-	        }
-		}
+        /**
+         * 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('MainController');
+            }
+        }
 
-		/**
-		 * This method is used to load the required resources for framework to work
-		 * @return void 
-		 */
-		private function loadRequiredResources(){
-			$this->logger->debug('Adding the loaded classes to the super instance');
-			foreach (class_loaded() as $var => $class){
-				$this->$var =& class_loader($class);
-			}
+        /**
+         * This method is used to load the required resources for framework to work
+         * @return void 
+         */
+        private function loadRequiredResources(){
+            $this->logger->debug('Adding the loaded classes to the super instance');
+            foreach (class_loaded() as $var => $class){
+                $this->$var =& class_loader($class);
+            }
 
-			$this->logger->debug('Loading the required classes into super instance');
-			$this->eventdispatcher =& class_loader('EventDispatcher', 'classes');
-			$this->loader =& class_loader('Loader', 'classes');
-			$this->lang =& class_loader('Lang', 'classes');
-			$this->request =& class_loader('Request', 'classes');
-			//dispatch the request instance created event
-			$this->eventdispatcher->dispatch('REQUEST_CREATED');
-			$this->response =& class_loader('Response', 'classes', 'classes');
-		}
+            $this->logger->debug('Loading the required classes into super instance');
+            $this->eventdispatcher =& class_loader('EventDispatcher', 'classes');
+            $this->loader =& class_loader('Loader', 'classes');
+            $this->lang =& class_loader('Lang', 'classes');
+            $this->request =& class_loader('Request', 'classes');
+            //dispatch the request instance created event
+            $this->eventdispatcher->dispatch('REQUEST_CREATED');
+            $this->response =& class_loader('Response', 'classes', 'classes');
+        }
 
-	}
+    }

core/classes/model/DBSessionHandlerModel.php

Indentation +65 added lines, -65 removed lines

@@ -1,39 +1,39 @@ 
 <?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.
+     */
 	
-	/**
-	 * DB session handler class
-	 */
- 	abstract class DBSessionHandlerModel extends Model {
+    /**
+     * DB session handler class
+     */
+        abstract class DBSessionHandlerModel extends Model {
 		
-		/**
-		 * The session table columns to use
-		 * @var array
-		 * @example
-		 * 	array(
+        /**
+         * The session table columns to use
+         * @var array
+         * @example
+         * 	array(
 				'sid' => '', //VARCHAR(255) Note: this a primary key
 				'sdata' => '', //TEXT
 				'stime' => '', //unix timestamp (INT|BIGINT)
@@ -42,41 +42,41 @@ 
 				'sbrowser' => '', //VARCHAR(255) 
 				'skey' => '' //VARCHAR(255) 
 			);
-		 */
-		protected $sessionTableColumns = array();
+         */
+        protected $sessionTableColumns = array();
 
-		public function __construct(Database $db = null){
-			parent::__construct($db);
-		}
+        public function __construct(Database $db = null){
+            parent::__construct($db);
+        }
 
-		/**
-		 * Return the session database table columns
-		 * @return array 
-		 */
-		public function getSessionTableColumns(){
-			return $this->sessionTableColumns;
-		}
+        /**
+         * Return the session database table columns
+         * @return array 
+         */
+        public function getSessionTableColumns(){
+            return $this->sessionTableColumns;
+        }
 
-		/**
-		 * Set the session database table columns
-		 * @param array $columns the columns definition
-		 */
-		public function setSessionTableColumns(array $columns){
-			$this->sessionTableColumns = $columns;
-			return $this;
-		}
+        /**
+         * Set the session database table columns
+         * @param array $columns the columns definition
+         */
+        public function setSessionTableColumns(array $columns){
+            $this->sessionTableColumns = $columns;
+            return $this;
+        }
 
-		/**
-		 * Delete the expire session
-		 * @param  int $time the unix timestamp
-		 * @return int       affected rows
-		 */
-		abstract public function deleteByTime($time);
+        /**
+         * Delete the expire session
+         * @param  int $time the unix timestamp
+         * @return int       affected rows
+         */
+        abstract public function deleteByTime($time);
 
 		
-		/**
-		 * How to get the value of the table column key. Generally is the session key
-		 * @return mixed the key value like used to identify the data
-		 */
-		abstract public function getKeyValue();
-	}
+        /**
+         * How to get the value of the table column key. Generally is the session key
+         * @return mixed the key value like used to identify the data
+         */
+        abstract public function getKeyValue();
+    }

core/classes/model/Model.php

Indentation +125 added lines, -125 removed lines

@@ -22,7 +22,7 @@ 
      * 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.
-    */
+     */
 
 
     /**
@@ -120,10 +120,10 @@ 
         protected $_temporary_return_type = NULL;
     	
     	
-    	/**
+        /**
     		The database cache time 
-    	*/
-    	protected $dbCacheTime = 0;
+         */
+        protected $dbCacheTime = 0;
 
         /**
          * Instance of the Loader class
@@ -151,12 +151,12 @@ 
             }
             else{
                 $obj = & get_instance();
-        		if (isset($obj->database) && is_object($obj->database)){
+                if (isset($obj->database) && is_object($obj->database)){
                     /**
-                    * NOTE: Need use "clone" because some Model need have the personal instance of the database library
-                    * to prevent duplication
-                    */
-        			$this->setDatabaseInstance(clone $obj->database);
+                     * NOTE: Need use "clone" because some Model need have the personal instance of the database library
+                     * to prevent duplication
+                     */
+                    $this->setDatabaseInstance(clone $obj->database);
                 }
             }
 
@@ -174,7 +174,7 @@ 
          */
         public function get($primary_value)
         {
-    		return $this->get_by($this->primary_key, $primary_value);
+            return $this->get_by($this->primary_key, $primary_value);
         }
 
         /**
@@ -189,12 +189,12 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-    		$this->_set_where($where);
+            $this->_set_where($where);
 
             $this->trigger('before_get');
-			$type = $this->_temporary_return_type == 'array' ? 'array' : false;
+            $type = $this->_temporary_return_type == 'array' ? 'array' : false;
             $this->getQueryBuilder()->from($this->_table);
-			$row = $this->_database->get($type);
+            $row = $this->_database->get($type);
             $this->_temporary_return_type = $this->return_type;
             $row = $this->trigger('after_get', $row);
             $this->_with = array();
@@ -231,9 +231,9 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-			$type = $this->_temporary_return_type == 'array' ? 'array':false;
+            $type = $this->_temporary_return_type == 'array' ? 'array':false;
             $this->getQueryBuilder()->from($this->_table);
-			$result = $this->_database->getAll($type);
+            $result = $this->_database->getAll($type);
             $this->_temporary_return_type = $this->return_type;
 
             foreach ($result as $key => &$row)
@@ -247,7 +247,7 @@ 
         /**
          * Insert a new row into the table. $data should be an associative array
          * of data to be inserted. Returns newly created ID.
-		 * @see Database::insert
+         * @see Database::insert
          */
         public function insert($data = array(), $skip_validation = FALSE, $escape = true)
         {
@@ -260,11 +260,11 @@ 
             {
                 $data = $this->trigger('before_create', $data);
                 $this->getQueryBuilder()->from($this->_table);
-				$this->_database->insert($data, $escape);
+                $this->_database->insert($data, $escape);
                 $insert_id = $this->_database->insertId();
                 $this->trigger('after_create', $insert_id);
-				//if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
-				return ! $insert_id ? true : $insert_id;
+                //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
+                return ! $insert_id ? true : $insert_id;
             }
             else
             {
@@ -324,7 +324,7 @@ 
             {
                 $this->getQueryBuilder()->in($this->primary_key, $primary_values)
                                         ->from($this->_table);
-				$result = $this->_database->update($data, $escape);
+                $result = $this->_database->update($data, $escape);
                 $this->trigger('after_update', array($data, $result));
                 return $result;
             }
@@ -356,7 +356,7 @@ 
             {
                 $this->_set_where($args);
                 $this->getQueryBuilder()->from($this->_table);
-				$result = $this->_database->update($data);
+                $result = $this->_database->update($data);
                 $this->trigger('after_update', array($data, $result));
                 return $result;
             }
@@ -373,7 +373,7 @@ 
         {
             $data = $this->trigger('before_update', $data);
             $this->getQueryBuilder()->from($this->_table);
-			$result = $this->_database->update($data, $escape);
+            $result = $this->_database->update($data, $escape);
             $this->trigger('after_update', array($data, $result));
             return $result;
         }
@@ -385,16 +385,16 @@ 
         {
             $this->trigger('before_delete', $id);
             $this->getQueryBuilder()->where($this->primary_key, $id);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
 
             $this->trigger('after_delete', $result);
@@ -407,18 +407,18 @@ 
         public function delete_by()
         {
             $where = func_get_args();
-    	    $where = $this->trigger('before_delete', $where);
+            $where = $this->trigger('before_delete', $where);
             $this->_set_where($where);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
             $this->trigger('after_delete', $result);
             return $result;
@@ -431,16 +431,16 @@ 
         {
             $primary_values = $this->trigger('before_delete', $primary_values);
             $this->getQueryBuilder()->in($this->primary_key, $primary_values);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
             $this->trigger('after_delete', $result);
             return $result;
@@ -452,8 +452,8 @@ 
          */
         public function truncate()
         {
-			$this->getQueryBuilder()->from($this->_table); 
-			$result = $this->_database->delete();
+            $this->getQueryBuilder()->from($this->_table); 
+            $result = $this->_database->delete();
             return $result;
         }
 
@@ -471,14 +471,14 @@ 
             return $this;
         }
 		
-		/**
-		* Relationship
-		*/
+        /**
+         * Relationship
+         */
         public function relate($row)
         {
-    		if (empty($row))
+            if (empty($row))
             {
-    		    return $row;
+                return $row;
             }
 
             $row = $this->relateBelongsTo($row);
@@ -511,9 +511,9 @@ 
                 $this->getQueryBuilder()->where($this->soft_delete_key, FALSE);
             }
             $this->getQueryBuilder()
-									 ->select(array($key, $value))
-									 ->from($this->_table);
-			$result = $this->_database->getAll();
+                                        ->select(array($key, $value))
+                                        ->from($this->_table);
+            $result = $this->_database->getAll();
             $options = array();
             foreach ($result as $row)
             {
@@ -535,7 +535,7 @@ 
             $where = func_get_args();
             $this->_set_where($where);
             $this->getQueryBuilder()->from($this->_table);
-			$this->_database->getAll();
+            $this->_database->getAll();
             return $this->_database->numRows();
         }
 
@@ -548,20 +548,20 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-			$this->getQueryBuilder()->from($this->_table);
-			$this->_database->getAll();
+            $this->getQueryBuilder()->from($this->_table);
+            $this->_database->getAll();
             return $this->_database->numRows();
         }
 		
-		/**
-		* Enabled cache temporary
-		*/
-		public function cached($ttl = 0){
-		  if ($ttl > 0){
-			$this->_database = $this->_database->cached($ttl);
-		  }
-		  return $this;
-		}
+        /**
+         * Enabled cache temporary
+         */
+        public function cached($ttl = 0){
+            if ($ttl > 0){
+            $this->_database = $this->_database->cached($ttl);
+            }
+            return $this;
+        }
 
         /**
          * Tell the class to skip the insert validation
@@ -585,10 +585,10 @@ 
          */
         public function get_next_id()
         {
-			$this->getQueryBuilder()->select('AUTO_INCREMENT')
-									->from('information_schema.TABLES')
-									->where('TABLE_NAME', $this->_table)
-									->where('TABLE_SCHEMA', $this->_database->getDatabaseName());
+            $this->getQueryBuilder()->select('AUTO_INCREMENT')
+                                    ->from('information_schema.TABLES')
+                                    ->where('TABLE_NAME', $this->_table)
+                                    ->where('TABLE_SCHEMA', $this->_database->getDatabaseName());
             return (int) $this->_database->get()->AUTO_INCREMENT;
         }
 
@@ -711,24 +711,24 @@ 
             {
                 if (is_object($row))
                 {
-					if (isset($row->$attr)){
-						unset($row->$attr);
-					}
+                    if (isset($row->$attr)){
+                        unset($row->$attr);
+                    }
                 }
                 else
                 {
-					if (isset($row[$attr])){
-						unset($row[$attr]);
-					}
+                    if (isset($row[$attr])){
+                        unset($row[$attr]);
+                    }
                 }
             }
             return $row;
         }
 		
-		 /**
-         * Return the database instance
-         * @return Database the database instance
-         */
+            /**
+             * Return the database instance
+             * @return Database the database instance
+             */
         public function getDatabaseInstance(){
             return $this->_database;
         }
@@ -737,7 +737,7 @@ 
          * set the Database instance for future use
          * @param Database $db the database object
          */
-         public function setDatabaseInstance($db){
+            public function setDatabaseInstance($db){
             $this->_database = $db;
             if ($this->dbCacheTime > 0){
                 $this->_database->setCache($this->dbCacheTime);
@@ -756,14 +756,14 @@ 
         /**
          * Set the loader instance for future use
          * @param Loader $loader the loader object
-		 * @return object
+         * @return object
          */
-         public function setLoader($loader){
+            public function setLoader($loader){
             $this->loaderInstance = $loader;
             return $this;
         }
 
-		/**
+        /**
          * Return the queryBuilder instance this is the shortcut to database queryBuilder
          * @return object the DatabaseQueryBuilder instance
          */
@@ -774,9 +774,9 @@ 
         /**
          * Set the DatabaseQueryBuilder instance for future use
          * @param object $queryBuilder the DatabaseQueryBuilder object
-		 * @return object
+         * @return object
          */
-         public function setQueryBuilder($queryBuilder){
+            public function setQueryBuilder($queryBuilder){
             $this->_database->setQueryBuilder($queryBuilder);
             return $this;
         }
@@ -793,9 +793,9 @@ 
         /**
          * Set the form validation instance for future use
          * @param FormValidation $fv the form validation object
-		 * @return object
+         * @return object
          */
-         public function setFormValidation($fv){
+            public function setFormValidation($fv){
             $this->formValidationInstance = $fv;
             return $this;
         }
@@ -836,12 +836,12 @@ 
          * INTERNAL METHODS
          * ------------------------------------------------------------ */
 
-		/**
-		* relate for the relation "belongs_to"
-		* @return mixed
-		*/
-		protected function relateBelongsTo($row){
-			foreach ($this->belongs_to as $key => $value)
+        /**
+         * relate for the relation "belongs_to"
+         * @return mixed
+         */
+        protected function relateBelongsTo($row){
+            foreach ($this->belongs_to as $key => $value)
             {
                 if (is_string($value))
                 {
@@ -872,15 +872,15 @@ 
                     }
                 }
             }
-			return $row;
-		}
-
-		/**
-		* relate for the relation "has_many"
-		* @return mixed
-		*/
-		protected function relateHasMany($row){
-			foreach ($this->has_many as $key => $value)
+            return $row;
+        }
+
+        /**
+         * relate for the relation "has_many"
+         * @return mixed
+         */
+        protected function relateHasMany($row){
+            foreach ($this->has_many as $key => $value)
             {
                 if (is_string($value))
                 {
@@ -911,8 +911,8 @@ 
                     }
                 }
             }
-			return $row;
-		}
+            return $row;
+        }
 		
         /**
          * Trigger an event and call its observers. Pass through the event name
@@ -977,30 +977,30 @@ 
         }
 		
 		
-		/**
-		* Set WHERE parameters, when is array
-		* @param array $params
-		*/
-		protected function _set_where_array(array $params){
-			foreach ($params as $field => $filter)
-			{
-				if (is_array($filter))
-				{
-					$this->getQueryBuilder()->in($field, $filter);
-				}
-				else
-				{
-					if (is_int($field))
-					{
-						$this->getQueryBuilder()->where($filter);
-					}
-					else
-					{
-						$this->getQueryBuilder()->where($field, $filter);
-					}
-				}
-			}
-		}
+        /**
+         * Set WHERE parameters, when is array
+         * @param array $params
+         */
+        protected function _set_where_array(array $params){
+            foreach ($params as $field => $filter)
+            {
+                if (is_array($filter))
+                {
+                    $this->getQueryBuilder()->in($field, $filter);
+                }
+                else
+                {
+                    if (is_int($field))
+                    {
+                        $this->getQueryBuilder()->where($filter);
+                    }
+                    else
+                    {
+                        $this->getQueryBuilder()->where($field, $filter);
+                    }
+                }
+            }
+        }
 
 
         /**
@@ -1016,8 +1016,8 @@ 
             {
                 $this->getQueryBuilder()->where($params[0]);
             }
-        	else if (count($params) == 2)
-    		{
+            else if (count($params) == 2)
+            {
                 if (is_array($params[1]))
                 {
                     $this->getQueryBuilder()->in($params[0], $params[1]);
@@ -1026,11 +1026,11 @@ 
                 {
                     $this->getQueryBuilder()->where($params[0], $params[1]);
                 }
-    		}
-    		else if (count($params) == 3)
-    		{
-    			$this->getQueryBuilder()->where($params[0], $params[1], $params[2]);
-    		}
+            }
+            else if (count($params) == 3)
+            {
+                $this->getQueryBuilder()->where($params[0], $params[1], $params[2]);
+            }
             else
             {
                 if (is_array($params[1]))
@@ -1046,7 +1046,7 @@ 
 
         /**
             Shortcut to controller
-        */
+         */
         public function __get($key){
             return get_instance()->{$key};
         }

core/classes/Lang.php

Indentation +205 added lines, -205 removed lines

@@ -1,208 +1,208 @@
 <?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.
-	*/
-
-	/**
-	 * For application languages management
-	 */
-	class Lang{
+    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.
+     */
+
+    /**
+     * For application languages management
+     */
+    class Lang{
 		
-		/**
-		 * The supported available language for this application.
-		 * @example "en" => "english" 
-		 * @see Lang::addLang()
-		 * @var array
-		 */
-		protected $availables = array();
-
-		/**
-		 * The all messages language
-		 * @var array
-		 */
-		protected $languages = array();
-
-		/**
-		 * The default language to use if can not
-		 *  determine the client language
-		 *  
-		 * @example $default = 'en'
-		 * @var string
-		 */
-		protected $default = null;
-
-		/**
-		 * The current client language
-		 * @var string
-		 */
-		protected $current = null;
-
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
-
-		/**
-		 * Construct new Lang instance
-		 */
-		public function __construct(){
-	        $this->logger =& class_loader('Log', 'classes');
-	        $this->logger->setLogger('Library::Lang');
-
-			$this->default = get_config('default_language', 'en');
-			$this->logger->debug('Setting the supported languages');
+        /**
+         * The supported available language for this application.
+         * @example "en" => "english" 
+         * @see Lang::addLang()
+         * @var array
+         */
+        protected $availables = array();
+
+        /**
+         * The all messages language
+         * @var array
+         */
+        protected $languages = array();
+
+        /**
+         * The default language to use if can not
+         *  determine the client language
+         *  
+         * @example $default = 'en'
+         * @var string
+         */
+        protected $default = null;
+
+        /**
+         * The current client language
+         * @var string
+         */
+        protected $current = null;
+
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
+
+        /**
+         * Construct new Lang instance
+         */
+        public function __construct(){
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Lang');
+
+            $this->default = get_config('default_language', 'en');
+            $this->logger->debug('Setting the supported languages');
 			
-			//add the supported languages ('key', 'display name')
-			$languages = get_config('languages', null);
-			if(! empty($languages)){
-				foreach($languages as $key => $displayName){
-					$this->addLang($key, $displayName);
-				}
-			}
-			unset($languages);
-
-			//if the language exists in cookie use it
-			$cfgKey = get_config('language_cookie_name');
-			$this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
-			$objCookie = & class_loader('Cookie');
-			$cookieLang = $objCookie->get($cfgKey);
-			if($cookieLang && $this->isValid($cookieLang)){
-				$this->current = $cookieLang;
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
-			}
-			else{
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
-				$this->current = $this->getDefault();
-			}
-		}
-
-		/**
-		 * Get the all languages messages
-		 *
-		 * @return array the language message list
-		 */
-		public function getAll(){
-			return $this->languages;
-		}
-
-		/**
-		 * Set the language message
-		 *
-		 * @param string $key the language key to identify
-		 * @param string $value the language message value
-		 */
-		public function set($key, $value){
-			$this->languages[$key] = $value;
-		}
-
-		/**
-		 * Get the language message for the given key. If can't find return the default value
-		 *
-		 * @param  string $key the message language key
-		 * @param  string $default the default value to return if can not found the language message key
-		 *
-		 * @return string the language message value
-		 */
-		public function get($key, $default = 'LANGUAGE_ERROR'){
-			if(isset($this->languages[$key])){
-				return $this->languages[$key];
-			}
-			$this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
-			return $default;
-		}
-
-		/**
-		 * Check whether the language file for given name exists
-		 *
-		 * @param  string  $language the language name like "fr", "en", etc.
-		 *
-		 * @return boolean true if the language directory exists, false or not
-		 */
-		public function isValid($language){
-			$searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
-			foreach($searchDir as $dir){
-				if(file_exists($dir . $language) && is_dir($dir . $language)){
-					return true;
-				}
-			}
-			return false;
-		}
-
-		/**
-		 * Get the default language value like "en" , "fr", etc.
-		 *
-		 * @return string the default language
-		 */
-		public function getDefault(){
-			return $this->default;
-		}
-
-		/**
-		 * Get the current language defined by cookie or the default value
-		 *
-		 * @return string the current language
-		 */
-		public function getCurrent(){
-			return $this->current;
-		}
-
-		/**
-		 * Add new supported or available language
-		 *
-		 * @param string $name the short language name like "en", "fr".
-		 * @param string $description the human readable description of this language
-		 */
-		public function addLang($name, $description){
-			if(isset($this->availables[$name])){
-				return; //already added cost in performance
-			}
-			if($this->isValid($name)){
-				$this->availables[$name] = $description;
-			}
-			else{
-				show_error('The language [' . $name . '] is not valid or does not exists.');
-			}
-		}
-
-		/**
-		 * Get the list of the application supported language
-		 *
-		 * @return array the list of the application language
-		 */
-		public function getSupported(){
-			return $this->availables;
-		}
-
-		/**
-		 * Add new language messages
-		 *
-		 * @param array $langs the languages array of the messages to be added
-		 */
-		public function addLangMessages(array $langs){
-			foreach ($langs as $key => $value) {
-				$this->set($key, $value);
-			}
-		}
-	}
+            //add the supported languages ('key', 'display name')
+            $languages = get_config('languages', null);
+            if(! empty($languages)){
+                foreach($languages as $key => $displayName){
+                    $this->addLang($key, $displayName);
+                }
+            }
+            unset($languages);
+
+            //if the language exists in cookie use it
+            $cfgKey = get_config('language_cookie_name');
+            $this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
+            $objCookie = & class_loader('Cookie');
+            $cookieLang = $objCookie->get($cfgKey);
+            if($cookieLang && $this->isValid($cookieLang)){
+                $this->current = $cookieLang;
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
+            }
+            else{
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
+                $this->current = $this->getDefault();
+            }
+        }
+
+        /**
+         * Get the all languages messages
+         *
+         * @return array the language message list
+         */
+        public function getAll(){
+            return $this->languages;
+        }
+
+        /**
+         * Set the language message
+         *
+         * @param string $key the language key to identify
+         * @param string $value the language message value
+         */
+        public function set($key, $value){
+            $this->languages[$key] = $value;
+        }
+
+        /**
+         * Get the language message for the given key. If can't find return the default value
+         *
+         * @param  string $key the message language key
+         * @param  string $default the default value to return if can not found the language message key
+         *
+         * @return string the language message value
+         */
+        public function get($key, $default = 'LANGUAGE_ERROR'){
+            if(isset($this->languages[$key])){
+                return $this->languages[$key];
+            }
+            $this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
+            return $default;
+        }
+
+        /**
+         * Check whether the language file for given name exists
+         *
+         * @param  string  $language the language name like "fr", "en", etc.
+         *
+         * @return boolean true if the language directory exists, false or not
+         */
+        public function isValid($language){
+            $searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
+            foreach($searchDir as $dir){
+                if(file_exists($dir . $language) && is_dir($dir . $language)){
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /**
+         * Get the default language value like "en" , "fr", etc.
+         *
+         * @return string the default language
+         */
+        public function getDefault(){
+            return $this->default;
+        }
+
+        /**
+         * Get the current language defined by cookie or the default value
+         *
+         * @return string the current language
+         */
+        public function getCurrent(){
+            return $this->current;
+        }
+
+        /**
+         * Add new supported or available language
+         *
+         * @param string $name the short language name like "en", "fr".
+         * @param string $description the human readable description of this language
+         */
+        public function addLang($name, $description){
+            if(isset($this->availables[$name])){
+                return; //already added cost in performance
+            }
+            if($this->isValid($name)){
+                $this->availables[$name] = $description;
+            }
+            else{
+                show_error('The language [' . $name . '] is not valid or does not exists.');
+            }
+        }
+
+        /**
+         * Get the list of the application supported language
+         *
+         * @return array the list of the application language
+         */
+        public function getSupported(){
+            return $this->availables;
+        }
+
+        /**
+         * Add new language messages
+         *
+         * @param array $langs the languages array of the messages to be added
+         */
+        public function addLangMessages(array $langs){
+            foreach ($langs as $key => $value) {
+                $this->set($key, $value);
+            }
+        }
+    }

core/functions/function_lang.php

Indentation +46 added lines, -46 removed lines

@@ -1,52 +1,52 @@
 <?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.
+     */
 
-	if(! function_exists('__')){
-		/**
-		 * function for the shortcut to Lang::get()
-		 * @param  string $key the language key to retrieve
-		 * @param mixed $default the default value to return if can not find the value
-		 * for the given key
-		 * @return string  the language value
-		 */
-		function __($key, $default = 'LANGUAGE_ERROR'){
-			return get_instance()->lang->get($key, $default);
-		}
+    if(! function_exists('__')){
+        /**
+         * function for the shortcut to Lang::get()
+         * @param  string $key the language key to retrieve
+         * @param mixed $default the default value to return if can not find the value
+         * for the given key
+         * @return string  the language value
+         */
+        function __($key, $default = 'LANGUAGE_ERROR'){
+            return get_instance()->lang->get($key, $default);
+        }
 
-	}
+    }
 
 
-	if(! function_exists('get_languages')){
-		/**
-		 * function for the shortcut to Lang::getSupported()
-		 * 
-		 * @return array all the supported languages
-		 */
-		function get_languages(){
-			return get_instance()->lang->getSupported();
-		}
+    if(! function_exists('get_languages')){
+        /**
+         * function for the shortcut to Lang::getSupported()
+         * 
+         * @return array all the supported languages
+         */
+        function get_languages(){
+            return get_instance()->lang->getSupported();
+        }
 
-	}
\ No newline at end of file
+    }
\ No newline at end of file