tnhfw / tnh-fw

core/classes/EventDispatcher.php

Indentation +163 added lines, -163 removed lines

@@ -1,175 +1,175 @@
 <?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 extends BaseClass{
+    class EventDispatcher extends BaseClass{
 		
-		/**
-		 * The list of the registered listeners
-		 * @var array
-		 */
-		private $listeners = array();
+        /**
+         * The list of the registered listeners
+         * @var array
+         */
+        private $listeners = array();
 		
 
-		public function __construct(){
-			parent::__construct();
-		}
+        public function __construct(){
+            parent::__construct();
+        }
 
-		/**
-		 * 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/Response.php

Indentation +463 added lines, -463 removed lines

@@ -1,511 +1,511 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Response extends BaseStaticClass{
+    class Response extends BaseStaticClass{
 
-		/**
-		 * The list of request header to send with response
-		 * @var array
-		 */
-		private static $headers = array();
+        /**
+         * The list of request header to send with response
+         * @var array
+         */
+        private static $headers = array();
 		
-		/**
-		 * The final page content to display to user
-		 * @var string
-		 */
-		private $_pageRender = null;
+        /**
+         * The final page content to display to user
+         * @var string
+         */
+        private $_pageRender = null;
 		
-		/**
-		 * The current request URL
-		 * @var string
-		 */
-		private $_currentUrl = null;
+        /**
+         * The current request URL
+         * @var string
+         */
+        private $_currentUrl = null;
 		
-		/**
-		 * The current request URL cache key
-		 * @var string
-		 */
-		private $_currentUrlCacheKey = null;
+        /**
+         * The current request URL cache key
+         * @var string
+         */
+        private $_currentUrlCacheKey = null;
 		
-		/**
-		* Whether we can compress the output using Gzip
-		* @var boolean
-		*/
-		private static $_canCompressOutput = false;
+        /**
+         * Whether we can compress the output using Gzip
+         * @var boolean
+         */
+        private static $_canCompressOutput = false;
 		
-		/**
-		 * Construct new response instance
-		 */
-		public function __construct(){
-			$currentUrl = '';
-			if (! empty($_SERVER['REQUEST_URI'])){
-				$currentUrl = $_SERVER['REQUEST_URI'];
-			}
-			if (! empty($_SERVER['QUERY_STRING'])){
-				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
-			}
-			$this->_currentUrl =  $currentUrl;
+        /**
+         * Construct new response instance
+         */
+        public function __construct(){
+            $currentUrl = '';
+            if (! empty($_SERVER['REQUEST_URI'])){
+                $currentUrl = $_SERVER['REQUEST_URI'];
+            }
+            if (! empty($_SERVER['QUERY_STRING'])){
+                $currentUrl .= '?' . $_SERVER['QUERY_STRING'];
+            }
+            $this->_currentUrl =  $currentUrl;
 					
-			$this->_currentUrlCacheKey = md5($this->_currentUrl);
+            $this->_currentUrlCacheKey = md5($this->_currentUrl);
 			
-			self::$_canCompressOutput = get_config('compress_output')
-										  && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
-										  && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
-										  && extension_loaded('zlib')
-										  && (bool) ini_get('zlib.output_compression') === false;
-		}
+            self::$_canCompressOutput = get_config('compress_output')
+                                          && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
+                                          && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
+                                          && extension_loaded('zlib')
+                                          && (bool) ini_get('zlib.output_compression') === false;
+        }
 
 		
-		/**
-		 * Send the HTTP Response headers
-		 * @param  integer $httpCode the HTTP status code
-		 * @param  array   $headers   the additional headers to add to the existing headers list
-		 */
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
-			set_http_status_header($httpCode);
-			self::setHeaders($headers);
-			if(! headers_sent()){
-				foreach(self::getHeaders() as $key => $value){
-					header($key .': '.$value);
-				}
-			}
-		}
+        /**
+         * Send the HTTP Response headers
+         * @param  integer $httpCode the HTTP status code
+         * @param  array   $headers   the additional headers to add to the existing headers list
+         */
+        public static function sendHeaders($httpCode = 200, array $headers = array()){
+            set_http_status_header($httpCode);
+            self::setHeaders($headers);
+            if(! headers_sent()){
+                foreach(self::getHeaders() as $key => $value){
+                    header($key .': '.$value);
+                }
+            }
+        }
 
-		/**
-		 * Get the list of the headers
-		 * @return array the headers list
-		 */
-		public static function getHeaders(){
-			return self::$headers;
-		}
+        /**
+         * Get the list of the headers
+         * @return array the headers list
+         */
+        public static function getHeaders(){
+            return self::$headers;
+        }
 
-		/**
-		 * Get the header value for the given name
-		 * @param  string $name the header name
-		 * @return string|null       the header value
-		 */
-		public static function getHeader($name){
-			if(array_key_exists($name, self::$headers)){
-				return self::$headers[$name];
-			}
-			return null;
-		}
+        /**
+         * Get the header value for the given name
+         * @param  string $name the header name
+         * @return string|null       the header value
+         */
+        public static function getHeader($name){
+            if(array_key_exists($name, self::$headers)){
+                return self::$headers[$name];
+            }
+            return null;
+        }
 
 
-		/**
-		 * Set the header value for the specified name
-		 * @param string $name  the header name
-		 * @param string $value the header value to be set
-		 */
-		public static function setHeader($name, $value){
-			self::$headers[$name] = $value;
-		}
+        /**
+         * Set the header value for the specified name
+         * @param string $name  the header name
+         * @param string $value the header value to be set
+         */
+        public static function setHeader($name, $value){
+            self::$headers[$name] = $value;
+        }
 
-		/**
-		 * Set the headers using array
-		 * @param array $headers the list of the headers to set. 
-		 * Note: this will merge with the existing headers
-		 */
-		public static function setHeaders(array $headers){
-			self::$headers = array_merge(self::getHeaders(), $headers);
-		}
+        /**
+         * Set the headers using array
+         * @param array $headers the list of the headers to set. 
+         * Note: this will merge with the existing headers
+         */
+        public static function setHeaders(array $headers){
+            self::$headers = array_merge(self::getHeaders(), $headers);
+        }
 		
-		/**
-		 * Redirect user to the specified page
-		 * @param  string $path the URL or URI to be redirect to
-		 */
-		public static function redirect($path = ''){
-			$logger = self::getLogger();
-			$url = Url::site_url($path);
-			$logger->info('Redirect to URL [' .$url. ']');
-			if(! headers_sent()){
-				header('Location: '.$url);
-				exit;
-			}
-			echo '<script>
+        /**
+         * Redirect user to the specified page
+         * @param  string $path the URL or URI to be redirect to
+         */
+        public static function redirect($path = ''){
+            $logger = self::getLogger();
+            $url = Url::site_url($path);
+            $logger->info('Redirect to URL [' .$url. ']');
+            if(! headers_sent()){
+                header('Location: '.$url);
+                exit;
+            }
+            echo '<script>
 					location.href = "'.$url.'";
 				</script>';
-		}
+        }
 
-		/**
-		 * Render the view to display later or return the content
-		 * @param  string  $view   the view name or path
-		 * @param  array|object   $data   the variable data to use in the view
-		 * @param  boolean $return whether to return the view generated content or display it directly
-		 * @return void|string          if $return is true will return the view content otherwise
-		 * will display the view content.
-		 */
-		public function render($view, $data = null, $return = false){
-			$logger = self::getLogger();
-			//convert data to an array
-			$data = (array) $data;
-			$view = str_ireplace('.php', '', $view);
-			$view = trim($view, '/\\');
-			$viewFile = $view . '.php';
-			$path = APPS_VIEWS_PATH . $viewFile;
+        /**
+         * Render the view to display later or return the content
+         * @param  string  $view   the view name or path
+         * @param  array|object   $data   the variable data to use in the view
+         * @param  boolean $return whether to return the view generated content or display it directly
+         * @return void|string          if $return is true will return the view content otherwise
+         * will display the view content.
+         */
+        public function render($view, $data = null, $return = false){
+            $logger = self::getLogger();
+            //convert data to an array
+            $data = (array) $data;
+            $view = str_ireplace('.php', '', $view);
+            $view = trim($view, '/\\');
+            $viewFile = $view . '.php';
+            $path = APPS_VIEWS_PATH . $viewFile;
 			
-			//check in module first
-			$logger->debug('Checking the view [' . $view . '] from module list ...');
-			$moduleInfo = $this->getModuleInfoForView($view);
-			$module    = $moduleInfo['module'];
-			$view  = $moduleInfo['view'];
+            //check in module first
+            $logger->debug('Checking the view [' . $view . '] from module list ...');
+            $moduleInfo = $this->getModuleInfoForView($view);
+            $module    = $moduleInfo['module'];
+            $view  = $moduleInfo['view'];
 			
-			$moduleViewPath = Module::findViewFullPath($view, $module);
-			if($moduleViewPath){
-				$path = $moduleViewPath;
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
-			}
-			else{
-				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
-			}
+            $moduleViewPath = Module::findViewFullPath($view, $module);
+            if($moduleViewPath){
+                $path = $moduleViewPath;
+                $logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
+            }
+            else{
+                $logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
+            }
 			
-			$logger->info('The view file path to be loaded is [' . $path . ']');
+            $logger->info('The view file path to be loaded is [' . $path . ']');
 			
-			/////////
-			if($return){
-				return $this->loadView($path, $data, true);
-			}
-			$this->loadView($path, $data, false);
-		}
+            /////////
+            if($return){
+                return $this->loadView($path, $data, true);
+            }
+            $this->loadView($path, $data, false);
+        }
 
 		
-		/**
-		* Send the final page output to user
-		*/
-		public function renderFinalPage(){
-			$logger = self::getLogger();
-			$obj = & get_instance();
-			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
-			$dispatcher = $obj->eventdispatcher;
-			$content = $this->_pageRender;
-			if(! $content){
-				$logger->warning('The final view content is empty.');
-				return;
-			}
-			//dispatch
-			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
-			$content = null;
-			if(! empty($event->payload)){
-				$content = $event->payload;
-			}
-			if(empty($content)){
-				$logger->warning('The view content is empty after dispatch to event listeners.');
-			}
-			//remove unsed space in the content
-			$content = preg_replace('~>\s*\n\s*<~', '><', $content);
-			//check whether need save the page into cache.
-			if($cachePageStatus){
-				$this->savePageContentIntoCache($content);
-			}
-			$content = $this->replaceElapseTimeAndMemoryUsage($content);
+        /**
+         * Send the final page output to user
+         */
+        public function renderFinalPage(){
+            $logger = self::getLogger();
+            $obj = & get_instance();
+            $cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
+            $dispatcher = $obj->eventdispatcher;
+            $content = $this->_pageRender;
+            if(! $content){
+                $logger->warning('The final view content is empty.');
+                return;
+            }
+            //dispatch
+            $event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
+            $content = null;
+            if(! empty($event->payload)){
+                $content = $event->payload;
+            }
+            if(empty($content)){
+                $logger->warning('The view content is empty after dispatch to event listeners.');
+            }
+            //remove unsed space in the content
+            $content = preg_replace('~>\s*\n\s*<~', '><', $content);
+            //check whether need save the page into cache.
+            if($cachePageStatus){
+                $this->savePageContentIntoCache($content);
+            }
+            $content = $this->replaceElapseTimeAndMemoryUsage($content);
 
-			//compress the output if is available
-			$type = null;
-			if (self::$_canCompressOutput){
-				$type = 'ob_gzhandler';
-			}
-			ob_start($type);
-			self::sendHeaders(200);
-			echo $content;
-			ob_end_flush();
-		}
+            //compress the output if is available
+            $type = null;
+            if (self::$_canCompressOutput){
+                $type = 'ob_gzhandler';
+            }
+            ob_start($type);
+            self::sendHeaders(200);
+            echo $content;
+            ob_end_flush();
+        }
 
 		
-		/**
-		* Send the final page output to user if is cached
-		* @param object $cache the cache instance
-		*
-		* @return boolean whether the page content if available or not
-		*/
-		public function renderFinalPageFromCache(&$cache){
-			$logger = self::getLogger();
-			//the current page cache key for identification
-			$pageCacheKey = $this->_currentUrlCacheKey;
+        /**
+         * Send the final page output to user if is cached
+         * @param object $cache the cache instance
+         *
+         * @return boolean whether the page content if available or not
+         */
+        public function renderFinalPageFromCache(&$cache){
+            $logger = self::getLogger();
+            //the current page cache key for identification
+            $pageCacheKey = $this->_currentUrlCacheKey;
 			
-			$logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
-			//get the cache information to prepare header to send to browser
-			$cacheInfo = $cache->getInfo($pageCacheKey);
-			if($cacheInfo){
-				$status = $this->sendCacheNotYetExpireInfoToBrowser($cacheInfo);
-				if($status === false){
-					return $this->sendCachePageContentToBrowser($cache);
-				}
-				return true;
-			}
-			return false;
-		}
+            $logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
+            //get the cache information to prepare header to send to browser
+            $cacheInfo = $cache->getInfo($pageCacheKey);
+            if($cacheInfo){
+                $status = $this->sendCacheNotYetExpireInfoToBrowser($cacheInfo);
+                if($status === false){
+                    return $this->sendCachePageContentToBrowser($cache);
+                }
+                return true;
+            }
+            return false;
+        }
 	
 		
-		/**
-		* Get the final page to be rendered
-		* @return string
-		*/
-		public function getFinalPageRendered(){
-			return $this->_pageRender;
-		}
+        /**
+         * Get the final page to be rendered
+         * @return string
+         */
+        public function getFinalPageRendered(){
+            return $this->_pageRender;
+        }
 
-		/**
-		 * Send the HTTP 404 error if can not found the 
-		 * routing information for the current request
-		 */
-		public static function send404(){
-			/********* for logs **************/
-			//can't use $obj = & get_instance()  here because the global super object will be available until
-			//the main controller is loaded even for Loader::library('xxxx');
-			$logger = self::getLogger();
-			$request =& class_loader('Request', 'classes');
-			$userAgent =& class_loader('Browser');
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
+        /**
+         * Send the HTTP 404 error if can not found the 
+         * routing information for the current request
+         */
+        public static function send404(){
+            /********* for logs **************/
+            //can't use $obj = & get_instance()  here because the global super object will be available until
+            //the main controller is loaded even for Loader::library('xxxx');
+            $logger = self::getLogger();
+            $request =& class_loader('Request', 'classes');
+            $userAgent =& class_loader('Browser');
+            $browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
 			
-			//here can't use Loader::functions just include the helper manually
-			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+            //here can't use Loader::functions just include the helper manually
+            require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 
-			$str = '[404 page not found] : ';
-			$str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
-			$logger->error($str);
-			/***********************************/
-			$path = CORE_VIEWS_PATH . '404.php';
-			if(file_exists($path)){
-				//compress the output if is available
-				$type = null;
-				if (self::$_canCompressOutput){
-					$type = 'ob_gzhandler';
-				}
-				ob_start($type);
-				require_once $path;
-				$output = ob_get_clean();
-				self::sendHeaders(404);
-				echo $output;
-			}
-			else{
-				show_error('The 404 view [' .$path. '] does not exist');
-			}
-		}
+            $str = '[404 page not found] : ';
+            $str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
+            $logger->error($str);
+            /***********************************/
+            $path = CORE_VIEWS_PATH . '404.php';
+            if(file_exists($path)){
+                //compress the output if is available
+                $type = null;
+                if (self::$_canCompressOutput){
+                    $type = 'ob_gzhandler';
+                }
+                ob_start($type);
+                require_once $path;
+                $output = ob_get_clean();
+                self::sendHeaders(404);
+                echo $output;
+            }
+            else{
+                show_error('The 404 view [' .$path. '] does not exist');
+            }
+        }
 
-		/**
-		 * Display the error to user
-		 * @param  array  $data the error information
-		 */
-		public static function sendError(array $data = array()){
-			$path = CORE_VIEWS_PATH . 'errors.php';
-			if(file_exists($path)){
-				//compress the output if is available
-				$type = null;
-				if (self::$_canCompressOutput){
-					$type = 'ob_gzhandler';
-				}
-				ob_start($type);
-				extract($data);
-				require_once $path;
-				$output = ob_get_clean();
-				self::sendHeaders(503);
-				echo $output;
-			}
-			else{
-				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
-				set_http_status_header(503);
-				echo 'The error view [' . $path . '] does not exist';
-			}
-		}
+        /**
+         * Display the error to user
+         * @param  array  $data the error information
+         */
+        public static function sendError(array $data = array()){
+            $path = CORE_VIEWS_PATH . 'errors.php';
+            if(file_exists($path)){
+                //compress the output if is available
+                $type = null;
+                if (self::$_canCompressOutput){
+                    $type = 'ob_gzhandler';
+                }
+                ob_start($type);
+                extract($data);
+                require_once $path;
+                $output = ob_get_clean();
+                self::sendHeaders(503);
+                echo $output;
+            }
+            else{
+                //can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
+                set_http_status_header(503);
+                echo 'The error view [' . $path . '] does not exist';
+            }
+        }
 
-		/**
-		 * Send the cache not yet expire to browser
-		 * @param  array $cacheInfo the cache information
-		 * @return boolean            true if the information is sent otherwise false
-		 */
-		protected function sendCacheNotYetExpireInfoToBrowser($cacheInfo){
-			if(! empty($cacheInfo)){
-				$logger = self::getLogger();
-				$lastModified = $cacheInfo['mtime'];
-				$expire = $cacheInfo['expire'];
-				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
-				self::setHeader('Pragma', 'public');
-				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
-					$logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
-					self::sendHeaders(304);
-					return true;
-				}
-			}
-			return false;
-		}
+        /**
+         * Send the cache not yet expire to browser
+         * @param  array $cacheInfo the cache information
+         * @return boolean            true if the information is sent otherwise false
+         */
+        protected function sendCacheNotYetExpireInfoToBrowser($cacheInfo){
+            if(! empty($cacheInfo)){
+                $logger = self::getLogger();
+                $lastModified = $cacheInfo['mtime'];
+                $expire = $cacheInfo['expire'];
+                $maxAge = $expire - $_SERVER['REQUEST_TIME'];
+                self::setHeader('Pragma', 'public');
+                self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
+                self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
+                self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
+                if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
+                    $logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
+                    self::sendHeaders(304);
+                    return true;
+                }
+            }
+            return false;
+        }
 
