tnhfw / tnh-fw

core/classes/cache/FileCache.php

Indentation +263 added lines, -263 removed lines

@@ -1,283 +1,283 @@
 <?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 FileCache extends BaseClass implements CacheInterface{
+    class FileCache extends BaseClass implements CacheInterface{
 		
-		/**
-		 * Whether to enable compression of the cache data file.
-		 * @var boolean
-		 */
-		private $compressCacheData = true;
+        /**
+         * Whether to enable compression of the cache data file.
+         * @var boolean
+         */
+        private $compressCacheData = true;
 
-		/**
-		 * Class constructor
-		 */
-		public function __construct(){
-			parent::__construct();
-			if(! $this->isSupported()){
-				show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
-			}
+        /**
+         * Class constructor
+         */
+        public function __construct(){
+            parent::__construct();
+            if(! $this->isSupported()){
+                show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
+            }
 			
-			//if Zlib extension is not loaded set compressCacheData to false
-			if(! extension_loaded('zlib')){
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-		}
+            //if Zlib extension is not loaded set compressCacheData to false
+            if(! extension_loaded('zlib')){
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+        }
 
-		/**
-		 * 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 .']');
-			$filePath = $this->getFilePath($key);
-			if(! file_exists($filePath)){
-				$this->logger->info('No cache file found for the key ['. $key .'], return false');
-				return false;
-			}
-			$this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
-			$handle = fopen($filePath,'r');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			// Getting a shared lock 
-		    flock($handle, LOCK_SH);
-		    $data = file_get_contents($filePath);
-      		fclose($handle);
-      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-      		if (! $data) {
-      			$this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
-		         // If unserializing somehow didn't work out, we'll delete the file
-		         unlink($filePath);
-		         return false;
-	      	}
-	      	if (time() > $data['expire']) {
-	      		$this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
-		        // Unlinking when the file was expired
-		        unlink($filePath);
-		        return false;
-		     }
-		     else{
-		     	$this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
-		     	return $data['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 .']');
+            $filePath = $this->getFilePath($key);
+            if(! file_exists($filePath)){
+                $this->logger->info('No cache file found for the key ['. $key .'], return false');
+                return false;
+            }
+            $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid');
+            $handle = fopen($filePath,'r');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            // Getting a shared lock 
+            flock($handle, LOCK_SH);
+            $data = file_get_contents($filePath);
+                fclose($handle);
+                $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                if (! $data) {
+                    $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false');
+                    // If unserializing somehow didn't work out, we'll delete the file
+                    unlink($filePath);
+                    return false;
+                }
+                if (time() > $data['expire']) {
+                    $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']');
+                // Unlinking when the file was expired
+                unlink($filePath);
+                return false;
+                }
+                else{
+                    $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']');
+                    return $data['data'];
+                }
+        }
 
 
-		/**
-		 * Save data to the cache
-		 * @param string  $key  the key to identify this cache data
-		 * @param mixed  $data the cache data
-		 * @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) . ']');
-			$filePath = $this->getFilePath($key);
-			$handle = fopen($filePath,'w');
-			if(! is_resource($handle)){
-				$this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
-				return false;
-			}
-			flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
-			//Serializing along with the TTL
-		    $cacheData = serialize(array(
-									'mtime' => time(),
-									'expire' => $expire,
-									'data' => $data,
-									'ttl' => $ttl
-									)
-								);		   
-		    $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
-		    if(! $result){
-		    	$this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
-		    	fclose($handle);
-		    	return false;
-		    }
-		    else{
-		    	$this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
-		    	fclose($handle);
-				chmod($filePath, 0640);
-				return true;
-		    }
-		}	
+        /**
+         * Save data to the cache
+         * @param string  $key  the key to identify this cache data
+         * @param mixed  $data the cache data
+         * @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) . ']');
+            $filePath = $this->getFilePath($key);
+            $handle = fopen($filePath,'w');
+            if(! is_resource($handle)){
+                $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false');
+                return false;
+            }
+            flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed
+            //Serializing along with the TTL
+            $cacheData = serialize(array(
+                                    'mtime' => time(),
+                                    'expire' => $expire,
+                                    'data' => $data,
+                                    'ttl' => $ttl
+                                    )
+                                );		   
+            $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData);
+            if(! $result){
+                $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false');
+                fclose($handle);
+                return false;
+            }
+            else{
+                $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']');
+                fclose($handle);
+                chmod($filePath, 0640);
+                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 delete, false if can't delete 
-		 * the cache or the cache with the given key not exist
-		 */
-		public function delete($key){
-			$this->logger->debug('Deleting of cache data for key [' .$key. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			else{
-				$this->logger->info('Found cache file [' .$filePath. '] remove it');
-	      		unlink($filePath);
-				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 delete, false if can't delete 
+         * the cache or the cache with the given key not exist
+         */
+        public function delete($key){
+            $this->logger->debug('Deleting of cache data for key [' .$key. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            else{
+                $this->logger->info('Found cache file [' .$filePath. '] remove it');
+                    unlink($filePath);
+                return 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. ']');
-			$filePath = $this->getFilePath($key);
-			$this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
-			if(! file_exists($filePath)){
-				$this->logger->info('This cache file does not exists skipping');
-				return false;
-			}
-			$this->logger->info('Found cache file [' .$filePath. '] check the validity');
-      		$data = file_get_contents($filePath);
-			$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-			if(! $data){
-				$this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
-				return false;
-			}
-			$this->logger->info('This cache data is OK check for expire');
-			if(isset($data['expire']) && $data['expire'] > time()){
-				$this->logger->info('This cache not yet expired return cache informations');
-				$info = array(
-					'mtime' => $data['mtime'],
-					'expire' => $data['expire'],
-					'ttl' => $data['ttl']
-					);
-				return $info;
-			}
-			$this->logger->info('This cache already expired return false');
-			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. ']');
+            $filePath = $this->getFilePath($key);
+            $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']');
+            if(! file_exists($filePath)){
+                $this->logger->info('This cache file does not exists skipping');
+                return false;
+            }
+            $this->logger->info('Found cache file [' .$filePath. '] check the validity');
+                $data = file_get_contents($filePath);
+            $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+            if(! $data){
+                $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']');
+                return false;
+            }
+            $this->logger->info('This cache data is OK check for expire');
+            if(isset($data['expire']) && $data['expire'] > time()){
+                $this->logger->info('This cache not yet expired return cache informations');
+                $info = array(
+                    'mtime' => $data['mtime'],
+                    'expire' => $data['expire'],
+                    'ttl' => $data['ttl']
+                    );
+                return $info;
+            }
+            $this->logger->info('This cache already expired return false');
+            return false;
+        }
 
 
-		/**
-		 * Used to delete expired cache data
-		 */
-		public function deleteExpiredCache(){
-			$this->logger->debug('Deleting of expired cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					$data = file_get_contents($file);
-		      		$data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
-		      		if(! $data){
-		      			$this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
-		      		}
-		      		else if(time() > $data['expire']){
-		      			$this->logger->info('The cache data for file [' . $file . '] already expired remove it');
-		      			unlink($file);
-		      		}
-		      		else{
-		      			$this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
-		      		}
-				}
-			}
-		}	
+        /**
+         * Used to delete expired cache data
+         */
+        public function deleteExpiredCache(){
+            $this->logger->debug('Deleting of expired cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove if expired');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    $data = file_get_contents($file);
+                        $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data);
+                        if(! $data){
+                            $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']');
+                        }
+                        else if(time() > $data['expire']){
+                            $this->logger->info('The cache data for file [' . $file . '] already expired remove it');
+                            unlink($file);
+                        }
+                        else{
+                            $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it');
+                        }
+                }
+            }
+        }	
 
