tnhfw / tnh-fw

core/classes/EventInfo.php

Indentation +56 added lines, -56 removed lines

@@ -1,63 +1,63 @@
 <?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 detail to dispatch to correspond listener
-	 */
-	class EventInfo{
+    /**
+     * This class represent the event detail to dispatch to correspond listener
+     */
+    class EventInfo{
 		
-		/**
-		 * The event name
-		 * @var string
-		 */
-		public $name;
+        /**
+         * The event name
+         * @var string
+         */
+        public $name;
 
-		/**
-		 * The event data to send to the listeners
-		 * @var mixed
-		 */
-		public $payload;
+        /**
+         * The event data to send to the listeners
+         * @var mixed
+         */
+        public $payload;
 
-		/**
-		 * If the listeners need return the event after treatment or not, false means no need
-		 * return true need return the event. 
-		 * @var boolean
-		 */
-		public $returnBack;
+        /**
+         * If the listeners need return the event after treatment or not, false means no need
+         * return true need return the event. 
+         * @var boolean
+         */
+        public $returnBack;
 
-		/**
-		 * This variable indicates if need stop the event propagation
-		 * @var boolean
-		 */
-		public $stop;
+        /**
+         * This variable indicates if need stop the event propagation
+         * @var boolean
+         */
+        public $stop;
 		
-		public function __construct($name, $payload = array(), $returnBack = false, $stop = false){
-			$this->name = $name;
-			$this->payload = $payload;
-			$this->returnBack = $returnBack;
-			$this->stop = $stop;
-		}
-	}
+        public function __construct($name, $payload = array(), $returnBack = false, $stop = false){
+            $this->name = $name;
+            $this->payload = $payload;
+            $this->returnBack = $returnBack;
+            $this->stop = $stop;
+        }
+    }

core/classes/database/DatabaseQueryResult.php

Indentation +47 added lines, -47 removed lines

@@ -1,43 +1,43 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
   
