tnhfw / tnh-fw

core/classes/cache/ApcCache.php

Indentation +194 added lines, -194 removed lines

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

core/classes/cache/CacheInterface.php

Indentation +70 added lines, -70 removed lines

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

core/classes/EventDispatcher.php

Indentation +169 added lines, -169 removed lines

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

core/classes/model/DBSessionHandlerModel.php

Indentation +65 added lines, -65 removed lines

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

core/classes/Lang.php

Indentation +205 added lines, -205 removed lines

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

core/functions/function_lang.php

Indentation +46 added lines, -46 removed lines

@@ -1,52 +1,52 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	if(! function_exists('__')){
-		/**
-		 * function for the shortcut to Lang::get()
-		 * @param  string $key the language key to retrieve
-		 * @param mixed $default the default value to return if can not find the value
-		 * for the given key
-		 * @return string  the language value
-		 */
-		function __($key, $default = 'LANGUAGE_ERROR'){
-			return get_instance()->lang->get($key, $default);
-		}
+    if(! function_exists('__')){
+        /**
+         * function for the shortcut to Lang::get()
+         * @param  string $key the language key to retrieve
+         * @param mixed $default the default value to return if can not find the value
+         * for the given key
+         * @return string  the language value
+         */
+        function __($key, $default = 'LANGUAGE_ERROR'){
+            return get_instance()->lang->get($key, $default);
+        }
 
-	}
+    }
 
 
-	if(! function_exists('get_languages')){
-		/**
-		 * function for the shortcut to Lang::getSupported()
-		 * 
-		 * @return array all the supported languages
-		 */
-		function get_languages(){
-			return get_instance()->lang->getSupported();
-		}
+    if(! function_exists('get_languages')){
+        /**
+         * function for the shortcut to Lang::getSupported()
+         * 
+         * @return array all the supported languages
+         */
+        function get_languages(){
+            return get_instance()->lang->getSupported();
+        }
 
-	}
\ No newline at end of file
+    }
\ No newline at end of file

core/libraries/Email.php

Indentation +730 added lines, -730 removed lines