-		/**
-		 * Remove all file from cache folder
-		 */
-		public function clean(){
-			$this->logger->debug('Deleting of all cache files');
-			$list = glob(CACHE_PATH . '*.cache');
-			if(! $list){
-				$this->logger->info('No cache files were found skipping');
-			}
-			else{
-				$this->logger->info('Found [' . count($list) . '] cache files to remove');
-				foreach ($list as $file) {
-					$this->logger->debug('Processing the cache file [' . $file . ']');
-					unlink($file);
-				}
-			}
-		}
+        /**
+         * Remove all file from cache folder
+         */
+        public function clean(){
+            $this->logger->debug('Deleting of all cache files');
+            $list = glob(CACHE_PATH . '*.cache');
+            if(! $list){
+                $this->logger->info('No cache files were found skipping');
+            }
+            else{
+                $this->logger->info('Found [' . count($list) . '] cache files to remove');
+                foreach ($list as $file) {
+                    $this->logger->debug('Processing the cache file [' . $file . ']');
+                    unlink($file);
+                }
+            }
+        }
 	
-	    /**
-	     * @return boolean
-	     */
-	    public function isCompressCacheData(){
-	        return $this->compressCacheData;
-	    }
+        /**
+         * @return boolean
+         */
+        public function isCompressCacheData(){
+            return $this->compressCacheData;
+        }
 