-		/**
-		 * Set the value of '{elapsed_time}' and '{memory_usage}'
-		 * @param  string $content the page content
-		 * @return string          the page content after replace 
-		 * '{elapsed_time}', '{memory_usage}'
-		 */
-		protected function replaceElapseTimeAndMemoryUsage($content){
-			//load benchmark class
-			$benchmark = & class_loader('Benchmark');
+        /**
+         * Set the value of '{elapsed_time}' and '{memory_usage}'
+         * @param  string $content the page content
+         * @return string          the page content after replace 
+         * '{elapsed_time}', '{memory_usage}'
+         */
+        protected function replaceElapseTimeAndMemoryUsage($content){
+            //load benchmark class
+            $benchmark = & class_loader('Benchmark');
 			
-			// Parse out the elapsed time and memory usage,
-			// then swap the pseudo-variables with the data
-			$elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
-			$memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
-			return str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);	
-		}
+            // Parse out the elapsed time and memory usage,
+            // then swap the pseudo-variables with the data
+            $elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
+            $memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
+            return str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);	
+        }
 
-		/**
-		 * Send the page content from cache to browser
-		 * @param object $cache the cache instance
-		 * @return boolean     the status of the operation
-		 */
-		protected function sendCachePageContentToBrowser(&$cache){
-			$logger = self::getLogger();
-			$logger->info('The cache page content is expired or the browser does not send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
-			self::sendHeaders(200);
-			//current page cache key
-			$pageCacheKey = $this->_currentUrlCacheKey;
-			//get the cache content
-			$content = $cache->get($pageCacheKey);
-			if($content){
-				$logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
-				$content = $this->replaceElapseTimeAndMemoryUsage($content);
-				///display the final output
-				//compress the output if is available
-				$type = null;
-				if (self::$_canCompressOutput){
-					$type = 'ob_gzhandler';
-				}
-				ob_start($type);
-				echo $content;
-				ob_end_flush();
-				return true;
-			}
-			$logger->info('The page cache content for the URL [' . $this->_currentUrl . '] is not valid may be already expired');
-			$cache->delete($pageCacheKey);
-			return false;
-		}
+        /**
+         * Send the page content from cache to browser
+         * @param object $cache the cache instance
+         * @return boolean     the status of the operation
+         */
+        protected function sendCachePageContentToBrowser(&$cache){
+            $logger = self::getLogger();
+            $logger->info('The cache page content is expired or the browser does not send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
+            self::sendHeaders(200);
+            //current page cache key
+            $pageCacheKey = $this->_currentUrlCacheKey;
+            //get the cache content
+            $content = $cache->get($pageCacheKey);
+            if($content){
+                $logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
+                $content = $this->replaceElapseTimeAndMemoryUsage($content);
+                ///display the final output
+                //compress the output if is available
+                $type = null;
+                if (self::$_canCompressOutput){
+                    $type = 'ob_gzhandler';
+                }
+                ob_start($type);
+                echo $content;
+                ob_end_flush();
+                return true;
+            }
+            $logger->info('The page cache content for the URL [' . $this->_currentUrl . '] is not valid may be already expired');
+            $cache->delete($pageCacheKey);
+            return false;
+        }
 
-		/**
-		 * Save the content of page into cache
-		 * @param  string $content the page content to be saved
-		 * @return void
-		 */
-		protected function savePageContentIntoCache($content){
-			$obj = & get_instance();
-			$logger = self::getLogger();
+        /**
+         * Save the content of page into cache
+         * @param  string $content the page content to be saved
+         * @return void
+         */
+        protected function savePageContentIntoCache($content){
+            $obj = & get_instance();
+            $logger = self::getLogger();
 
-			//current page URL
-			$url = $this->_currentUrl;
-			//Cache view Time to live in second
-			$viewCacheTtl = get_config('cache_ttl');
-			if (!empty($obj->view_cache_ttl)){
-				$viewCacheTtl = $obj->view_cache_ttl;
-			}
-			//the cache handler instance
-			$cacheInstance = $obj->cache;
-			//the current page cache key for identification
-			$cacheKey = $this->_currentUrlCacheKey;
-			$logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
-			$cacheInstance->set($cacheKey, $content, $viewCacheTtl);
+            //current page URL
+            $url = $this->_currentUrl;
+            //Cache view Time to live in second
+            $viewCacheTtl = get_config('cache_ttl');
+            if (!empty($obj->view_cache_ttl)){
+                $viewCacheTtl = $obj->view_cache_ttl;
+            }
+            //the cache handler instance
+            $cacheInstance = $obj->cache;
+            //the current page cache key for identification
+            $cacheKey = $this->_currentUrlCacheKey;
+            $logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
+            $cacheInstance->set($cacheKey, $content, $viewCacheTtl);
 			
-			//get the cache information to prepare header to send to browser
-			$cacheInfo = $cacheInstance->getInfo($cacheKey);
-			if($cacheInfo){
-				$lastModified = $cacheInfo['mtime'];
-				$expire = $cacheInfo['expire'];
-				$maxAge = $expire - time();
-				self::setHeader('Pragma', 'public');
-				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
-			}
-		}
+            //get the cache information to prepare header to send to browser
+            $cacheInfo = $cacheInstance->getInfo($cacheKey);
+            if($cacheInfo){
+                $lastModified = $cacheInfo['mtime'];
+                $expire = $cacheInfo['expire'];
+                $maxAge = $expire - time();
+                self::setHeader('Pragma', 'public');
+                self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
+                self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
+                self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
+            }
+        }
 		
 
-		/**
-		 * Get the module information for the view to load
-		 * @param  string $view the view name like moduleName/viewName, viewName
-		 * 
-		 * @return array        the module information
-		 * array(
-		 * 	'module'=> 'module_name'
-		 * 	'view' => 'view_name'
-		 * 	'viewFile' => 'view_file'
-		 * )
-		 */
-		protected  function getModuleInfoForView($view){
-			$module = null;
-			$viewFile = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($view, '/') !== false){
-				$viewPath = explode('/', $view);
-				if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
-					$module = $viewPath[0];
-					array_shift($viewPath);
-					$view = implode('/', $viewPath);
-					$viewFile = $view . '.php';
-				}
-			}
-			if(! $module && !empty($obj->moduleName)){
-				$module = $obj->moduleName;
-			}
-			return array(
-						'view' => $view,
-						'module' => $module,
-						'viewFile' => $viewFile
-					);
-		}
+        /**
+         * Get the module information for the view to load
+         * @param  string $view the view name like moduleName/viewName, viewName
+         * 
+         * @return array        the module information
+         * array(
+         * 	'module'=> 'module_name'
+         * 	'view' => 'view_name'
+         * 	'viewFile' => 'view_file'
+         * )
+         */
+        protected  function getModuleInfoForView($view){
+            $module = null;
+            $viewFile = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($view, '/') !== false){
+                $viewPath = explode('/', $view);
+                if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
+                    $module = $viewPath[0];
+                    array_shift($viewPath);
+                    $view = implode('/', $viewPath);
+                    $viewFile = $view . '.php';
+                }
+            }
+            if(! $module && !empty($obj->moduleName)){
+                $module = $obj->moduleName;
+            }
+            return array(
+                        'view' => $view,
+                        'module' => $module,
+                        'viewFile' => $viewFile
+                    );
+        }
 