-  class DatabaseQueryResult{
+    class DatabaseQueryResult{
   	
-  	/**
-  	 * The database query result
-  	 * @var mixed
-  	 */
-     private $result  = null;
+        /**
+         * The database query result
+         * @var mixed
+         */
+        private $result  = null;
   	
     
-  	/**
-	 * The number of rows returned by the last query
-	 * @var int
-     */
-     private $numRows = 0;
+        /**
+         * The number of rows returned by the last query
+         * @var int
+         */
+        private $numRows = 0;
   	
 	
     /**
@@ -51,24 +51,24 @@ 
     }
 
     
-     /**
-     * Return the query result
-     *
-     * @return mixed
-     */
+        /**
+         * Return the query result
+         *
+         * @return mixed
+         */
     public function getResult(){
-      return $this->result;
+        return $this->result;
     }
 
     /**
      * Set the query result
      * @param mixed $result the query result
      *
-	 * @return object DatabaseQueryResult
+     * @return object DatabaseQueryResult
      */
     public function setResult($result){
-      $this->result = $result;
-      return $this;
+        $this->result = $result;
+        return $this;
     }
     
     /**
@@ -77,18 +77,18 @@ 
      * @return int
      */
     public function getNumRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
      * Set the number of rows returned by the query
      * @param int $numRows the number of rows returned
      *
-	 * @return object DatabaseQueryResult
+     * @return object DatabaseQueryResult
      */
     public function setNumRows($numRows){
-      $this->numRows = $numRows;
-      return $this;
+        $this->numRows = $numRows;
+        return $this;
     }
    
 }

core/classes/Session.php

Indentation +154 added lines, -154 removed lines

@@ -1,168 +1,168 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-	class Session{
+    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 Session{
 		
-		/**
-		 * The session flash key to use
-		 * @const
-		 */
-		const SESSION_FLASH_KEY = 'session_flash';
+        /**
+         * The session flash key to use
+         * @const
+         */
+        const SESSION_FLASH_KEY = 'session_flash';
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * Get the logger singleton instance
-		 * @return Log the logger instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Session');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * Get the logger singleton instance
+         * @return Log the logger instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Session');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * Get the session item value
-		 * @param  string $item    the session item name to get
-		 * @param  mixed $default the default value to use if can not find the session item in the list
-		 * @return mixed          the session value if exist or the default value
-		 */
-		public static function get($item, $default = null){
-			$logger = self::getLogger();
-			$logger->debug('Getting session data for item [' .$item. '] ...');
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
-				return $_SESSION[$item];
-			}
-			$logger->warning('Cannot find session item [' . $item . '] using the default value ['. $default . ']');
-			return $default;
-		}
+        /**
+         * Get the session item value
+         * @param  string $item    the session item name to get
+         * @param  mixed $default the default value to use if can not find the session item in the list
+         * @return mixed          the session value if exist or the default value
+         */
+        public static function get($item, $default = null){
+            $logger = self::getLogger();
+            $logger->debug('Getting session data for item [' .$item. '] ...');
+            if(array_key_exists($item, $_SESSION)){
+                $logger->info('Found session data for item [' . $item . '] the vaue is : [' . stringfy_vars($_SESSION[$item]) . ']');
+                return $_SESSION[$item];
+            }
+            $logger->warning('Cannot find session item [' . $item . '] using the default value ['. $default . ']');
+            return $default;
+        }
 
-		/**
-		 * Set the session item value
-		 * @param string $item  the session item name to set
-		 * @param mixed $value the session item value
-		 */
-		public static function set($item, $value){
-			$logger = self::getLogger();
-			$logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
-			$_SESSION[$item] = $value;
-		}
+        /**
+         * Set the session item value
+         * @param string $item  the session item name to set
+         * @param mixed $value the session item value
+         */
+        public static function set($item, $value){
+            $logger = self::getLogger();
+            $logger->debug('Setting session data for item [' . $item . '], value [' . stringfy_vars($value) . ']');
+            $_SESSION[$item] = $value;
+        }
 
-		/**
-		 * Get the session flash item value
-		 * @param  string $item    the session flash item name to get
-		 * @param  mixed $default the default value to use if can not find the session flash item in the list
-		 * @return mixed          the session flash value if exist or the default value
-		 */
-		public static function getFlash($item, $default = null){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			$return = array_key_exists($key, $_SESSION) ?
-			($_SESSION[$key]) : $default;
-			if(array_key_exists($key, $_SESSION)){
-				unset($_SESSION[$key]);
-			}
-			else{
-				$logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
-			}
-			return $return;
-		}
+        /**
+         * Get the session flash item value
+         * @param  string $item    the session flash item name to get
+         * @param  mixed $default the default value to use if can not find the session flash item in the list
+         * @return mixed          the session flash value if exist or the default value
+         */
+        public static function getFlash($item, $default = null){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            $return = array_key_exists($key, $_SESSION) ?
+            ($_SESSION[$key]) : $default;
+            if(array_key_exists($key, $_SESSION)){
+                unset($_SESSION[$key]);
+            }
+            else{
+                $logger->warning('Cannot find session flash item ['. $key .'] using the default value ['. $default .']');
+            }
+            return $return;
+        }
 
-		/**
-		 * Check whether the given session flash item exists
-		 * @param  string  $item the session flash item name
-		 * @return boolean 
-		 */
-		public static function hasFlash($item){
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			return array_key_exists($key, $_SESSION);
-		}
+        /**
+         * Check whether the given session flash item exists
+         * @param  string  $item the session flash item name
+         * @return boolean 
+         */
+        public static function hasFlash($item){
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            return array_key_exists($key, $_SESSION);
+        }
 
-		/**
-		 * Set the session flash item value
-		 * @param string $item  the session flash item name to set
-		 * @param mixed $value the session flash item value
-		 */
-		public static function setFlash($item, $value){
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			$_SESSION[$key] = $value;
-		}
+        /**
+         * Set the session flash item value
+         * @param string $item  the session flash item name to set
+         * @param mixed $value the session flash item value
+         */
+        public static function setFlash($item, $value){
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            $_SESSION[$key] = $value;
+        }
 
-		/**
-		 * Clear the session item in the list
-		 * @param  string $item the session item name to be deleted
-		 */
-		public static function clear($item){
-			$logger = self::getLogger();
-			if(array_key_exists($item, $_SESSION)){
-				$logger->info('Deleting of session for item ['.$item.' ]');
-				unset($_SESSION[$item]);
-			}
-			else{
-				$logger->warning('Session item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session item in the list
+         * @param  string $item the session item name to be deleted
+         */
+        public static function clear($item){
+            $logger = self::getLogger();
+            if(array_key_exists($item, $_SESSION)){
+                $logger->info('Deleting of session for item ['.$item.' ]');
+                unset($_SESSION[$item]);
+            }
+            else{
+                $logger->warning('Session item ['.$item.'] to be deleted does not exists');
+            }
+        }
 		
-		/**
-		 * Clear the session flash item in the list
-		 * @param  string $item the session flash item name to be deleted
-		 */
-		public static function clearFlash($item){
-			$logger = self::getLogger();
-			$key = self::SESSION_FLASH_KEY.'_'.$item;
-			if(array_key_exists($key, $_SESSION)){
-				$logger->info('Delete session flash for item ['.$item.']');
-				unset($_SESSION[$item]);
-			}
-			else{
-				$logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
-			}
-		}
+        /**
+         * Clear the session flash item in the list
+         * @param  string $item the session flash item name to be deleted
+         */
+        public static function clearFlash($item){
+            $logger = self::getLogger();
+            $key = self::SESSION_FLASH_KEY.'_'.$item;
+            if(array_key_exists($key, $_SESSION)){
+                $logger->info('Delete session flash for item ['.$item.']');
+                unset($_SESSION[$item]);
+            }
+            else{
+                $logger->warning('Dession flash item ['.$item.'] to be deleted does not exists');
+            }
+        }
 
-		/**
-		 * Check whether the given session item exists
-		 * @param  string  $item the session item name
-		 * @return boolean 
-		 */
-		public static function exists($item){
-			return array_key_exists($item, $_SESSION);
-		}
+        /**
+         * Check whether the given session item exists
+         * @param  string  $item the session item name
+         * @return boolean 
+         */
+        public static function exists($item){
+            return array_key_exists($item, $_SESSION);
+        }
 
-		/**
-		 * Destroy all session data values
-		 */
-		public static function clearAll(){
-			session_unset();
-			session_destroy();
-		}
+        /**
+         * Destroy all session data values
+         */
+        public static function clearAll(){
+            session_unset();
+            session_destroy();
+        }
 
-	}
+    }

core/classes/DBSessionHandler.php

Indentation +344 added lines, -344 removed lines

@@ -1,330 +1,330 @@ 
 <?php 
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	/**
-	 * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
-	 */
-	if( !interface_exists('SessionHandlerInterface')){
-		show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
-	}
-
-	class DBSessionHandler implements SessionHandlerInterface{
+    /**
+     * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
+     */
+    if( !interface_exists('SessionHandlerInterface')){
+        show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
+    }
+
+    class DBSessionHandler implements SessionHandlerInterface{
 		
-		/**
-		 * The encryption method to use to encrypt session data in database
-		 * @const string
-		 */
-		const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
+        /**
+         * The encryption method to use to encrypt session data in database
+         * @const string
+         */
+        const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
 		
-		/**
-		 * Super global instance
-		 * @var object
-		 */
-		protected $OBJ = null;
-
-		/**
-		 * Session secret to use 
-		 * @var string
-		 */
-		private $sessionSecret = null;
-
-		/**
-		 * The initialisation vector to use for openssl
-		 * @var string
-		 */
-		private $iv = null;
-
-		/**
-		 * The model instance name to use after load model
-		 * @var object
-		 */
-		private $modelInstanceName = null;
-
-		/**
-		 * The columns of the table to use to store session data
-		 * @var array
-		 */
-		private $sessionTableColumns = array();
-
-		/**
-		 * The instance of the Log 
-		 * @var Log
-		 */
-		private $logger;
-
-		/**
+        /**
+         * Super global instance
+         * @var object
+         */
+        protected $OBJ = null;
+
+        /**
+         * Session secret to use 
+         * @var string
+         */
+        private $sessionSecret = null;
+
+        /**
+         * The initialisation vector to use for openssl
+         * @var string
+         */
+        private $iv = null;
+
+        /**
+         * The model instance name to use after load model
+         * @var object
+         */
+        private $modelInstanceName = null;
+
+        /**
+         * The columns of the table to use to store session data
+         * @var array
+         */
+        private $sessionTableColumns = array();
+
+        /**
+         * The instance of the Log 
+         * @var Log
+         */
+        private $logger;
+
+        /**
          * Instance of the Loader class
          * @var Loader
          */
         protected $loader = null;
 
-		public function __construct(DBSessionHandlerModel $modelInstance = null, Log $logger = null, Loader $loader = null){
-			/**
-	         * instance of the Log class
-	         */
-	        if(is_object($logger)){
-	          $this->setLogger($logger);
-	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
-	            $this->logger->setLogger('Library::DBSessionHandler');
-	        }
-
-	        if(is_object($loader)){
-	          $this->setLoader($loader);
-	        }
-		    $this->OBJ = & get_instance();
+        public function __construct(DBSessionHandlerModel $modelInstance = null, Log $logger = null, Loader $loader = null){
+            /**
+             * instance of the Log class
+             */
+            if(is_object($logger)){
+                $this->setLogger($logger);
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::DBSessionHandler');
+            }
+
+            if(is_object($loader)){
+                $this->setLoader($loader);
+            }
+            $this->OBJ = & get_instance();
 
 		    
-			if(is_object($modelInstance)){
-				$this->setModelInstance($modelInstance);
-			}
-		}
-
-		/**
-		 * Set the session secret used to encrypt the data in database 
-		 * @param string $secret the base64 string secret
-		 */
-		public function setSessionSecret($secret){
-			$this->sessionSecret = $secret;
-			return $this;
-		}
-
-		/**
-		 * Return the session secret
-		 * @return string 
-		 */
-		public function getSessionSecret(){
-			return $this->sessionSecret;
-		}
-
-
-		/**
-		 * Set the initializer vector for openssl 
-		 * @param string $key the session secret used
-		 */
-		public function setInitializerVector($key){
-			$iv_length = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
-			$key = base64_decode($key);
-			$this->iv = substr(hash('sha256', $key), 0, $iv_length);
-			return $this;
-		}
-
-		/**
-		 * Return the initializer vector
-		 * @return string 
-		 */
-		public function getInitializerVector(){
-			return $this->iv;
-		}
-
-		/**
-		 * Open the database session handler, here nothing to do just return true
-		 * @param  string $savePath    the session save path
-		 * @param  string $sessionName the session name
-		 * @return boolean 
-		 */
-		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)){
-				$secret = get_config('session_secret', null);
-				$this->setSessionSecret($secret);
-			}
-			$this->logger->info('Session secret: ' . $secret);
-
-			if(! $this->getModelInstance()){
-				$this->setModelInstanceFromConfig();
-			}
-			$this->setInitializerVector($secret);
-
-			//set session tables columns
-			$this->sessionTableColumns = $this->getModelInstance()->getSessionTableColumns();
-
-			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));
+            if(is_object($modelInstance)){
+                $this->setModelInstance($modelInstance);
+            }
+        }
+
+        /**
+         * Set the session secret used to encrypt the data in database 
+         * @param string $secret the base64 string secret
+         */
+        public function setSessionSecret($secret){
+            $this->sessionSecret = $secret;
+            return $this;
+        }
+
+        /**
+         * Return the session secret
+         * @return string 
+         */
+        public function getSessionSecret(){
+            return $this->sessionSecret;
+        }
+
+
+        /**
+         * Set the initializer vector for openssl 
+         * @param string $key the session secret used
+         */
+        public function setInitializerVector($key){
+            $iv_length = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
+            $key = base64_decode($key);
+            $this->iv = substr(hash('sha256', $key), 0, $iv_length);
+            return $this;
+        }
+
+        /**
+         * Return the initializer vector
+         * @return string 
+         */
+        public function getInitializerVector(){
+            return $this->iv;
+        }
+
+        /**
+         * Open the database session handler, here nothing to do just return true
+         * @param  string $savePath    the session save path
+         * @param  string $sessionName the session name
+         * @return boolean 
+         */
+        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)){
+                $secret = get_config('session_secret', null);
+                $this->setSessionSecret($secret);
+            }
+            $this->logger->info('Session secret: ' . $secret);
+
+            if(! $this->getModelInstance()){
+                $this->setModelInstanceFromConfig();
+            }
+            $this->setInitializerVector($secret);
+
+            //set session tables columns
+            $this->sessionTableColumns = $this->getModelInstance()->getSessionTableColumns();
+
+            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));
 			