-	    /**
-	     * @param boolean $compressCacheData
-	     *
-	     * @return object
-	     */
-	    public function setCompressCacheData($status = true){
-			//if Zlib extension is not loaded set compressCacheData to false
-			if($status === true && ! extension_loaded('zlib')){
+        /**
+         * @param boolean $compressCacheData
+         *
+         * @return object
+         */
+        public function setCompressCacheData($status = true){
+            //if Zlib extension is not loaded set compressCacheData to false
+            if($status === true && ! extension_loaded('zlib')){
 				
-				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
-				$this->compressCacheData = false;
-			}
-			else{
-				$this->compressCacheData = $status;
-			}
-			return $this;
-	    }
+                $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
+                $this->compressCacheData = false;
+            }
+            else{
+                $this->compressCacheData = $status;
+            }
+            return $this;
+        }
 		
-		/**
-		 * Check whether the cache feature for the handle is supported
-		 *
-		 * @return bool
-		 */
-		public function isSupported(){
-			return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
-		}
+        /**
+         * Check whether the cache feature for the handle is supported
+         *
+         * @return bool
+         */
+        public function isSupported(){
+            return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
+        }
 
 	
-		/**
-		* Get the cache file full path for the given key
-		*
-		* @param string $key the cache item key
-		* @return string the full cache file path for this key
-		*/
-		private function getFilePath($key){
-			return CACHE_PATH . md5($key) . '.cache';
-		}
-	}
+        /**
+         * Get the cache file full path for the given key
+         *
+         * @param string $key the cache item key
+         * @return string the full cache file path for this key
+         */
+        private function getFilePath($key){
+            return CACHE_PATH . md5($key) . '.cache';
+        }
+    }

Spacing +54 added lines, -54 removed lines

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

Braces +8 added lines, -16 removed lines

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

core/classes/Controller.php

Indentation +106 added lines, -106 removed lines

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

