tnhfw / tnh-fw

core/classes/Router.php

Indentation +378 added lines, -378 removed lines

@@ -1,393 +1,393 @@ 
 <?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 Router {
+    class Router {
 		
-		/**
-		* @var array $pattern: The list of URIs to validate against
-		*/
-		private $pattern = array();
+        /**
+         * @var array $pattern: The list of URIs to validate against
+         */
+        private $pattern = array();
 
-		/**
-		* @var array $callback: The list of callback to call
-		*/
-		private $callback = array();
+        /**
+         * @var array $callback: The list of callback to call
+         */
+        private $callback = array();
 
-		/**
-		* @var string $uriTrim: The char to remove from the URIs
-		*/
-		protected $uriTrim = '/\^$';
+        /**
+         * @var string $uriTrim: The char to remove from the URIs
+         */
+        protected $uriTrim = '/\^$';
 
-		/**
-		 * The module name of the current request
-		 * @var string
-		 */
-		protected $module = null;
+        /**
+         * The module name of the current request
+         * @var string
+         */
+        protected $module = null;
 		
-		/**
-		 * The controller name of the current request
-		 * @var string
-		 */
-		protected $controller = null;
+        /**
+         * The controller name of the current request
+         * @var string
+         */
+        protected $controller = null;
 
-		/**
-		 * The controller path
-		 * @var string
-		 */
-		protected $controllerPath = null;
+        /**
+         * The controller path
+         * @var string
+         */
+        protected $controllerPath = null;
 
-		/**
-		 * The method name. The default value is "index"
-		 * @var string
-		 */
-		protected $method = 'index';
+        /**
+         * The method name. The default value is "index"
+         * @var string
+         */
+        protected $method = 'index';
 
-		/**
-		 * List of argument to pass to the method
-		 * @var array
-		 */
-		protected $args = array();
+        /**
+         * List of argument to pass to the method
+         * @var array
+         */
+        protected $args = array();
 
-		/**
-		 * List of routes configurations
-		 * @var array
-		 */
-		protected $routes = array();
+        /**
+         * List of routes configurations
+         * @var array
+         */
+        protected $routes = array();
 
-		/**
-		 * The segments array for the current request
-		 * @var array
-		 */
-		protected $segments;
+        /**
+         * The segments array for the current request
+         * @var array
+         */
+        protected $segments;
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 
-		/**
-		 * Construct the new Router instance
-		 */
-		public function __construct(){
-			$this->setLoggerFromParamOrCreateNewInstance(null);
+        /**
+         * Construct the new Router instance
+         */
+        public function __construct(){
+            $this->setLoggerFromParamOrCreateNewInstance(null);
 			
-			//loading routes for module
-			$moduleRouteList = array();
-			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
-				$moduleRouteList = $modulesRoutes;
-				unset($modulesRoutes);
-			}
-			$this->setRouteConfiguration($moduleRouteList);
-			$this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
+            //loading routes for module
+            $moduleRouteList = array();
+            $modulesRoutes = Module::getModulesRoutes();
+            if($modulesRoutes && is_array($modulesRoutes)){
+                $moduleRouteList = $modulesRoutes;
+                unset($modulesRoutes);
+            }
+            $this->setRouteConfiguration($moduleRouteList);
+            $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
 
-			//Set route parameters
-			$this->setRouteParams();
-		}
+            //Set route parameters
+            $this->setRouteParams();
+        }
 
-		/**
-		* Add the URI and callback to the list of URIs to validate
-		*
-		* @param string $uri the request URI
-		* @param object $callback the callback function
-		*/
-		public function add($uri, $callback) {
-			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
-				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
-			}
-			$this->pattern[] = $uri;
-			$this->callback[] = $callback;
-		}
+        /**
+         * Add the URI and callback to the list of URIs to validate
+         *
+         * @param string $uri the request URI
+         * @param object $callback the callback function
+         */
+        public function add($uri, $callback) {
+            $uri = trim($uri, $this->uriTrim);
+            if(in_array($uri, $this->pattern)){
+                $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
+            }
+            $this->pattern[] = $uri;
+            $this->callback[] = $callback;
+        }
 
-		/**
-		 * Get the module name
-		 * @return string
-		 */
-		public function getModule(){
-			return $this->module;
-		}
+        /**
+         * Get the module name
+         * @return string
+         */
+        public function getModule(){
+            return $this->module;
+        }
 		
-		/**
-		 * Get the controller name
-		 * @return string
-		 */
-		public function getController(){
-			return $this->controller;
-		}
+        /**
+         * Get the controller name
+         * @return string
+         */
+        public function getController(){
+            return $this->controller;
+        }
 
-		/**
-		 * Get the controller file path
-		 * @return string
-		 */
-		public function getControllerPath(){
-			return $this->controllerPath;
-		}
+        /**
+         * Get the controller file path
+         * @return string
+         */
+        public function getControllerPath(){
+            return $this->controllerPath;
+        }
 
-		/**
-		 * Get the controller method
-		 * @return string
-		 */
-		public function getMethod(){
-			return $this->method;
-		}
+        /**
+         * Get the controller method
+         * @return string
+         */
+        public function getMethod(){
+            return $this->method;
+        }
 
-		/**
-		 * Get the request arguments
-		 * @return array
-		 */
-		public function getArgs(){
-			return $this->args;
-		}
+        /**
+         * Get the request arguments
+         * @return array
+         */
+        public function getArgs(){
+            return $this->args;
+        }
 
-		/**
-		 * Get the URL segments array
-		 * @return array
-		 */
-		public function getSegments(){
-			return $this->segments;
-		}
+        /**
+         * Get the URL segments array
+         * @return array
+         */
+        public function getSegments(){
+            return $this->segments;
+        }
 