-			//delete the expired session
-			$timeActivity = get_config('session_inactivity_time', 100);
-			$this->gc($timeActivity);
+            //delete the expired session
+            $timeActivity = get_config('session_inactivity_time', 100);
+            $this->gc($timeActivity);
 			
-			return true;
-		}
-
-		/**
-		 * Close the session
-		 * @return boolean
-		 */
-		public function close(){
-			$this->logger->debug('Closing database session handler');
-			return true;
-		}
-
-		/**
-		 * Get the session value for the given session id
-		 * @param  string $sid the session id to use
-		 * @return string      the session data in serialiaze format
-		 */
-		public function read($sid){
-			$this->logger->debug('Reading database session data for SID: ' . $sid);
-			$instance = $this->getModelInstance();
-			$columns = $this->sessionTableColumns;
-			if($this->getLoader()){
-				$this->getLoader()->functions('user_agent'); 
-				$this->getLoader()->library('Browser'); 
-			}
-			else{
-            	Loader::functions('user_agent');
-            	Loader::library('Browser');
+            return true;
+        }
+
+        /**
+         * Close the session
+         * @return boolean
+         */
+        public function close(){
+            $this->logger->debug('Closing database session handler');
+            return true;
+        }
+
+        /**
+         * Get the session value for the given session id
+         * @param  string $sid the session id to use
+         * @return string      the session data in serialiaze format
+         */
+        public function read($sid){
+            $this->logger->debug('Reading database session data for SID: ' . $sid);
+            $instance = $this->getModelInstance();
+            $columns = $this->sessionTableColumns;
+            if($this->getLoader()){
+                $this->getLoader()->functions('user_agent'); 
+                $this->getLoader()->library('Browser'); 
+            }
+            else{
+                Loader::functions('user_agent');
+                Loader::library('Browser');
             }
 			
-			$ip = get_ip();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $ip = get_ip();
+            $host = @gethostbyaddr($ip) or null;
+            $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']})){
-				//checking inactivity 
-				$timeInactivity = time() - get_config('session_inactivity_time', 100);
-				if($data->{$columns['stime']} < $timeInactivity){
-					$this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
-					$this->destroy($sid);
-					return null;
-				}
-				return $this->decode($data->{$columns['sdata']});
-			}
-			$this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
-			return null;
-		}
-
-		/**
-		 * Save the session data
-		 * @param  string $sid  the session ID
-		 * @param  mixed $data the session data to save in serialize format
-		 * @return boolean 
-		 */
-		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;
-
-			if($this->getLoader()){
-				$this->getLoader()->functions('user_agent'); 
-				$this->getLoader()->library('Browser'); 
-			}
-			else{
-            	Loader::functions('user_agent');
-            	Loader::library('Browser');
+            $data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
+            if($data && isset($data->{$columns['sdata']})){
+                //checking inactivity 
+                $timeInactivity = time() - get_config('session_inactivity_time', 100);
+                if($data->{$columns['stime']} < $timeInactivity){
+                    $this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
+                    $this->destroy($sid);
+                    return null;
+                }
+                return $this->decode($data->{$columns['sdata']});
+            }
+            $this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
+            return null;
+        }
+
+        /**
+         * Save the session data
+         * @param  string $sid  the session ID
+         * @param  mixed $data the session data to save in serialize format
+         * @return boolean 
+         */
+        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;
+
+            if($this->getLoader()){
+                $this->getLoader()->functions('user_agent'); 
+                $this->getLoader()->library('Browser'); 
+            }
+            else{
+                Loader::functions('user_agent');
+                Loader::library('Browser');
+            }
+
+            $ip = get_ip();
+            $keyValue = $instance->getKeyValue();
+            $host = @gethostbyaddr($ip) or null;
+            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $data = $this->encode($data);
+            $params = array(
+                            $columns['sid'] => $sid,
+                            $columns['sdata'] => $data,
+                            $columns['stime'] => time(),
+                            $columns['shost'] => $host,
+                            $columns['sbrowser'] => $browser,
+                            $columns['sip'] => $ip,
+                            $columns['skey'] => $keyValue
+                        );
+            $this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
+            $exists = $instance->get($sid);
+            if($exists){
+                $this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
+                //update
+                unset($params[$columns['sid']]);
+                $instance->update($sid, $params);
             }