@@ -1,739 +1,739 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * Simple Mail
-	 *
-	 * A simple PHP wrapper class for sending email using the mail() method.
-	 *
-	 * PHP version > 5.2
-	 *
-	 * LICENSE: This source file is subject to the MIT license, which is
-	 * available through the world-wide-web at the following URI:
-	 * http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt
-	 *
-	 * @category  SimpleMail
-	 * @package   SimpleMail
-	 * @author    Eoghan O'Brien <eoghan@eoghanobrien.com>
-	 * @copyright 2009 - 2017 Eoghan O'Brien
-	 * @license   http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt MIT
-	 * @version   1.7.1
-	 * @link      http://github.com/eoghanobrien/php-simple-mail
-	 */
-
-	/**
-	 * Simple Mail class.
-	 *
-	 * @category  SimpleMail
-	 * @package   SimpleMail
-	 * @author    Eoghan O'Brien <eoghan@eoghanobrien.com>
-	 * @copyright 2009 - 2017 Eoghan O'Brien
-	 * @license   http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt MIT
-	 * @version   1.7.1
-	 * @link      http://github.com/eoghanobrien/php-simple-mail
-	 */
-	class Email
-	{
-		/**
-		 * @var int $_wrap
-		 */
-		protected $_wrap = 78;
-
-		/**
-		 * @var array $_to
-		 */
-		protected $_to = array();
-
-		/**
-		 * @var string $_subject
-		 */
-		protected $_subject;
-
-		/**
-		 * @var string $_message
-		 */
-		protected $_message;
-
-		/**
-		 * @var array $_headers
-		 */
-		protected $_headers = array();
-
-		/**
-		 * @var string $_parameters
-		 */
-		protected $_params;
-
-		/**
-		 * @var array $_attachments
-		 */
-		protected $_attachments = array();
-
-		/**
-		 * @var string $_uid
-		 */
-		protected $_uid;
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * Simple Mail
+     *
+     * A simple PHP wrapper class for sending email using the mail() method.
+     *
+     * PHP version > 5.2
+     *
+     * LICENSE: This source file is subject to the MIT license, which is
+     * available through the world-wide-web at the following URI:
+     * http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt
+     *
+     * @category  SimpleMail
+     * @package   SimpleMail
+     * @author    Eoghan O'Brien <eoghan@eoghanobrien.com>
+     * @copyright 2009 - 2017 Eoghan O'Brien
+     * @license   http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt MIT
+     * @version   1.7.1
+     * @link      http://github.com/eoghanobrien/php-simple-mail
+     */
+
+    /**
+     * Simple Mail class.
+     *
+     * @category  SimpleMail
+     * @package   SimpleMail
+     * @author    Eoghan O'Brien <eoghan@eoghanobrien.com>
+     * @copyright 2009 - 2017 Eoghan O'Brien
+     * @license   http://github.com/eoghanobrien/php-simple-mail/LICENCE.txt MIT
+     * @version   1.7.1
+     * @link      http://github.com/eoghanobrien/php-simple-mail
+     */
+    class Email
+    {
+        /**
+         * @var int $_wrap
+         */
+        protected $_wrap = 78;
+
+        /**
+         * @var array $_to
+         */
+        protected $_to = array();
+
+        /**
+         * @var string $_subject
+         */
+        protected $_subject;
+
+        /**
+         * @var string $_message
+         */
+        protected $_message;
+
+        /**
+         * @var array $_headers
+         */
+        protected $_headers = array();
+
+        /**
+         * @var string $_parameters
+         */
+        protected $_params;
+
+        /**
+         * @var array $_attachments
+         */
+        protected $_attachments = array();
+
+        /**
+         * @var string $_uid
+         */
+        protected $_uid;
 		
-		/**
+        /**
          * The logger instance
          * @var Log
          */
-		private $logger;
+        private $logger;
 
-		/**
-		 * __construct
-		 *
-		 * Resets the class properties.
-		 */
-		public function __construct()
-		{
-			$this->logger =& class_loader('Log', 'classes');
+        /**
+         * __construct
+         *
+         * Resets the class properties.
+         */
+        public function __construct()
+        {
+            $this->logger =& class_loader('Log', 'classes');
             $this->logger->setLogger('Library::Email');
-			$this->reset();
-		}
-
-		/**
-		 * reset
-		 *
-		 * Resets all properties to initial state.
-		 *
-		 * @return self
-		 */
-		public function reset()
-		{
-			$this->_to = array();
-			$this->_headers = array();
-			$this->_subject = null;
-			$this->_message = null;
-			$this->_wrap = 78;
-			$this->_params = null;
-			$this->_attachments = array();
-			$this->_uid = $this->getUniqueId();
-			return $this;
-		}
+            $this->reset();
+        }
+
+        /**
+         * reset
+         *
+         * Resets all properties to initial state.
+         *
+         * @return self
+         */
+        public function reset()
+        {
+            $this->_to = array();
+            $this->_headers = array();
+            $this->_subject = null;
+            $this->_message = null;
+            $this->_wrap = 78;
+            $this->_params = null;
+            $this->_attachments = array();
+            $this->_uid = $this->getUniqueId();
+            return $this;
+        }
 		
-		 /**
-		 * setFrom
-		 *
-		 * @param string $email The email to send as from.
-		 * @param string $name  The name to send as from.
-		 *
-		 * @return self
-		 */
-		public function setFrom($email, $name = null)
-		{
-			$this->addMailHeader('From', (string) $email, (string) $name);
-			return $this;
-		}
-
-		/**
-		 * setTo
-		 *
-		 * @param string $email The email address to send to.
-		 * @param string $name  The name of the person to send to.
-		 *
-		 * @return self
-		 */
-		public function setTo($email, $name = null)
-		{
-			$this->_to[] = $this->formatHeader((string) $email, (string) $name);
-			return $this;
-		}
+            /**
+             * setFrom
+             *
+             * @param string $email The email to send as from.
+             * @param string $name  The name to send as from.
+             *
+             * @return self
+             */
+        public function setFrom($email, $name = null)
+        {
+            $this->addMailHeader('From', (string) $email, (string) $name);
+            return $this;
+        }
+
+        /**
+         * setTo
+         *
+         * @param string $email The email address to send to.
+         * @param string $name  The name of the person to send to.
+         *
+         * @return self
+         */
+        public function setTo($email, $name = null)
+        {
+            $this->_to[] = $this->formatHeader((string) $email, (string) $name);
+            return $this;
+        }
 		
-		/**
-		* Set destination using array
-		* @params array $emails the list of recipient. This is an associative array name => email
-		* @example array('John Doe' => 'email1@example.com')
-		* @return Object the current instance
-		*/
-		public function setTos(array $emails)
-		{
-			foreach ($emails as $name => $email) {
-				if(is_numeric($name)){
-					$this->setTo($email);
-				}
-				else{
-					$this->setTo($email, $name);
-				}
-			}
-			return $this;
-		}
-
-
-		/**
-		 * getTo
-		 *
-		 * Return an array of formatted To addresses.
-		 *
-		 * @return array
-		 */
-		public function getTo()
-		{
-			return $this->_to;
-		}
-
-
-		/**
-		 * setCc
-		 *
-		 * @param array  $pairs  An array of name => email pairs.
-		 *
-		 * @return self
-		 */
-		public function setCc(array $pairs)
-		{
-			return $this->addMailHeaders('Cc', $pairs);
-		}
-
-		/**
-		 * setBcc
-		 *
-		 * @param array  $pairs  An array of name => email pairs.
-		 *
-		 * @return self
-		 */
-		public function setBcc(array $pairs)
-		{
-			return $this->addMailHeaders('Bcc', $pairs);
-		}
-
-		/**
-		 * setReplyTo
-		 *
-		 * @param string $email
-		 * @param string $name
-		 *
-		 * @return self
-		 */
-		public function setReplyTo($email, $name = null)
-		{
-			return $this->addMailHeader('Reply-To', $email, $name);
-		}
-
-		/**
-		 * setHtml
-		 *
-		 * @return self
-		 */
-		public function setHtml()
-		{
-			$this->addGenericHeader(
-				'Content-Type', 'text/html; charset="utf-8"'
-			);
-			return $this;
-		}
-
-		/**
-		 * setSubject
-		 *
-		 * @param string $subject The email subject
-		 *
-		 * @return self
-		 */
-		public function setSubject($subject)
-		{
-			$this->_subject = $this->encodeUtf8(
-				$this->filterOther((string) $subject)
-			);
-			return $this;
-		}
-
-		/**
-		 * getSubject function.
-		 *
-		 * @return string
-		 */
-		public function getSubject()
-		{
-			return $this->_subject;
-		}
-
-		/**
-		 * setMessage
-		 *
-		 * @param string $message The message to send.
-		 *
-		 * @return self
-		 */
-		public function setMessage($message)
-		{
-			$this->_message = str_replace("\n.", "\n..", (string) $message);
-			return $this;
-		}
-
-		/**
-		 * getMessage
-		 *
-		 * @return string
-		 */
-		public function getMessage()
-		{
-			return $this->_message;
-		}
-
-		/**
-		 * addAttachment
-		 *
-		 * @param string $path The file path to the attachment.
-		 * @param string $filename The filename of the attachment when emailed.
-		 * @param string $data
-		 * 
-		 * @return self
-		 */
-		public function addAttachment($path, $filename = null, $data = null)
-		{
-			if(! file_exists($path)){
-				show_error('The file [' .$path. '] does not exists.');
-			}
-			$filename = empty($filename) ? basename($path) : $filename;
-			$filename = $this->encodeUtf8($this->filterOther((string) $filename));
-			$data = empty($data) ? $this->getAttachmentData($path) : $data;
-			$this->_attachments[] = array(
-				'path' => $path,
-				'file' => $filename,
-				'data' => chunk_split(base64_encode($data))
-			);
-			return $this;
-		}
-
-		/**
-		 * getAttachmentData
-		 *
-		 * @param string $path The path to the attachment file.
-		 *
-		 * @return string
-		 */
-		public function getAttachmentData($path)
-		{
-			if(! file_exists($path)){
-				show_error('The file [' .$path. '] does not exists.');
-			}
-			$filesize = filesize($path);
-			$handle = fopen($path, "r");
-			$attachment = null;
-			if(is_resource($handle)){
-				$attachment = fread($handle, $filesize);
-				fclose($handle);
-			}
-			return $attachment;
-		}
-
-		/**
-		 * addMailHeader
-		 *
-		 * @param string $header The header to add.
-		 * @param string $email  The email to add.
-		 * @param string $name   The name to add.
-		 *
-		 * @return self
-		 */
-		public function addMailHeader($header, $email, $name = null)
-		{
-			$address = $this->formatHeader((string) $email, (string) $name);
-			$this->_headers[] = sprintf('%s: %s', (string) $header, $address);
-			return $this;
-		}
-
-		/**
-		 * addMailHeaders
-		 *
-		 * @param string $header The header to add.
-		 * @param array  $pairs  An array of name => email pairs.
-		 *
-		 * @return self
-		 */
-		public function addMailHeaders($header, array $pairs)
-		{
-			if (count($pairs) === 0) {
-				show_error('You must pass at least one name => email pair.');
-			}
-			$addresses = array();
-			foreach ($pairs as $name => $email) {
-				$name = is_numeric($name) ? null : $name;
-				$addresses[] = $this->formatHeader($email, $name);
-			}
-			$this->addGenericHeader($header, implode(',', $addresses));
-			return $this;
-		}
-
-		/**
-		 * addGenericHeader
-		 *
-		 * @param string $name The generic header to add.
-		 * @param mixed  $value  The value of the header.
-		 *
-		 * @return self
-		 */
-		public function addGenericHeader($name, $value)
-		{
-			$this->_headers[] = sprintf(
-				'%s: %s',
-				(string) $name,
-				(string) $value
-			);
-			return $this;
-		}
-
-		/**
-		 * getHeaders
-		 *
-		 * Return the headers registered so far as an array.
-		 *
-		 * @return array
-		 */
-		public function getHeaders()
-		{
-			return $this->_headers;
-		}
-
-		/**
-		 * setAdditionalParameters
-		 *
-		 * Such as "-fyouremail@yourserver.com
-		 *
-		 * @param string $additionalParameters The addition mail parameter.
-		 *
-		 * @return self
-		 */
-		public function setParameters($additionalParameters)
-		{
-			$this->_params = (string) $additionalParameters;
-			return $this;
-		}
-
-		/**
-		 * getAdditionalParameters
-		 *
-		 * @return string
-		 */
-		public function getParameters()
-		{
-			return $this->_params;
-		}
-
-		/**
-		 * setWrap
-		 *
-		 * @param int $wrap The number of characters at which the message will wrap.
-		 *
-		 * @return self
-		 */
-		public function setWrap($wrap = 78)
-		{
-			$wrap = (int) $wrap;
-			if ($wrap < 1) {
-				$wrap = 78;
-			}
-			$this->_wrap = $wrap;
-			return $this;
-		}
-
-		/**
-		 * getWrap
-		 *
-		 * @return int
-		 */
-		public function getWrap()
-		{
-			return $this->_wrap;
-		}
-
-		/**
-		 * hasAttachments
-		 * 
-		 * Checks if the email has any registered attachments.
-		 *
-		 * @return bool
-		 */
-		public function hasAttachments()
-		{
-			return !empty($this->_attachments);
-		}
-
-		/**
-		 * assembleAttachment
-		 *
-		 * @return string
-		 */
-		public function assembleAttachmentHeaders()
-		{
-			$head = array();
-			$head[] = "MIME-Version: 1.0";
-			$head[] = "Content-Type: multipart/mixed; boundary=\"{$this->_uid}\"";
-
-			return join(PHP_EOL, $head);
-		}
-
-		/**
-		 * assembleAttachmentBody
-		 *
-		 * @return string
-		 */
-		public function assembleAttachmentBody()
-		{
-			$body = array();
-			$body[] = "This is a multi-part message in MIME format.";
-			$body[] = "--{$this->_uid}";
-			$body[] = "Content-Type: text/html; charset=\"utf-8\"";
-			$body[] = "Content-Transfer-Encoding: quoted-printable";
-			$body[] = "";
-			$body[] = quoted_printable_encode($this->_message);
-			$body[] = "";
-			$body[] = "--{$this->_uid}";
-
-			foreach ($this->_attachments as $attachment) {
-				$body[] = $this->getAttachmentMimeTemplate($attachment);
-			}
-
-			return implode(PHP_EOL, $body) . '--';
-		}
-
-		/**
-		 * getAttachmentMimeTemplate
-		 *
-		 * @param array  $attachment An array containing 'file' and 'data' keys.
-		 *
-		 * @return string
-		 */
-		public function getAttachmentMimeTemplate($attachment)
-		{
-			$file = $attachment['file'];
-			$data = $attachment['data'];
-
-			$head = array();
-			$head[] = "Content-Type: application/octet-stream; name=\"{$file}\"";
-			$head[] = "Content-Transfer-Encoding: base64";
-			$head[] = "Content-Disposition: attachment; filename=\"{$file}\"";
-			$head[] = "";
-			$head[] = $data;
-			$head[] = "";
-			$head[] = "--{$this->_uid}";
-
-			return implode(PHP_EOL, $head);
-		}
-
-		/**
-		 * send the email
-		 *
-		 * @return boolean
-		 */
-		public function send()
-		{
-			$to = $this->getToForSend();
-			$headers = $this->getHeadersForSend();
-
-			if (empty($to)) {
-				show_error('Unable to send, no To address has been set.');
-			}
-
-			if ($this->hasAttachments()) {
-				$message  = $this->assembleAttachmentBody();
-				$headers .= PHP_EOL . $this->assembleAttachmentHeaders();
-			} else {
-				$message = $this->getWrapMessage();
-			}
-			$this->logger->info('Sending new mail, the information are listed below: destination: ' . $to . ', headers: ' . $headers . ', message: ' . $message);
-			return mail($to, $this->_subject, $message, $headers, $this->_params);
-		}
-
-		/**
-		 * debug
-		 *
-		 * @return string
-		 */
-		public function debug()
-		{
-			return '<pre>' . print_r($this, true) . '</pre>';
-		}
-
-		/**
-		 * magic __toString function
-		 *
-		 * @return string
-		 */
-		public function __toString()
-		{
-			return print_r($this, true);
-		}
-
-		/**
-		 * formatHeader
-		 *
-		 * Formats a display address for emails according to RFC2822 e.g.
-		 * Name <address@domain.tld>
-		 *
-		 * @param string $email The email address.
-		 * @param string $name  The display name.
-		 *
-		 * @return string
-		 */
-		public function formatHeader($email, $name = null)
-		{
-			$email = $this->filterEmail((string) $email);
-			if (empty($name)) {
-				return $email;
-			}
-			$name = $this->encodeUtf8($this->filterName((string) $name));
-			return sprintf('"%s" <%s>', $name, $email);
-		}
-
-		/**
-		 * encodeUtf8
-		 *
-		 * @param string $value The value to encode.
-		 *
-		 * @return string
-		 */
-		public function encodeUtf8($value)
-		{
-			$value = trim($value);
-			if (preg_match('/(\s)/', $value)) {
-				return $this->encodeUtf8Words($value);
-			}
-			return $this->encodeUtf8Word($value);
-		}
-
-		/**
-		 * encodeUtf8Word
-		 *
-		 * @param string $value The word to encode.
-		 *
-		 * @return string
-		 */
-		public function encodeUtf8Word($value)
-		{
-			return sprintf('=?UTF-8?B?%s?=', base64_encode($value));
-		}
-
-		/**
-		 * encodeUtf8Words
-		 *
-		 * @param string $value The words to encode.
-		 *
-		 * @return string
-		 */
-		public function encodeUtf8Words($value)
-		{
-			$words = explode(' ', $value);
-			$encoded = array();
-			foreach ($words as $word) {
-				$encoded[] = $this->encodeUtf8Word($word);
-			}
-			return join($this->encodeUtf8Word(' '), $encoded);
-		}
-
-		/**
-		 * filterEmail
-		 *
-		 * Removes any carriage return, line feed, tab, double quote, comma
-		 * and angle bracket characters before sanitizing the email address.
-		 *
-		 * @param string $email The email to filter.
-		 *
-		 * @return string
-		 */
-		public function filterEmail($email)
-		{
-			$rule = array(
-				"\r" => '',
-				"\n" => '',
-				"\t" => '',
-				'"'  => '',
-				','  => '',
-				'<'  => '',
-				'>'  => ''
-			);
-			$email = strtr($email, $rule);
-			$email = filter_var($email, FILTER_SANITIZE_EMAIL);
-			return $email;
-		}
-
-		/**
-		 * filterName
-		 *
-		 * Removes any carriage return, line feed or tab characters. Replaces
-		 * double quotes with single quotes and angle brackets with square
-		 * brackets, before sanitizing the string and stripping out html tags.
-		 *
-		 * @param string $name The name to filter.
-		 *
-		 * @return string
-		 */
-		public function filterName($name)
-		{
-			$rule = array(
-				"\r" => '',
-				"\n" => '',
-				"\t" => '',
-				'"'  => "'",
-				'<'  => '[',
-				'>'  => ']',
-			);
-			$filtered = filter_var(
-				$name,
-				FILTER_SANITIZE_STRING,
-				FILTER_FLAG_NO_ENCODE_QUOTES
-			);
-			return trim(strtr($filtered, $rule));
-		}
-
-		/**
-		 * filterOther
-		 *
-		 * Removes ASCII control characters including any carriage return, line
-		 * feed or tab characters.
-		 *
-		 * @param string $data The data to filter.
-		 *
-		 * @return string
-		 */
-		public function filterOther($data)
-		{
-			return filter_var($data, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
-		}
-
-		/**
-		 * getHeadersForSend
-		 *
-		 * @return string
-		 */
-		public function getHeadersForSend()
-		{
-			if (empty($this->_headers)) {
-				return '';
-			}
-			return join(PHP_EOL, $this->_headers);
-		}
-
-		/**
-		 * getToForSend
-		 *
-		 * @return string
-		 */
-		public function getToForSend()
-		{
-			if (empty($this->_to)) {
-				return '';
-			}
-			return join(', ', $this->_to);
-		}
-
-		/**
-		 * getUniqueId
-		 *
-		 * @return string
-		 */
-		public function getUniqueId()
-		{
-			return md5(uniqid(time()));
-		}
-
-		/**
-		 * getWrapMessage
-		 *
-		 * @return string
-		 */
-		public function getWrapMessage()
-		{
-			return wordwrap($this->_message, $this->_wrap);
-		}
-	}
+        /**
+         * Set destination using array
+         * @params array $emails the list of recipient. This is an associative array name => email
+         * @example array('John Doe' => 'email1@example.com')
+         * @return Object the current instance
+         */
+        public function setTos(array $emails)
+        {
+            foreach ($emails as $name => $email) {
+                if(is_numeric($name)){
+                    $this->setTo($email);
+                }
+                else{
+                    $this->setTo($email, $name);
+                }
+            }
+            return $this;
+        }
+
+
+        /**
+         * getTo
+         *
+         * Return an array of formatted To addresses.
+         *
+         * @return array
+         */
+        public function getTo()
+        {
+            return $this->_to;
+        }
+
+
+        /**
+         * setCc
+         *
+         * @param array  $pairs  An array of name => email pairs.
+         *
+         * @return self
+         */
+        public function setCc(array $pairs)
+        {
+            return $this->addMailHeaders('Cc', $pairs);
+        }
+
+        /**
+         * setBcc
+         *
+         * @param array  $pairs  An array of name => email pairs.
+         *
+         * @return self
+         */
+        public function setBcc(array $pairs)
+        {
+            return $this->addMailHeaders('Bcc', $pairs);
+        }
+
+        /**
+         * setReplyTo
+         *
+         * @param string $email
+         * @param string $name
+         *
+         * @return self
+         */
+        public function setReplyTo($email, $name = null)
+        {
+            return $this->addMailHeader('Reply-To', $email, $name);
+        }
+
+        /**
+         * setHtml
+         *
+         * @return self
+         */
+        public function setHtml()
+        {
+            $this->addGenericHeader(
+                'Content-Type', 'text/html; charset="utf-8"'
+            );
+            return $this;
+        }
+
+        /**
+         * setSubject
+         *
+         * @param string $subject The email subject
+         *
+         * @return self
+         */
+        public function setSubject($subject)
+        {
+            $this->_subject = $this->encodeUtf8(
+                $this->filterOther((string) $subject)
+            );
+            return $this;
+        }
+
+        /**
+         * getSubject function.
+         *
+         * @return string
+         */
+        public function getSubject()
+        {
+            return $this->_subject;
+        }
+
+        /**
+         * setMessage
+         *
+         * @param string $message The message to send.
+         *
+         * @return self
+         */
+        public function setMessage($message)
+        {
+            $this->_message = str_replace("\n.", "\n..", (string) $message);
+            return $this;
+        }
+
+        /**
+         * getMessage
+         *
+         * @return string
+         */
+        public function getMessage()
+        {
+            return $this->_message;
+        }
+
+        /**
+         * addAttachment
+         *
+         * @param string $path The file path to the attachment.
+         * @param string $filename The filename of the attachment when emailed.
+         * @param string $data
+         * 
+         * @return self
+         */
+        public function addAttachment($path, $filename = null, $data = null)
+        {
+            if(! file_exists($path)){
+                show_error('The file [' .$path. '] does not exists.');
+            }
+            $filename = empty($filename) ? basename($path) : $filename;
+            $filename = $this->encodeUtf8($this->filterOther((string) $filename));
+            $data = empty($data) ? $this->getAttachmentData($path) : $data;
+            $this->_attachments[] = array(
+                'path' => $path,
+                'file' => $filename,
+                'data' => chunk_split(base64_encode($data))
+            );
+            return $this;
+        }
+
+        /**
+         * getAttachmentData
+         *
+         * @param string $path The path to the attachment file.
+         *
+         * @return string
+         */
+        public function getAttachmentData($path)
+        {
+            if(! file_exists($path)){
+                show_error('The file [' .$path. '] does not exists.');
+            }
+            $filesize = filesize($path);
+            $handle = fopen($path, "r");
+            $attachment = null;
+            if(is_resource($handle)){
+                $attachment = fread($handle, $filesize);
+                fclose($handle);
+            }
+            return $attachment;
+        }
+
+        /**
+         * addMailHeader
+         *
+         * @param string $header The header to add.
+         * @param string $email  The email to add.
+         * @param string $name   The name to add.
+         *
+         * @return self
+         */
+        public function addMailHeader($header, $email, $name = null)
+        {
+            $address = $this->formatHeader((string) $email, (string) $name);
+            $this->_headers[] = sprintf('%s: %s', (string) $header, $address);
+            return $this;
+        }
+
+        /**
+         * addMailHeaders
+         *
+         * @param string $header The header to add.
+         * @param array  $pairs  An array of name => email pairs.
+         *
+         * @return self
+         */
+        public function addMailHeaders($header, array $pairs)
+        {
+            if (count($pairs) === 0) {
+                show_error('You must pass at least one name => email pair.');
+            }
+            $addresses = array();
+            foreach ($pairs as $name => $email) {
+                $name = is_numeric($name) ? null : $name;
+                $addresses[] = $this->formatHeader($email, $name);
+            }
+            $this->addGenericHeader($header, implode(',', $addresses));
+            return $this;
+        }
+
+        /**
+         * addGenericHeader
+         *
+         * @param string $name The generic header to add.
+         * @param mixed  $value  The value of the header.
+         *
+         * @return self
+         */
+        public function addGenericHeader($name, $value)
+        {
+            $this->_headers[] = sprintf(
+                '%s: %s',
+                (string) $name,
+                (string) $value
+            );
+            return $this;
+        }
+
+        /**
+         * getHeaders
+         *
+         * Return the headers registered so far as an array.
+         *
+         * @return array
+         */
+        public function getHeaders()
+        {
+            return $this->_headers;
+        }
+
+        /**
+         * setAdditionalParameters
+         *
+         * Such as "-fyouremail@yourserver.com
+         *
+         * @param string $additionalParameters The addition mail parameter.
+         *
+         * @return self
+         */
+        public function setParameters($additionalParameters)
+        {
+            $this->_params = (string) $additionalParameters;
+            return $this;
+        }
+
+        /**
+         * getAdditionalParameters
+         *
+         * @return string
+         */
+        public function getParameters()
+        {
+            return $this->_params;
+        }
+
+        /**
+         * setWrap
+         *
+         * @param int $wrap The number of characters at which the message will wrap.
+         *
+         * @return self
+         */
+        public function setWrap($wrap = 78)
+        {
+            $wrap = (int) $wrap;
+            if ($wrap < 1) {
+                $wrap = 78;
+            }
+            $this->_wrap = $wrap;
+            return $this;
+        }
+
+        /**
+         * getWrap
+         *
+         * @return int
+         */
+        public function getWrap()
+        {
+            return $this->_wrap;
+        }
+
+        /**
+         * hasAttachments
+         * 
+         * Checks if the email has any registered attachments.
+         *
+         * @return bool
+         */
+        public function hasAttachments()
+        {
+            return !empty($this->_attachments);
+        }
+
+        /**
+         * assembleAttachment
+         *
+         * @return string
+         */
+        public function assembleAttachmentHeaders()
+        {
+            $head = array();
+            $head[] = "MIME-Version: 1.0";
+            $head[] = "Content-Type: multipart/mixed; boundary=\"{$this->_uid}\"";
+
+            return join(PHP_EOL, $head);
+        }
+
+        /**
+         * assembleAttachmentBody
+         *
+         * @return string
+         */
+        public function assembleAttachmentBody()
+        {
+            $body = array();
+            $body[] = "This is a multi-part message in MIME format.";
+            $body[] = "--{$this->_uid}";
+            $body[] = "Content-Type: text/html; charset=\"utf-8\"";
+            $body[] = "Content-Transfer-Encoding: quoted-printable";
+            $body[] = "";
+            $body[] = quoted_printable_encode($this->_message);
+            $body[] = "";
+            $body[] = "--{$this->_uid}";
+
+            foreach ($this->_attachments as $attachment) {
+                $body[] = $this->getAttachmentMimeTemplate($attachment);
+            }
+
+            return implode(PHP_EOL, $body) . '--';
+        }
+
+        /**
+         * getAttachmentMimeTemplate
+         *
+         * @param array  $attachment An array containing 'file' and 'data' keys.
+         *
+         * @return string
+         */
+        public function getAttachmentMimeTemplate($attachment)
+        {
+            $file = $attachment['file'];
+            $data = $attachment['data'];
+
+            $head = array();
+            $head[] = "Content-Type: application/octet-stream; name=\"{$file}\"";
+            $head[] = "Content-Transfer-Encoding: base64";
+            $head[] = "Content-Disposition: attachment; filename=\"{$file}\"";
+            $head[] = "";
+            $head[] = $data;
+            $head[] = "";
+            $head[] = "--{$this->_uid}";
+
+            return implode(PHP_EOL, $head);
+        }
+
+        /**
+         * send the email
+         *
+         * @return boolean
+         */
+        public function send()
+        {
+            $to = $this->getToForSend();
+            $headers = $this->getHeadersForSend();
+
+            if (empty($to)) {
+                show_error('Unable to send, no To address has been set.');
+            }
+
+            if ($this->hasAttachments()) {
+                $message  = $this->assembleAttachmentBody();
+                $headers .= PHP_EOL . $this->assembleAttachmentHeaders();
+            } else {
+                $message = $this->getWrapMessage();
+            }
+            $this->logger->info('Sending new mail, the information are listed below: destination: ' . $to . ', headers: ' . $headers . ', message: ' . $message);
+            return mail($to, $this->_subject, $message, $headers, $this->_params);
+        }
+
+        /**
+         * debug
+         *
+         * @return string
+         */
+        public function debug()
+        {
+            return '<pre>' . print_r($this, true) . '</pre>';
+        }
+
+        /**
+         * magic __toString function
+         *
+         * @return string
+         */
+        public function __toString()
+        {
+            return print_r($this, true);
+        }
+
+        /**
+         * formatHeader
+         *
+         * Formats a display address for emails according to RFC2822 e.g.
+         * Name <address@domain.tld>
+         *
+         * @param string $email The email address.
+         * @param string $name  The display name.
+         *
+         * @return string
+         */
+        public function formatHeader($email, $name = null)
+        {
+            $email = $this->filterEmail((string) $email);
+            if (empty($name)) {
+                return $email;
+            }
+            $name = $this->encodeUtf8($this->filterName((string) $name));
+            return sprintf('"%s" <%s>', $name, $email);
+        }
+
+        /**
+         * encodeUtf8
+         *
+         * @param string $value The value to encode.
+         *
+         * @return string
+         */
+        public function encodeUtf8($value)
+        {
+            $value = trim($value);
+            if (preg_match('/(\s)/', $value)) {
+                return $this->encodeUtf8Words($value);
+            }
+            return $this->encodeUtf8Word($value);
+        }
+
+        /**
+         * encodeUtf8Word
+         *
+         * @param string $value The word to encode.
+         *
+         * @return string
+         */
+        public function encodeUtf8Word($value)
+        {
+            return sprintf('=?UTF-8?B?%s?=', base64_encode($value));
+        }
+
+        /**
+         * encodeUtf8Words
+         *
+         * @param string $value The words to encode.
+         *
+         * @return string
+         */
+        public function encodeUtf8Words($value)
+        {
+            $words = explode(' ', $value);
+            $encoded = array();
+            foreach ($words as $word) {
+                $encoded[] = $this->encodeUtf8Word($word);
+            }
+            return join($this->encodeUtf8Word(' '), $encoded);
+        }
+
+        /**
+         * filterEmail
+         *
+         * Removes any carriage return, line feed, tab, double quote, comma
+         * and angle bracket characters before sanitizing the email address.
+         *
+         * @param string $email The email to filter.
+         *
+         * @return string
+         */
+        public function filterEmail($email)
+        {
+            $rule = array(
+                "\r" => '',
+                "\n" => '',
+                "\t" => '',
+                '"'  => '',
+                ','  => '',
+                '<'  => '',
+                '>'  => ''
+            );
+            $email = strtr($email, $rule);
+            $email = filter_var($email, FILTER_SANITIZE_EMAIL);
+            return $email;
+        }
+
+        /**
+         * filterName
+         *
+         * Removes any carriage return, line feed or tab characters. Replaces
+         * double quotes with single quotes and angle brackets with square
+         * brackets, before sanitizing the string and stripping out html tags.
+         *
+         * @param string $name The name to filter.
+         *
+         * @return string
+         */
+        public function filterName($name)
+        {
+            $rule = array(
+                "\r" => '',
+                "\n" => '',
+                "\t" => '',
+                '"'  => "'",
+                '<'  => '[',
+                '>'  => ']',
+            );
+            $filtered = filter_var(
+                $name,
+                FILTER_SANITIZE_STRING,
+                FILTER_FLAG_NO_ENCODE_QUOTES
+            );
+            return trim(strtr($filtered, $rule));
+        }
+
+        /**
+         * filterOther
+         *
+         * Removes ASCII control characters including any carriage return, line
+         * feed or tab characters.
+         *
+         * @param string $data The data to filter.
+         *
+         * @return string
+         */
+        public function filterOther($data)
+        {
+            return filter_var($data, FILTER_UNSAFE_RAW, FILTER_FLAG_STRIP_LOW);
+        }
+
+        /**
+         * getHeadersForSend
+         *
+         * @return string
+         */
+        public function getHeadersForSend()
+        {
+            if (empty($this->_headers)) {
+                return '';
+            }
+            return join(PHP_EOL, $this->_headers);
+        }
+
+        /**
+         * getToForSend
+         *
+         * @return string
+         */
+        public function getToForSend()
+        {
+            if (empty($this->_to)) {
+                return '';
+            }
+            return join(', ', $this->_to);
+        }
+
+        /**
+         * getUniqueId
+         *
+         * @return string
+         */
+        public function getUniqueId()
+        {
+            return md5(uniqid(time()));
+        }
+
+        /**
+         * getWrapMessage
+         *
+         * @return string
+         */
+        public function getWrapMessage()
+        {
+            return wordwrap($this->_message, $this->_wrap);
+        }
+    }

core/libraries/Cookie.php

Indentation +101 added lines, -101 removed lines

@@ -1,112 +1,112 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class Cookie{
+    class Cookie{
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * The signleton of the logger
-		 * @return Object the Log instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Cookie');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Cookie');
+            }
+            return self::$logger[0];
+        }
 
