tnhfw / tnh-fw

core/classes/DBSessionHandler.php

Spacing +29 added lines, -29 removed lines

@@ -27,11 +27,11 @@ 
     /**
      * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
      */
-    if ( !interface_exists('SessionHandlerInterface')){
+    if (!interface_exists('SessionHandlerInterface')) {
         show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
     }
 
-    class DBSessionHandler extends BaseClass implements SessionHandlerInterface{
+    class DBSessionHandler extends BaseClass implements SessionHandlerInterface {
 		
         /**
          * The encryption method to use to encrypt session data in database
@@ -79,7 +79,7 @@ 
          * Create new instance of Database session handler
          * @param object $modelInstance the model instance
          */
-        public function __construct(DBSessionHandlerModel $modelInstance = null){
+        public function __construct(DBSessionHandlerModel $modelInstance = null) {
             parent::__construct();
 			
             //Set Loader instance to use
@@ -87,7 +87,7 @@ 
 	       
             $this->OBJ = & get_instance();
 		    
-            if (is_object($modelInstance)){
+            if (is_object($modelInstance)) {
                 $this->setModelInstance($modelInstance);
             }
         }
@@ -96,7 +96,7 @@ 
          * Set the session secret used to encrypt the data in database 
          * @param string $secret the base64 string secret
          */
-        public function setSessionSecret($secret){
+        public function setSessionSecret($secret) {
             $this->sessionSecret = $secret;
             return $this;
         }
@@ -105,7 +105,7 @@ 
          * Return the session secret
          * @return string 
          */
-        public function getSessionSecret(){
+        public function getSessionSecret() {
             return $this->sessionSecret;
         }
 
@@ -114,7 +114,7 @@ 
          * Set the initializer vector for openssl 
          * @param string $key the session secret used in base64 format
          */
-        public function setInitializerVector($key){
+        public function setInitializerVector($key) {
             $ivLength = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
             $key = base64_decode($key);
             $this->iv = substr(hash('sha256', $key), 0, $ivLength);
@@ -125,7 +125,7 @@ 
          * Return the initializer vector
          * @return string 
          */
-        public function getInitializerVector(){
+        public function getInitializerVector() {
             return $this->iv;
         }
 
@@ -135,17 +135,17 @@ 
          * @param  string $sessionName the session name
          * @return boolean 
          */
-        public function open($savePath, $sessionName){
+        public function open($savePath, $sessionName) {
             $this->logger->debug('Opening database session handler for [' . $sessionName . ']');
             //try to check if session secret is set before
             $secret = $this->getSessionSecret();
-            if (empty($secret)){
+            if (empty($secret)) {
                 $secret = get_config('session_secret', null);
                 $this->setSessionSecret($secret);
             }
             $this->logger->info('Session secret: ' . $secret);
 
-            if (! is_object($this->modelInstance)){
+            if (!is_object($this->modelInstance)) {
                 $this->setModelInstanceFromSessionConfig();
             }
             $this->setInitializerVector($secret);
@@ -153,7 +153,7 @@ 
             //set session tables columns
             $this->sessionTableColumns = $this->modelInstance->getSessionTableColumns();
 
-            if (empty($this->sessionTableColumns)){
+            if (empty($this->sessionTableColumns)) {
                 show_error('The session handler is "database" but the table columns not set');
             }
             $this->logger->info('Database session, the model columns are listed below: ' . stringfy_vars($this->sessionTableColumns));
@@ -169,7 +169,7 @@ 
          * Close the session
          * @return boolean
          */
-        public function close(){
+        public function close() {
             $this->logger->debug('Closing database session handler');
             return true;
         }
@@ -179,7 +179,7 @@ 
          * @param  string $sid the session id to use
          * @return string      the session data in serialiaze format
          */
-        public function read($sid){
+        public function read($sid) {
             $this->logger->debug('Reading database session data for SID: ' . $sid);
             $instance = $this->getModelInstance();
             $columns = $this->sessionTableColumns;
@@ -188,13 +188,13 @@ 
 			
             $ip = get_ip();
             $host = @gethostbyaddr($ip) or null;
-            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $browser = $this->OBJ->browser->getPlatform() . ', ' . $this->OBJ->browser->getBrowser() . ' ' . $this->OBJ->browser->getVersion();
 			
             $data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
-            if ($data && isset($data->{$columns['sdata']})){
+            if ($data && isset($data->{$columns['sdata']})) {
                 //checking inactivity 
                 $timeInactivity = time() - get_config('session_inactivity_time', 100);
-                if ($data->{$columns['stime']} < $timeInactivity){
+                if ($data->{$columns['stime']} < $timeInactivity) {
                     $this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
                     $this->destroy($sid);
                     return null;
@@ -211,7 +211,7 @@ 
          * @param  mixed $data the session data to save in serialize format
          * @return boolean 
          */
-        public function write($sid, $data){
+        public function write($sid, $data) {
             $this->logger->debug('Saving database session data for SID: ' . $sid . ', data: ' . stringfy_vars($data));
             $instance = $this->getModelInstance();
             $columns = $this->sessionTableColumns;
@@ -222,7 +222,7 @@ 
             $ip = get_ip();
             $keyValue = $instance->getKeyValue();
             $host = @gethostbyaddr($ip) or null;
-            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $browser = $this->OBJ->browser->getPlatform() . ', ' . $this->OBJ->browser->getBrowser() . ' ' . $this->OBJ->browser->getVersion();
             $data = $this->encode($data);
             $params = array(
                             $columns['sid'] => $sid,
@@ -235,7 +235,7 @@ 
                         );
             $this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
             $exists = $instance->get($sid);
-            if ($exists){
+            if ($exists) {
                 $this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
                 //update
                 unset($params[$columns['sid']]);
@@ -251,7 +251,7 @@ 
          * @param  string $sid the session id value
          * @return boolean
          */
-        public function destroy($sid){
+        public function destroy($sid) {
             $this->logger->debug('Destroy of session data for SID: ' . $sid);
             $instance = $this->modelInstance;
             $instance->delete($sid);
@@ -263,7 +263,7 @@ 
          * @param  integer $maxLifetime the max lifetime
          * @return boolean
          */
-        public function gc($maxLifetime){
+        public function gc($maxLifetime) {
             $instance = $this->modelInstance;
             $time = time() - $maxLifetime;
             $this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
@@ -276,9 +276,9 @@ 
          * @param  mixed $data the session data to encode
          * @return mixed the encoded session data
          */
-        public function encode($data){
+        public function encode($data) {
             $key = base64_decode($this->sessionSecret);
-            $dataEncrypted = openssl_encrypt($data , self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
+            $dataEncrypted = openssl_encrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
             $output = base64_encode($dataEncrypted);
             return $output;
         }
@@ -289,7 +289,7 @@ 
          * @param  mixed $data the data to decode
          * @return mixed       the decoded data
          */
-        public function decode($data){
+        public function decode($data) {
             $key = base64_decode($this->sessionSecret);
             $data = base64_decode($data);
             $data = openssl_decrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
@@ -309,7 +309,7 @@ 
          * set the loader instance for future use
          * @param object Loader $loader the loader object
          */
-            public function setLoader($loader){
+            public function setLoader($loader) {
             $this->loader = $loader;
             return $this;
         }
@@ -326,7 +326,7 @@ 
          * set the model instance for future use
          * @param DBSessionHandlerModel $modelInstance the model object
          */
-            public function setModelInstance(DBSessionHandlerModel $modelInstance){
+            public function setModelInstance(DBSessionHandlerModel $modelInstance) {
             $this->modelInstance = $modelInstance;
             return $this;
         }
@@ -334,13 +334,13 @@ 
         /**
          * Set the model instance using the configuration for session
          */
-        protected function setModelInstanceFromSessionConfig(){
+        protected function setModelInstanceFromSessionConfig() {
             $modelName = get_config('session_save_path');
             $this->logger->info('The database session model: ' . $modelName);
             $this->loader->model($modelName, 'dbsessionhandlerinstance'); 
             //@codeCoverageIgnoreStart
             if (isset($this->OBJ->dbsessionhandlerinstance) 
-                && ! ($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
+                && !($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
             ) {
                 show_error('To use database session handler, your class model "' . get_class($this->OBJ->dbsessionhandlerinstance) . '" need extends "DBSessionHandlerModel"');
             }  

core/classes/Response.php

Indentation +460 added lines, -460 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -170,21 +170,21 @@ 
 			//check in module first
 			$logger->debug('Checking the view [' . $view . '] from module list ...');
 			$moduleInfo = $this->getModuleInfoForView($view);
-			$module    = $moduleInfo['module'];
-			$view  = $moduleInfo['view'];
+			$module = $moduleInfo['module'];
+			$view = $moduleInfo['view'];
 			
 			$moduleViewPath = Module::findViewFullPath($view, $module);
-			if($moduleViewPath){
+			if ($moduleViewPath) {
 				$path = $moduleViewPath;
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
-			} else{
-				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
+				$logger->info('Found view [' . $view . '] in module [' . $module . '], the file path is [' . $moduleViewPath . '] we will used it');
+			} else {
+				$logger->info('Cannot find view [' . $view . '] in module [' . $module . '] using the default location');
 			}
 			
 			$logger->info('The view file path to be loaded is [' . $path . ']');
 			
 			/////////
-			if($return){
+			if ($return) {
 				return $this->loadView($path, $data, true);
 			}
 			$this->loadView($path, $data, false);
@@ -298,8 +298,8 @@ 
 				$output = ob_get_clean();
 				self::sendHeaders(404);
 				echo $output;
-			} else{
-				show_error('The 404 view [' .$path. '] does not exist');
+			} else {
+				show_error('The 404 view [' . $path . '] does not exist');
 			}
 		}
 
@@ -321,7 +321,7 @@ 
 				$output = ob_get_clean();
 				self::sendHeaders(503);
 				echo $output;
-			} else{
+			} else {
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
 				set_http_status_header(503);
 				echo 'The error view [' . $path . '] does not exist';

core/classes/Request.php

Indentation +230 added lines, -230 removed lines

@@ -1,255 +1,255 @@
 <?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 Request {
+    class Request {
 		
-		/**
-		 * The value for the super global $_GET
-		 * @var array
-		 */
-		public $get = null;
+        /**
+         * The value for the super global $_GET
+         * @var array
+         */
+        public $get = null;
 
-		/**
-		 * The value for the super global $_POST
-		 * @var array
-		 */
-		public $post = null;
+        /**
+         * The value for the super global $_POST
+         * @var array
+         */
+        public $post = null;
 
-		/**
-		 * The value for the super global $_SERVER
-		 * @var array
-		 */
-		public $server = null;
+        /**
+         * The value for the super global $_SERVER
+         * @var array
+         */
+        public $server = null;
 
-		/**
-		 * The value for the super global $_COOKIE
-		 * @var array
-		 */
-		public $cookie = null;
+        /**
+         * The value for the super global $_COOKIE
+         * @var array
+         */
+        public $cookie = null;
 
-		/**
-		 * The value for the super global $_FILES
-		 * @var array
-		 */
-		public $file = null;
+        /**
+         * The value for the super global $_FILES
+         * @var array
+         */
+        public $file = null;
 
-		/**
-		 * The value for the super global $_REQUEST
-		 * @var array
-		 */
-		public $query = null;
+        /**
+         * The value for the super global $_REQUEST
+         * @var array
+         */
+        public $query = null;
 		
-		/**
-		 * The session instance
-		 * @var Session
-		 */
-		public $session = null;
+        /**
+         * The session instance
+         * @var Session
+         */
+        public $session = null;
 		
-		/**
-		 * The request headers
-		 * @var array
-		 */
-		public $header = null;
+        /**
+         * The request headers
+         * @var array
+         */
+        public $header = null;
 
-		/**
-		 * The current request method 'GET', 'POST', 'PUT', etc.
-		 * @var null
-		 */
-		private $method = null;
+        /**
+         * The current request method 'GET', 'POST', 'PUT', etc.
+         * @var null
+         */
+        private $method = null;
 
-		/**
-		 * The current request URI
-		 * @var string
-		 */
-		private $requestUri = null;
+        /**
+         * The current request URI
+         * @var string
+         */
+        private $requestUri = null;
 		
 		
-		/**
-		 * Construct new request instance
-		 */
-		public function __construct(){
-			$this->get = $_GET;
-			$this->post = $_POST;
-			$this->server = $_SERVER;
-			$this->query = $_REQUEST;
-			$this->cookie = $_COOKIE;
-			$this->file = $_FILES;
-			$this->session =& class_loader('Session', 'classes');
-			$this->method = $this->server('REQUEST_METHOD');
-			$this->requestUri = $this->server('REQUEST_URI');
-			$this->header = array();
-			if(function_exists('apache_request_headers')){
-				$this->header = apache_request_headers();
-			} else if(function_exists('getallheaders')){
-				$this->header = getallheaders();
-			}
-		}
+        /**
+         * Construct new request instance
+         */
+        public function __construct(){
+            $this->get = $_GET;
+            $this->post = $_POST;
+            $this->server = $_SERVER;
+            $this->query = $_REQUEST;
+            $this->cookie = $_COOKIE;
+            $this->file = $_FILES;
+            $this->session =& class_loader('Session', 'classes');
+            $this->method = $this->server('REQUEST_METHOD');
+            $this->requestUri = $this->server('REQUEST_URI');
+            $this->header = array();
+            if(function_exists('apache_request_headers')){
+                $this->header = apache_request_headers();
+            } else if(function_exists('getallheaders')){
+                $this->header = getallheaders();
+            }
+        }
 
-		/**
-		 * Get the request method
-		 * @return string
-		 */
-		public function method() {
-			return $this->method;
-		}
+        /**
+         * Get the request method
+         * @return string
+         */
+        public function method() {
+            return $this->method;
+        }
 		
-		/**
-		 * Get the request URI
-		 * @return string
-		 */
-		public function requestUri() {
-			return $this->requestUri;
-		}
+        /**
+         * Get the request URI
+         * @return string
+         */
+        public function requestUri() {
+            return $this->requestUri;
+        }
 
-		/**
-		 * Get the value from $_REQUEST for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function query($key = null, $xss = true) {
-			if (empty($key)) {
-				//return all
-				return $xss ? clean_input($this->query) : $this->query;
-			}
-			$query = array_key_exists($key, $this->query) ? $this->query[$key] : null;
-			if ($xss) {
-				$query = clean_input($query);
-			}
-			return $query;
-		}
+        /**
+         * Get the value from $_REQUEST for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function query($key = null, $xss = true) {
+            if (empty($key)) {
+                //return all
+                return $xss ? clean_input($this->query) : $this->query;
+            }
+            $query = array_key_exists($key, $this->query) ? $this->query[$key] : null;
+            if ($xss) {
+                $query = clean_input($query);
+            }
+            return $query;
+        }
 		
-		/**
-		 * Get the value from $_GET for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function get($key = null, $xss = true) {
-			if (empty($key)) {
-				//return all
-				return $xss ? clean_input($this->get) : $this->get;
-			}
-			$get = array_key_exists($key, $this->get) ? $this->get[$key] : null;
-			if ($xss) {
-				$get = clean_input($get);
-			}
-			return $get;
-		}
+        /**
+         * Get the value from $_GET for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function get($key = null, $xss = true) {
+            if (empty($key)) {
+                //return all
+                return $xss ? clean_input($this->get) : $this->get;
+            }
+            $get = array_key_exists($key, $this->get) ? $this->get[$key] : null;
+            if ($xss) {
+                $get = clean_input($get);
+            }
+            return $get;
+        }
 		
-		/**
-		 * Get the value from $_POST for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function post($key = null, $xss = true) {
-			if (empty($key)) {
-				//return all
-				return $xss ? clean_input($this->post) : $this->post;
-			}
-			$post = array_key_exists($key, $this->post) ? $this->post[$key] : null;
-			if ($xss) {
-				$post = clean_input($post);
-			}
-			return $post;
-		}
+        /**
+         * Get the value from $_POST for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function post($key = null, $xss = true) {
+            if (empty($key)) {
+                //return all
+                return $xss ? clean_input($this->post) : $this->post;
+            }
+            $post = array_key_exists($key, $this->post) ? $this->post[$key] : null;
+            if ($xss) {
+                $post = clean_input($post);
+            }
+            return $post;
+        }
 		
-		/**
-		 * Get the value from $_SERVER for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function server($key = null, $xss = true) {
-			if (empty($key)) {
-				//return all
-				return $xss ? clean_input($this->server) : $this->server;
-			}
-			$server = array_key_exists($key, $this->server) ? $this->server[$key] : null;
-			if ($xss) {
-				$server = clean_input($server);
-			}
-			return $server;
-		}
+        /**
+         * Get the value from $_SERVER for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function server($key = null, $xss = true) {
+            if (empty($key)) {
+                //return all
+                return $xss ? clean_input($this->server) : $this->server;
+            }
+            $server = array_key_exists($key, $this->server) ? $this->server[$key] : null;
+            if ($xss) {
+                $server = clean_input($server);
+            }
+            return $server;
+        }
 		
-		/**
-		 * Get the value from $_COOKIE for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function cookie($key = null, $xss = true) {
-			if (empty($key)) {
-				//return all
-				return $xss ? clean_input($this->cookie) : $this->cookie;
-			}
-			$cookie = array_key_exists($key, $this->cookie) ? $this->cookie[$key] : null;
-			if ($xss) {
-				$cookie = clean_input($cookie);
-			}
-			return $cookie;
-		}
+        /**
+         * Get the value from $_COOKIE for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function cookie($key = null, $xss = true) {
+            if (empty($key)) {
+                //return all
+                return $xss ? clean_input($this->cookie) : $this->cookie;
+            }
+            $cookie = array_key_exists($key, $this->cookie) ? $this->cookie[$key] : null;
+            if ($xss) {
+                $cookie = clean_input($cookie);
+            }
+            return $cookie;
+        }
 		
-		/**
-		 * Get the value from $_FILES for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
-		 */
-		public function file($key) {
-			$file = array_key_exists($key, $this->file) ? $this->file[$key] : null;
-			return $file;
-		}
+        /**
+         * Get the value from $_FILES for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @return array|mixed       the item value if the key exists or all array if the key does not exists or is empty
+         */
+        public function file($key) {
+            $file = array_key_exists($key, $this->file) ? $this->file[$key] : null;
+            return $file;
+        }
 		
-		/**
-		 * Get the value from $_SESSION for given key. if the key is empty will return the all values
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return array|mixed       the item value if the key exists or null if the key does not exists
-		 */
-		public function session($key, $xss = true) {
-			$session = $this->session->get($key);
-			if ($xss) {
-				$session = clean_input($session);
-			}
-			return $session;
-		}
+        /**
+         * Get the value from $_SESSION for given key. if the key is empty will return the all values
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return array|mixed       the item value if the key exists or null if the key does not exists
+         */
+        public function session($key, $xss = true) {
+            $session = $this->session->get($key);
+            if ($xss) {
+                $session = clean_input($session);
+            }
+            return $session;
+        }
 
-		/**
-		 * Get the value from header array for given key.
-		 * @param  string  $key the item key to be fetched
-		 * @param  boolean $xss if need apply some XSS attack rule on the value
-		 * @return mixed       the item value if the key exists or null if the key does not exists
-		 */
-		public function header($key, $xss = true) {
-			$header = array_key_exists($key, $this->header) ? $this->header[$key] : null;
-			if ($xss) {
-				$header = clean_input($header);
-			}
-			return $header;
-		}
+        /**
+         * Get the value from header array for given key.
+         * @param  string  $key the item key to be fetched
+         * @param  boolean $xss if need apply some XSS attack rule on the value
+         * @return mixed       the item value if the key exists or null if the key does not exists
+         */
+        public function header($key, $xss = true) {
+            $header = array_key_exists($key, $this->header) ? $this->header[$key] : null;
+            if ($xss) {
+                $header = clean_input($header);
+            }
+            return $header;
+        }
 		
-	}
+    }

Spacing +4 added lines, -4 removed lines

@@ -90,20 +90,20 @@
 		/**
 		 * Construct new request instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$this->get = $_GET;
 			$this->post = $_POST;
 			$this->server = $_SERVER;
 			$this->query = $_REQUEST;
 			$this->cookie = $_COOKIE;
 			$this->file = $_FILES;
-			$this->session =& class_loader('Session', 'classes');
+			$this->session = & class_loader('Session', 'classes');
 			$this->method = $this->server('REQUEST_METHOD');
 			$this->requestUri = $this->server('REQUEST_URI');
 			$this->header = array();
-			if(function_exists('apache_request_headers')){
+			if (function_exists('apache_request_headers')) {
 				$this->header = apache_request_headers();
-			} else if(function_exists('getallheaders')){
+			} else if (function_exists('getallheaders')) {
 				$this->header = getallheaders();
 			}
 		}

core/classes/BaseClass.php

Spacing +9 added lines, -9 removed lines

@@ -24,7 +24,7 @@ 
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
      */
 
-    class BaseClass{
+    class BaseClass {
         /**
          * The logger instance
          * @var object
@@ -34,7 +34,7 @@ 
         /**
          * Class constructor
          */
-        public function __construct(){
+        public function __construct() {
             //Set Log instance to use
                 $this->setLoggerFromParamOrCreate(null);
         }
@@ -49,12 +49,12 @@ 
          *
          * @return object this current instance
          */
-        protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
-            if ($instance !== null){
+        protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes') {
+            if ($instance !== null) {
             $this->{$name} = $instance;
             return $this;
             }
-            $this->{$name} =& class_loader($loadClassName, $loadClassePath);
+            $this->{$name} = & class_loader($loadClassName, $loadClassePath);
             return $this;
         }
 
@@ -62,7 +62,7 @@ 
          * Return the Log instance
          * @return object
          */
-        public function getLogger(){
+        public function getLogger() {
             return $this->logger;
         }
 
@@ -71,7 +71,7 @@ 
          * @param object $logger the log object
          * @return object Database
          */
-        public function setLogger($logger){
+        public function setLogger($logger) {
             $this->logger = $logger;
             return $this;
         }
@@ -82,9 +82,9 @@ 
          *
          * @return object this current instance
          */
-        protected function setLoggerFromParamOrCreate(Log $logger = null){
+        protected function setLoggerFromParamOrCreate(Log $logger = null) {
             $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
-            if ($logger === null){
+            if ($logger === null) {
             $this->logger->setLogger('Class::' . get_class($this));
             }
             return $this;

core/classes/cache/ApcCache.php

Spacing +34 added lines, -34 removed lines

@@ -24,13 +24,13 @@ 
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
      */
 	
-    class ApcCache extends BaseClass implements CacheInterface{
+    class ApcCache extends BaseClass implements CacheInterface {
 
 		
 		
-        public function __construct(){
+        public function __construct() {
             parent::__construct();
-            if(! $this->isSupported()){
+            if (!$this->isSupported()) {
                 show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
             }
         }
@@ -40,21 +40,21 @@ 
          * @param  string $key the key to identify the cache data
          * @return mixed      the cache data if exists else return false
          */
-        public function get($key){
-            $this->logger->debug('Getting cache data for key ['. $key .']');
+        public function get($key) {
+            $this->logger->debug('Getting cache data for key [' . $key . ']');
             $success = false;
             $data = apc_fetch($key, $success);
-            if($success === false){
-                $this->logger->info('No cache found for the key ['. $key .'], return false');
+            if ($success === false) {
+                $this->logger->info('No cache found for the key [' . $key . '], return false');
                 return false;
             }
-            else{
+            else {
                 $cacheInfo = $this->_getCacheInfo($key);
                 $expire = time();
-                if($cacheInfo){
+                if ($cacheInfo) {
                     $expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
                 }
-                $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+                $this->logger->info('The cache not yet expire, now return the cache data for key [' . $key . '], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
                 return $data;
             }
         }
@@ -67,16 +67,16 @@ 
          * @param integer $ttl  the cache life time
          * @return boolean true if success otherwise will return false
          */
-        public function set($key, $data, $ttl = 0){
+        public function set($key, $data, $ttl = 0) {
             $expire = time() + $ttl;
-            $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+            $this->logger->debug('Setting cache data for key [' . $key . '], time to live [' . $ttl . '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
             $result = apc_store($key, $data, $ttl);
-            if($result === false){
-                $this->logger->error('Can not write cache data for the key ['. $key .'], return false');
+            if ($result === false) {
+                $this->logger->error('Can not write cache data for the key [' . $key . '], return false');
                 return false;
             }
-            else{
-                $this->logger->info('Cache data saved for the key ['. $key .']');
+            else {
+                $this->logger->info('Cache data saved for the key [' . $key . ']');
                 return true;
             }
         }
@@ -88,15 +88,15 @@ 
          * @return boolean      true if the cache is deleted, false if can't delete 
          * the cache or the cache with the given key not exist
          */
-        public function delete($key){
-            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+        public function delete($key) {
+            $this->logger->debug('Deleting of cache data for key [' . $key . ']');
             $cacheInfo = $this->_getCacheInfo($key);
-            if($cacheInfo === false){
+            if ($cacheInfo === false) {
                 $this->logger->info('This cache data does not exists skipping');
                 return false;
             }
-            else{
-                $this->logger->info('Found cache data for the key [' .$key. '] remove it');
+            else {
+                $this->logger->info('Found cache data for the key [' . $key . '] remove it');
                     return apc_delete($key) === true;
             }
         }
@@ -109,10 +109,10 @@ 
          * 'expire' => expiration time of the cache (Unix timestamp),
          * 'ttl' => the time to live of the cache in second
          */
-        public function getInfo($key){
-            $this->logger->debug('Getting of cache info for key [' .$key. ']');
+        public function getInfo($key) {
+            $this->logger->debug('Getting of cache info for key [' . $key . ']');
             $cacheInfos = $this->_getCacheInfo($key);
-            if($cacheInfos){
+            if ($cacheInfos) {
                 $data = array(
                             'mtime' => $cacheInfos['creation_time'],
                             'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
@@ -120,7 +120,7 @@ 
                             );
                 return $data;
             }
-            else{
+            else {
                 $this->logger->info('This cache does not exists skipping');
                 return false;
             }
@@ -130,7 +130,7 @@ 
         /**
          * Used to delete expired cache data
          */
-        public function deleteExpiredCache(){
+        public function deleteExpiredCache() {
             //for APC[u] is done automatically
             return true;
         }
@@ -138,14 +138,14 @@ 
         /**
          * Remove all cache data
          */
-        public function clean(){
+        public function clean() {
             $this->logger->debug('Deleting of all cache data');
             $cacheInfos = apc_cache_info('user');
-            if(empty($cacheInfos['cache_list'])){
+            if (empty($cacheInfos['cache_list'])) {
                 $this->logger->info('No cache data were found skipping');
                 return false;
             }
-            else{
+            else {
                 $this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
                 return apc_clear_cache('user');
             }
@@ -157,7 +157,7 @@ 
          *
          * @return bool
          */
-        public function isSupported(){
+        public function isSupported() {
             return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
         }
 		
@@ -167,12 +167,12 @@ 
          * @param string $key the cache key to get the cache information 
          * @return boolean|array
          */
-        private function _getCacheInfo($key){
+        private function _getCacheInfo($key) {
             $caches = apc_cache_info('user');
-            if(! empty($caches['cache_list'])){
+            if (!empty($caches['cache_list'])) {
                 $cacheLists = $caches['cache_list'];
-                foreach ($cacheLists as $c){
-                    if(isset($c['info']) && $c['info'] === $key){
+                foreach ($cacheLists as $c) {
+                    if (isset($c['info']) && $c['info'] === $key) {
                         return $c;
                     }
                 }

Braces +5 added lines, -10 removed lines

@@ -47,8 +47,7 @@ 
             if($success === false){
                 $this->logger->info('No cache found for the key ['. $key .'], return false');
                 return false;
-            }
-            else{
+            } else{
                 $cacheInfo = $this->_getCacheInfo($key);
                 $expire = time();
                 if($cacheInfo){
@@ -74,8 +73,7 @@ 
             if($result === false){
                 $this->logger->error('Can not write cache data for the key ['. $key .'], return false');
                 return false;
-            }
-            else{
+            } else{
                 $this->logger->info('Cache data saved for the key ['. $key .']');
                 return true;
             }
@@ -94,8 +92,7 @@ 
             if($cacheInfo === false){
                 $this->logger->info('This cache data does not exists skipping');
                 return false;
-            }
-            else{
+            } else{
                 $this->logger->info('Found cache data for the key [' .$key. '] remove it');
                     return apc_delete($key) === true;
             }
@@ -119,8 +116,7 @@ 
                             'ttl' => $cacheInfos['ttl']
                             );
                 return $data;
-            }
-            else{
+            } else{
                 $this->logger->info('This cache does not exists skipping');
                 return false;
             }
@@ -144,8 +140,7 @@ 
             if(empty($cacheInfos['cache_list'])){
                 $this->logger->info('No cache data were found skipping');
                 return false;
-            }
-            else{
+            } else{
                 $this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
                 return apc_clear_cache('user');
             }

core/classes/cache/CacheInterface.php

Indentation +70 added lines, -70 removed lines

@@ -1,84 +1,84 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	interface CacheInterface {
+    interface CacheInterface {
 
-		/**
-		 * This is used to get the cache data using the key
-		 * @param  string $key the key to identify the cache data
-		 * @return mixed      the cache data if exists else return false
-		 */
-		public function get($key);
+        /**
+         * This is used to get the cache data using the key
+         * @param  string $key the key to identify the cache data
+         * @return mixed      the cache data if exists else return false
+         */
+        public function get($key);
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data to be saved
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0);
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data to be saved
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0);
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is deleted, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key);
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is deleted, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key);
 		
 		
-		/**
-		 * Get the cache information for given key
-		 * @param  string $key the key for cache to get the information for
-		 * @return boolean|array    the cache information. The associative array and must contains the following information:
-		 * 'mtime' => creation time of the cache (Unix timestamp),
-		 * 'expire' => expiration time of the cache (Unix timestamp),
-		 * 'ttl' => the time to live of the cache in second
-		 */
-		public function getInfo($key);
+        /**
+         * Get the cache information for given key
+         * @param  string $key the key for cache to get the information for
+         * @return boolean|array    the cache information. The associative array and must contains the following information:
+         * 'mtime' => creation time of the cache (Unix timestamp),
+         * 'expire' => expiration time of the cache (Unix timestamp),
+         * 'ttl' => the time to live of the cache in second
+         */
+        public function getInfo($key);
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache();
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache();
 
-		/**
-		 * Remove all cache data
-		 */
-		public function clean();
+        /**
+         * Remove all cache data
+         */
+        public function clean();
 		
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported();
-	}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported();
+    }

core/classes/cache/FileCache.php

Spacing +54 added lines, -54 removed lines

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

Braces +8 added lines, -16 removed lines

@@ -82,8 +82,7 @@ 
                 // Unlinking when the file was expired
                 unlink($filePath);
                 return false;
-                }
-                else{
+                } else{
                     $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
                     return $data['data'];
                 }
@@ -120,8 +119,7 @@ 
                 $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
                 fclose($handle);
                 return false;
-            }
-            else{
+            } else{
                 $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
                 fclose($handle);
                 chmod($filePath, 0640);
@@ -143,8 +141,7 @@ 
             if(! file_exists($filePath)){
                 $this->logger->info('This cache file does not exists skipping');
                 return false;
-            }
-            else{
+            } else{
                 $this->logger->info('Found cache file [' .$filePath. '] remove it');
                     unlink($filePath);
                 return true;
@@ -197,8 +194,7 @@ 
             $list = glob(CACHE_PATH . '*.cache');
             if(! $list){
                 $this->logger->info('No cache files were found skipping');
-            }
-            else{
+            } else{
                 $this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
                 foreach ($list as $file) {
                     $this->logger->debug('Processing the cache file [' . $file . ']');
@@ -206,12 +202,10 @@ 
                         $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
                         if(! $data){
                             $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
-                        }
-                        else if(time() > $data['expire']){
+                        } else if(time() > $data['expire']){
                             $this->logger->info('The cache data for file [' . $file . '] already expired remove it');
                             unlink($file);
-                        }
-                        else{
+                        } else{
                             $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
                         }
                 }
@@ -226,8 +220,7 @@ 
             $list = glob(CACHE_PATH . '*.cache');
             if(! $list){
                 $this->logger->info('No cache files were found skipping');
-            }
-            else{
+            } else{
                 $this->logger->info('Found [' . count($list) . '] cache files to remove');
                 foreach ($list as $file) {
                     $this->logger->debug('Processing the cache file [' . $file . ']');
@@ -254,8 +247,7 @@ 
 				
                 $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
                 $this->compressCacheData = false;
-            }
-            else{
+            } else{
                 $this->compressCacheData = $status;
             }
             return $this;

core/classes/Router.php

Spacing +71 added lines, -71 removed lines

@@ -24,7 +24,7 @@ 
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
      */
 
-    class Router extends BaseClass{
+    class Router extends BaseClass {
         /**
          * @var array $pattern: The list of URIs to validate against
          */
@@ -90,13 +90,13 @@ 
         /**
          * Construct the new Router instance
          */
-        public function __construct(){
+        public function __construct() {
             parent::__construct();
 			
             //loading routes for module
             $moduleRouteList = array();
             $modulesRoutes = Module::getModulesRoutesConfig();
-            if($modulesRoutes && is_array($modulesRoutes)){
+            if ($modulesRoutes && is_array($modulesRoutes)) {
                 $moduleRouteList = $modulesRoutes;
                 unset($modulesRoutes);
             }
@@ -111,7 +111,7 @@ 
          * Get the route patterns
          * @return array
          */
-        public function getPattern(){
+        public function getPattern() {
             return $this->pattern;
         }
 
@@ -119,7 +119,7 @@ 
          * Get the route callbacks
          * @return array
          */
-        public function getCallback(){
+        public function getCallback() {
             return $this->callback;
         }
 
@@ -127,7 +127,7 @@ 
          * Get the module name
          * @return string
          */
-        public function getModule(){
+        public function getModule() {
             return $this->module;
         }
 		
@@ -135,7 +135,7 @@ 
          * Get the controller name
          * @return string
          */
-        public function getController(){
+        public function getController() {
             return $this->controller;
         }
 
@@ -143,7 +143,7 @@ 
          * Get the controller file path
          * @return string
          */
-        public function getControllerPath(){
+        public function getControllerPath() {
             return $this->controllerPath;
         }
 
@@ -151,7 +151,7 @@ 
          * Get the controller method
          * @return string
          */
-        public function getMethod(){
+        public function getMethod() {
             return $this->method;
         }
 
@@ -159,7 +159,7 @@ 
          * Get the request arguments
          * @return array
          */
-        public function getArgs(){
+        public function getArgs() {
             return $this->args;
         }
 
@@ -167,7 +167,7 @@ 
          * Get the URL segments array
          * @return array
          */
-        public function getSegments(){
+        public function getSegments() {
             return $this->segments;
         }
 
@@ -175,7 +175,7 @@ 
          * Get the route URI
          * @return string
          */
-        public function getRouteUri(){
+        public function getRouteUri() {
             return $this->uri;
         }
 
@@ -189,7 +189,7 @@ 
          */
         public function add($uri, $callback) {
             $uri = trim($uri, $this->uriTrim);
-            if(in_array($uri, $this->pattern)){
+            if (in_array($uri, $this->pattern)) {
                 $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
             }
             $this->pattern[] = $uri;
@@ -205,8 +205,8 @@ 
          * @return object the current instance
          */
         public function removeRoute($uri) {
-            $index  = array_search($uri, $this->pattern, true);
-            if($index !== false){
+            $index = array_search($uri, $this->pattern, true);
+            if ($index !== false) {
                 $this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
                 unset($this->pattern[$index]);
                 unset($this->callback[$index]);
@@ -234,26 +234,26 @@ 
          * @param string $uri the route URI, if is empty will determine automatically
          * @return object
          */
-        public function setRouteUri($uri = ''){
+        public function setRouteUri($uri = '') {
             $routeUri = '';
-            if(! empty($uri)){
+            if (!empty($uri)) {
                 $routeUri = $uri;
             }
             //if the application is running in CLI mode use the first argument
-            else if(IS_CLI && isset($_SERVER['argv'][1])){
+            else if (IS_CLI && isset($_SERVER['argv'][1])) {
                 $routeUri = $_SERVER['argv'][1];
             }
-            else if(isset($_SERVER['REQUEST_URI'])){
+            else if (isset($_SERVER['REQUEST_URI'])) {
                 $routeUri = $_SERVER['REQUEST_URI'];
             }
             $this->logger->debug('Check if URL suffix is enabled in the configuration');
             //remove url suffix from the request URI
             $suffix = get_config('url_suffix');
             if ($suffix) {
-                $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+                $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']');
                 $routeUri = str_ireplace($suffix, '', $routeUri);
             } 
-            if (strpos($routeUri, '?') !== false){
+            if (strpos($routeUri, '?') !== false) {
                 $routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
             }
             $this->uri = trim($routeUri, $this->uriTrim);
@@ -266,8 +266,8 @@ 
              * 
              * @return object
              */
-        public function setRouteSegments(array $segments = array()){
-            if(! empty($segments)){
+        public function setRouteSegments(array $segments = array()) {
+            if (!empty($segments)) {
                 $this->segments = $segments;
             } else if (!empty($this->uri)) {
                 $this->segments = explode('/', $this->uri);
@@ -275,12 +275,12 @@ 
             $segment = $this->segments;
             $baseUrl = get_config('base_url');
             //check if the app is not in DOCUMENT_ROOT
-            if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
+            if (isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false) {
                 array_shift($segment);
                 $this->segments = $segment;
             }
             $this->logger->debug('Check if the request URI contains the front controller');
-            if(isset($segment[0]) && $segment[0] == SELF){
+            if (isset($segment[0]) && $segment[0] == SELF) {
                 $this->logger->info('The request URI contains the front controller');
                 array_shift($segment);
                 $this->segments = $segment;
@@ -300,7 +300,7 @@ 
 			
             //if can not determine the module/controller/method via the defined routes configuration we will use
             //the URL like http://domain.com/module/controller/method/arg1/arg2
-            if(! $this->controller){
+            if (!$this->controller) {
                 $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
                 //determine route parameters using the REQUEST_URI param
                 $this->determineRouteParamsFromRequestUri();
@@ -316,14 +316,14 @@ 
              * Routing the request to the correspondant module/controller/method if exists
              * otherwise send 404 error.
              */
-        public function processRequest(){
+        public function processRequest() {
             //Setting the route URI
             $this->setRouteUri();
 
             //setting route segments
             $this->setRouteSegments();
 
-            $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
+            $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']');
 
             //determine the route parameters information
             $this->determineRouteParamsInformation();
@@ -334,20 +334,20 @@ 
             $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
             $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 	    	
-            if(file_exists($classFilePath)){
+            if (file_exists($classFilePath)) {
                 require_once $classFilePath;
-                if(! class_exists($controller, false)){
+                if (!class_exists($controller, false)) {
                     $e404 = true;
-                    $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+                    $this->logger->warning('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']');
                 }
-                else{
+                else {
                     $controllerInstance = new $controller();
                     $controllerMethod = $this->getMethod();
-                    if(! method_exists($controllerInstance, $controllerMethod)){
+                    if (!method_exists($controllerInstance, $controllerMethod)) {
                         $e404 = true;
                         $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
                     }
-                    else{
+                    else {
                         $this->logger->info('Routing data is set correctly now GO!');
                         call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
                         //render the final page to user
@@ -356,16 +356,16 @@ 
                     }
                 }
             }
-            else{
+            else {
                 $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
                 $e404 = true;
             }
-            if($e404){
-                if(IS_CLI){
+            if ($e404) {
+                if (IS_CLI) {
                     set_http_status_header(404);
                     echo 'Error 404: page not found.';
                 } else {
-                    $response =& class_loader('Response', 'classes');
+                    $response = & class_loader('Response', 'classes');
                     $response->send404();
                 }
             }
@@ -378,15 +378,15 @@ 
          * @param boolean $useConfigFile whether to use route configuration file
          * @return object
          */
-        public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+        public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
             $route = array();
-            if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+            if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')) {
                 require_once CONFIG_PATH . 'routes.php';
             }
             $route = array_merge($route, $overwriteConfig);
             $this->routes = $route;
             //if route is empty remove all configuration
-            if(empty($route)){
+            if (empty($route)) {
                 $this->removeAllRoute();
             }
             return $this;
@@ -396,7 +396,7 @@ 
              * Get the route configuration
              * @return array
              */
-        public function getRouteConfiguration(){
+        public function getRouteConfiguration() {
             return $this->routes;
         }
 
@@ -408,19 +408,19 @@ 
          *
          * @return object the current instance
          */
-        public function setControllerFilePath($path = null){
-            if($path !== null){
+        public function setControllerFilePath($path = null) {
+            if ($path !== null) {
                 $this->controllerPath = $path;
                 return $this;
             }
             //did we set the controller, so set the controller path
-            if($this->controller && ! $this->controllerPath){
+            if ($this->controller && !$this->controllerPath) {
                 $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
                 $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
                 //if the controller is in module
-                if($this->module){
+                if ($this->module) {
                     $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-                    if($path !== false){
+                    if ($path !== false) {
                         $controllerPath = $path;
                     }
                 }
@@ -433,7 +433,7 @@ 
          * Determine the route parameters from route configuration
          * @return void
          */
-        protected function determineRouteParamsFromConfig(){
+        protected function determineRouteParamsFromConfig() {
             $uri = implode('/', $this->segments);
             /*
 	   		* Generics routes patterns
@@ -458,20 +458,20 @@ 
                     array_shift($args);
                     //check if this contains an module
                     $moduleControllerMethod = explode('#', $this->callback[$index]);
-                    if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+                    if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) {
                         $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
                         $this->module = $moduleControllerMethod[0];
                         $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
                     }
-                    else{
+                    else {
                         $this->logger->info('The current request does not use the module');
                         $moduleControllerMethod = explode('@', $this->callback[$index]);
                     }
-                    if(is_array($moduleControllerMethod)){
-                        if(isset($moduleControllerMethod[0])){
+                    if (is_array($moduleControllerMethod)) {
+                        if (isset($moduleControllerMethod[0])) {
                             $this->controller = $moduleControllerMethod[0];	
                         }
-                        if(isset($moduleControllerMethod[1])){
+                        if (isset($moduleControllerMethod[1])) {
                             $this->method = $moduleControllerMethod[1];
                         }
                         $this->args = $args;
@@ -482,7 +482,7 @@ 
             }
 
             //first if the controller is not set and the module is set use the module name as the controller
-            if(! $this->controller && $this->module){
+            if (!$this->controller && $this->module) {
                 $this->logger->info(
                                     'After loop in predefined routes configuration, 
 									the module name is set but the controller is not set, 
@@ -496,67 +496,67 @@ 
          * Determine the route parameters using the server variable "REQUEST_URI"
          * @return void
          */
-        protected function determineRouteParamsFromRequestUri(){
+        protected function determineRouteParamsFromRequestUri() {
             $segment = $this->segments;
             $nbSegment = count($segment);
             //if segment is null so means no need to perform
-            if($nbSegment > 0){
+            if ($nbSegment > 0) {
                 //get the module list
                 $modules = Module::getModuleList();
                 //first check if no module
-                if(empty($modules)){
+                if (empty($modules)) {
                     $this->logger->info('No module was loaded will skip the module checking');
                     //the application don't use module
                     //controller
-                    if(isset($segment[0])){
+                    if (isset($segment[0])) {
                         $this->controller = $segment[0];
                         array_shift($segment);
                     }
                     //method
-                    if(isset($segment[0])){
+                    if (isset($segment[0])) {
                         $this->method = $segment[0];
                         array_shift($segment);
                     }
                     //args
                     $this->args = $segment;
                 }
-                else{
+                else {
                     $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-                    if(in_array($segment[0], $modules)){
+                    if (in_array($segment[0], $modules)) {
                         $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
                         $this->module = $segment[0];
                         array_shift($segment);
                         //check if the second arg is the controller from module
-                        if(isset($segment[0])){
+                        if (isset($segment[0])) {
                             $this->controller = $segment[0];
                             //check if the request use the same module name and controller
                             $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-                            if(! $path){
+                            if (!$path) {
                                 $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
                                 $this->controller = $this->module;
                             }
-                            else{
+                            else {
                                 $this->controllerPath = $path;
                                 array_shift($segment);
                             }
                         }
                         //check for method
-                        if(isset($segment[0])){
+                        if (isset($segment[0])) {
                             $this->method = $segment[0];
                             array_shift($segment);
                         }
                         //the remaining is for args
                         $this->args = $segment;
                     }
-                    else{
+                    else {
                         $this->logger->info('The current request information is not found in the module list');
                         //controller
-                        if(isset($segment[0])){
+                        if (isset($segment[0])) {
                             $this->controller = $segment[0];
                             array_shift($segment);
                         }
                         //method
-                        if(isset($segment[0])){
+                        if (isset($segment[0])) {
                             $this->method = $segment[0];
                             array_shift($segment);
                         }
@@ -564,7 +564,7 @@ 
                         $this->args = $segment;
                     }
                 }
-                if(! $this->controller && $this->module){
+                if (!$this->controller && $this->module) {
                     $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
                     $this->controller = $this->module;
                 }
@@ -576,9 +576,9 @@ 
          *
          * @return object the current instance
          */
-        protected function setRouteConfigurationInfos(){
+        protected function setRouteConfigurationInfos() {
             //adding route
-            foreach($this->routes as $pattern => $callback){
+            foreach ($this->routes as $pattern => $callback) {
                 $this->add($pattern, $callback);
             }
             return $this;

Braces +8 added lines, -16 removed lines

@@ -242,8 +242,7 @@ 
             //if the application is running in CLI mode use the first argument
             else if(IS_CLI && isset($_SERVER['argv'][1])){
                 $routeUri = $_SERVER['argv'][1];
-            }
-            else if(isset($_SERVER['REQUEST_URI'])){
+            } else if(isset($_SERVER['REQUEST_URI'])){
                 $routeUri = $_SERVER['REQUEST_URI'];
             }
             $this->logger->debug('Check if URL suffix is enabled in the configuration');
@@ -339,15 +338,13 @@ 
                 if(! class_exists($controller, false)){
                     $e404 = true;
                     $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-                }
-                else{
+                } else{
                     $controllerInstance = new $controller();
                     $controllerMethod = $this->getMethod();
                     if(! method_exists($controllerInstance, $controllerMethod)){
                         $e404 = true;
                         $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-                    }
-                    else{
+                    } else{
                         $this->logger->info('Routing data is set correctly now GO!');
                         call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
                         //render the final page to user
@@ -355,8 +352,7 @@ 
                         get_instance()->response->renderFinalPage();
                     }
                 }
-            }
-            else{
+            } else{
                 $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
                 $e404 = true;
             }
@@ -462,8 +458,7 @@ 
                         $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
                         $this->module = $moduleControllerMethod[0];
                         $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-                    }
-                    else{
+                    } else{
                         $this->logger->info('The current request does not use the module');
                         $moduleControllerMethod = explode('@', $this->callback[$index]);
                     }
@@ -519,8 +514,7 @@ 
                     }
                     //args
                     $this->args = $segment;
-                }
-                else{
+                } else{
                     $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
                     if(in_array($segment[0], $modules)){
                         $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
@@ -534,8 +528,7 @@ 
                             if(! $path){
                                 $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
                                 $this->controller = $this->module;
-                            }
-                            else{
+                            } else{
                                 $this->controllerPath = $path;
                                 array_shift($segment);
                             }
@@ -547,8 +540,7 @@ 
                         }
                         //the remaining is for args
                         $this->args = $segment;
-                    }
-                    else{
+                    } else{
                         $this->logger->info('The current request information is not found in the module list');
                         //controller
                         if(isset($segment[0])){

core/classes/EventDispatcher.php

Indentation +155 added lines, -155 removed lines

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

Spacing +35 added lines, -35 removed lines

@@ -47,12 +47,12 @@ 
 		 * @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])){
+		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{
+			} else {
 				$this->logger->info('This event already have the registered listener, add this listener to the list');
 			}
 			$this->listeners[$eventName][] = $listener;
@@ -63,17 +63,17 @@ 
 		 * @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])){
+		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');
+				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{
+				} else {
 					$this->logger->info('Cannot found this listener in the event listener list');
 				}
-			} else{
+			} else {
 				$this->logger->info('This event does not have this listener ignore remove');
 			}
 		}
@@ -83,12 +83,12 @@ 
 		 * 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])){
+		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{
+			} 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();
 			}
@@ -108,20 +108,20 @@ 
 		 * @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){
+		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->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){
+			if ($event->returnBack) {
 				$this->logger->info('This event need return back, return the result for future use');
 				return $this->dispatchToListerners($event);
-			} else{
+			} else {
 				$this->logger->info('This event no need return back the result, just dispatch it');
 				$this->dispatchToListerners($event);
 			}
@@ -132,35 +132,35 @@ 
 		 * @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){
+		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){
+			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));
+			} 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){
+			foreach ($list as $listener) {
+				if ($eBackup->returnBack) {
 					$returnedEvent = call_user_func_array($listener, array($event));
-					if($returnedEvent instanceof EventInfo){
+					if ($returnedEvent instanceof EventInfo) {
 						$event = $returnedEvent;
-					} else{
-						show_error('This event [' .$event->name. '] need you return the event object after processing');
+					} else {
+						show_error('This event [' . $event->name . '] need you return the event object after processing');
 					}
-				} else{
+				} else {
 					call_user_func_array($listener, array($event));
 				}
-				if($event->stop){
+				if ($event->stop) {
 					break;
 				}
 			}
 			//only test for original event may be during the flow some listeners change this parameter
-			if($eBackup->returnBack){
+			if ($eBackup->returnBack) {
 				return $event;
 			}
 		}