+            else{
+                $this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
+                $instance->insert($params);
+            }
+            return true;
+        }
+
+
+        /**
+         * Destroy the session data for the given session id
+         * @param  string $sid the session id value
+         * @return boolean
+         */
+        public function destroy($sid){
+            $this->logger->debug('Destroy of session data for SID: ' . $sid);
+            $instance = $this->modelInstanceName;
+            $instance->delete($sid);
+            return true;
+        }
 
-			$ip = get_ip();
-			$keyValue = $instance->getKeyValue();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
-			$data = $this->encode($data);
-			$params = array(
-							$columns['sid'] => $sid,
-							$columns['sdata'] => $data,
-							$columns['stime'] => time(),
-							$columns['shost'] => $host,
-							$columns['sbrowser'] => $browser,
-							$columns['sip'] => $ip,
-							$columns['skey'] => $keyValue
-						);
-			$this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
-			$exists = $instance->get($sid);
-			if($exists){
-				$this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
-				//update
-				unset($params[$columns['sid']]);
-				$instance->update($sid, $params);
-			}
-			else{
-				$this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
-				$instance->insert($params);
-			}
-			return true;
-		}
-
-
-		/**
-		 * Destroy the session data for the given session id
-		 * @param  string $sid the session id value
-		 * @return boolean
-		 */
-		public function destroy($sid){
-			$this->logger->debug('Destroy of session data for SID: ' . $sid);
-			$instance = $this->modelInstanceName;
-			$instance->delete($sid);
-			return true;
-		}
-
-		/**
-		 * Clean the expire session data to save espace
-		 * @param  integer $maxLifetime the max lifetime
-		 * @return boolean
-		 */
-		public function gc($maxLifetime){
-			$instance = $this->modelInstanceName;
-			$time = time() - $maxLifetime;
-			$this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
-			$instance->deleteByTime($time);
-			return true;
-		}
-
-		/**
-		 * Encode the session data using the openssl
-		 * @param  mixed $data the session data to encode
-		 * @return mixed the encoded session 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());
-			$output = base64_encode($dataEncrypted);
-			return $output;
-		}
-
-
-		/**
-		 * Decode the session data using the openssl
-		 * @param  mixed $data the data to decode
-		 * @return mixed       the decoded 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());
-			return $data;
-		}
+        /**
+         * Clean the expire session data to save espace
+         * @param  integer $maxLifetime the max lifetime
+         * @return boolean
+         */
+        public function gc($maxLifetime){
+            $instance = $this->modelInstanceName;
+            $time = time() - $maxLifetime;
+            $this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
+            $instance->deleteByTime($time);
+            return true;
+        }
+
+        /**
+         * Encode the session data using the openssl
+         * @param  mixed $data the session data to encode
+         * @return mixed the encoded session 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());
+            $output = base64_encode($dataEncrypted);
+            return $output;
+        }
+
+
+        /**
+         * Decode the session data using the openssl
+         * @param  mixed $data the data to decode
+         * @return mixed       the decoded 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());
+            return $data;
+        }
 
 		
-		/**
+        /**
          * Return the loader instance
          * @return object Loader the loader instance
          */