-		/**
-		 * Get the cookie item value
-		 * @param  string $item    the cookie item name to get
-		 * @param  mixed $default the default value to use if can not find the cokkie item in the list
-		 * @return mixed          the cookie value if exist or the default value
-		 */
-		public static function get($item, $default = null){
-			$logger = self::getLogger();
-			if(array_key_exists($item, $_COOKIE)){
-				return $_COOKIE[$item];
-			}
-			$logger->warning('Cannot find cookie item [' . $item . '], using the default value [' . $default . ']');
-			return $default;
-		}
+        /**
+         * Get the cookie item value
+         * @param  string $item    the cookie item name to get
+         * @param  mixed $default the default value to use if can not find the cokkie item in the list
+         * @return mixed          the cookie value if exist or the default value
+         */
+        public static function get($item, $default = null){
+            $logger = self::getLogger();
+            if(array_key_exists($item, $_COOKIE)){
+                return $_COOKIE[$item];
+            }
+            $logger->warning('Cannot find cookie item [' . $item . '], using the default value [' . $default . ']');
+            return $default;
+        }
 
-		/**
-		 * Set the cookie item value
-		 * @param string  $name     the cookie item name
-		 * @param string  $value    the cookie value to set
-		 * @param integer $expire   the time to live for this cookie
-		 * @param string  $path     the path that the cookie will be available
-		 * @param string  $domain   the domain that the cookie will be available
-		 * @param boolean $secure   if this cookie will be available on secure connection or not
-		 * @param boolean $httponly if this cookie will be available under HTTP protocol.
-		 */
-		public static function set($name, $value = '', $expire = 0, $path = '/', $domain = '', $secure = false, $httponly = false){
-			if(headers_sent()){
-				show_error('There exists a cookie that we wanted to create that we couldn\'t 
+        /**
+         * Set the cookie item value
+         * @param string  $name     the cookie item name
+         * @param string  $value    the cookie value to set
+         * @param integer $expire   the time to live for this cookie
+         * @param string  $path     the path that the cookie will be available
+         * @param string  $domain   the domain that the cookie will be available
+         * @param boolean $secure   if this cookie will be available on secure connection or not
+         * @param boolean $httponly if this cookie will be available under HTTP protocol.
+         */
+        public static function set($name, $value = '', $expire = 0, $path = '/', $domain = '', $secure = false, $httponly = false){
+            if(headers_sent()){
+                show_error('There exists a cookie that we wanted to create that we couldn\'t 
 						    because headers was already sent. Make sure to do this first 
 							before outputing anything.');
-			}
-			$timestamp = $expire;
-			if($expire){
-				$timestamp = time() + $expire;
-			}
-			setcookie($name, $value, $timestamp, $path, $domain, $secure, $httponly);
-		}
+            }
+            $timestamp = $expire;
+            if($expire){
+                $timestamp = time() + $expire;
+            }
+            setcookie($name, $value, $timestamp, $path, $domain, $secure, $httponly);
+        }
 
-		/**
-		 * Delete the cookie item in the list
-		 * @param  string $item the cookie item name to be cleared
-		 * @return boolean true if the item exists and is deleted successfully otherwise will return false.
-		 */
-		public static function delete($item){
-			$logger = self::getLogger();
-			if(array_key_exists($item, $_COOKIE)){
-				$logger->info('Delete cookie item ['.$item.']');
-				unset($_COOKIE[$item]);
-				return true;
-			}
-			else{
-				$logger->warning('Cookie item ['.$item.'] to be deleted does not exists');
-				return false;
-			}
-		}
+        /**
+         * Delete the cookie item in the list
+         * @param  string $item the cookie item name to be cleared
+         * @return boolean true if the item exists and is deleted successfully otherwise will return false.
+         */
+        public static function delete($item){
+            $logger = self::getLogger();
+            if(array_key_exists($item, $_COOKIE)){
+                $logger->info('Delete cookie item ['.$item.']');
+                unset($_COOKIE[$item]);
+                return true;
+            }
+            else{
+                $logger->warning('Cookie item ['.$item.'] to be deleted does not exists');
+                return false;
+            }
+        }
 
-		/**
-		 * Check if the given cookie item exists
-		 * @param  string $item the cookie item name
-		 * @return boolean       true if the cookie item is set, false or not
-		 */
-		public static function exists($item){
-			return array_key_exists($item, $_COOKIE);
-		}
+        /**
+         * Check if the given cookie item exists
+         * @param  string $item the cookie item name
+         * @return boolean       true if the cookie item is set, false or not
+         */
+        public static function exists($item){
+            return array_key_exists($item, $_COOKIE);
+        }
 
-	}
+    }