-		/**
-		 * Routing the request to the correspondant module/controller/method if exists
-		 * otherwise send 404 error.
-		 */
-		public function run() {
-			$benchmark =& class_loader('Benchmark');
-			$benchmark->mark('ROUTING_PROCESS_START');
-			$this->logger->debug('Routing process start ...');
-			$segment = $this->segments;
-			$baseUrl = get_config('base_url');
-			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
-				$this->logger->info('The request URI contains the front controller');
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			else{
-				$this->logger->info('The request URI does not contain the front controller');
-			}
-			$uri = implode('/', $segment);
-			$this->logger->info('The final Request URI is [' . $uri . ']' );
-			//generic routes
-			$pattern = array(':num', ':alpha', ':alnum', ':any');
-			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
-			$this->logger->debug('Begin to loop in the predefined routes configuration to check if the current request match');
-			// Cycle through the URIs stored in the array
-			foreach ($this->pattern as $index => $uriList) {
-				$uriList = str_ireplace($pattern, $replace, $uriList);
-				// Check for an existant matching URI
-				if (preg_match("#^$uriList$#", $uri, $args)) {
-					$this->logger->info('Route found for request URI [' . $uri . '] using the predefined configuration [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']');
-					array_shift($args);
-					//check if this contains an module
-					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
-						$this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
-						$this->module = $moduleControllerMethod[0];
-						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
-						$this->logger->info('The current request does not use the module');
-						$moduleControllerMethod = explode('@', $this->callback[$index]);
-					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
-							$this->controller = $moduleControllerMethod[0];	
-						}
-						if(isset($moduleControllerMethod[1])){
-							$this->method = $moduleControllerMethod[1];
-						}
-						$this->args = $args;
-					}
-					// stop here
-					break;
-				}
-			}
-			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->getController() && $this->getModule()){
-				$this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller');
-				$this->controller = $this->getModule();
-			}
-			//if can not determine the module/controller/method via the defined routes configuration we will use
-			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->getController()){
-				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
-				$nbSegment = count($segment);
-				//if segment is null so means no need to perform
-				if($nbSegment > 0){
-					//get the module list
-					$modules = Module::getModuleList();
-					//first check if no module
-					if(! $modules){
-						$this->logger->info('No module was loaded will skip the module checking');
-						//the application don't use module
-						//controller
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							array_shift($segment);
-						}
-						//method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//args
-						$this->args = $segment;
-					}
-					else{
-						$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-						if(in_array($segment[0], $modules)){
-							$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
-							$this->module = $segment[0];
-							array_shift($segment);
-							//check if the second arg is the controller from module
-							if(isset($segment[0])){
-								$this->controller = $segment[0];
-								//check if the request use the same module name and controller
-								$path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-								if(! $path){
-									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
-									$this->controller = $this->getModule();
-								}
-								else{
-									$this->controllerPath = $path;
-									array_shift($segment);
-								}
-							}
-							//check for method
-							if(isset($segment[0])){
-								$this->method = $segment[0];
-								array_shift($segment);
-							}
-							//the remaining is for args
-							$this->args = $segment;
-						}
-						else{
-							$this->logger->info('The current request information is not found in the module list');
-							//controller
-							if(isset($segment[0])){
-								$this->controller = $segment[0];
-								array_shift($segment);
-							}
-							//method
-							if(isset($segment[0])){
-								$this->method = $segment[0];
-								array_shift($segment);
-							}
-							//args
-							$this->args = $segment;
-						}
-					}
-				}
-			}
-			if(! $this->getController() && $this->getModule()){
-				$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
-				$this->controller = $this->getModule();
-			}
-			//did we set the controller, so set the controller path
-			if($this->getController() && ! $this->getControllerPath()){
-				$this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
-				//if it is the module controller
-				if($this->getModule()){
-					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-				}
-				else{
-					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
-				}
-			}
-			$controller = ucfirst($this->getController());
-			$this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
-			$classFilePath = $this->getControllerPath();
-			$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
-			$benchmark->mark('ROUTING_PROCESS_END');
-			$e404 = false;
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(! class_exists($controller, false)){
-					$e404 = true;
-					$this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
-					$controllerInstance = new $controller();
-					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
-						$e404 = true;
-						$this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
-						$this->logger->info('Routing data is set correctly now GO!');
-						call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
-						$obj = & get_instance();
-						//render the final page to user
-						$this->logger->info('Render the final output to the browser');
-						$obj->response->renderFinalPage();
-					}
-				}
-			}
-			else{
-				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
-				$e404 = true;
-			}
-			if($e404){
-				$response =& class_loader('Response', 'classes');
-				$response->send404();
-			}
-		}
+        /**
+         * Routing the request to the correspondant module/controller/method if exists
+         * otherwise send 404 error.
+         */
+        public function run() {
+            $benchmark =& class_loader('Benchmark');
+            $benchmark->mark('ROUTING_PROCESS_START');
+            $this->logger->debug('Routing process start ...');
+            $segment = $this->segments;
+            $baseUrl = get_config('base_url');
+            //check if the app is not in DOCUMENT_ROOT
+            if(isset($segment[0]) && stripos($baseUrl, $segment[0]) != false){
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            $this->logger->debug('Check if the request URI contains the front controller');
+            if(isset($segment[0]) && $segment[0] == SELF){
+                $this->logger->info('The request URI contains the front controller');
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            else{
+                $this->logger->info('The request URI does not contain the front controller');
+            }
+            $uri = implode('/', $segment);
+            $this->logger->info('The final Request URI is [' . $uri . ']' );
+            //generic routes
+            $pattern = array(':num', ':alpha', ':alnum', ':any');
+            $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
+            $this->logger->debug('Begin to loop in the predefined routes configuration to check if the current request match');
+            // Cycle through the URIs stored in the array
+            foreach ($this->pattern as $index => $uriList) {
+                $uriList = str_ireplace($pattern, $replace, $uriList);
+                // Check for an existant matching URI
+                if (preg_match("#^$uriList$#", $uri, $args)) {
+                    $this->logger->info('Route found for request URI [' . $uri . '] using the predefined configuration [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']');
+                    array_shift($args);
+                    //check if this contains an module
+                    $moduleControllerMethod = explode('#', $this->callback[$index]);
+                    if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+                        $this->logger->info('The current request use the module [' .$moduleControllerMethod[0]. ']');
+                        $this->module = $moduleControllerMethod[0];
+                        $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
+                    }
+                    else{
+                        $this->logger->info('The current request does not use the module');
+                        $moduleControllerMethod = explode('@', $this->callback[$index]);
+                    }
+                    if(is_array($moduleControllerMethod)){
+                        if(isset($moduleControllerMethod[0])){
+                            $this->controller = $moduleControllerMethod[0];	
+                        }
+                        if(isset($moduleControllerMethod[1])){
+                            $this->method = $moduleControllerMethod[1];
+                        }
+                        $this->args = $args;
+                    }
+                    // stop here
+                    break;
+                }
+            }
+            //first if the controller is not set and the module is set use the module name as the controller
+            if(! $this->getController() && $this->getModule()){
+                $this->logger->info('After loop in predefined routes configuration, the module name is set but the controller is not set, so we will use module as the controller');
+                $this->controller = $this->getModule();
+            }
+            //if can not determine the module/controller/method via the defined routes configuration we will use
+            //the URL like http://domain.com/module/controller/method/arg1/arg2
+            if(! $this->getController()){
+                $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
+                $nbSegment = count($segment);
+                //if segment is null so means no need to perform
+                if($nbSegment > 0){
+                    //get the module list
+                    $modules = Module::getModuleList();
+                    //first check if no module
+                    if(! $modules){
+                        $this->logger->info('No module was loaded will skip the module checking');
+                        //the application don't use module
+                        //controller
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            array_shift($segment);
+                        }
+                        //method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //args
+                        $this->args = $segment;
+                    }
+                    else{
+                        $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
+                        if(in_array($segment[0], $modules)){
+                            $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
+                            $this->module = $segment[0];
+                            array_shift($segment);
+                            //check if the second arg is the controller from module
+                            if(isset($segment[0])){
+                                $this->controller = $segment[0];
+                                //check if the request use the same module name and controller
+                                $path = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
+                                if(! $path){
+                                    $this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
+                                    $this->controller = $this->getModule();
+                                }
+                                else{
+                                    $this->controllerPath = $path;
+                                    array_shift($segment);
+                                }
+                            }
+                            //check for method
+                            if(isset($segment[0])){
+                                $this->method = $segment[0];
+                                array_shift($segment);
+                            }
+                            //the remaining is for args
+                            $this->args = $segment;
+                        }
+                        else{
+                            $this->logger->info('The current request information is not found in the module list');
+                            //controller
+                            if(isset($segment[0])){
+                                $this->controller = $segment[0];
+                                array_shift($segment);
+                            }
+                            //method
+                            if(isset($segment[0])){
+                                $this->method = $segment[0];
+                                array_shift($segment);
+                            }
+                            //args
+                            $this->args = $segment;
+                        }
+                    }
+                }
+            }
+            if(! $this->getController() && $this->getModule()){
+                $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
+                $this->controller = $this->getModule();
+            }
+            //did we set the controller, so set the controller path
+            if($this->getController() && ! $this->getControllerPath()){
+                $this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
+                //if it is the module controller
+                if($this->getModule()){
+                    $this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
+                }
+                else{
+                    $this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
+                }
+            }
+            $controller = ucfirst($this->getController());
+            $this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
+            $classFilePath = $this->getControllerPath();
+            $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
+            $benchmark->mark('ROUTING_PROCESS_END');
+            $e404 = false;
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(! class_exists($controller, false)){
+                    $e404 = true;
+                    $this->logger->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+                }
+                else{
+                    $controllerInstance = new $controller();
+                    $controllerMethod = $this->getMethod();
+                    if(! method_exists($controllerInstance, $controllerMethod)){
+                        $e404 = true;
+                        $this->logger->info('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
+                    }
+                    else{
+                        $this->logger->info('Routing data is set correctly now GO!');
+                        call_user_func_array(array($controllerInstance, $controllerMethod), $this->getArgs());
+                        $obj = & get_instance();
+                        //render the final page to user
+                        $this->logger->info('Render the final output to the browser');
+                        $obj->response->renderFinalPage();
+                    }
+                }
+            }
+            else{
+                $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
+                $e404 = true;
+            }
+            if($e404){
+                $response =& class_loader('Response', 'classes');
+                $response->send404();
+            }
+        }
 