@@ -336,7 +336,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;
         }
@@ -353,47 +353,47 @@ 
          * set the model instance for future use
          * @param DBSessionHandlerModel $modelInstance the model object
          */
-         public function setModelInstance(DBSessionHandlerModel $modelInstance){
+            public function setModelInstance(DBSessionHandlerModel $modelInstance){
             $this->modelInstanceName = $modelInstance;
             return $this;
         }
 
         /**
-	     * Return the Log instance
-	     * @return Log
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
-
-	    /**
-	     * Set the log instance
-	     * @param Log $logger the log object
-	     */
-	    public function setLogger(Log $logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
-
-	    /**
-	     * Set the model instance using the configuration for session
-	     */
-	    private function setModelInstanceFromConfig(){
-	    	$modelName = get_config('session_save_path');
-			$this->logger->info('The database session model: ' . $modelName);
-			if($this->getLoader()){
-				$this->getLoader()->model($modelName, 'dbsessionhandlerinstance'); 
-			}
-			//@codeCoverageIgnoreStart
-			else{
-            	Loader::model($modelName, 'dbsessionhandlerinstance'); 
+         * Return the Log instance
+         * @return Log
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
+
+        /**
+         * Set the log instance
+         * @param Log $logger the log object
+         */
+        public function setLogger(Log $logger){
+            $this->logger = $logger;
+            return $this;
+        }
+
+        /**
+         * Set the model instance using the configuration for session
+         */
+        private function setModelInstanceFromConfig(){
+            $modelName = get_config('session_save_path');
+            $this->logger->info('The database session model: ' . $modelName);
+            if($this->getLoader()){
+                $this->getLoader()->model($modelName, 'dbsessionhandlerinstance'); 
+            }
+            //@codeCoverageIgnoreStart
+            else{
+                Loader::model($modelName, 'dbsessionhandlerinstance'); 
             }
             if(isset($this->OBJ->dbsessionhandlerinstance) && ! $this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel){
-				show_error('To use database session handler, your class model "'.get_class($this->OBJ->dbsessionhandlerinstance).'" need extends "DBSessionHandlerModel"');
-			}  
-			//@codeCoverageIgnoreEnd
+                show_error('To use database session handler, your class model "'.get_class($this->OBJ->dbsessionhandlerinstance).'" need extends "DBSessionHandlerModel"');
+            }  
+            //@codeCoverageIgnoreEnd
 			
-			//set model instance
-			$this->setModelInstance($this->OBJ->dbsessionhandlerinstance);
-	    }
-	}
+            //set model instance
+            $this->setModelInstance($this->OBJ->dbsessionhandlerinstance);
+        }
+    }