Spacing +16 added lines, -16 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Controller extends BaseClass{
+	class Controller extends BaseClass {
 		
 		/**
 		 * The name of the module if this controller belong to an module
@@ -42,7 +42,7 @@ 
 		/**
 		 * Class constructor
 		 */
-		public function __construct(){
+		public function __construct() {
 			parent::__construct();
 			
 			//instance of the super object
@@ -50,8 +50,8 @@ 
 
 			//Load the resources loaded during the application bootstrap
 			$this->logger->debug('Adding the loaded classes to the super instance');
-			foreach (class_loaded() as $var => $class){
-				$this->$var =& class_loader($class);
+			foreach (class_loaded() as $var => $class) {
+				$this->$var = & class_loader($class);
 			}
 			
 			//set module using the router
@@ -83,9 +83,9 @@ 
 		/**
 		 * This method is used to set the module name
 		 */
-		protected function setModuleNameFromRouter(){
+		protected function setModuleNameFromRouter() {
 			//set the module using the router instance
-			if(isset($this->router) && $this->router->getModule()){
+			if (isset($this->router) && $this->router->getModule()) {
 				$this->moduleName = $this->router->getModule();
 			}
 		}
@@ -94,13 +94,13 @@ 
 		 * Set the cache using the argument otherwise will use the configuration
 		 * @param CacheInterface $cache the implementation of CacheInterface if null will use the configured
 		 */
-		protected function setCacheFromParamOrConfig(CacheInterface $cache = null){
+		protected function setCacheFromParamOrConfig(CacheInterface $cache = null) {
 			$this->logger->debug('Setting the cache handler instance');
 			//set cache handler instance
-			if(get_config('cache_enable', false)){
-				if ($cache !== null){
+			if (get_config('cache_enable', false)) {
+				if ($cache !== null) {
 					$this->cache = $cache;
-				} else if (isset($this->{strtolower(get_config('cache_handler'))})){
+				} else if (isset($this->{strtolower(get_config('cache_handler'))})) {
 					$this->cache = $this->{strtolower(get_config('cache_handler'))};
 					unset($this->{strtolower(get_config('cache_handler'))});
 				} 
@@ -112,15 +112,15 @@ 
 		 * This method is used to load the required resources for framework to work
 		 * @return void 
 		 */
-		private function loadRequiredResources(){
+		private function loadRequiredResources() {
 			$this->logger->debug('Loading the required classes into super instance');
-			$this->eventdispatcher =& class_loader('EventDispatcher', 'classes');
-			$this->loader =& class_loader('Loader', 'classes');
-			$this->lang =& class_loader('Lang', 'classes');
-			$this->request =& class_loader('Request', 'classes');
+			$this->eventdispatcher = & class_loader('EventDispatcher', 'classes');
+			$this->loader = & class_loader('Loader', 'classes');
+			$this->lang = & class_loader('Lang', 'classes');
+			$this->request = & class_loader('Request', 'classes');
 			//dispatch the request instance created event
 			$this->eventdispatcher->dispatch('REQUEST_CREATED');
-			$this->response =& class_loader('Response', 'classes', 'classes');
+			$this->response = & class_loader('Response', 'classes', 'classes');
 		}
 
 	}

core/classes/BaseClass.php

Indentation +85 added lines, -85 removed lines

@@ -1,93 +1,93 @@
 <?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 BaseClass{
-		/**
-		 * The logger instance
-		 * @var object
-		 */
-		protected $logger;
+    class BaseClass{
+        /**
+         * The logger instance
+         * @var object
+         */
+        protected $logger;
 
-		/**
-		 * Class constructor
-		 */
-		public function __construct(){
-			//Set Log instance to use
-       		$this->setLoggerFromParamOrCreate(null);
-		}
+        /**
+         * Class constructor
+         */
+        public function __construct(){
+            //Set Log instance to use
+                $this->setLoggerFromParamOrCreate(null);
+        }
 
-		/**
-	     * Set the dependencies instance using argument or create new instance if is null
-	     * @param string $name this class property name.
-	     * @param object $instance the instance. If is not null will use it
-	     * otherwise will create new instance.
-	     * @param string $loadClassName the name of class to load using class_loader function.
-	     * @param string $loadClassPath the path of class to load using class_loader function.
-	     *
-	     * @return object this current instance
-	     */
-	    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
-	      if ($instance !== null){
-	        $this->{$name} = $instance;
-	        return $this;
-	      }
-	      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
-	      return $this;
-	    }
+        /**
+         * Set the dependencies instance using argument or create new instance if is null
+         * @param string $name this class property name.
+         * @param object $instance the instance. If is not null will use it
+         * otherwise will create new instance.
+         * @param string $loadClassName the name of class to load using class_loader function.
+         * @param string $loadClassPath the path of class to load using class_loader function.
+         *
+         * @return object this current instance
+         */
+        protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
+            if ($instance !== null){
+            $this->{$name} = $instance;
+            return $this;
+            }
+            $this->{$name} =& class_loader($loadClassName, $loadClassePath);
+            return $this;
+        }
 
-	    /**
-	     * Return the Log instance
-	     * @return object
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
+        /**
+         * Return the Log instance
+         * @return object
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
 
-	    /**
-	     * Set the log instance
-	     * @param object $logger the log object
-		 * @return object Database
-	     */
-	    public function setLogger($logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
+        /**
+         * Set the log instance
+         * @param object $logger the log object
+         * @return object Database
+         */
+        public function setLogger($logger){
+            $this->logger = $logger;
+            return $this;
+        }
 
-	    /**
-	     * Set the Log instance using argument or create new instance
-	     * @param object $logger the Log instance if not null
-	     *
-	     * @return object this current instance
-	     */
-	    protected function setLoggerFromParamOrCreate(Log $logger = null){
-	      $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
-	      if ($logger === null){
-	        $this->logger->setLogger('Class::' . get_class($this));
-	      }
-	      return $this;
-	    }
+        /**
+         * Set the Log instance using argument or create new instance
+         * @param object $logger the Log instance if not null
+         *
+         * @return object this current instance
+         */
+        protected function setLoggerFromParamOrCreate(Log $logger = null){
+            $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
+            if ($logger === null){
+            $this->logger->setLogger('Class::' . get_class($this));
+            }
+            return $this;
+        }
 
-	}
+    }

Spacing +9 added lines, -9 removed lines

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

core/classes/BaseStaticClass.php

Indentation +53 added lines, -53 removed lines

@@ -1,58 +1,58 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	class BaseStaticClass{
-		/**
-		 * The logger instance
-		 * @var object
-		 */
-		protected static $logger;
+    class BaseStaticClass{
+        /**
+         * The logger instance
+         * @var object
+         */
+        protected static $logger;
 
-		/**
-		 * The signleton of the logger
-		 * @return Object the Log instance
-		 */
-		public static function getLogger(){
-			if(self::$logger == null){
-				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
-				$logger[0]->setLogger('Class::' . get_called_class());
-				self::$logger = $logger[0];
-			}
-			return self::$logger;			
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        public static function getLogger(){
+            if(self::$logger == null){
+                $logger = array();
+                $logger[0] =& class_loader('Log', 'classes');
+                $logger[0]->setLogger('Class::' . get_called_class());
+                self::$logger = $logger[0];
+            }
+            return self::$logger;			
+        }
 
-		/**
-		 * Set the log instance for future use
-		 * @param object $logger the log object
-		 * @return object the log instance
-		 */
-		public static function setLogger($logger){
-			self::$logger = $logger;
-			return self::$logger;
-		}
+        /**
+         * Set the log instance for future use
+         * @param object $logger the log object
+         * @return object the log instance
+         */
+        public static function setLogger($logger){
+            self::$logger = $logger;
+            return self::$logger;
+        }
 
-	}
+    }

Spacing +5 added lines, -5 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class BaseStaticClass{
+	class BaseStaticClass {
 		/**
 		 * The logger instance
 		 * @var object
@@ -35,10 +35,10 @@ 
 		 * The signleton of the logger
 		 * @return Object the Log instance
 		 */
-		public static function getLogger(){
-			if(self::$logger == null){
+		public static function getLogger() {
+			if (self::$logger == null) {
 				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
+				$logger[0] = & class_loader('Log', 'classes');
 				$logger[0]->setLogger('Class::' . get_called_class());
 				self::$logger = $logger[0];
 			}
@@ -50,7 +50,7 @@ 
 		 * @param object $logger the log object
 		 * @return object the log instance
 		 */
-		public static function setLogger($logger){
+		public static function setLogger($logger) {
 			self::$logger = $logger;
 			return self::$logger;
 		}

core/classes/Log.php

Indentation +262 added lines, -262 removed lines

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

Spacing +30 added lines, -30 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Log{
+	class Log {
 		
 		/**
 		 * The defined constante for Log level
@@ -52,14 +52,14 @@ 
 		/**
 		 * Create new Log instance
 		 */
-		public function __construct(){
+		public function __construct() {
 		}
 
 		/**
 		 * Set the logger to identify each message in the log
 		 * @param string $logger the logger name
 		 */
-		public  function setLogger($logger){
+		public  function setLogger($logger) {
 			$this->logger = $logger;
 		}
 
@@ -68,7 +68,7 @@ 
 		 * @see Log::writeLog for more detail
 		 * @param  string $message the log message to save
 		 */
-		public function fatal($message){
+		public function fatal($message) {
 			$this->writeLog($message, self::FATAL);
 		} 
 		
@@ -77,7 +77,7 @@ 
 		 * @see Log::writeLog for more detail
 		 * @param  string $message the log message to save
 		 */
-		public function error($message){
+		public function error($message) {
 			$this->writeLog($message, self::ERROR);
 		} 
 
@@ -86,7 +86,7 @@ 
 		 * @see Log::writeLog for more detail
 		 * @param  string $message the log message to save
 		 */
-		public function warning($message){
+		public function warning($message) {
 			$this->writeLog($message, self::WARNING);
 		} 
 		
@@ -95,7 +95,7 @@ 
 		 * @see Log::writeLog for more detail
 		 * @param  string $message the log message to save
 		 */
-		public function info($message){
+		public function info($message) {
 			$this->writeLog($message, self::INFO);
 		} 
 		
@@ -104,7 +104,7 @@ 
 		 * @see Log::writeLog for more detail
 		 * @param  string $message the log message to save
 		 */
-		public function debug($message){
+		public function debug($message) {
 			$this->writeLog($message, self::DEBUG);
 		} 
 		
@@ -115,31 +115,31 @@ 
 		 * @param  integer|string $level   the log level in integer or string format, if is string will convert into integer
 		 * to allow check the log level threshold.
 		 */
-		public function writeLog($message, $level = self::INFO){
+		public function writeLog($message, $level = self::INFO) {
 			$configLogLevel = get_config('log_level');
-			if(! $configLogLevel){
+			if (!$configLogLevel) {
 				//so means no need log just stop here
 				return;
 			}
 			//check config log level
-			if(! self::isValidConfigLevel($configLogLevel)){
+			if (!self::isValidConfigLevel($configLogLevel)) {
 				//NOTE: here need put the show_error() "logging" to false to prevent loop
 				show_error('Invalid config log level [' . $configLogLevel . '], the value must be one of the following: ' . implode(', ', array_map('strtoupper', self::$validConfigLevel)), $title = 'Log Config Error', $logging = false);	
 			}
 			
 			//check if config log_logger_name and current log can save log data
-			if(! $this->canSaveLogDataForLogger()){
+			if (!$this->canSaveLogDataForLogger()) {
 				return;
 			}
 			
 			//if $level is not an integer
-			if(! is_numeric($level)){
+			if (!is_numeric($level)) {
 				$level = self::getLevelValue($level);
 			}
 			
 			//check if can logging regarding the log level config
 			$configLevel = self::getLevelValue($configLogLevel);
-			if($configLevel > $level){
+			if ($configLevel > $level) {
 				//can't log
 				return;
 			}
@@ -156,7 +156,7 @@ 
 		 * @param  string $message the log message to save
 		 * @return void
 		 */
-		protected function saveLogData($path, $level, $message){
+		protected function saveLogData($path, $level, $message) {
 			//may be at this time helper user_agent not yet included
 			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 			
@@ -169,7 +169,7 @@ 
 			$ip = get_ip();
 			
 			//if $level is not an integer
-			if(! is_numeric($level)){
+			if (!is_numeric($level)) {
 				$level = self::getLevelValue($level);
 			}
 
@@ -179,13 +179,13 @@ 
 			//debug info
 			$dtrace = debug_backtrace();
 			$fileInfo = $dtrace[0];
-			if ($dtrace[0]['file'] == __FILE__ || $dtrace[1]['file'] == __FILE__){
+			if ($dtrace[0]['file'] == __FILE__ || $dtrace[1]['file'] == __FILE__) {
 				$fileInfo = $dtrace[2];
 			}
 			
 			$str = $logDate . ' [' . str_pad($levelName, 7 /*warning len*/) . '] ' . ' [' . str_pad($ip, 15) . '] ' . $this->logger . ' : ' . $message . ' ' . '[' . $fileInfo['file'] . '::' . $fileInfo['line'] . ']' . "\n";
 			$fp = fopen($path, 'a+');
-			if(is_resource($fp)){
+			if (is_resource($fp)) {
 				flock($fp, LOCK_EX); // exclusive lock, will get released when the file is closed
 				fwrite($fp, $str);
 				fclose($fp);
@@ -197,13 +197,13 @@ 
 		 * of logger filter
 		 * @return boolean
 		 */
-		protected function canSaveLogDataForLogger(){
-			if(! empty($this->logger)){
+		protected function canSaveLogDataForLogger() {
+			if (!empty($this->logger)) {
 				$configLoggersName = get_config('log_logger_name', array());
 				if (!empty($configLoggersName)) {
 					//for best comparaison put all string to lowercase
 					$configLoggersName = array_map('strtolower', $configLoggersName);
-					if(! in_array(strtolower($this->logger), $configLoggersName)){
+					if (!in_array(strtolower($this->logger), $configLoggersName)) {
 						return false;
 					}
 				}
@@ -215,19 +215,19 @@ 
 		 * Check the file and directory 
 		 * @return string the log file path
 		 */
-		protected function checkAndSetLogFileDirectory(){
+		protected function checkAndSetLogFileDirectory() {
 			$logSavePath = get_config('log_save_path');
-			if(! $logSavePath){
+			if (!$logSavePath) {
 				$logSavePath = LOGS_PATH;
 			}
 			
-			if(! is_dir($logSavePath) || !is_writable($logSavePath)){
+			if (!is_dir($logSavePath) || !is_writable($logSavePath)) {
 				//NOTE: here need put the show_error() "logging" to false to prevent loop
 				show_error('Error : the log dir does not exists or is not writable', $title = 'Log directory error', $logging = false);
 			}
 			
 			$path = $logSavePath . 'logs-' . date('Y-m-d') . '.log';
-			if(! file_exists($path)){
+			if (!file_exists($path)) {
 				touch($path);
 			}
 			return $path;
@@ -240,7 +240,7 @@ 
 		 *
 		 * @return boolean        true if the given log level is valid, false if not
 		 */
-		protected static function isValidConfigLevel($level){
+		protected static function isValidConfigLevel($level) {
 			$level = strtolower($level);
 			return in_array($level, self::$validConfigLevel);
 		}
@@ -251,7 +251,7 @@ 
 		 * 
 		 * @return int        the log level in integer format using the predefined constants
 		 */
-		protected static function getLevelValue($level){
+		protected static function getLevelValue($level) {
 			$level = strtolower($level);
 			$levelMaps = array(
 				'fatal'   => self::FATAL,
@@ -264,7 +264,7 @@ 
 			);
 			//the default value is NONE, so means no need test for NONE
 			$value = self::NONE;
-			if(isset($levelMaps[$level])){
+			if (isset($levelMaps[$level])) {
 				$value = $levelMaps[$level];
 			}
 			return $value;
@@ -275,7 +275,7 @@ 
 		 * @param  integer $level the log level in integer format
 		 * @return string        the log level in string format
 		 */
-		protected static function getLevelName($level){
+		protected static function getLevelName($level) {
 			$levelMaps = array(
 				self::FATAL   => 'FATAL',
 				self::ERROR   => 'ERROR',
@@ -284,7 +284,7 @@ 
 				self::DEBUG   => 'DEBUG'
 			);
 			$value = '';
-			if(isset($levelMaps[$level])){
+			if (isset($levelMaps[$level])) {
 				$value = $levelMaps[$level];
 			}
 			return $value;