-	/**
+    /**
      * Return the Log instance
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object
+     * @return object
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
 
     /**
-    * Setting the route configuration using the configuration file and additional configuration from param
-    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-    * @param boolean $useConfigFile whether to use route configuration file
-	* @return object
-    */
+     * Setting the route configuration using the configuration file and additional configuration from param
+     * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+     * @param boolean $useConfigFile whether to use route configuration file
+     * @return object
+     */
     public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
         $route = array();
         if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
@@ -395,45 +395,45 @@ 
         }
         $route = array_merge($route, $overwriteConfig);
         $this->routes = $route;
-		return $this;
+        return $this;
     }
 
     /**
      * Set the route paramaters using the configuration
      */
     protected function setRouteParams(){
-    	//adding route
-		foreach($this->routes as $pattern => $callback){
-			$this->add($pattern, $callback);
-		}
+        //adding route
+        foreach($this->routes as $pattern => $callback){
+            $this->add($pattern, $callback);
+        }
 		
-		//here use directly the variable $_SERVER
-		$uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
-		$this->logger->debug('Check if URL suffix is enabled in the configuration');
-		//remove url suffix from the request URI
-		$suffix = get_config('url_suffix');
-		if ($suffix) {
-			$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
-			$uri = str_ireplace($suffix, '', $uri);
-		} 
-		if (strpos($uri, '?') !== false){
-			$uri = substr($uri, 0, strpos($uri, '?'));
-		}
-		$uri = trim($uri, $this->uriTrim);
-		$this->segments = explode('/', $uri);
-	}
+        //here use directly the variable $_SERVER
+        $uri = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '';
+        $this->logger->debug('Check if URL suffix is enabled in the configuration');
+        //remove url suffix from the request URI
+        $suffix = get_config('url_suffix');
+        if ($suffix) {
+            $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+            $uri = str_ireplace($suffix, '', $uri);
+        } 
+        if (strpos($uri, '?') !== false){
+            $uri = substr($uri, 0, strpos($uri, '?'));
+        }
+        $uri = trim($uri, $this->uriTrim);
+        $this->segments = explode('/', $uri);
+    }
 
-	/**
+    /**
      * Set the Log instance using argument or create new instance
      * @param object $logger the Log instance if not null
      */
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::Router');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Router');
+        }
     }
 }

core/classes/DatabaseQueryBuilder.php

Indentation +390 added lines, -390 removed lines

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

core/classes/EventDispatcher.php

Indentation +169 added lines, -169 removed lines

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

core/classes/Log.php

Indentation +236 added lines, -236 removed lines

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

core/classes/Loader.php

Indentation +496 added lines, -496 removed lines