core/libraries/StringHash.php

Indentation +58 added lines, -58 removed lines

@@ -1,65 +1,65 @@
 <?php 
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class StringHash{
+    class StringHash{
 		 
-		 //blowfish
-		private static $algo = '$2a';
+            //blowfish
+        private static $algo = '$2a';
 		
-		//cost parameter
-		private static $cost = '$10';
+        //cost parameter
+        private static $cost = '$10';
 
-		/**
-		 * Get the unique salt for the string hash
-		 * @return string the unique generated salt
-		 */
-		private static function uniqueSalt() {
-			return substr(sha1(mt_rand()), 0, 22);
-		}
+        /**
+         * Get the unique salt for the string hash
+         * @return string the unique generated salt
+         */
+        private static function uniqueSalt() {
+            return substr(sha1(mt_rand()), 0, 22);
+        }
 
-		/**
-		 * Hash the given string
-		 * @param  string $value the plain string text to be hashed
-		 * @return string           the hashed string
-		 */
-		public static function hash($value) {
-			return crypt($value, self::$algo .
-					self::$cost .
-					'$' . self::uniqueSalt());
-		}
+        /**
+         * Hash the given string
+         * @param  string $value the plain string text to be hashed
+         * @return string           the hashed string
+         */
+        public static function hash($value) {
+            return crypt($value, self::$algo .
+                    self::$cost .
+                    '$' . self::uniqueSalt());
+        }
 
-		/**
-		 * Check if the hash and plain string is valid
-		 * @param  string $hash     the hashed string
-		 * @param  string $plain the plain text
-		 * @return boolean  true if is valid or false if not
-		 */
-		public static function check($hash, $plain) {
-			$full_salt = substr($hash, 0, 29);
-			$new_hash = crypt($plain, $full_salt);
-			return ($hash === $new_hash);
-		}	
-	}
\ No newline at end of file
+        /**
+         * Check if the hash and plain string is valid
+         * @param  string $hash     the hashed string
+         * @param  string $plain the plain text
+         * @return boolean  true if is valid or false if not
+         */
+        public static function check($hash, $plain) {
+            $full_salt = substr($hash, 0, 29);
+            $new_hash = crypt($plain, $full_salt);
+            return ($hash === $new_hash);
+        }	
+    }
\ No newline at end of file