-		/**
-		 * Render the view page
-		 * @see  Response::render
-		 * @return void|string
-		 */
-		protected  function loadView($path, array $data = array(), $return = false){
-			$found = false;
-			if(file_exists($path)){
-				//super instance
-				$obj = & get_instance();
-				foreach(get_object_vars($obj) as $key => $value){
-					if(! isset($this->{$key})){
-						$this->{$key} = & $obj->{$key};
-					}
-				}
-				ob_start();
-				extract($data);
-				//need use require() instead of require_once because can load this view many time
-				require $path;
-				$content = ob_get_clean();
-				if($return){
-					//remove unused html space 
-					return preg_replace('~>\s*\n\s*<~', '><', $content);
-				}
-				$this->_pageRender .= $content;
-				$found = true;
-			}
-			if(! $found){
-				show_error('Unable to find view [' .$path . ']');
-			}
-		}
+        /**
+         * Render the view page
+         * @see  Response::render
+         * @return void|string
+         */
+        protected  function loadView($path, array $data = array(), $return = false){
+            $found = false;
+            if(file_exists($path)){
+                //super instance
+                $obj = & get_instance();
+                foreach(get_object_vars($obj) as $key => $value){
+                    if(! isset($this->{$key})){
+                        $this->{$key} = & $obj->{$key};
+                    }
+                }
+                ob_start();
+                extract($data);
+                //need use require() instead of require_once because can load this view many time
+                require $path;
+                $content = ob_get_clean();
+                if($return){
+                    //remove unused html space 
+                    return preg_replace('~>\s*\n\s*<~', '><', $content);
+                }
+                $this->_pageRender .= $content;
+                $found = true;
+            }
+            if(! $found){
+                show_error('Unable to find view [' .$path . ']');
+            }
+        }
 