@@ -1,521 +1,521 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-	class Loader{
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class Loader{
 		
-		/**
-		 * List of loaded resources
-		 * @var array
-		 */
-		public static $loaded = array();
+        /**
+         * List of loaded resources
+         * @var array
+         */
+        public static $loaded = array();
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
 
-		public function __construct(){
-			//add the resources already loaded during application bootstrap
-			//in the list to prevent duplicate or loading the resources again.
-			static::$loaded = class_loaded();
+        public function __construct(){
+            //add the resources already loaded during application bootstrap
+            //in the list to prevent duplicate or loading the resources again.
+            static::$loaded = class_loaded();
 			
-			//Load resources from autoload configuration
-			$this->loadResourcesFromAutoloadConfig();
-		}
+            //Load resources from autoload configuration
+            $this->loadResourcesFromAutoloadConfig();
+        }
 
-		/**
-		 * Get the logger singleton instance
-		 * @return Log the logger instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Loader');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * Get the logger singleton instance
+         * @return Log the logger instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Loader');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * Load the model class
-		 *
-		 * @param  string $class    the class name to be loaded
-		 * @param  string $instance the name of the instance to use in super object
-		 *
-		 * @return void
-		 */
-		public static function model($class, $instance = null){
-			$logger = static::getLogger();
-			$class = str_ireplace('.php', '', $class);
-			$class = trim($class, '/\\');
-			$file = ucfirst($class).'.php';
-			$logger->debug('Loading model [' . $class . '] ...');
-			if(! $instance){
-				//for module
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[1])){
-						$instance = strtolower($path[1]);
-					}
-				}
-				else{
-					$instance = strtolower($class);
-				}
-			}
-			if(isset(static::$loaded[$instance])){
-				$logger->info('Model [' . $class . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$classFilePath = APPS_MODEL_PATH . $file;
-			//first check if this model is in the module
-			$logger->debug('Checking model [' . $class . '] from module list ...');
-			$searchModuleName = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($class, '/') !== false){
-				$path = explode('/', $class);
-				if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$searchModuleName = $path[0];
-					$class = ucfirst($path[1]);
-				}
-			}
-			else{
-				$class = ucfirst($class);
-			}
+        /**
+         * Load the model class
+         *
+         * @param  string $class    the class name to be loaded
+         * @param  string $instance the name of the instance to use in super object
+         *
+         * @return void
+         */
+        public static function model($class, $instance = null){
+            $logger = static::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = trim($class, '/\\');
+            $file = ucfirst($class).'.php';
+            $logger->debug('Loading model [' . $class . '] ...');
+            if(! $instance){
+                //for module
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[1])){
+                        $instance = strtolower($path[1]);
+                    }
+                }
+                else{
+                    $instance = strtolower($class);
+                }
+            }
+            if(isset(static::$loaded[$instance])){
+                $logger->info('Model [' . $class . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $classFilePath = APPS_MODEL_PATH . $file;
+            //first check if this model is in the module
+            $logger->debug('Checking model [' . $class . '] from module list ...');
+            $searchModuleName = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($class, '/') !== false){
+                $path = explode('/', $class);
+                if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $searchModuleName = $path[0];
+                    $class = ucfirst($path[1]);
+                }
+            }
+            else{
+                $class = ucfirst($class);
+            }
 
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleModelFilePath = Module::findModelFullPath($class, $searchModuleName);
-			if($moduleModelFilePath){
-				$logger->info('Found model [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleModelFilePath. '] we will used it');
-				$classFilePath = $moduleModelFilePath;
-			}
-			else{
-				$logger->info('Cannot find model [' . $class . '] from modules using the default location');
-			}
-			$logger->info('The model file path to be loaded is [' . $classFilePath . ']');
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(class_exists($class)){
-					$c = new $class();
-					$obj = & get_instance();
-					$obj->{$instance} = $c;
-					static::$loaded[$instance] = $class;
-					$logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
-				}
-				else{
-					show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
-				}
-			}
-			else{
-				show_error('Unable to find the model [' . $class . ']');
-			}
-		}
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleModelFilePath = Module::findModelFullPath($class, $searchModuleName);
+            if($moduleModelFilePath){
+                $logger->info('Found model [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleModelFilePath. '] we will used it');
+                $classFilePath = $moduleModelFilePath;
+            }
+            else{
+                $logger->info('Cannot find model [' . $class . '] from modules using the default location');
+            }
+            $logger->info('The model file path to be loaded is [' . $classFilePath . ']');
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(class_exists($class)){
+                    $c = new $class();
+                    $obj = & get_instance();
+                    $obj->{$instance} = $c;
+                    static::$loaded[$instance] = $class;
+                    $logger->info('Model [' . $class . '] --> ' . $classFilePath . ' loaded successfully.');
+                }
+                else{
+                    show_error('The file '.$classFilePath.' exists but does not contain the class ['. $class . ']');
+                }
+            }
+            else{
+                show_error('Unable to find the model [' . $class . ']');
+            }
+        }
 
 
-		/**
-		 * Load the library class
-		 *
-		 * @param  string $class    the library class name to be loaded
-		 * @param  string $instance the instance name to use in super object
-		 * @param mixed $params the arguments to pass to the constructor
-		 *
-		 * @return void
-		 */
-		public static function library($class, $instance = null, array $params = array()){
-			$logger = static::getLogger();
-			$class = str_ireplace('.php', '', $class);
-			$class = trim($class, '/\\');
-			$file = ucfirst($class) .'.php';
-			$logger->debug('Loading library [' . $class . '] ...');
-			if(! $instance){
-				//for module
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[1])){
-						$instance = strtolower($path[1]);
-					}
-				}
-				else{
-					$instance = strtolower($class);
-				}
-			}
-			if(isset(static::$loaded[$instance])){
-				$logger->info('Library [' . $class . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$obj = & get_instance();
-			//TODO for Database library
-			if(strtolower($class) == 'database'){
-				$logger->info('This is the Database library ...');
-				$dbInstance = & class_loader('Database', 'classes/database', $params);
-				$obj->{$instance} = $dbInstance;
-				static::$loaded[$instance] = $class;
-				$logger->info('Library Database loaded successfully.');
-				return;
-			}
-			$libraryFilePath = null;
-			$logger->debug('Check if this is a system library ...');
-			if(file_exists(CORE_LIBRARY_PATH . $file)){
-				$libraryFilePath = CORE_LIBRARY_PATH . $file;
-				$class = ucfirst($class);
-				$logger->info('This library is a system library');
-			}
-			else{
-				$logger->info('This library is not a system library');	
-				//first check if this library is in the module
-				$logger->debug('Checking library [' . $class . '] from module list ...');
-				$searchModuleName = null;
-				//check if the request class contains module name
-				if(strpos($class, '/') !== false){
-					$path = explode('/', $class);
-					if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-						$searchModuleName = $path[0];
-						$class = ucfirst($path[1]);
-					}
-				}
-				else{
-					$class = ucfirst($class);
-				}
-				if(! $searchModuleName && !empty($obj->moduleName)){
-					$searchModuleName = $obj->moduleName;
-				}
-				$moduleLibraryPath = Module::findLibraryFullPath($class, $searchModuleName);
-				if($moduleLibraryPath){
-					$logger->info('Found library [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLibraryPath. '] we will used it');
-					$libraryFilePath = $moduleLibraryPath;
-				}
-				else{
-					$logger->info('Cannot find library [' . $class . '] from modules using the default location');
-				}
-			}
-			if(! $libraryFilePath){
-				$searchDir = array(LIBRARY_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $file;
-					if(file_exists($filePath)){
-						$libraryFilePath = $filePath;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
-			if($libraryFilePath){
-				require_once $libraryFilePath;
-				if(class_exists($class)){
-					$c = $params ? new $class($params) : new $class();
-					$obj = & get_instance();
-					$obj->{$instance} = $c;
-					static::$loaded[$instance] = $class;
-					$logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
-				}
-				else{
-					show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
-				}
-			}
-			else{
-				show_error('Unable to find library class [' . $class . ']');
-			}
-		}
+        /**
+         * Load the library class
+         *
+         * @param  string $class    the library class name to be loaded
+         * @param  string $instance the instance name to use in super object
+         * @param mixed $params the arguments to pass to the constructor
+         *
+         * @return void
+         */
+        public static function library($class, $instance = null, array $params = array()){
+            $logger = static::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = trim($class, '/\\');
+            $file = ucfirst($class) .'.php';
+            $logger->debug('Loading library [' . $class . '] ...');
+            if(! $instance){
+                //for module
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[1])){
+                        $instance = strtolower($path[1]);
+                    }
+                }
+                else{
+                    $instance = strtolower($class);
+                }
+            }
+            if(isset(static::$loaded[$instance])){
+                $logger->info('Library [' . $class . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $obj = & get_instance();
+            //TODO for Database library
+            if(strtolower($class) == 'database'){
+                $logger->info('This is the Database library ...');
+                $dbInstance = & class_loader('Database', 'classes/database', $params);
+                $obj->{$instance} = $dbInstance;
+                static::$loaded[$instance] = $class;
+                $logger->info('Library Database loaded successfully.');
+                return;
+            }
+            $libraryFilePath = null;
+            $logger->debug('Check if this is a system library ...');
+            if(file_exists(CORE_LIBRARY_PATH . $file)){
+                $libraryFilePath = CORE_LIBRARY_PATH . $file;
+                $class = ucfirst($class);
+                $logger->info('This library is a system library');
+            }
+            else{
+                $logger->info('This library is not a system library');	
+                //first check if this library is in the module
+                $logger->debug('Checking library [' . $class . '] from module list ...');
+                $searchModuleName = null;
+                //check if the request class contains module name
+                if(strpos($class, '/') !== false){
+                    $path = explode('/', $class);
+                    if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                        $searchModuleName = $path[0];
+                        $class = ucfirst($path[1]);
+                    }
+                }
+                else{
+                    $class = ucfirst($class);
+                }
+                if(! $searchModuleName && !empty($obj->moduleName)){
+                    $searchModuleName = $obj->moduleName;
+                }
+                $moduleLibraryPath = Module::findLibraryFullPath($class, $searchModuleName);
+                if($moduleLibraryPath){
+                    $logger->info('Found library [' . $class . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLibraryPath. '] we will used it');
+                    $libraryFilePath = $moduleLibraryPath;
+                }
+                else{
+                    $logger->info('Cannot find library [' . $class . '] from modules using the default location');
+                }
+            }
+            if(! $libraryFilePath){
+                $searchDir = array(LIBRARY_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $file;
+                    if(file_exists($filePath)){
+                        $libraryFilePath = $filePath;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The library file path to be loaded is [' . $libraryFilePath . ']');
+            if($libraryFilePath){
+                require_once $libraryFilePath;
+                if(class_exists($class)){
+                    $c = $params ? new $class($params) : new $class();
+                    $obj = & get_instance();
+                    $obj->{$instance} = $c;
+                    static::$loaded[$instance] = $class;
+                    $logger->info('Library [' . $class . '] --> ' . $libraryFilePath . ' loaded successfully.');
+                }
+                else{
+                    show_error('The file '.$libraryFilePath.' exists but does not contain the class '.$class);
+                }
+            }
+            else{
+                show_error('Unable to find library class [' . $class . ']');
+            }
+        }
 
-		/**
-		 * Load the helper
-		 *
-		 * @param  string $function the helper name to be loaded
-		 *
-		 * @return void
-		 */
-		public static function functions($function){
-			$logger = static::getLogger();
-			$function = str_ireplace('.php', '', $function);
-			$function = trim($function, '/\\');
-			$function = str_ireplace('function_', '', $function);
-			$file = 'function_'.$function.'.php';
-			$logger->debug('Loading helper [' . $function . '] ...');
-			if(isset(static::$loaded['function_' . $function])){
-				$logger->info('Helper [' . $function . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$functionFilePath = null;
-			//first check if this helper is in the module
-			$logger->debug('Checking helper [' . $function . '] from module list ...');
-			$searchModuleName = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($function, '/') !== false){
-				$path = explode('/', $function);
-				if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$searchModuleName = $path[0];
-					$function = 'function_' . $path[1] . '.php';
-					$file = $path[0] . DS . 'function_'.$function.'.php';
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleFunctionPath = Module::findFunctionFullPath($function, $searchModuleName);
-			if($moduleFunctionPath){
-				$logger->info('Found helper [' . $function . '] from module [' .$searchModuleName. '], the file path is [' .$moduleFunctionPath. '] we will used it');
-				$functionFilePath = $moduleFunctionPath;
-			}
-			else{
-				$logger->info('Cannot find helper [' . $function . '] from modules using the default location');
-			}
-			if(! $functionFilePath){
-				$searchDir = array(FUNCTIONS_PATH, CORE_FUNCTIONS_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $file;
-					if(file_exists($filePath)){
-						$functionFilePath = $filePath;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The helper file path to be loaded is [' . $functionFilePath . ']');
-			if($functionFilePath){
-				require_once $functionFilePath;
-				static::$loaded['function_' . $function] = $functionFilePath;
-				$logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
-			}
-			else{
-				show_error('Unable to find helper file [' . $file . ']');
-			}
-		}
+        /**
+         * Load the helper
+         *
+         * @param  string $function the helper name to be loaded
+         *
+         * @return void
+         */
+        public static function functions($function){
+            $logger = static::getLogger();
+            $function = str_ireplace('.php', '', $function);
+            $function = trim($function, '/\\');
+            $function = str_ireplace('function_', '', $function);
+            $file = 'function_'.$function.'.php';
+            $logger->debug('Loading helper [' . $function . '] ...');
+            if(isset(static::$loaded['function_' . $function])){
+                $logger->info('Helper [' . $function . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $functionFilePath = null;
+            //first check if this helper is in the module
+            $logger->debug('Checking helper [' . $function . '] from module list ...');
+            $searchModuleName = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($function, '/') !== false){
+                $path = explode('/', $function);
+                if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $searchModuleName = $path[0];
+                    $function = 'function_' . $path[1] . '.php';
+                    $file = $path[0] . DS . 'function_'.$function.'.php';
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleFunctionPath = Module::findFunctionFullPath($function, $searchModuleName);
+            if($moduleFunctionPath){
+                $logger->info('Found helper [' . $function . '] from module [' .$searchModuleName. '], the file path is [' .$moduleFunctionPath. '] we will used it');
+                $functionFilePath = $moduleFunctionPath;
+            }
+            else{
+                $logger->info('Cannot find helper [' . $function . '] from modules using the default location');
+            }
+            if(! $functionFilePath){
+                $searchDir = array(FUNCTIONS_PATH, CORE_FUNCTIONS_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $file;
+                    if(file_exists($filePath)){
+                        $functionFilePath = $filePath;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The helper file path to be loaded is [' . $functionFilePath . ']');
+            if($functionFilePath){
+                require_once $functionFilePath;
+                static::$loaded['function_' . $function] = $functionFilePath;
+                $logger->info('Helper [' . $function . '] --> ' . $functionFilePath . ' loaded successfully.');
+            }
+            else{
+                show_error('Unable to find helper file [' . $file . ']');
+            }
+        }
 
-		/**
-		 * Load the configuration file
-		 *
-		 * @param  string $filename the configuration filename located at CONFIG_PATH or MODULE_PATH/config
-		 *
-		 * @return void
-		 */
-		public static function config($filename){
-			$logger = static::getLogger();
-			$filename = str_ireplace('.php', '', $filename);
-			$filename = trim($filename, '/\\');
-			$filename = str_ireplace('config_', '', $filename);
-			$file = 'config_'.$filename.'.php';
-			$logger->debug('Loading configuration [' . $filename . '] ...');
-			if(isset(static::$loaded['config_' . $filename])){
-				$logger->info('Configuration [' . $file . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			$configFilePath = CONFIG_PATH . $file;
-			//first check if this config is in the module
-			$logger->debug('Checking config [' . $filename . '] from module list ...');
-			$searchModuleName = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($filename, '/') !== false){
-				$path = explode('/', $filename);
-				if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$searchModuleName = $path[0];
-					$filename = $path[1] . '.php';
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleConfigPath = Module::findConfigFullPath($filename, $searchModuleName);
-			if($moduleConfigPath){
-				$logger->info('Found config [' . $filename . '] from module [' .$searchModuleName. '], the file path is [' .$moduleConfigPath. '] we will used it');
-				$configFilePath = $moduleConfigPath;
-			}
-			else{
-				$logger->info('Cannot find config [' . $filename . '] from modules using the default location');
-			}
-			$logger->info('The config file path to be loaded is [' . $configFilePath . ']');
-			$config = array();
-			if(file_exists($configFilePath)){
-				require_once $configFilePath;
-				if(! empty($config) && is_array($config)){
-					Config::setAll($config);
-				}
-			}
-			else{
-				show_error('Unable to find config file ['. $configFilePath . ']');
-			}
-			static::$loaded['config_' . $filename] = $configFilePath;
-			$logger->info('Configuration [' . $configFilePath . '] loaded successfully.');
-			$logger->info('The custom application configuration loaded are listed below: ' . stringfy_vars($config));
-			unset($config);
-		}
+        /**
+         * Load the configuration file
+         *
+         * @param  string $filename the configuration filename located at CONFIG_PATH or MODULE_PATH/config
+         *
+         * @return void
+         */
+        public static function config($filename){
+            $logger = static::getLogger();
+            $filename = str_ireplace('.php', '', $filename);
+            $filename = trim($filename, '/\\');
+            $filename = str_ireplace('config_', '', $filename);
+            $file = 'config_'.$filename.'.php';
+            $logger->debug('Loading configuration [' . $filename . '] ...');
+            if(isset(static::$loaded['config_' . $filename])){
+                $logger->info('Configuration [' . $file . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            $configFilePath = CONFIG_PATH . $file;
+            //first check if this config is in the module
+            $logger->debug('Checking config [' . $filename . '] from module list ...');
+            $searchModuleName = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($filename, '/') !== false){
+                $path = explode('/', $filename);
+                if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $searchModuleName = $path[0];
+                    $filename = $path[1] . '.php';
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleConfigPath = Module::findConfigFullPath($filename, $searchModuleName);
+            if($moduleConfigPath){
+                $logger->info('Found config [' . $filename . '] from module [' .$searchModuleName. '], the file path is [' .$moduleConfigPath. '] we will used it');
+                $configFilePath = $moduleConfigPath;
+            }
+            else{
+                $logger->info('Cannot find config [' . $filename . '] from modules using the default location');
+            }
+            $logger->info('The config file path to be loaded is [' . $configFilePath . ']');
+            $config = array();
+            if(file_exists($configFilePath)){
+                require_once $configFilePath;
+                if(! empty($config) && is_array($config)){
+                    Config::setAll($config);
+                }
+            }
+            else{
+                show_error('Unable to find config file ['. $configFilePath . ']');
+            }
+            static::$loaded['config_' . $filename] = $configFilePath;
+            $logger->info('Configuration [' . $configFilePath . '] loaded successfully.');
+            $logger->info('The custom application configuration loaded are listed below: ' . stringfy_vars($config));
+            unset($config);
+        }
 
 
-		/**
-		 * Load the language
-		 *
-		 * @param  string $language the language name to be loaded
-		 *
-		 * @return void
-		 */
-		public static function lang($language){
-			$logger = static::getLogger();
-			$language = str_ireplace('.php', '', $language);
-			$language = trim($language, '/\\');
-			$language = str_ireplace('lang_', '', $language);
-			$file = 'lang_'.$language.'.php';
-			$logger->debug('Loading language [' . $language . '] ...');
-			if(isset(static::$loaded['lang_' . $language])){
-				$logger->info('Language [' . $language . '] already loaded no need to load it again, cost in performance');
-				return;
-			}
-			//determine the current language
-			$appLang = get_config('default_language');
-			//if the language exists in the cookie use it
-			$cfgKey = get_config('language_cookie_name');
-			$objCookie = & class_loader('Cookie');
-			$cookieLang = $objCookie->get($cfgKey);
-			if($cookieLang){
-				$appLang = $cookieLang;
-			}
-			$languageFilePath = null;
-			//first check if this language is in the module
-			$logger->debug('Checking language [' . $language . '] from module list ...');
-			$searchModuleName = null;
-			$obj = & get_instance();
-			//check if the request class contains module name
-			if(strpos($language, '/') !== false){
-				$path = explode('/', $language);
-				if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
-					$searchModuleName = $path[0];
-					$language = 'lang_' . $path[1] . '.php';
-					$file = $path[0] . DS .$language;
-				}
-			}
-			if(! $searchModuleName && !empty($obj->moduleName)){
-				$searchModuleName = $obj->moduleName;
-			}
-			$moduleLanguagePath = Module::findLanguageFullPath($language, $searchModuleName, $appLang);
-			if($moduleLanguagePath){
-				$logger->info('Found language [' . $language . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLanguagePath. '] we will used it');
-				$languageFilePath = $moduleLanguagePath;
-			}
-			else{
-				$logger->info('Cannot find language [' . $language . '] from modules using the default location');
-			}
-			if(! $languageFilePath){
-				$searchDir = array(APP_LANG_PATH, CORE_LANG_PATH);
-				foreach($searchDir as $dir){
-					$filePath = $dir . $appLang . DS . $file;
-					if(file_exists($filePath)){
-						$languageFilePath = $filePath;
-						//is already found not to continue
-						break;
-					}
-				}
-			}
-			$logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
-			if($languageFilePath){
-				$lang = array();
-				require_once $languageFilePath;
-				if(! empty($lang) && is_array($lang)){
-					$logger->info('Language file  [' .$languageFilePath. '] contains the valid languages keys add them to language list');
-					//Note: may be here the class 'Lang' not yet loaded
-					$langObj =& class_loader('Lang', 'classes');
-					$langObj->addLangMessages($lang);
-					//free the memory
-					unset($lang);
-				}
-				static::$loaded['lang_' . $language] = $languageFilePath;
-				$logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
-			}
-			else{
-				show_error('Unable to find language file [' . $file . ']');
-			}
-		}
+        /**
+         * Load the language
+         *
+         * @param  string $language the language name to be loaded
+         *
+         * @return void
+         */
+        public static function lang($language){
+            $logger = static::getLogger();
+            $language = str_ireplace('.php', '', $language);
+            $language = trim($language, '/\\');
+            $language = str_ireplace('lang_', '', $language);
+            $file = 'lang_'.$language.'.php';
+            $logger->debug('Loading language [' . $language . '] ...');
+            if(isset(static::$loaded['lang_' . $language])){
+                $logger->info('Language [' . $language . '] already loaded no need to load it again, cost in performance');
+                return;
+            }
+            //determine the current language
+            $appLang = get_config('default_language');
+            //if the language exists in the cookie use it
+            $cfgKey = get_config('language_cookie_name');
+            $objCookie = & class_loader('Cookie');
+            $cookieLang = $objCookie->get($cfgKey);
+            if($cookieLang){
+                $appLang = $cookieLang;
+            }
+            $languageFilePath = null;
+            //first check if this language is in the module
+            $logger->debug('Checking language [' . $language . '] from module list ...');
+            $searchModuleName = null;
+            $obj = & get_instance();
+            //check if the request class contains module name
+            if(strpos($language, '/') !== false){
+                $path = explode('/', $language);
+                if(isset($path[0]) && in_array($path[0], Module::getModuleList())){
+                    $searchModuleName = $path[0];
+                    $language = 'lang_' . $path[1] . '.php';
+                    $file = $path[0] . DS .$language;
+                }
+            }
+            if(! $searchModuleName && !empty($obj->moduleName)){
+                $searchModuleName = $obj->moduleName;
+            }
+            $moduleLanguagePath = Module::findLanguageFullPath($language, $searchModuleName, $appLang);
+            if($moduleLanguagePath){
+                $logger->info('Found language [' . $language . '] from module [' .$searchModuleName. '], the file path is [' .$moduleLanguagePath. '] we will used it');
+                $languageFilePath = $moduleLanguagePath;
+            }
+            else{
+                $logger->info('Cannot find language [' . $language . '] from modules using the default location');
+            }
+            if(! $languageFilePath){
+                $searchDir = array(APP_LANG_PATH, CORE_LANG_PATH);
+                foreach($searchDir as $dir){
+                    $filePath = $dir . $appLang . DS . $file;
+                    if(file_exists($filePath)){
+                        $languageFilePath = $filePath;
+                        //is already found not to continue
+                        break;
+                    }
+                }
+            }
+            $logger->info('The language file path to be loaded is [' . $languageFilePath . ']');
+            if($languageFilePath){
+                $lang = array();
+                require_once $languageFilePath;
+                if(! empty($lang) && is_array($lang)){
+                    $logger->info('Language file  [' .$languageFilePath. '] contains the valid languages keys add them to language list');
+                    //Note: may be here the class 'Lang' not yet loaded
+                    $langObj =& class_loader('Lang', 'classes');
+                    $langObj->addLangMessages($lang);
+                    //free the memory
+                    unset($lang);
+                }
+                static::$loaded['lang_' . $language] = $languageFilePath;
+                $logger->info('Language [' . $language . '] --> ' . $languageFilePath . ' loaded successfully.');
+            }
+            else{
+                show_error('Unable to find language file [' . $file . ']');
+            }
+        }
 
 
-		private function getResourcesFromAutoloadConfig(){
-			$autoloads = array();
-			$autoloads['config']    = array();
-			$autoloads['languages'] = array();
-			$autoloads['libraries'] = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			//loading of the resources in autoload.php configuration file
-			if(file_exists(CONFIG_PATH . 'autoload.php')){
-				$autoload = array();
-				require_once CONFIG_PATH . 'autoload.php';
-				if(! empty($autoload) && is_array($autoload)){
-					$autoloads = array_merge($autoloads, $autoload);
-					unset($autoload);
-				}
-			}
-			//loading autoload configuration for modules
-			$modulesAutoloads = Module::getModulesAutoloadConfig();
-			if(! empty($modulesAutoloads) && is_array($modulesAutoloads)){
-				$autoloads = array_merge_recursive($autoloads, $modulesAutoloads);
-			}
-			return $autoloads;
-		}
+        private function getResourcesFromAutoloadConfig(){
+            $autoloads = array();
+            $autoloads['config']    = array();
+            $autoloads['languages'] = array();
+            $autoloads['libraries'] = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            //loading of the resources in autoload.php configuration file
+            if(file_exists(CONFIG_PATH . 'autoload.php')){
+                $autoload = array();
+                require_once CONFIG_PATH . 'autoload.php';
+                if(! empty($autoload) && is_array($autoload)){
+                    $autoloads = array_merge($autoloads, $autoload);
+                    unset($autoload);
+                }
+            }
+            //loading autoload configuration for modules
+            $modulesAutoloads = Module::getModulesAutoloadConfig();
+            if(! empty($modulesAutoloads) && is_array($modulesAutoloads)){
+                $autoloads = array_merge_recursive($autoloads, $modulesAutoloads);
+            }
+            return $autoloads;
+        }
 
-		/**
-		 * Load the autoload configuration
-		 * @return void
-		 */
-		private function loadResourcesFromAutoloadConfig(){
-			$autoloads = array();
-			$autoloads['config']    = array();
-			$autoloads['languages'] = array();
-			$autoloads['libraries'] = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
+        /**
+         * Load the autoload configuration
+         * @return void
+         */
+        private function loadResourcesFromAutoloadConfig(){
+            $autoloads = array();
+            $autoloads['config']    = array();
+            $autoloads['languages'] = array();
+            $autoloads['libraries'] = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
 
-			$list = $this->getResourcesFromAutoloadConfig();
-			$autoloads = array_merge($autoloads, $list);
+            $list = $this->getResourcesFromAutoloadConfig();
+            $autoloads = array_merge($autoloads, $list);
 			
-			//config autoload
-			$this->loadAutoloadResourcesArray('config', $autoloads['config']);
+            //config autoload
+            $this->loadAutoloadResourcesArray('config', $autoloads['config']);
 			
-			//languages autoload
-			$this->loadAutoloadResourcesArray('lang', $autoloads['languages']);
+            //languages autoload
+            $this->loadAutoloadResourcesArray('lang', $autoloads['languages']);
 			
-			//libraries autoload
-			$this->loadAutoloadResourcesArray('library', $autoloads['libraries']);
+            //libraries autoload
+            $this->loadAutoloadResourcesArray('library', $autoloads['libraries']);
 
-			//models autoload
-			$this->loadAutoloadResourcesArray('model', $autoloads['models']);
+            //models autoload
+            $this->loadAutoloadResourcesArray('model', $autoloads['models']);
 			
-			//functions autoload
-			$this->loadAutoloadResourcesArray('functions', $autoloads['functions']);
-		}
+            //functions autoload
+            $this->loadAutoloadResourcesArray('functions', $autoloads['functions']);
+        }
 
-		/**
-		 * Load the resources autoload array
-		 * @param  string $method    this object method name to call
-		 * @param  array  $resources the resource to load
-		 * @return void            
-		 */
-		private function loadAutoloadResourcesArray($method, array $resources){
-			foreach ($resources as $name) {
-				$this->{$method}($name);
-			}
-		}
-	}
+        /**
+         * Load the resources autoload array
+         * @param  string $method    this object method name to call
+         * @param  array  $resources the resource to load
+         * @return void            
+         */
+        private function loadAutoloadResourcesArray($method, array $resources){
+            foreach ($resources as $name) {
+                $this->{$method}($name);
+            }
+        }
+    }

core/classes/Controller.php

Indentation +125 added lines, -125 removed lines

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

core/classes/model/DBSessionHandlerModel.php

Indentation +65 added lines, -65 removed lines

@@ -1,39 +1,39 @@ 
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	/**
-	 * DB session handler class
-	 */
- 	abstract class DBSessionHandlerModel extends Model {
+    /**
+     * DB session handler class
+     */
+        abstract class DBSessionHandlerModel extends Model {
 		
-		/**
-		 * The session table columns to use
-		 * @var array
-		 * @example
-		 * 	array(
+        /**
+         * The session table columns to use
+         * @var array
+         * @example
+         * 	array(
 				'sid' => '', //VARCHAR(255) Note: this a primary key
 				'sdata' => '', //TEXT
 				'stime' => '', //unix timestamp (INT|BIGINT)
@@ -42,41 +42,41 @@ 
 				'sbrowser' => '', //VARCHAR(255) 
 				'skey' => '' //VARCHAR(255) 
 			);
-		 */
-		protected $sessionTableColumns = array();
+         */
+        protected $sessionTableColumns = array();
 
-		public function __construct(Database $db = null){
-			parent::__construct($db);
-		}
+        public function __construct(Database $db = null){
+            parent::__construct($db);
+        }
 
-		/**
-		 * Return the session database table columns
-		 * @return array 
-		 */
-		public function getSessionTableColumns(){
-			return $this->sessionTableColumns;
-		}
+        /**
+         * Return the session database table columns
+         * @return array 
+         */
+        public function getSessionTableColumns(){
+            return $this->sessionTableColumns;
+        }
 
-		/**
-		 * Set the session database table columns
-		 * @param array $columns the columns definition
-		 */
-		public function setSessionTableColumns(array $columns){
-			$this->sessionTableColumns = $columns;
-			return $this;
-		}
+        /**
+         * Set the session database table columns
+         * @param array $columns the columns definition
+         */
+        public function setSessionTableColumns(array $columns){
+            $this->sessionTableColumns = $columns;
+            return $this;
+        }
 
-		/**
-		 * Delete the expire session
-		 * @param  int $time the unix timestamp
-		 * @return int       affected rows
-		 */
-		abstract public function deleteByTime($time);
+        /**
+         * Delete the expire session
+         * @param  int $time the unix timestamp
+         * @return int       affected rows
+         */
+        abstract public function deleteByTime($time);
 
 		
-		/**
-		 * How to get the value of the table column key. Generally is the session key
-		 * @return mixed the key value like used to identify the data
-		 */
-		abstract public function getKeyValue();
-	}
+        /**
+         * How to get the value of the table column key. Generally is the session key
+         * @return mixed the key value like used to identify the data
+         */
+        abstract public function getKeyValue();
+    }

core/classes/model/Model.php

Indentation +125 added lines, -125 removed lines

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

core/classes/Lang.php

Indentation +205 added lines, -205 removed lines

@@ -1,208 +1,208 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-
-	/**
-	 * For application languages management
-	 */
-	class Lang{
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+
+    /**
+     * For application languages management
+     */
+    class Lang{
 		
-		/**
-		 * The supported available language for this application.
-		 * @example "en" => "english" 
-		 * @see Lang::addLang()
-		 * @var array
-		 */
-		protected $availables = array();
-
-		/**
-		 * The all messages language
-		 * @var array
-		 */
-		protected $languages = array();
-
-		/**
-		 * The default language to use if can not
-		 *  determine the client language
-		 *  
-		 * @example $default = 'en'
-		 * @var string
-		 */
-		protected $default = null;
-
-		/**
-		 * The current client language
-		 * @var string
-		 */
-		protected $current = null;
-
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
-
-		/**
-		 * Construct new Lang instance
-		 */
-		public function __construct(){
-	        $this->logger =& class_loader('Log', 'classes');
-	        $this->logger->setLogger('Library::Lang');
-
-			$this->default = get_config('default_language', 'en');
-			$this->logger->debug('Setting the supported languages');
+        /**
+         * The supported available language for this application.
+         * @example "en" => "english" 
+         * @see Lang::addLang()
+         * @var array
+         */
+        protected $availables = array();
+
+        /**
+         * The all messages language
+         * @var array
+         */
+        protected $languages = array();
+
+        /**
+         * The default language to use if can not
+         *  determine the client language
+         *  
+         * @example $default = 'en'
+         * @var string
+         */
+        protected $default = null;
+
+        /**
+         * The current client language
+         * @var string
+         */
+        protected $current = null;
+
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
+
+        /**
+         * Construct new Lang instance
+         */
+        public function __construct(){
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Lang');
+
+            $this->default = get_config('default_language', 'en');
+            $this->logger->debug('Setting the supported languages');
 			
-			//add the supported languages ('key', 'display name')
-			$languages = get_config('languages', null);
-			if(! empty($languages)){
-				foreach($languages as $key => $displayName){
-					$this->addLang($key, $displayName);
-				}
-			}
-			unset($languages);
-
-			//if the language exists in cookie use it
-			$cfgKey = get_config('language_cookie_name');
-			$this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
-			$objCookie = & class_loader('Cookie');
-			$cookieLang = $objCookie->get($cfgKey);
-			if($cookieLang && $this->isValid($cookieLang)){
-				$this->current = $cookieLang;
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
-			}
-			else{
-				$this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
-				$this->current = $this->getDefault();
-			}
-		}
-
-		/**
-		 * Get the all languages messages
-		 *
-		 * @return array the language message list
-		 */
-		public function getAll(){
-			return $this->languages;
-		}
-
-		/**
-		 * Set the language message
-		 *
-		 * @param string $key the language key to identify
-		 * @param string $value the language message value
-		 */
-		public function set($key, $value){
-			$this->languages[$key] = $value;
-		}
-
-		/**
-		 * Get the language message for the given key. If can't find return the default value
-		 *
-		 * @param  string $key the message language key
-		 * @param  string $default the default value to return if can not found the language message key
-		 *
-		 * @return string the language message value
-		 */
-		public function get($key, $default = 'LANGUAGE_ERROR'){
-			if(isset($this->languages[$key])){
-				return $this->languages[$key];
-			}
-			$this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
-			return $default;
-		}
-
-		/**
-		 * Check whether the language file for given name exists
-		 *
-		 * @param  string  $language the language name like "fr", "en", etc.
-		 *
-		 * @return boolean true if the language directory exists, false or not
-		 */
-		public function isValid($language){
-			$searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
-			foreach($searchDir as $dir){
-				if(file_exists($dir . $language) && is_dir($dir . $language)){
-					return true;
-				}
-			}
-			return false;
-		}
-
-		/**
-		 * Get the default language value like "en" , "fr", etc.
-		 *
-		 * @return string the default language
-		 */
-		public function getDefault(){
-			return $this->default;
-		}
-
-		/**
-		 * Get the current language defined by cookie or the default value
-		 *
-		 * @return string the current language
-		 */
-		public function getCurrent(){
-			return $this->current;
-		}
-
-		/**
-		 * Add new supported or available language
-		 *
-		 * @param string $name the short language name like "en", "fr".
-		 * @param string $description the human readable description of this language
-		 */
-		public function addLang($name, $description){
-			if(isset($this->availables[$name])){
-				return; //already added cost in performance
-			}
-			if($this->isValid($name)){
-				$this->availables[$name] = $description;
-			}
-			else{
-				show_error('The language [' . $name . '] is not valid or does not exists.');
-			}
-		}
-
-		/**
-		 * Get the list of the application supported language
-		 *
-		 * @return array the list of the application language
-		 */
-		public function getSupported(){
-			return $this->availables;
-		}
-
-		/**
-		 * Add new language messages
-		 *
-		 * @param array $langs the languages array of the messages to be added
-		 */
-		public function addLangMessages(array $langs){
-			foreach ($langs as $key => $value) {
-				$this->set($key, $value);
-			}
-		}
-	}
+            //add the supported languages ('key', 'display name')
+            $languages = get_config('languages', null);
+            if(! empty($languages)){
+                foreach($languages as $key => $displayName){
+                    $this->addLang($key, $displayName);
+                }
+            }
+            unset($languages);
+
+            //if the language exists in cookie use it
+            $cfgKey = get_config('language_cookie_name');
+            $this->logger->debug('Getting current language from cookie [' .$cfgKey. ']');
+            $objCookie = & class_loader('Cookie');
+            $cookieLang = $objCookie->get($cfgKey);
+            if($cookieLang && $this->isValid($cookieLang)){
+                $this->current = $cookieLang;
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is valid so we will set the language using the cookie value [' .$cookieLang. ']');
+            }
+            else{
+                $this->logger->info('Language from cookie [' .$cfgKey. '] is not set, use the default value [' .$this->getDefault(). ']');
+                $this->current = $this->getDefault();
+            }
+        }
+
+        /**
+         * Get the all languages messages
+         *
+         * @return array the language message list
+         */
+        public function getAll(){
+            return $this->languages;
+        }
+
+        /**
+         * Set the language message
+         *
+         * @param string $key the language key to identify
+         * @param string $value the language message value
+         */
+        public function set($key, $value){
+            $this->languages[$key] = $value;
+        }
+
+        /**
+         * Get the language message for the given key. If can't find return the default value
+         *
+         * @param  string $key the message language key
+         * @param  string $default the default value to return if can not found the language message key
+         *
+         * @return string the language message value
+         */
+        public function get($key, $default = 'LANGUAGE_ERROR'){
+            if(isset($this->languages[$key])){
+                return $this->languages[$key];
+            }
+            $this->logger->warning('Language key  [' .$key. '] does not exist use the default value [' .$default. ']');
+            return $default;
+        }
+
+        /**
+         * Check whether the language file for given name exists
+         *
+         * @param  string  $language the language name like "fr", "en", etc.
+         *
+         * @return boolean true if the language directory exists, false or not
+         */
+        public function isValid($language){
+            $searchDir = array(CORE_LANG_PATH, APP_LANG_PATH);
+            foreach($searchDir as $dir){
+                if(file_exists($dir . $language) && is_dir($dir . $language)){
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        /**
+         * Get the default language value like "en" , "fr", etc.
+         *
+         * @return string the default language
+         */
+        public function getDefault(){
+            return $this->default;
+        }
+
+        /**
+         * Get the current language defined by cookie or the default value
+         *
+         * @return string the current language
+         */
+        public function getCurrent(){
+            return $this->current;
+        }
+
+        /**
+         * Add new supported or available language
+         *
+         * @param string $name the short language name like "en", "fr".
+         * @param string $description the human readable description of this language
+         */
+        public function addLang($name, $description){
+            if(isset($this->availables[$name])){
+                return; //already added cost in performance
+            }
+            if($this->isValid($name)){
+                $this->availables[$name] = $description;
+            }
+            else{
+                show_error('The language [' . $name . '] is not valid or does not exists.');
+            }
+        }
+
+        /**
+         * Get the list of the application supported language
+         *
+         * @return array the list of the application language
+         */
+        public function getSupported(){
+            return $this->availables;
+        }
+
+        /**
+         * Add new language messages
+         *
+         * @param array $langs the languages array of the messages to be added
+         */
+        public function addLangMessages(array $langs){
+            foreach ($langs as $key => $value) {
+                $this->set($key, $value);
+            }
+        }
+    }