core/classes/Request.php

Indentation +231 added lines, -231 removed lines

@@ -1,256 +1,256 @@
 <?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;
+        }
 		
-	}
+    }

core/classes/cache/ApcCache.php

Indentation +194 added lines, -194 removed lines

@@ -1,215 +1,215 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	class ApcCache implements CacheInterface{
+    class ApcCache implements CacheInterface{
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 		
 		
-		public function __construct(Log $logger = null){
-			if(! $this->isSupported()){
-				show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
-			}
+        public function __construct(Log $logger = null){
+            if(! $this->isSupported()){
+                show_error('The cache for APC[u] driver is not available. Check if APC[u] extension is loaded and enabled.');
+            }
 
-			/**
-	         * instance of the Log class
-	         */
-	        if(is_object($logger)){
-	          $this->logger = $logger;
-	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
-	            $this->logger->setLogger('Library::ApcCache');
-	        }
-		}
+            /**
+             * instance of the Log class
+             */
+            if(is_object($logger)){
+                $this->logger = $logger;
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::ApcCache');
+            }
+        }
 
-		/**
-		 * This is used to get the cache data using the key
-		 * @param  string $key the key to identify the cache data
-		 * @return mixed      the cache data if exists else return false
-		 */
-		public function get($key){
-			$this->logger->debug('Getting cache data for key ['. $key .']');
-			$success = false;
-			$data = apc_fetch($key, $success);
-			if($success === false){
-				$this->logger->info('No cache found for the key ['. $key .'], return false');
-				return false;
-			}
-			else{
-				$cacheInfo = $this->_getCacheInfo($key);
-				$expire = time();
-				if($cacheInfo){
-					$expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
-				}
-				$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-				return $data;
-			}
-		}
+        /**
+         * This is used to get the cache data using the key
+         * @param  string $key the key to identify the cache data
+         * @return mixed      the cache data if exists else return false
+         */
+        public function get($key){
+            $this->logger->debug('Getting cache data for key ['. $key .']');
+            $success = false;
+            $data = apc_fetch($key, $success);
+            if($success === false){
+                $this->logger->info('No cache found for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $cacheInfo = $this->_getCacheInfo($key);
+                $expire = time();
+                if($cacheInfo){
+                    $expire = $cacheInfo['creation_time'] + $cacheInfo['ttl'];
+                }
+                $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+                return $data;
+            }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data to be saved
-		 * @param integer $ttl  the cache life time
-		 * @return boolean true if success otherwise will return false
-		 */
-		public function set($key, $data, $ttl = 0){
-			$expire = time() + $ttl;
-			$this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
-			$result = apc_store($key, $data, $ttl);
-			if($result === false){
-		    	$this->logger->error('Can not write cache data for the key ['. $key .'], return false');
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved for the key ['. $key .']');
-		    	return true;
-		    }
-		}
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data to be saved
+         * @param integer $ttl  the cache life time
+         * @return boolean true if success otherwise will return false
+         */
+        public function set($key, $data, $ttl = 0){
+            $expire = time() + $ttl;
+            $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']');
+            $result = apc_store($key, $data, $ttl);
+            if($result === false){
+                $this->logger->error('Can not write cache data for the key ['. $key .'], return false');
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved for the key ['. $key .']');
+                return true;
+            }
+        }
 
 
-		/**
-		 * Delete the cache data for given key
-		 * @param  string $key the key for cache to be deleted
-		 * @return boolean      true if the cache is deleted, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
-			$cacheInfo = $this->_getCacheInfo($key);
-			if($cacheInfo === false){
-				$this->logger->info('This cache data does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache data for the key [' .$key. '] remove it');
-	      		return apc_delete($key) === true;
-			}
-		}
+        /**
+         * Delete the cache data for given key
+         * @param  string $key the key for cache to be deleted
+         * @return boolean      true if the cache is deleted, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key){
+            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+            $cacheInfo = $this->_getCacheInfo($key);
+            if($cacheInfo === false){
+                $this->logger->info('This cache data does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache data for the key [' .$key. '] remove it');
+                    return apc_delete($key) === true;
+            }
+        }
 		
-		/**
-		 * Get the cache information for given key
-		 * @param  string $key the key for cache to get the information for
-		 * @return boolean|array    the cache information. The associative array and must contains the following information:
-		 * 'mtime' => creation time of the cache (Unix timestamp),
-		 * 'expire' => expiration time of the cache (Unix timestamp),
-		 * 'ttl' => the time to live of the cache in second
-		 */
-		public function getInfo($key){
-			$this->logger->debug('Getting of cache info for key [' .$key. ']');
-			$cacheInfos = $this->_getCacheInfo($key);
-			if($cacheInfos){
-				$data = array(
-							'mtime' => $cacheInfos['creation_time'],
-							'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
-							'ttl' => $cacheInfos['ttl']
-							);
-				return $data;
-			}
-			else{
-				$this->logger->info('This cache does not exists skipping');
-				return false;
-			}
-		}
+        /**
+         * Get the cache information for given key
+         * @param  string $key the key for cache to get the information for
+         * @return boolean|array    the cache information. The associative array and must contains the following information:
+         * 'mtime' => creation time of the cache (Unix timestamp),
+         * 'expire' => expiration time of the cache (Unix timestamp),
+         * 'ttl' => the time to live of the cache in second
+         */
+        public function getInfo($key){
+            $this->logger->debug('Getting of cache info for key [' .$key. ']');
+            $cacheInfos = $this->_getCacheInfo($key);
+            if($cacheInfos){
+                $data = array(
+                            'mtime' => $cacheInfos['creation_time'],
+                            'expire' => $cacheInfos['creation_time'] + $cacheInfos['ttl'],
+                            'ttl' => $cacheInfos['ttl']
+                            );
+                return $data;
+            }
+            else{
+                $this->logger->info('This cache does not exists skipping');
+                return false;
+            }
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			//for APC[u] is done automatically
-			return true;
-		}
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            //for APC[u] is done automatically
+            return true;
+        }
 
-		/**
-		 * Remove all cache data
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache data');
-			$cacheInfos = apc_cache_info('user');
-			if(empty($cacheInfos['cache_list'])){
-				$this->logger->info('No cache data were found skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
-				return apc_clear_cache('user');
-			}
-		}
+        /**
+         * Remove all cache data
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache data');
+            $cacheInfos = apc_cache_info('user');
+            if(empty($cacheInfos['cache_list'])){
+                $this->logger->info('No cache data were found skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found [' . count($cacheInfos) . '] cache data to remove');
+                return apc_clear_cache('user');
+            }
+        }
 		
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return (extension_loaded('apc') || extension_loaded('apcu')) && ini_get('apc.enabled');
+        }
 
-		/**
-	     * Return the Log instance
-	     * @return Log
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
+        /**
+         * Return the Log instance
+         * @return Log
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
 
-	    /**
-	     * Set the log instance
-	     * @param Log $logger the log object
-	     */
-	    public function setLogger(Log $logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
+        /**
+         * Set the log instance
+         * @param Log $logger the log object
+         */
+        public function setLogger(Log $logger){
+            $this->logger = $logger;
+            return $this;
+        }
 		
-		/**
-		* Return the array of cache information
-		*
-		* @param string $key the cache key to get the cache information 
-		* @return boolean|array
-		*/
-		private function _getCacheInfo($key){
-			$caches = apc_cache_info('user');
-			if(! empty($caches['cache_list'])){
-				$cacheLists = $caches['cache_list'];
-				foreach ($cacheLists as $c){
-					if(isset($c['info']) && $c['info'] === $key){
-						return $c;
-					}
-				}
+        /**
+         * Return the array of cache information
+         *
+         * @param string $key the cache key to get the cache information 
+         * @return boolean|array
+         */
+        private function _getCacheInfo($key){
+            $caches = apc_cache_info('user');
+            if(! empty($caches['cache_list'])){
+                $cacheLists = $caches['cache_list'];
+                foreach ($cacheLists as $c){
+                    if(isset($c['info']) && $c['info'] === $key){
+                        return $c;
+                    }
+                }
 				
-			}
-			return false;
-		}
-	}
+            }
+            return false;
+        }
+    }

core/classes/cache/CacheInterface.php

Indentation +70 added lines, -70 removed lines

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

core/classes/EventDispatcher.php

Indentation +169 added lines, -169 removed lines

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

core/classes/model/DBSessionHandlerModel.php

Indentation +65 added lines, -65 removed lines

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