-	}
+    }

core/classes/BaseStaticClass.php

Indentation +53 added lines, -53 removed lines

@@ -1,58 +1,58 @@
 <?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 BaseStaticClass{
-		/**
-		 * The logger instance
-		 * @var object
-		 */
-		protected static $logger;
+    class BaseStaticClass{
+        /**
+         * The logger instance
+         * @var object
+         */
+        protected static $logger;
 
-		/**
-		 * The signleton of the logger
-		 * @return Object the Log instance
-		 */
-		public static function getLogger(){
-			if(self::$logger == null){
-				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
-				$logger[0]->setLogger('Class::' . get_called_class());
-				self::$logger = $logger[0];
-			}
-			return self::$logger;			
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        public static function getLogger(){
+            if(self::$logger == null){
+                $logger = array();
+                $logger[0] =& class_loader('Log', 'classes');
+                $logger[0]->setLogger('Class::' . get_called_class());
+                self::$logger = $logger[0];
+            }
+            return self::$logger;			
+        }
 
-		/**
-		 * Set the log instance for future use
-		 * @param object $logger the log object
-		 * @return object the log instance
-		 */
-		public static function setLogger($logger){
-			self::$logger = $logger;
-			return self::$logger;
-		}
+        /**
+         * Set the log instance for future use
+         * @param object $logger the log object
+         * @return object the log instance
+         */
+        public static function setLogger($logger){
+            self::$logger = $logger;
+            return self::$logger;
+        }
 
-	}
+    }

core/classes/Loader.php

Indentation +595 added lines, -595 removed lines

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

core/classes/Log.php

Indentation +262 added lines, -262 removed lines

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