tnhfw / tnh-fw

tests/tnhfw/classes/database/DatabaseQueryResultTest.php

Indentation +20 added lines, -20 removed lines

@@ -1,31 +1,31 @@
 <?php 
 
-	use PHPUnit\Framework\TestCase;
+    use PHPUnit\Framework\TestCase;
 
-	class DatabaseQueryResultTest extends TestCase
-	{	
+    class DatabaseQueryResultTest extends TestCase
+    {	
 	
-		public static function setUpBeforeClass()
-		{
+        public static function setUpBeforeClass()
+        {
 		
-		}
+        }
 		
-		public static function tearDownAfterClass()
-		{
+        public static function tearDownAfterClass()
+        {
 			
-		}
+        }
 		
-		protected function setUp()
-		{
-		}
+        protected function setUp()
+        {
+        }
 
-		protected function tearDown()
-		{
-		}
+        protected function tearDown()
+        {
+        }
 		
-		public function testNotYet()
-		{
-			$this->markTestSkipped();
-		}
+        public function testNotYet()
+        {
+            $this->markTestSkipped();
+        }
 
-	}
\ No newline at end of file
+    }
\ No newline at end of file

tests/tnhfw/classes/database/DatabaseQueryRunnerTest.php

Indentation +20 added lines, -20 removed lines

@@ -1,31 +1,31 @@
 <?php 
 
-	use PHPUnit\Framework\TestCase;
+    use PHPUnit\Framework\TestCase;
 
-	class DatabaseQueryRunnerTest extends TestCase
-	{	
+    class DatabaseQueryRunnerTest extends TestCase
+    {	
 	
-		public static function setUpBeforeClass()
-		{
+        public static function setUpBeforeClass()
+        {
 		
-		}
+        }
 		
-		public static function tearDownAfterClass()
-		{
+        public static function tearDownAfterClass()
+        {
 			
-		}
+        }
 		
-		protected function setUp()
-		{
-		}
+        protected function setUp()
+        {
+        }
 
-		protected function tearDown()
-		{
-		}
+        protected function tearDown()
+        {
+        }
 		
-		public function testNotYet()
-		{
-			$this->markTestSkipped();
-		}
+        public function testNotYet()
+        {
+            $this->markTestSkipped();
+        }
 
-	}
\ No newline at end of file
+    }
\ No newline at end of file

tests/tnhfw/functions/FunctionUserAgentTest.php

Indentation +33 added lines, -33 removed lines

@@ -1,69 +1,69 @@
 <?php 
 
-	use PHPUnit\Framework\TestCase;
+    use PHPUnit\Framework\TestCase;
 
-	class FunctionUserAgentTest extends TestCase
-	{	
+    class FunctionUserAgentTest extends TestCase
+    {	
 	
-		public static function setUpBeforeClass()
-		{
+        public static function setUpBeforeClass()
+        {
             require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
-		}
+        }
 		
-		public function testLoopBack()
-		{
-			$this->assertEquals('127.0.0.1', get_ip());
-		}
+        public function testLoopBack()
+        {
+            $this->assertEquals('127.0.0.1', get_ip());
+        }
         
         public function testServerRemoteAddr()
-		{
+        {
             $ip = '182.23.24.56';
             $_SERVER['REMOTE_ADDR'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
         public function testServerHttpClientIp()
-		{
+        {
             $ip = '192.168.24.1';
             $_SERVER['HTTP_CLIENT_IP'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
         public function testServerHttpXForwardedFor()
-		{
+        {
             $ip = '172.18.2.1';
             $_SERVER['HTTP_X_FORWARDED_FOR'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
         public function testServerHttpXForwarded()
-		{
+        {
             
             $ip = '12.18.2.1';
             $_SERVER['HTTP_X_FORWARDED'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
         public function testServerHttpForwardedFor()
-		{
+        {
             $ip = '198.180.2.1';
             $_SERVER['HTTP_FORWARDED_FOR'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
         public function testServerHttpForwarded()
-		{
+        {
             $ip = '220.200.2.1';
             $_SERVER['HTTP_FORWARDED'] = $ip;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
         
-         public function testManyIp()
-		{
+            public function testManyIp()
+        {
             $ips = '20.200.2.1, 192.168.34.4';
             $ip = '20.200.2.1';
             $_SERVER['REMOTE_ADDR'] = $ips;
-			$this->assertEquals($ip, get_ip());
-		}
+            $this->assertEquals($ip, get_ip());
+        }
 
-	}
\ No newline at end of file
+    }
\ No newline at end of file

tests/bootstrap.php

Indentation +240 added lines, -240 removed lines

@@ -1,287 +1,287 @@
 <?php
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 	
-	error_reporting(E_ALL | E_STRICT);
-	ini_set('display_errors', 1);
+    error_reporting(E_ALL | E_STRICT);
+    ini_set('display_errors', 1);
 
-	/**
-	* the directory separator, under windows it is \ and unix, linux /
-	*/
-	define('DS', DIRECTORY_SEPARATOR);
+    /**
+     * the directory separator, under windows it is \ and unix, linux /
+     */
+    define('DS', DIRECTORY_SEPARATOR);
 
-	/**
-	* The root directory of the application.
-	*
-	* you can place this directory outside of your web directory, for example "/home/your_app", etc.
-	*/
-	define('ROOT_PATH', dirname(realpath(__FILE__)) . DS . '..' . DS);
+    /**
+     * The root directory of the application.
+     *
+     * you can place this directory outside of your web directory, for example "/home/your_app", etc.
+     */
+    define('ROOT_PATH', dirname(realpath(__FILE__)) . DS . '..' . DS);
 	
-	//tests dir path
-	define('TESTS_PATH', dirname(realpath(__FILE__)) . DS);
+    //tests dir path
+    define('TESTS_PATH', dirname(realpath(__FILE__)) . DS);
 
-	/**
-	* The path to the directory.
-	*
-	* That contains your static files (javascript, css, images, etc.)
-	* Note: the path must be relative to the file index.php (the front-end controller).
-	*/
-	define('ASSETS_PATH', 'assets/');
+    /**
+     * The path to the directory.
+     *
+     * That contains your static files (javascript, css, images, etc.)
+     * Note: the path must be relative to the file index.php (the front-end controller).
+     */
+    define('ASSETS_PATH', 'assets/');
 
-	/**
-	* The path to the directory of your cache files.
-	*
-	* This feature is available currently for database and views.
-	*/
-	define('CACHE_PATH', ROOT_PATH . 'cache' . DS);
+    /**
+     * The path to the directory of your cache files.
+     *
+     * This feature is available currently for database and views.
+     */
+    define('CACHE_PATH', ROOT_PATH . 'cache' . DS);
 
-	/**
-	* Custom application path for tests 
-	*/
-	define('APPS_PATH', TESTS_PATH .'hmvc' . DS);
+    /**
+     * Custom application path for tests 
+     */
+    define('APPS_PATH', TESTS_PATH .'hmvc' . DS);
 
-	/**
-	* The path to the controller directory of your application.
-	*
-	* If you already know the MVC architecture you know what a controller means; 
-	* it is he who makes the business logic of your application in general.
-	*/
-	define('APPS_CONTROLLER_PATH', APPS_PATH . 'controllers' . DS);
+    /**
+     * The path to the controller directory of your application.
+     *
+     * If you already know the MVC architecture you know what a controller means; 
+     * it is he who makes the business logic of your application in general.
+     */
+    define('APPS_CONTROLLER_PATH', APPS_PATH . 'controllers' . DS);
 
-	/**
-	* The path to the directory of your model classes of your application. 
-	*
-	* If you already know the MVC architecture you know what a model means; 
-	* it's the one who interacts with the database, in one word persistent data from your application.
-	*/
-	define('APPS_MODEL_PATH', APPS_PATH . 'models' . DS);
+    /**
+     * The path to the directory of your model classes of your application. 
+     *
+     * If you already know the MVC architecture you know what a model means; 
+     * it's the one who interacts with the database, in one word persistent data from your application.
+     */
+    define('APPS_MODEL_PATH', APPS_PATH . 'models' . DS);
 
-	/**
-	* The path to the directory of your views.
-	*
-	* If you already know the MVC architecture you know what a view means, 
-	* a view is just a user interface (html page, form, etc.) that is to say 
-	* everything displayed in the browser interface, etc.
-	*/
-	define('APPS_VIEWS_PATH', APPS_PATH . 'views' . DS);
+    /**
+     * The path to the directory of your views.
+     *
+     * If you already know the MVC architecture you know what a view means, 
+     * a view is just a user interface (html page, form, etc.) that is to say 
+     * everything displayed in the browser interface, etc.
+     */
+    define('APPS_VIEWS_PATH', APPS_PATH . 'views' . DS);
 
-	/**
-	* The path to the configuration directory.
-	*
-	* That contains most of the configuration files for your 
-	* application (database, class loading file, functions, etc.)
-	*/
-	define('CONFIG_PATH', ROOT_PATH . 'config' . DS);
+    /**
+     * The path to the configuration directory.
+     *
+     * That contains most of the configuration files for your 
+     * application (database, class loading file, functions, etc.)
+     */
+    define('CONFIG_PATH', ROOT_PATH . 'config' . DS);
 
-	/** 
-	* The core directory
-	*
-	* It is recommended to put this folder out of the web directory of your server and 
-	* you should not change its content because in case of update you could lose the modified files.
-	*/
-	define('CORE_PATH', ROOT_PATH . 'core' . DS);
+    /** 
+     * The core directory
+     *
+     * It is recommended to put this folder out of the web directory of your server and 
+     * you should not change its content because in case of update you could lose the modified files.
+     */
+    define('CORE_PATH', ROOT_PATH . 'core' . DS);
 	
-	/**
-	* The path to the directory of core classes that used by the system.
-	*
-	* It contains PHP classes that are used by the framework internally.
-	*/
-	define('CORE_CLASSES_PATH', CORE_PATH . 'classes' . DS);
+    /**
+     * The path to the directory of core classes that used by the system.
+     *
+     * It contains PHP classes that are used by the framework internally.
+     */
+    define('CORE_CLASSES_PATH', CORE_PATH . 'classes' . DS);
 	
-	/**
-	* The path to the directory of core classes for the cache used by the system.
-	*
-	* It contains PHP classes for the cache drivers.
-	*/
-	define('CORE_CLASSES_CACHE_PATH', CORE_CLASSES_PATH . 'cache' . DS);
+    /**
+     * The path to the directory of core classes for the cache used by the system.
+     *
+     * It contains PHP classes for the cache drivers.
+     */
+    define('CORE_CLASSES_CACHE_PATH', CORE_CLASSES_PATH . 'cache' . DS);
 	
     /**
-	* The path to the directory of core classes for the database used by the system.
-	*
-	* It contains PHP classes for the database library, drivers, etc.
-	*/
-	define('CORE_CLASSES_DATABASE_PATH', CORE_CLASSES_PATH . 'database' . DS);
+     * The path to the directory of core classes for the database used by the system.
+     *
+     * It contains PHP classes for the database library, drivers, etc.
+     */
+    define('CORE_CLASSES_DATABASE_PATH', CORE_CLASSES_PATH . 'database' . DS);
     
-	/**
-	* The path to the directory of core classes for the model used by the system.
-	*
-	* It contains PHP classes for the models.
-	*/
-	define('CORE_CLASSES_MODEL_PATH', CORE_CLASSES_PATH . 'model' . DS);
+    /**
+     * The path to the directory of core classes for the model used by the system.
+     *
+     * It contains PHP classes for the models.
+     */
+    define('CORE_CLASSES_MODEL_PATH', CORE_CLASSES_PATH . 'model' . DS);
 
-	/**
-	* The path to the directory of functions or helper systems.
-	*
-	* It contains PHP functions that perform a particular task: character string processing, URL, etc.
-	*/
-	define('CORE_FUNCTIONS_PATH', CORE_PATH . 'functions' . DS);
+    /**
+     * The path to the directory of functions or helper systems.
+     *
+     * It contains PHP functions that perform a particular task: character string processing, URL, etc.
+     */
+    define('CORE_FUNCTIONS_PATH', CORE_PATH . 'functions' . DS);
 
-	/**
-	* The path to the core directory of languages files. 
-	*
-	*/
-	define('CORE_LANG_PATH', CORE_PATH . 'lang' . DS);
+    /**
+     * The path to the core directory of languages files. 
+     *
+     */
+    define('CORE_LANG_PATH', CORE_PATH . 'lang' . DS);
 
-	/**
-	* The path to the system library directory.
-	*
-	* Which contains the libraries most often used in your web application, as for the 
-	* core directory it is advisable to put it out of the root directory of your application.
-	*/
-	define('CORE_LIBRARY_PATH', CORE_PATH . 'libraries' . DS);
+    /**
+     * The path to the system library directory.
+     *
+     * Which contains the libraries most often used in your web application, as for the 
+     * core directory it is advisable to put it out of the root directory of your application.
+     */
+    define('CORE_LIBRARY_PATH', CORE_PATH . 'libraries' . DS);
 
-	/**
-	* The path to the system view directory.
-	*
-	* That contains the views used for the system, such as error messages, and so on.
-	*/
-	define('CORE_VIEWS_PATH', CORE_PATH . 'views' . DS);
+    /**
+     * The path to the system view directory.
+     *
+     * That contains the views used for the system, such as error messages, and so on.
+     */
+    define('CORE_VIEWS_PATH', CORE_PATH . 'views' . DS);
 	
-	/**
-	* The path to the directory of your PHP personal functions or helper.
-	*
-	* It contains your PHP functions that perform a particular task: utilities, etc.
-	* Note: Do not put your personal functions or helpers in the system functions directory, 
-	* because if you update the system you may lose them.
-	*/
-	define('FUNCTIONS_PATH', ROOT_PATH . 'functions' . DS);
+    /**
+     * The path to the directory of your PHP personal functions or helper.
+     *
+     * It contains your PHP functions that perform a particular task: utilities, etc.
+     * Note: Do not put your personal functions or helpers in the system functions directory, 
+     * because if you update the system you may lose them.
+     */
+    define('FUNCTIONS_PATH', ROOT_PATH . 'functions' . DS);
 
-	/**
-	* The path to the app directory of personal language. 
-	*
-	* This feature is not yet available. 
-	* You can help us do this if you are nice or wish to see the developed framework.
-	*/
-	define('APP_LANG_PATH', ROOT_PATH . 'lang' . DS);
+    /**
+     * The path to the app directory of personal language. 
+     *
+     * This feature is not yet available. 
+     * You can help us do this if you are nice or wish to see the developed framework.
+     */
+    define('APP_LANG_PATH', ROOT_PATH . 'lang' . DS);
 
-	/**
-	* The path to the directory of your personal libraries
-	*
-	* It contains your PHP classes, package, etc.
-	* Note: you should not put your personal libraries in the system library directory, 
-	* because it is recalled in case of updating the system you might have surprises.
-	*/
-	define('LIBRARY_PATH', ROOT_PATH . 'libraries' . DS);
+    /**
+     * The path to the directory of your personal libraries
+     *
+     * It contains your PHP classes, package, etc.
+     * Note: you should not put your personal libraries in the system library directory, 
+     * because it is recalled in case of updating the system you might have surprises.
+     */
+    define('LIBRARY_PATH', ROOT_PATH . 'libraries' . DS);
 
-	/**
-	* The path to the directory that contains the log files.
-	*
-	* Note: This directory must be available in writing and if possible must have as owner the user who launches your web server, 
-	* under unix or linux most often with the apache web server it is "www-data" or "httpd" even "nobody" for more
-	* details see the documentation of your web server.
-	* Example for Unix or linux with apache web server:
-	* # chmod -R 700 /path/to/your/logs/directory/
-	* # chown -R www-data:www-data /path/to/your/logs/directory/
-	*/
-	define('LOGS_PATH', ROOT_PATH . 'logs' . DS);
+    /**
+     * The path to the directory that contains the log files.
+     *
+     * Note: This directory must be available in writing and if possible must have as owner the user who launches your web server, 
+     * under unix or linux most often with the apache web server it is "www-data" or "httpd" even "nobody" for more
+     * details see the documentation of your web server.
+     * Example for Unix or linux with apache web server:
+     * # chmod -R 700 /path/to/your/logs/directory/
+     * # chown -R www-data:www-data /path/to/your/logs/directory/
+     */
+    define('LOGS_PATH', ROOT_PATH . 'logs' . DS);
 
-	/**
-	* The path to the modules directory. 
-	*
-	* It contains your modules used files (config, controllers, libraries, etc.) that is to say which contains your files of the modules, 
-	* in HMVC architecture (hierichical, controllers, models, views).
-	*/
-	define('MODULE_PATH', dirname(realpath(__FILE__)) . DS .'hmvc' . DS . 'modules' . DS);
+    /**
+     * The path to the modules directory. 
+     *
+     * It contains your modules used files (config, controllers, libraries, etc.) that is to say which contains your files of the modules, 
+     * in HMVC architecture (hierichical, controllers, models, views).
+     */
+    define('MODULE_PATH', dirname(realpath(__FILE__)) . DS .'hmvc' . DS . 'modules' . DS);
 
-	/**
-	* The path to the directory of sources external to your application.
-	*
-	* If you have already used "composer" you know what that means.
-	*/
-	define('VENDOR_PATH', ROOT_PATH . 'vendor' . DS);
+    /**
+     * The path to the directory of sources external to your application.
+     *
+     * If you have already used "composer" you know what that means.
+     */
+    define('VENDOR_PATH', ROOT_PATH . 'vendor' . DS);
 
-	/**
-	* The front controller of your application.
-	*
-	* "index.php" it is through this file that all the requests come, there is a possibility to hidden it in the url of 
-	* your application by using the rewrite module URL of your web server .
-	* For example, under apache web server, there is a configuration example file that is located at the root 
-	* of your framework folder : "htaccess.txt" rename it to ".htaccess".
-	*/
-	define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME));
+    /**
+     * The front controller of your application.
+     *
+     * "index.php" it is through this file that all the requests come, there is a possibility to hidden it in the url of 
+     * your application by using the rewrite module URL of your web server .
+     * For example, under apache web server, there is a configuration example file that is located at the root 
+     * of your framework folder : "htaccess.txt" rename it to ".htaccess".
+     */
+    define('SELF', pathinfo(__FILE__, PATHINFO_BASENAME));
 	
-	/**
-	 * Check if user run the application under CLI
-	 */
-	define('IS_CLI', stripos('cli', php_sapi_name()) !== false);
+    /**
+     * Check if user run the application under CLI
+     */
+    define('IS_CLI', stripos('cli', php_sapi_name()) !== false);
 
-	/**
-	* The environment of your application (production, test, development). 
-	*
-	* if your application is still in development you use the value "development" 
-	* so you will have the display of the error messages, etc. 
-	* Once you finish the development of your application that is to put it online 
-	* you change this value to "production" or "testing", in this case there will be deactivation of error messages, 
-	* the loading of the system, will be fast.
-	*/
-	define('ENVIRONMENT', 'testing');
+    /**
+     * The environment of your application (production, test, development). 
+     *
+     * if your application is still in development you use the value "development" 
+     * so you will have the display of the error messages, etc. 
+     * Once you finish the development of your application that is to put it online 
+     * you change this value to "production" or "testing", in this case there will be deactivation of error messages, 
+     * the loading of the system, will be fast.
+     */
+    define('ENVIRONMENT', 'testing');
 	
 	
-	//Fix to allow test as if application is running in CLI mode $_SESSION global variable is not available
-	$_SESSION = array();
+    //Fix to allow test as if application is running in CLI mode $_SESSION global variable is not available
+    $_SESSION = array();
 	
-	//check for composer autoload file if exists include it
-	if (file_exists(VENDOR_PATH . 'autoload.php')){
-		require_once VENDOR_PATH . 'autoload.php';
+    //check for composer autoload file if exists include it
+    if (file_exists(VENDOR_PATH . 'autoload.php')){
+        require_once VENDOR_PATH . 'autoload.php';
 		
-		//define the class alias for vstream
-		class_alias('org\bovigo\vfs\vfsStream', 'vfsStream');
-		class_alias('org\bovigo\vfs\vfsStreamDirectory', 'vfsStreamDirectory');
-		class_alias('org\bovigo\vfs\vfsStreamWrapper', 'vfsStreamWrapper');
+        //define the class alias for vstream
+        class_alias('org\bovigo\vfs\vfsStream', 'vfsStream');
+        class_alias('org\bovigo\vfs\vfsStreamDirectory', 'vfsStreamDirectory');
+        class_alias('org\bovigo\vfs\vfsStreamWrapper', 'vfsStreamWrapper');
 		
-	}
+    }
 
-	//require autoloader for test
-	require_once  'include/autoloader.php';
+    //require autoloader for test
+    require_once  'include/autoloader.php';
 	
 	
 
-	//grap from core/common.php functions and mock some functions for tests
-	require_once  'include/common.php';
+    //grap from core/common.php functions and mock some functions for tests
+    require_once  'include/common.php';
 	
-	//Some utilities functions, classes, etc.
-	require_once  'include/testsUtil.php';
+    //Some utilities functions, classes, etc.
+    require_once  'include/testsUtil.php';
 	
-	/**
-	* Setting of the PHP error message handling function
-	*/
-	set_error_handler('php_error_handler');
+    /**
+     * Setting of the PHP error message handling function
+     */
+    set_error_handler('php_error_handler');
 
-	/**
-	* Setting of the PHP error exception handling function
-	*/
-	set_exception_handler('php_exception_handler');
+    /**
+     * Setting of the PHP error exception handling function
+     */
+    set_exception_handler('php_exception_handler');
 
-	/**
-	 * Setting of the PHP shutdown handling function
-	 */
-	register_shutdown_function('php_shudown_handler');
+    /**
+     * Setting of the PHP shutdown handling function
+     */
+    register_shutdown_function('php_shudown_handler');
 	
-	/**
-	* Register the tests autoload
-	*/
-	spl_autoload_register('tests_autoload');
+    /**
+     * Register the tests autoload
+     */
+    spl_autoload_register('tests_autoload');
 	
 	
-	
\ No newline at end of file
+    
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -59,7 +59,7 @@ 
 	/**
 	* Custom application path for tests 
 	*/
-	define('APPS_PATH', TESTS_PATH .'hmvc' . DS);
+	define('APPS_PATH', TESTS_PATH . 'hmvc' . DS);
 
 	/**
 	* The path to the controller directory of your application.
@@ -202,7 +202,7 @@ 
 	* It contains your modules used files (config, controllers, libraries, etc.) that is to say which contains your files of the modules, 
 	* in HMVC architecture (hierichical, controllers, models, views).
 	*/
-	define('MODULE_PATH', dirname(realpath(__FILE__)) . DS .'hmvc' . DS . 'modules' . DS);
+	define('MODULE_PATH', dirname(realpath(__FILE__)) . DS . 'hmvc' . DS . 'modules' . DS);
 
 	/**
 	* The path to the directory of sources external to your application.
@@ -242,7 +242,7 @@ 
 	$_SESSION = array();
 	
 	//check for composer autoload file if exists include it
-	if (file_exists(VENDOR_PATH . 'autoload.php')){
+	if (file_exists(VENDOR_PATH . 'autoload.php')) {
 		require_once VENDOR_PATH . 'autoload.php';
 		
 		//define the class alias for vstream

core/classes/cache/FileCache.php

Indentation +289 added lines, -289 removed lines

@@ -1,312 +1,312 @@
 <?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 implements CacheInterface{
+    class FileCache 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;
 		
-		/**
-		 * 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 file system is not available. Check the cache directory if is exists or is writable.');
-			}
-			/**
-	         * instance of the Log class
-	         */
-	        if(is_object($logger)){
-	          $this->logger = $logger;
-	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
-	            $this->logger->setLogger('Library::FileCache');
-	        }
+        public function __construct(Log $logger = null){
+            if(! $this->isSupported()){
+                show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
+            }
+            /**
+             * instance of the Log class
+             */
+            if(is_object($logger)){
+                $this->logger = $logger;
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::FileCache');
+            }
 			
-			//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);
+        }
 
-		/**
-	     * 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 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;
+        }
 		
-		/**
-		* 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 +59 added lines, -59 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class FileCache implements CacheInterface{
+	class FileCache implements CacheInterface {
 		
 		/**
 		 * Whether to enable compression of the cache data file.
@@ -39,23 +39,23 @@ 
 		private $logger;
 		
 		
-		public function __construct(Log $logger = null){
-			if(! $this->isSupported()){
+		public function __construct(Log $logger = null) {
+			if (!$this->isSupported()) {
 				show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.');
 			}
 			/**
 	         * instance of the Log class
 	         */
-	        if(is_object($logger)){
+	        if (is_object($logger)) {
 	          $this->logger = $logger;
 	        }
-	        else{
-	            $this->logger =& class_loader('Log', 'classes');
+	        else {
+	            $this->logger = & class_loader('Log', 'classes');
 	            $this->logger->setLogger('Library::FileCache');
 	        }
 			
 			//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;
 			}
@@ -66,17 +66,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 
@@ -84,20 +84,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'];
 		     }
 		}
@@ -110,13 +110,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
@@ -129,13 +129,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;
@@ -149,16 +149,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;
 			}
@@ -172,23 +172,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'],
@@ -205,26 +205,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');
 		      		}
 				}
@@ -234,13 +234,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 . ']');
@@ -252,7 +252,7 @@ 
 	    /**
 	     * @return boolean
 	     */
-	    public function isCompressCacheData(){
+	    public function isCompressCacheData() {
 	        return $this->compressCacheData;
 	    }
 
@@ -261,14 +261,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;
@@ -279,7 +279,7 @@ 
 		 *
 		 * @return bool
 		 */
-		public function isSupported(){
+		public function isSupported() {
 			return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH);
 		}
 
@@ -287,7 +287,7 @@ 
 	     * Return the Log instance
 	     * @return object
 	     */
-	    public function getLogger(){
+	    public function getLogger() {
 	      return $this->logger;
 	    }
 
@@ -295,7 +295,7 @@ 
 	     * Set the log instance
 	     * @param Log $logger the log object
 	     */
-	    public function setLogger(Log $logger){
+	    public function setLogger(Log $logger) {
 	      $this->logger = $logger;
 	      return $this;
 	    }
@@ -306,7 +306,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 +9 added lines, -18 removed lines

@@ -48,8 +48,7 @@ 
 	         */
 	        if(is_object($logger)){
 	          $this->logger = $logger;
-	        }
-	        else{
+	        } else{
 	            $this->logger =& class_loader('Log', 'classes');
 	            $this->logger->setLogger('Library::FileCache');
 	        }
@@ -95,8 +94,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'];
 		     }
@@ -133,8 +131,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);
@@ -156,8 +153,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;
@@ -210,8 +206,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 . ']');
@@ -219,12 +214,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');
 		      		}
 				}
@@ -239,8 +232,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 . ']');
@@ -267,8 +259,7 @@ 
 				
 				$this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE');
 				$this->compressCacheData = false;
-			}
-			else{
+			} else{
 				$this->compressCacheData = $status;
 			}
 			return $this;

core/classes/Router.php

Indentation +610 added lines, -610 removed lines

@@ -1,624 +1,624 @@
 <?php
-	defined('ROOT_PATH') or exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
-
-	class Router {
-		/**
-		* @var array $pattern: The list of URIs to validate against
-		*/
-		private $pattern = array();
-
-		/**
-		* @var array $callback: The list of callback to call
-		*/
-		private $callback = array();
-
-		/**
-		* @var string $uriTrim: The char to remove from the URIs
-		*/
-		protected $uriTrim = '/\^$';
-
-		/**
-		* @var string $uri: The route URI to use
-		*/
-		protected $uri = '';
-
-		/**
-		 * The module name of the current request
-		 * @var string
-		 */
-		protected $module = null;
+    defined('ROOT_PATH') or exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+
+    class Router {
+        /**
+         * @var array $pattern: The list of URIs to validate against
+         */
+        private $pattern = array();
+
+        /**
+         * @var array $callback: The list of callback to call
+         */
+        private $callback = array();
+
+        /**
+         * @var string $uriTrim: The char to remove from the URIs
+         */
+        protected $uriTrim = '/\^$';
+
+        /**
+         * @var string $uri: The route URI to use
+         */
+        protected $uri = '';
+
+        /**
+         * The module name of the current request
+         * @var string
+         */
+        protected $module = null;
 		
-		/**
-		 * The controller name of the current request
-		 * @var string
-		 */
-		protected $controller = null;
-
-		/**
-		 * The controller path
-		 * @var string
-		 */
-		protected $controllerPath = null;
-
-		/**
-		 * The method name. The default value is "index"
-		 * @var string
-		 */
-		protected $method = 'index';
-
-		/**
-		 * List of argument to pass to the method
-		 * @var array
-		 */
-		protected $args = array();
-
-		/**
-		 * List of routes configurations
-		 * @var array
-		 */
-		protected $routes = array();
-
-		/**
-		 * The segments array for the current request
-		 * @var array
-		 */
-		protected $segments = array();
-
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
-
-		/**
-		 * Construct the new Router instance
-		 */
-		public function __construct(){
-			$this->setLoggerFromParamOrCreateNewInstance(null);
+        /**
+         * The controller name of the current request
+         * @var string
+         */
+        protected $controller = null;
+
+        /**
+         * The controller path
+         * @var string
+         */
+        protected $controllerPath = null;
+
+        /**
+         * The method name. The default value is "index"
+         * @var string
+         */
+        protected $method = 'index';
+
+        /**
+         * List of argument to pass to the method
+         * @var array
+         */
+        protected $args = array();
+
+        /**
+         * List of routes configurations
+         * @var array
+         */
+        protected $routes = array();
+
+        /**
+         * The segments array for the current request
+         * @var array
+         */
+        protected $segments = array();
+
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
+
+        /**
+         * Construct the new Router instance
+         */
+        public function __construct(){
+            $this->setLoggerFromParamOrCreateNewInstance(null);
 			
-			//loading routes for module
-			$moduleRouteList = array();
-			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
-				$moduleRouteList = $modulesRoutes;
-				unset($modulesRoutes);
-			}
-			$this->setRouteConfiguration($moduleRouteList);
-			$this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
-
-			//Set route informations
-			$this->setRouteConfigurationInfos();
-		}
-
-		/**
-		 * Get the route patterns
-		 * @return array
-		 */
-		public function getPattern(){
-			return $this->pattern;
-		}
-
-		/**
-		 * Get the route callbacks
-		 * @return array
-		 */
-		public function getCallback(){
-			return $this->callback;
-		}
-
-	    /**
-		 * Get the module name
-		 * @return string
-		 */
-		public function getModule(){
-			return $this->module;
-		}
+            //loading routes for module
+            $moduleRouteList = array();
+            $modulesRoutes = Module::getModulesRoutes();
+            if($modulesRoutes && is_array($modulesRoutes)){
+                $moduleRouteList = $modulesRoutes;
+                unset($modulesRoutes);
+            }
+            $this->setRouteConfiguration($moduleRouteList);
+            $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes));
+
+            //Set route informations
+            $this->setRouteConfigurationInfos();
+        }
+
+        /**
+         * Get the route patterns
+         * @return array
+         */
+        public function getPattern(){
+            return $this->pattern;
+        }
+
+        /**
+         * Get the route callbacks
+         * @return array
+         */
+        public function getCallback(){
+            return $this->callback;
+        }
+
+        /**
+         * Get the module name
+         * @return string
+         */
+        public function getModule(){
+            return $this->module;
+        }
 		
-		/**
-		 * Get the controller name
-		 * @return string
-		 */
-		public function getController(){
-			return $this->controller;
-		}
-
-		/**
-		 * Get the controller file path
-		 * @return string
-		 */
-		public function getControllerPath(){
-			return $this->controllerPath;
-		}
-
-		/**
-		 * Get the controller method
-		 * @return string
-		 */
-		public function getMethod(){
-			return $this->method;
-		}
-
-		/**
-		 * Get the request arguments
-		 * @return array
-		 */
-		public function getArgs(){
-			return $this->args;
-		}
-
-		/**
-		 * Get the URL segments array
-		 * @return array
-		 */
-		public function getSegments(){
-			return $this->segments;
-		}
-
-		/**
-	     * Return the Log instance
-	     * @return Log
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
-
-	    /**
-	     * Set the log instance
-	     * @param Log $logger the log object
-		 * @return object
-	     */
-	    public function setLogger($logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
-
-	    /**
-		 * Get the route URI
-		 * @return string
-		 */
-		public function getRouteUri(){
-			return $this->uri;
-		}
-
-		/**
-		* Add the URI and callback to the list of URIs to validate
-		*
-		* @param string $uri the request URI
-		* @param string $callback the callback function
-		*
-		* @return object the current instance
-		*/
-		public function add($uri, $callback) {
-			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
-				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
-			}
-			$this->pattern[] = $uri;
-			$this->callback[] = $callback;
-			return $this;
-		}
-
-		/**
-		* Remove the route configuration
-		*
-		* @param string $uri the URI
-		*
-		* @return object the current instance
-		*/
-		public function removeRoute($uri) {
-			$index  = array_search($uri, $this->pattern, true);
-			if($index !== false){
-				$this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
-				unset($this->pattern[$index]);
-				unset($this->callback[$index]);
-			}
-			return $this;
-		}
-
-
-		/**
-		* Remove all the routes from the configuration
-		*
-		* @return object the current instance
-		*/
-		public function removeAllRoute() {
-			$this->logger->info('Remove all routes from the configuration');
-			$this->pattern  = array();
-			$this->callback = array();
-			$this->routes = array();
-			return $this;
-		}
-
-
-		/**
-	     * Set the route URI to use later
-	     * @param string $uri the route URI, if is empty will determine automatically
-	     * @return object
-	     */
-	    public function setRouteUri($uri = ''){
-	    	$routeUri = '';
-	    	if(! empty($uri)){
-	    		$routeUri = $uri;
-	    	}
-	    	//if the application is running in CLI mode use the first argument
-			else if(IS_CLI && isset($_SERVER['argv'][1])){
-				$routeUri = $_SERVER['argv'][1];
-			}
-			else if(isset($_SERVER['REQUEST_URI'])){
-				$routeUri = $_SERVER['REQUEST_URI'];
-			}
-			$this->logger->debug('Check if URL suffix is enabled in the configuration');
-			//remove url suffix from the request URI
-			$suffix = get_config('url_suffix');
-			if ($suffix) {
-				$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
-				$routeUri = str_ireplace($suffix, '', $routeUri);
-			} 
-			if (strpos($routeUri, '?') !== false){
-				$routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
-			}
-			$this->uri = trim($routeUri, $this->uriTrim);
-			return $this;
-	    }
-
-	     /**
-		 * Set the route segments informations
-		 * @param array $segements the route segments information
-		 * 
-		 * @return object
-		 */
-		public function setRouteSegments(array $segments = array()){
-			if(! empty($segments)){
-				$this->segments = $segments;
-			} else if (!empty($this->uri)) {
-				$this->segments = explode('/', $this->uri);
-			}
-			$segment = $this->segments;
-			$baseUrl = get_config('base_url');
-			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
-				$this->logger->info('The request URI contains the front controller');
-				array_shift($segment);
-				$this->segments = $segment;
-			}
-			return $this;
-		}
-
-		/**
-		 * Setting the route parameters like module, controller, method, argument
-		 * @return object the current instance
-		 */
-		public function determineRouteParamsInformation() {
-			$this->logger->debug('Routing process start ...');
+        /**
+         * Get the controller name
+         * @return string
+         */
+        public function getController(){
+            return $this->controller;
+        }
+
+        /**
+         * Get the controller file path
+         * @return string
+         */
+        public function getControllerPath(){
+            return $this->controllerPath;
+        }
+
+        /**
+         * Get the controller method
+         * @return string
+         */
+        public function getMethod(){
+            return $this->method;
+        }
+
+        /**
+         * Get the request arguments
+         * @return array
+         */
+        public function getArgs(){
+            return $this->args;
+        }
+
+        /**
+         * Get the URL segments array
+         * @return array
+         */
+        public function getSegments(){
+            return $this->segments;
+        }
+
+        /**
+         * Return the Log instance
+         * @return Log
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
+
+        /**
+         * Set the log instance
+         * @param Log $logger the log object
+         * @return object
+         */
+        public function setLogger($logger){
+            $this->logger = $logger;
+            return $this;
+        }
+
+        /**
+         * Get the route URI
+         * @return string
+         */
+        public function getRouteUri(){
+            return $this->uri;
+        }
+
+        /**
+         * Add the URI and callback to the list of URIs to validate
+         *
+         * @param string $uri the request URI
+         * @param string $callback the callback function
+         *
+         * @return object the current instance
+         */
+        public function add($uri, $callback) {
+            $uri = trim($uri, $this->uriTrim);
+            if(in_array($uri, $this->pattern)){
+                $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
+            }
+            $this->pattern[] = $uri;
+            $this->callback[] = $callback;
+            return $this;
+        }
+
+        /**
+         * Remove the route configuration
+         *
+         * @param string $uri the URI
+         *
+         * @return object the current instance
+         */
+        public function removeRoute($uri) {
+            $index  = array_search($uri, $this->pattern, true);
+            if($index !== false){
+                $this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
+                unset($this->pattern[$index]);
+                unset($this->callback[$index]);
+            }
+            return $this;
+        }
+
+
+        /**
+         * Remove all the routes from the configuration
+         *
+         * @return object the current instance
+         */
+        public function removeAllRoute() {
+            $this->logger->info('Remove all routes from the configuration');
+            $this->pattern  = array();
+            $this->callback = array();
+            $this->routes = array();
+            return $this;
+        }
+
+
+        /**
+         * Set the route URI to use later
+         * @param string $uri the route URI, if is empty will determine automatically
+         * @return object
+         */
+        public function setRouteUri($uri = ''){
+            $routeUri = '';
+            if(! empty($uri)){
+                $routeUri = $uri;
+            }
+            //if the application is running in CLI mode use the first argument
+            else if(IS_CLI && isset($_SERVER['argv'][1])){
+                $routeUri = $_SERVER['argv'][1];
+            }
+            else if(isset($_SERVER['REQUEST_URI'])){
+                $routeUri = $_SERVER['REQUEST_URI'];
+            }
+            $this->logger->debug('Check if URL suffix is enabled in the configuration');
+            //remove url suffix from the request URI
+            $suffix = get_config('url_suffix');
+            if ($suffix) {
+                $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+                $routeUri = str_ireplace($suffix, '', $routeUri);
+            } 
+            if (strpos($routeUri, '?') !== false){
+                $routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
+            }
+            $this->uri = trim($routeUri, $this->uriTrim);
+            return $this;
+        }
+
+            /**
+             * Set the route segments informations
+             * @param array $segements the route segments information
+             * 
+             * @return object
+             */
+        public function setRouteSegments(array $segments = array()){
+            if(! empty($segments)){
+                $this->segments = $segments;
+            } else if (!empty($this->uri)) {
+                $this->segments = explode('/', $this->uri);
+            }
+            $segment = $this->segments;
+            $baseUrl = get_config('base_url');
+            //check if the app is not in DOCUMENT_ROOT
+            if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            $this->logger->debug('Check if the request URI contains the front controller');
+            if(isset($segment[0]) && $segment[0] == SELF){
+                $this->logger->info('The request URI contains the front controller');
+                array_shift($segment);
+                $this->segments = $segment;
+            }
+            return $this;
+        }
+
+        /**
+         * Setting the route parameters like module, controller, method, argument
+         * @return object the current instance
+         */
+        public function determineRouteParamsInformation() {
+            $this->logger->debug('Routing process start ...');
 			
-			//determine route parameters using the config
-			$this->determineRouteParamsFromConfig();
+            //determine route parameters using the config
+            $this->determineRouteParamsFromConfig();
 			
-			//if can not determine the module/controller/method via the defined routes configuration we will use
-			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->controller){
-				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
-				//determine route parameters using the REQUEST_URI param
-				$this->determineRouteParamsFromRequestUri();
-			}
-			//Set the controller file path if not yet set
-			$this->setControllerFilePath();
-			$this->logger->debug('Routing process end.');
-
-			return $this;
-		}
+            //if can not determine the module/controller/method via the defined routes configuration we will use
+            //the URL like http://domain.com/module/controller/method/arg1/arg2
+            if(! $this->controller){
+                $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
+                //determine route parameters using the REQUEST_URI param
+                $this->determineRouteParamsFromRequestUri();
+            }
+            //Set the controller file path if not yet set
+            $this->setControllerFilePath();
+            $this->logger->debug('Routing process end.');
+
+            return $this;
+        }
 	
-		 /**
-		 * Routing the request to the correspondant module/controller/method if exists
-		 * otherwise send 404 error.
-		 */
-	    public function processRequest(){
-	    	//Setting the route URI
-			$this->setRouteUri();
-
-			//setting route segments
-			$this->setRouteSegments();
-
-			$this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
-
-	    	//determine the route parameters information
-	    	$this->determineRouteParamsInformation();
-
-	    	$e404 = false;
-	    	$classFilePath = $this->controllerPath;
-	    	$controller = ucfirst($this->controller);
-	    	$this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
-	    	$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
+            /**
+             * Routing the request to the correspondant module/controller/method if exists
+             * otherwise send 404 error.
+             */
+        public function processRequest(){
+            //Setting the route URI
+            $this->setRouteUri();
+
+            //setting route segments
+            $this->setRouteSegments();
+
+            $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
+
+            //determine the route parameters information
+            $this->determineRouteParamsInformation();
+
+            $e404 = false;
+            $classFilePath = $this->controllerPath;
+            $controller = ucfirst($this->controller);
+            $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
+            $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 	    	
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(! class_exists($controller, false)){
-					$e404 = true;
-					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
-					$controllerInstance = new $controller();
-					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
-						$e404 = true;
-						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
-						$this->logger->info('Routing data is set correctly now GO!');
-						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
-						//render the final page to user
-						$this->logger->info('Render the final output to the browser');
-						get_instance()->response->renderFinalPage();
-					}
-				}
-			}
-			else{
-				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
-				$e404 = true;
-			}
-			if($e404){
-				if(IS_CLI){
-					set_http_status_header(404);
-					echo 'Error 404: page not found.';
-				} else {
-					$response =& class_loader('Response', 'classes');
-					$response->send404();
-				}
-			}
-	    }
-
-
-	    /**
-	    * Setting the route configuration using the configuration file and additional configuration from param
-	    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
-	    * @param boolean $useConfigFile whether to use route configuration file
-		* @return object
-	    */
-	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
-	        $route = array();
-	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
-	            require_once CONFIG_PATH . 'routes.php';
-	        }
-	        $route = array_merge($route, $overwriteConfig);
-	        $this->routes = $route;
-	        //if route is empty remove all configuration
-	        if(empty($route)){
-	        	$this->removeAllRoute();
-	        }
-			return $this;
-	    }
-
-	     /**
-		 * Get the route configuration
-		 * @return array
-		 */
-		public function getRouteConfiguration(){
-			return $this->routes;
-		}
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(! class_exists($controller, false)){
+                    $e404 = true;
+                    $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+                }
+                else{
+                    $controllerInstance = new $controller();
+                    $controllerMethod = $this->getMethod();
+                    if(! method_exists($controllerInstance, $controllerMethod)){
+                        $e404 = true;
+                        $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
+                    }
+                    else{
+                        $this->logger->info('Routing data is set correctly now GO!');
+                        call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
+                        //render the final page to user
+                        $this->logger->info('Render the final output to the browser');
+                        get_instance()->response->renderFinalPage();
+                    }
+                }
+            }
+            else{
+                $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
+                $e404 = true;
+            }
+            if($e404){
+                if(IS_CLI){
+                    set_http_status_header(404);
+                    echo 'Error 404: page not found.';
+                } else {
+                    $response =& class_loader('Response', 'classes');
+                    $response->send404();
+                }
+            }
+        }
+
+
+        /**
+         * Setting the route configuration using the configuration file and additional configuration from param
+         * @param array $overwriteConfig the additional configuration to overwrite with the existing one
+         * @param boolean $useConfigFile whether to use route configuration file
+         * @return object
+         */
+        public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+            $route = array();
+            if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+                require_once CONFIG_PATH . 'routes.php';
+            }
+            $route = array_merge($route, $overwriteConfig);
+            $this->routes = $route;
+            //if route is empty remove all configuration
+            if(empty($route)){
+                $this->removeAllRoute();
+            }
+            return $this;
+        }
+
+            /**
+             * Get the route configuration
+             * @return array
+             */
+        public function getRouteConfiguration(){
+            return $this->routes;
+        }
 
 	    
-	    /**
-	     * Set the controller file path if is not set
-	     * @param string $path the file path if is null will using the route 
-	     * information
-	     *
-	     * @return object the current instance
-	     */
-	    public function setControllerFilePath($path = null){
-	    	if($path !== null){
-	    		$this->controllerPath = $path;
-	    		return $this;
-	    	}
-	    	//did we set the controller, so set the controller path
-			if($this->controller && ! $this->controllerPath){
-				$this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
-				$controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
-				//if the controller is in module
-				if($this->module){
-					$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-					if($path !== false){
-						$controllerPath = $path;
-					}
-				}
-				$this->controllerPath = $controllerPath;
-			}
-			return $this;
-	    }
-
-	    /**
-	     * Determine the route parameters from route configuration
-	     * @return void
-	     */
-	    protected function determineRouteParamsFromConfig(){
-	    	$uri = implode('/', $this->segments);
-	    	/*
+        /**
+         * Set the controller file path if is not set
+         * @param string $path the file path if is null will using the route 
+         * information
+         *
+         * @return object the current instance
+         */
+        public function setControllerFilePath($path = null){
+            if($path !== null){
+                $this->controllerPath = $path;
+                return $this;
+            }
+            //did we set the controller, so set the controller path
+            if($this->controller && ! $this->controllerPath){
+                $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
+                $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
+                //if the controller is in module
+                if($this->module){
+                    $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
+                    if($path !== false){
+                        $controllerPath = $path;
+                    }
+                }
+                $this->controllerPath = $controllerPath;
+            }
+            return $this;
+        }
+
+        /**
+         * Determine the route parameters from route configuration
+         * @return void
+         */
+        protected function determineRouteParamsFromConfig(){
+            $uri = implode('/', $this->segments);
+            /*
 	   		* Generics routes patterns
 	    	*/
-			$pattern = array(':num', ':alpha', ':alnum', ':any');
-			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
-
-			$this->logger->debug(
-									'Begin to loop in the predefined routes configuration ' 
-									. 'to check if the current request match'
-									);
-
-			// Cycle through the URIs stored in the array
-			foreach ($this->pattern as $index => $uriList) {
-				$uriList = str_ireplace($pattern, $replace, $uriList);
-				// Check for an existant matching URI
-				if (preg_match("#^$uriList$#", $uri, $args)) {
-					$this->logger->info(
-										'Route found for request URI [' . $uri . '] using the predefined configuration '
-										. ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']'
-									);
-					array_shift($args);
-					//check if this contains an module
-					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
-						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
-						$this->module = $moduleControllerMethod[0];
-						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
-						$this->logger->info('The current request does not use the module');
-						$moduleControllerMethod = explode('@', $this->callback[$index]);
-					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
-							$this->controller = $moduleControllerMethod[0];	
-						}
-						if(isset($moduleControllerMethod[1])){
-							$this->method = $moduleControllerMethod[1];
-						}
-						$this->args = $args;
-					}
-					// stop here
-					break;
-				}
-			}
-
-			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->controller && $this->module){
-				$this->logger->info(
-									'After loop in predefined routes configuration, 
+            $pattern = array(':num', ':alpha', ':alnum', ':any');
+            $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
+
+            $this->logger->debug(
+                                    'Begin to loop in the predefined routes configuration ' 
+                                    . 'to check if the current request match'
+                                    );
+
+            // Cycle through the URIs stored in the array
+            foreach ($this->pattern as $index => $uriList) {
+                $uriList = str_ireplace($pattern, $replace, $uriList);
+                // Check for an existant matching URI
+                if (preg_match("#^$uriList$#", $uri, $args)) {
+                    $this->logger->info(
+                                        'Route found for request URI [' . $uri . '] using the predefined configuration '
+                                        . ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']'
+                                    );
+                    array_shift($args);
+                    //check if this contains an module
+                    $moduleControllerMethod = explode('#', $this->callback[$index]);
+                    if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+                        $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
+                        $this->module = $moduleControllerMethod[0];
+                        $moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
+                    }
+                    else{
+                        $this->logger->info('The current request does not use the module');
+                        $moduleControllerMethod = explode('@', $this->callback[$index]);
+                    }
+                    if(is_array($moduleControllerMethod)){
+                        if(isset($moduleControllerMethod[0])){
+                            $this->controller = $moduleControllerMethod[0];	
+                        }
+                        if(isset($moduleControllerMethod[1])){
+                            $this->method = $moduleControllerMethod[1];
+                        }
+                        $this->args = $args;
+                    }
+                    // stop here
+                    break;
+                }
+            }
+
+            //first if the controller is not set and the module is set use the module name as the controller
+            if(! $this->controller && $this->module){
+                $this->logger->info(
+                                    'After loop in predefined routes configuration, 
 									the module name is set but the controller is not set, 
 									so we will use module as the controller'
-								);
-				$this->controller = $this->module;
-			}
-	    }
-
-	    /**
-	     * Determine the route parameters using the server variable "REQUEST_URI"
-	     * @return void
-	     */
-	    protected function determineRouteParamsFromRequestUri(){
-	    	$segment = $this->segments;
-	    	$nbSegment = count($segment);
-			//if segment is null so means no need to perform
-			if($nbSegment > 0){
-				//get the module list
-				$modules = Module::getModuleList();
-				//first check if no module
-				if(empty($modules)){
-					$this->logger->info('No module was loaded will skip the module checking');
-					//the application don't use module
-					//controller
-					if(isset($segment[0])){
-						$this->controller = $segment[0];
-						array_shift($segment);
-					}
-					//method
-					if(isset($segment[0])){
-						$this->method = $segment[0];
-						array_shift($segment);
-					}
-					//args
-					$this->args = $segment;
-				}
-				else{
-					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-					if(in_array($segment[0], $modules)){
-						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
-						$this->module = $segment[0];
-						array_shift($segment);
-						//check if the second arg is the controller from module
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							//check if the request use the same module name and controller
-							$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-							if(! $path){
-								$this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
-								$this->controller = $this->module;
-							}
-							else{
-								$this->controllerPath = $path;
-								array_shift($segment);
-							}
-						}
-						//check for method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//the remaining is for args
-						$this->args = $segment;
-					}
-					else{
-						$this->logger->info('The current request information is not found in the module list');
-						//controller
-						if(isset($segment[0])){
-							$this->controller = $segment[0];
-							array_shift($segment);
-						}
-						//method
-						if(isset($segment[0])){
-							$this->method = $segment[0];
-							array_shift($segment);
-						}
-						//args
-						$this->args = $segment;
-					}
-				}
-				if(! $this->controller && $this->module){
-					$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
-					$this->controller = $this->module;
-				}
-			}
-	    }
-
-	    /**
-	     * Set the route informations using the configuration
-	     *
-	     * @return object the current instance
-	     */
-	    protected function setRouteConfigurationInfos(){
-	    	//adding route
-			foreach($this->routes as $pattern => $callback){
-				$this->add($pattern, $callback);
-			}
-			return $this;
-		}
-
-		/**
-	     * Set the Log instance using argument or create new instance
-	     * @param object $logger the Log instance if not null
-	     */
-	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-	      if ($logger !== null){
-	        $this->logger = $logger;
-	      }
-	      else{
-	          $this->logger =& class_loader('Log', 'classes');
-	          $this->logger->setLogger('Library::Router');
-	      }
-	    }
-	}
+                                );
+                $this->controller = $this->module;
+            }
+        }
+
+        /**
+         * Determine the route parameters using the server variable "REQUEST_URI"
+         * @return void
+         */
+        protected function determineRouteParamsFromRequestUri(){
+            $segment = $this->segments;
+            $nbSegment = count($segment);
+            //if segment is null so means no need to perform
+            if($nbSegment > 0){
+                //get the module list
+                $modules = Module::getModuleList();
+                //first check if no module
+                if(empty($modules)){
+                    $this->logger->info('No module was loaded will skip the module checking');
+                    //the application don't use module
+                    //controller
+                    if(isset($segment[0])){
+                        $this->controller = $segment[0];
+                        array_shift($segment);
+                    }
+                    //method
+                    if(isset($segment[0])){
+                        $this->method = $segment[0];
+                        array_shift($segment);
+                    }
+                    //args
+                    $this->args = $segment;
+                }
+                else{
+                    $this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
+                    if(in_array($segment[0], $modules)){
+                        $this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
+                        $this->module = $segment[0];
+                        array_shift($segment);
+                        //check if the second arg is the controller from module
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            //check if the request use the same module name and controller
+                            $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
+                            if(! $path){
+                                $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
+                                $this->controller = $this->module;
+                            }
+                            else{
+                                $this->controllerPath = $path;
+                                array_shift($segment);
+                            }
+                        }
+                        //check for method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //the remaining is for args
+                        $this->args = $segment;
+                    }
+                    else{
+                        $this->logger->info('The current request information is not found in the module list');
+                        //controller
+                        if(isset($segment[0])){
+                            $this->controller = $segment[0];
+                            array_shift($segment);
+                        }
+                        //method
+                        if(isset($segment[0])){
+                            $this->method = $segment[0];
+                            array_shift($segment);
+                        }
+                        //args
+                        $this->args = $segment;
+                    }
+                }
+                if(! $this->controller && $this->module){
+                    $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
+                    $this->controller = $this->module;
+                }
+            }
+        }
+
+        /**
+         * Set the route informations using the configuration
+         *
+         * @return object the current instance
+         */
+        protected function setRouteConfigurationInfos(){
+            //adding route
+            foreach($this->routes as $pattern => $callback){
+                $this->add($pattern, $callback);
+            }
+            return $this;
+        }
+
+        /**
+         * Set the Log instance using argument or create new instance
+         * @param object $logger the Log instance if not null
+         */
+        protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
+            if ($logger !== null){
+            $this->logger = $logger;
+            }
+            else{
+                $this->logger =& class_loader('Log', 'classes');
+                $this->logger->setLogger('Library::Router');
+            }
+        }
+    }

Spacing +76 added lines, -76 removed lines

@@ -96,13 +96,13 @@ 
 		/**
 		 * Construct the new Router instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$this->setLoggerFromParamOrCreateNewInstance(null);
 			
 			//loading routes for module
 			$moduleRouteList = array();
 			$modulesRoutes = Module::getModulesRoutes();
-			if($modulesRoutes && is_array($modulesRoutes)){
+			if ($modulesRoutes && is_array($modulesRoutes)) {
 				$moduleRouteList = $modulesRoutes;
 				unset($modulesRoutes);
 			}
@@ -117,7 +117,7 @@ 
 		 * Get the route patterns
 		 * @return array
 		 */
-		public function getPattern(){
+		public function getPattern() {
 			return $this->pattern;
 		}
 
@@ -125,7 +125,7 @@ 
 		 * Get the route callbacks
 		 * @return array
 		 */
-		public function getCallback(){
+		public function getCallback() {
 			return $this->callback;
 		}
 
@@ -133,7 +133,7 @@ 
 		 * Get the module name
 		 * @return string
 		 */
-		public function getModule(){
+		public function getModule() {
 			return $this->module;
 		}
 		
@@ -141,7 +141,7 @@ 
 		 * Get the controller name
 		 * @return string
 		 */
-		public function getController(){
+		public function getController() {
 			return $this->controller;
 		}
 
@@ -149,7 +149,7 @@ 
 		 * Get the controller file path
 		 * @return string
 		 */
-		public function getControllerPath(){
+		public function getControllerPath() {
 			return $this->controllerPath;
 		}
 
@@ -157,7 +157,7 @@ 
 		 * Get the controller method
 		 * @return string
 		 */
-		public function getMethod(){
+		public function getMethod() {
 			return $this->method;
 		}
 
@@ -165,7 +165,7 @@ 
 		 * Get the request arguments
 		 * @return array
 		 */
-		public function getArgs(){
+		public function getArgs() {
 			return $this->args;
 		}
 
@@ -173,7 +173,7 @@ 
 		 * Get the URL segments array
 		 * @return array
 		 */
-		public function getSegments(){
+		public function getSegments() {
 			return $this->segments;
 		}
 
@@ -181,7 +181,7 @@ 
 	     * Return the Log instance
 	     * @return Log
 	     */
-	    public function getLogger(){
+	    public function getLogger() {
 	      return $this->logger;
 	    }
 
@@ -190,7 +190,7 @@ 
 	     * @param Log $logger the log object
 		 * @return object
 	     */
-	    public function setLogger($logger){
+	    public function setLogger($logger) {
 	      $this->logger = $logger;
 	      return $this;
 	    }
@@ -199,7 +199,7 @@ 
 		 * Get the route URI
 		 * @return string
 		 */
-		public function getRouteUri(){
+		public function getRouteUri() {
 			return $this->uri;
 		}
 
@@ -213,7 +213,7 @@ 
 		*/
 		public function add($uri, $callback) {
 			$uri = trim($uri, $this->uriTrim);
-			if(in_array($uri, $this->pattern)){
+			if (in_array($uri, $this->pattern)) {
 				$this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict');
 			}
 			$this->pattern[] = $uri;
@@ -229,8 +229,8 @@ 
 		* @return object the current instance
 		*/
 		public function removeRoute($uri) {
-			$index  = array_search($uri, $this->pattern, true);
-			if($index !== false){
+			$index = array_search($uri, $this->pattern, true);
+			if ($index !== false) {
 				$this->logger->info('Remove route for uri [' . $uri . '] from the configuration');
 				unset($this->pattern[$index]);
 				unset($this->callback[$index]);
@@ -258,26 +258,26 @@ 
 	     * @param string $uri the route URI, if is empty will determine automatically
 	     * @return object
 	     */
-	    public function setRouteUri($uri = ''){
+	    public function setRouteUri($uri = '') {
 	    	$routeUri = '';
-	    	if(! empty($uri)){
+	    	if (!empty($uri)) {
 	    		$routeUri = $uri;
 	    	}
 	    	//if the application is running in CLI mode use the first argument
-			else if(IS_CLI && isset($_SERVER['argv'][1])){
+			else if (IS_CLI && isset($_SERVER['argv'][1])) {
 				$routeUri = $_SERVER['argv'][1];
 			}
-			else if(isset($_SERVER['REQUEST_URI'])){
+			else if (isset($_SERVER['REQUEST_URI'])) {
 				$routeUri = $_SERVER['REQUEST_URI'];
 			}
 			$this->logger->debug('Check if URL suffix is enabled in the configuration');
 			//remove url suffix from the request URI
 			$suffix = get_config('url_suffix');
 			if ($suffix) {
-				$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' );
+				$this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']');
 				$routeUri = str_ireplace($suffix, '', $routeUri);
 			} 
-			if (strpos($routeUri, '?') !== false){
+			if (strpos($routeUri, '?') !== false) {
 				$routeUri = substr($routeUri, 0, strpos($routeUri, '?'));
 			}
 			$this->uri = trim($routeUri, $this->uriTrim);
@@ -290,8 +290,8 @@ 
 		 * 
 		 * @return object
 		 */
-		public function setRouteSegments(array $segments = array()){
-			if(! empty($segments)){
+		public function setRouteSegments(array $segments = array()) {
+			if (!empty($segments)) {
 				$this->segments = $segments;
 			} else if (!empty($this->uri)) {
 				$this->segments = explode('/', $this->uri);
@@ -299,12 +299,12 @@ 
 			$segment = $this->segments;
 			$baseUrl = get_config('base_url');
 			//check if the app is not in DOCUMENT_ROOT
-			if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){
+			if (isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false) {
 				array_shift($segment);
 				$this->segments = $segment;
 			}
 			$this->logger->debug('Check if the request URI contains the front controller');
-			if(isset($segment[0]) && $segment[0] == SELF){
+			if (isset($segment[0]) && $segment[0] == SELF) {
 				$this->logger->info('The request URI contains the front controller');
 				array_shift($segment);
 				$this->segments = $segment;
@@ -324,7 +324,7 @@ 
 			
 			//if can not determine the module/controller/method via the defined routes configuration we will use
 			//the URL like http://domain.com/module/controller/method/arg1/arg2
-			if(! $this->controller){
+			if (!$this->controller) {
 				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
 				//determine route parameters using the REQUEST_URI param
 				$this->determineRouteParamsFromRequestUri();
@@ -340,14 +340,14 @@ 
 		 * Routing the request to the correspondant module/controller/method if exists
 		 * otherwise send 404 error.
 		 */
-	    public function processRequest(){
+	    public function processRequest() {
 	    	//Setting the route URI
 			$this->setRouteUri();
 
 			//setting route segments
 			$this->setRouteSegments();
 
-			$this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' );
+			$this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']');
 
 	    	//determine the route parameters information
 	    	$this->determineRouteParamsInformation();
@@ -358,20 +358,20 @@ 
 	    	$this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']');
 	    	$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 	    	
-			if(file_exists($classFilePath)){
+			if (file_exists($classFilePath)) {
 				require_once $classFilePath;
-				if(! class_exists($controller, false)){
+				if (!class_exists($controller, false)) {
 					$e404 = true;
-					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+					$this->logger->warning('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']');
 				}
-				else{
+				else {
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
-					if(! method_exists($controllerInstance, $controllerMethod)){
+					if (!method_exists($controllerInstance, $controllerMethod)) {
 						$e404 = true;
 						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
 					}
-					else{
+					else {
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
 						//render the final page to user
@@ -380,16 +380,16 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
-			if($e404){
-				if(IS_CLI){
+			if ($e404) {
+				if (IS_CLI) {
 					set_http_status_header(404);
 					echo 'Error 404: page not found.';
 				} else {
-					$response =& class_loader('Response', 'classes');
+					$response = & class_loader('Response', 'classes');
 					$response->send404();
 				}
 			}
@@ -402,15 +402,15 @@ 
 	    * @param boolean $useConfigFile whether to use route configuration file
 		* @return object
 	    */
-	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+	    public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
 	        $route = array();
-	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){
+	        if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')) {
 	            require_once CONFIG_PATH . 'routes.php';
 	        }
 	        $route = array_merge($route, $overwriteConfig);
 	        $this->routes = $route;
 	        //if route is empty remove all configuration
-	        if(empty($route)){
+	        if (empty($route)) {
 	        	$this->removeAllRoute();
 	        }
 			return $this;
@@ -420,7 +420,7 @@ 
 		 * Get the route configuration
 		 * @return array
 		 */
-		public function getRouteConfiguration(){
+		public function getRouteConfiguration() {
 			return $this->routes;
 		}
 
@@ -432,19 +432,19 @@ 
 	     *
 	     * @return object the current instance
 	     */
-	    public function setControllerFilePath($path = null){
-	    	if($path !== null){
+	    public function setControllerFilePath($path = null) {
+	    	if ($path !== null) {
 	    		$this->controllerPath = $path;
 	    		return $this;
 	    	}
 	    	//did we set the controller, so set the controller path
-			if($this->controller && ! $this->controllerPath){
+			if ($this->controller && !$this->controllerPath) {
 				$this->logger->debug('Setting the file path for the controller [' . $this->controller . ']');
 				$controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php';
 				//if the controller is in module
-				if($this->module){
+				if ($this->module) {
 					$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-					if($path !== false){
+					if ($path !== false) {
 						$controllerPath = $path;
 					}
 				}
@@ -457,7 +457,7 @@ 
 	     * Determine the route parameters from route configuration
 	     * @return void
 	     */
-	    protected function determineRouteParamsFromConfig(){
+	    protected function determineRouteParamsFromConfig() {
 	    	$uri = implode('/', $this->segments);
 	    	/*
 	   		* Generics routes patterns
@@ -482,20 +482,20 @@ 
 					array_shift($args);
 					//check if this contains an module
 					$moduleControllerMethod = explode('#', $this->callback[$index]);
-					if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){
+					if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) {
 						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
 					}
-					else{
+					else {
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
-					if(is_array($moduleControllerMethod)){
-						if(isset($moduleControllerMethod[0])){
+					if (is_array($moduleControllerMethod)) {
+						if (isset($moduleControllerMethod[0])) {
 							$this->controller = $moduleControllerMethod[0];	
 						}
-						if(isset($moduleControllerMethod[1])){
+						if (isset($moduleControllerMethod[1])) {
 							$this->method = $moduleControllerMethod[1];
 						}
 						$this->args = $args;
@@ -506,7 +506,7 @@ 
 			}
 
 			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->controller && $this->module){
+			if (!$this->controller && $this->module) {
 				$this->logger->info(
 									'After loop in predefined routes configuration, 
 									the module name is set but the controller is not set, 
@@ -520,67 +520,67 @@ 
 	     * Determine the route parameters using the server variable "REQUEST_URI"
 	     * @return void
 	     */
-	    protected function determineRouteParamsFromRequestUri(){
+	    protected function determineRouteParamsFromRequestUri() {
 	    	$segment = $this->segments;
 	    	$nbSegment = count($segment);
 			//if segment is null so means no need to perform
-			if($nbSegment > 0){
+			if ($nbSegment > 0) {
 				//get the module list
 				$modules = Module::getModuleList();
 				//first check if no module
-				if(empty($modules)){
+				if (empty($modules)) {
 					$this->logger->info('No module was loaded will skip the module checking');
 					//the application don't use module
 					//controller
-					if(isset($segment[0])){
+					if (isset($segment[0])) {
 						$this->controller = $segment[0];
 						array_shift($segment);
 					}
 					//method
-					if(isset($segment[0])){
+					if (isset($segment[0])) {
 						$this->method = $segment[0];
 						array_shift($segment);
 					}
 					//args
 					$this->args = $segment;
 				}
-				else{
+				else {
 					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
-					if(in_array($segment[0], $modules)){
+					if (in_array($segment[0], $modules)) {
 						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
 						$this->module = $segment[0];
 						array_shift($segment);
 						//check if the second arg is the controller from module
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->controller = $segment[0];
 							//check if the request use the same module name and controller
 							$path = Module::findControllerFullPath(ucfirst($this->controller), $this->module);
-							if(! $path){
+							if (!$path) {
 								$this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
 								$this->controller = $this->module;
 							}
-							else{
+							else {
 								$this->controllerPath = $path;
 								array_shift($segment);
 							}
 						}
 						//check for method
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->method = $segment[0];
 							array_shift($segment);
 						}
 						//the remaining is for args
 						$this->args = $segment;
 					}
-					else{
+					else {
 						$this->logger->info('The current request information is not found in the module list');
 						//controller
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->controller = $segment[0];
 							array_shift($segment);
 						}
 						//method
-						if(isset($segment[0])){
+						if (isset($segment[0])) {
 							$this->method = $segment[0];
 							array_shift($segment);
 						}
@@ -588,7 +588,7 @@ 
 						$this->args = $segment;
 					}
 				}
-				if(! $this->controller && $this->module){
+				if (!$this->controller && $this->module) {
 					$this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller');
 					$this->controller = $this->module;
 				}
@@ -600,9 +600,9 @@ 
 	     *
 	     * @return object the current instance
 	     */
-	    protected function setRouteConfigurationInfos(){
+	    protected function setRouteConfigurationInfos() {
 	    	//adding route
-			foreach($this->routes as $pattern => $callback){
+			foreach ($this->routes as $pattern => $callback) {
 				$this->add($pattern, $callback);
 			}
 			return $this;
@@ -612,12 +612,12 @@ 
 	     * Set the Log instance using argument or create new instance
 	     * @param object $logger the Log instance if not null
 	     */
-	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-	      if ($logger !== null){
+	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) {
+	      if ($logger !== null) {
 	        $this->logger = $logger;
 	      }
-	      else{
-	          $this->logger =& class_loader('Log', 'classes');
+	      else {
+	          $this->logger = & class_loader('Log', 'classes');
 	          $this->logger->setLogger('Library::Router');
 	      }
 	    }

Braces +9 added lines, -18 removed lines

@@ -266,8 +266,7 @@ 
 	    	//if the application is running in CLI mode use the first argument
 			else if(IS_CLI && isset($_SERVER['argv'][1])){
 				$routeUri = $_SERVER['argv'][1];
-			}
-			else if(isset($_SERVER['REQUEST_URI'])){
+			} else if(isset($_SERVER['REQUEST_URI'])){
 				$routeUri = $_SERVER['REQUEST_URI'];
 			}
 			$this->logger->debug('Check if URL suffix is enabled in the configuration');
@@ -363,15 +362,13 @@ 
 				if(! class_exists($controller, false)){
 					$e404 = true;
 					$this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
-				}
-				else{
+				} else{
 					$controllerInstance = new $controller();
 					$controllerMethod = $this->getMethod();
 					if(! method_exists($controllerInstance, $controllerMethod)){
 						$e404 = true;
 						$this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']');
-					}
-					else{
+					} else{
 						$this->logger->info('Routing data is set correctly now GO!');
 						call_user_func_array(array($controllerInstance, $controllerMethod), $this->args);
 						//render the final page to user
@@ -379,8 +376,7 @@ 
 						get_instance()->response->renderFinalPage();
 					}
 				}
-			}
-			else{
+			} else{
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
@@ -486,8 +482,7 @@ 
 						$this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']');
 						$this->module = $moduleControllerMethod[0];
 						$moduleControllerMethod = explode('@', $moduleControllerMethod[1]);
-					}
-					else{
+					} else{
 						$this->logger->info('The current request does not use the module');
 						$moduleControllerMethod = explode('@', $this->callback[$index]);
 					}
@@ -543,8 +538,7 @@ 
 					}
 					//args
 					$this->args = $segment;
-				}
-				else{
+				} else{
 					$this->logger->info('The application contains a loaded module will check if the current request is found in the module list');
 					if(in_array($segment[0], $modules)){
 						$this->logger->info('Found, the current request use the module [' . $segment[0] . ']');
@@ -558,8 +552,7 @@ 
 							if(! $path){
 								$this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller');
 								$this->controller = $this->module;
-							}
-							else{
+							} else{
 								$this->controllerPath = $path;
 								array_shift($segment);
 							}
@@ -571,8 +564,7 @@ 
 						}
 						//the remaining is for args
 						$this->args = $segment;
-					}
-					else{
+					} else{
 						$this->logger->info('The current request information is not found in the module list');
 						//controller
 						if(isset($segment[0])){
@@ -615,8 +607,7 @@ 
 	    protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
 	      if ($logger !== null){
 	        $this->logger = $logger;
-	      }
-	      else{
+	      } else{
 	          $this->logger =& class_loader('Log', 'classes');
 	          $this->logger->setLogger('Library::Router');
 	      }

core/classes/Security.php

Indentation +147 added lines, -147 removed lines

@@ -1,157 +1,157 @@
 <?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 Security{
+    class Security{
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * Get the logger singleton instance
-		 * @return Log the logger instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Security');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * Get the logger singleton instance
+         * @return Log the logger instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Security');
+            }
+            return self::$logger[0];
+        }
 
 
-		/**
-		 * This method is used to generate the CSRF token
-		 * @return string the generated CSRF token
-		 */
-		public static function generateCSRF(){
-			$logger = self::getLogger();
-			$logger->debug('Generation of CSRF ...');
+        /**
+         * This method is used to generate the CSRF token
+         * @return string the generated CSRF token
+         */
+        public static function generateCSRF(){
+            $logger = self::getLogger();
+            $logger->debug('Generation of CSRF ...');
 			
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
-				$logger->info('The CSRF token not yet expire just return it');
-				return Session::get($key);
-			}
-			else{
-				$newTime = $currentTime + $expire;
-				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
-				Session::set($keyExpire, $newTime);
-				Session::set($key, $token);
-				return Session::get($key);
-			}
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+                $logger->info('The CSRF token not yet expire just return it');
+                return Session::get($key);
+            }
+            else{
+                $newTime = $currentTime + $expire;
+                $token = sha1(uniqid()) . sha1(uniqid());
+                $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+                Session::set($keyExpire, $newTime);
+                Session::set($key, $token);
+                return Session::get($key);
+            }
+        }
 
-		/**
-		 * This method is used to check the CSRF if is valid, not yet expire, etc.
-		 * @return boolean true if valid, false if not valid
-		 */
-		public static function validateCSRF(){
-			$logger = self::getLogger();
-			$logger->debug('Validation of CSRF ...');
+        /**
+         * This method is used to check the CSRF if is valid, not yet expire, etc.
+         * @return boolean true if valid, false if not valid
+         */
+        public static function validateCSRF(){
+            $logger = self::getLogger();
+            $logger->debug('Validation of CSRF ...');
 				
-			$key = get_config('csrf_key', 'csrf_key');
-			$expire = get_config('csrf_expire', 60);
-			$keyExpire = 'csrf_expire';
-			$currentTime = time();
-			$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']');
-			if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){
-				$logger->warning('The CSRF session data is not valide');
-				return false;
-			}
-			//perform form data
-			//need use request->query() for best retrieve
-			//super instance
-			$obj = & get_instance();
-			$token = $obj->request->query($key);
-			if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){
-				$logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job');
-				return false;
-			}
-			$logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue');
-			//remove the token from session
-			Session::clear($key);
-			Session::clear($keyExpire);
-			return true;
-		}
+            $key = get_config('csrf_key', 'csrf_key');
+            $expire = get_config('csrf_expire', 60);
+            $keyExpire = 'csrf_expire';
+            $currentTime = time();
+            $logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']');
+            if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){
+                $logger->warning('The CSRF session data is not valide');
+                return false;
+            }
+            //perform form data
+            //need use request->query() for best retrieve
+            //super instance
+            $obj = & get_instance();
+            $token = $obj->request->query($key);
+            if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){
+                $logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job');
+                return false;
+            }
+            $logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue');
+            //remove the token from session
+            Session::clear($key);
+            Session::clear($keyExpire);
+            return true;
+        }
 		
-		/**
-		 * This method is used to check the whitelist IP address access
-		 */
-		 public static function checkWhiteListIpAccess(){
-			$logger = self::getLogger();
-			$logger->debug('Validation of the IP address access ...');
-			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
-			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
-				$logger->info('Whitelist IP access is enabled in the configuration');
-				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
-					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
-					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
-					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
-						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
-						//wildcard to access all ip address
-						return;
-					}
-					else{
-						// go through all whitelisted ips
-						foreach ($list as $ipaddr) {
-							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
-							$wildcardPosition = strpos($ipaddr, '*');
-							if ($wildcardPosition === false) {
-								// no wild card in whitelisted ip --continue searching
-								continue;
-							}
-							// cut ip at the position where we got the wild card on the whitelisted ip
-							// and add the wold card to get the same pattern
-							if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
-								// f.e. we got
-								//  ip "127.0.0.1"
-								//  whitelisted ip "127.0.*"
-								// then we compared "127.0.*" with "127.0.*"
-								// return success
-								$logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
-								return;
-							}
-						}
-						$logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
-						show_error('Access to this application is not allowed');
-					}
-				}
-			}
-			else{
-				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
-			}
-		 }
-	}
+        /**
+         * This method is used to check the whitelist IP address access
+         */
+            public static function checkWhiteListIpAccess(){
+            $logger = self::getLogger();
+            $logger->debug('Validation of the IP address access ...');
+            $logger->debug('Check if whitelist IP access is enabled in the configuration ...');
+            $isEnable = get_config('white_list_ip_enable', false);
+            if($isEnable){
+                $logger->info('Whitelist IP access is enabled in the configuration');
+                $list = get_config('white_list_ip_addresses', array());
+                if(! empty($list)){
+                    //Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
+                    require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
+                    $ip = get_ip();
+                    if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+                        $logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
+                        //wildcard to access all ip address
+                        return;
+                    }
+                    else{
+                        // go through all whitelisted ips
+                        foreach ($list as $ipaddr) {
+                            // find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
+                            $wildcardPosition = strpos($ipaddr, '*');
+                            if ($wildcardPosition === false) {
+                                // no wild card in whitelisted ip --continue searching
+                                continue;
+                            }
+                            // cut ip at the position where we got the wild card on the whitelisted ip
+                            // and add the wold card to get the same pattern
+                            if (substr($ip, 0, $wildcardPosition) . '*' === $ipaddr) {
+                                // f.e. we got
+                                //  ip "127.0.0.1"
+                                //  whitelisted ip "127.0.*"
+                                // then we compared "127.0.*" with "127.0.*"
+                                // return success
+                                $logger->info('IP address ' . $ip . ' allowed using the wildcard like "x.x.x.*"');
+                                return;
+                            }
+                        }
+                        $logger->warning('IP address ' . $ip . ' is not allowed to access to this application');
+                        show_error('Access to this application is not allowed');
+                    }
+                }
+            }
+            else{
+                $logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
+            }
+            }
+    }

Spacing +20 added lines, -20 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Security{
+	class Security {
 		
 		/**
 		 * The logger instance
@@ -36,9 +36,9 @@ 
 		 * Get the logger singleton instance
 		 * @return Log the logger instance
 		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
+		private static function getLogger() {
+			if (self::$logger == null) {
+				self::$logger[0] = & class_loader('Log', 'classes');
 				self::$logger[0]->setLogger('Library::Security');
 			}
 			return self::$logger[0];
@@ -49,7 +49,7 @@ 
 		 * This method is used to generate the CSRF token
 		 * @return string the generated CSRF token
 		 */
-		public static function generateCSRF(){
+		public static function generateCSRF() {
 			$logger = self::getLogger();
 			$logger->debug('Generation of CSRF ...');
 			
@@ -57,14 +57,14 @@ 
 			$expire = get_config('csrf_expire', 60);
 			$keyExpire = 'csrf_expire';
 			$currentTime = time();
-			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
+			if (Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime) {
 				$logger->info('The CSRF token not yet expire just return it');
 				return Session::get($key);
 			}
-			else{
+			else {
 				$newTime = $currentTime + $expire;
 				$token = sha1(uniqid()) . sha1(uniqid());
-				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
+				$logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . '], token [' . $token . ']');
 				Session::set($keyExpire, $newTime);
 				Session::set($key, $token);
 				return Session::get($key);
@@ -75,7 +75,7 @@ 
 		 * This method is used to check the CSRF if is valid, not yet expire, etc.
 		 * @return boolean true if valid, false if not valid
 		 */
-		public static function validateCSRF(){
+		public static function validateCSRF() {
 			$logger = self::getLogger();
 			$logger->debug('Validation of CSRF ...');
 				
@@ -83,8 +83,8 @@ 
 			$expire = get_config('csrf_expire', 60);
 			$keyExpire = 'csrf_expire';
 			$currentTime = time();
-			$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. ']');
-			if(! Session::exists($key) || Session::get($keyExpire) <= $currentTime){
+			$logger->info('The CSRF informations are listed below: key [' . $key . '], key expire [' . $keyExpire . '], expire time [' . $expire . ']');
+			if (!Session::exists($key) || Session::get($keyExpire) <= $currentTime) {
 				$logger->warning('The CSRF session data is not valide');
 				return false;
 			}
@@ -93,11 +93,11 @@ 
 			//super instance
 			$obj = & get_instance();
 			$token = $obj->request->query($key);
-			if(! $token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime){
-				$logger->warning('The CSRF data [' .$token. '] is not valide may be attacker do his job');
+			if (!$token || $token !== Session::get($key) || Session::get($keyExpire) <= $currentTime) {
+				$logger->warning('The CSRF data [' . $token . '] is not valide may be attacker do his job');
 				return false;
 			}
-			$logger->info('The CSRF data [' .$token. '] is valide the form data is safe continue');
+			$logger->info('The CSRF data [' . $token . '] is valide the form data is safe continue');
 			//remove the token from session
 			Session::clear($key);
 			Session::clear($keyExpire);
@@ -107,24 +107,24 @@ 
 		/**
 		 * This method is used to check the whitelist IP address access
 		 */
-		 public static function checkWhiteListIpAccess(){
+		 public static function checkWhiteListIpAccess() {
 			$logger = self::getLogger();
 			$logger->debug('Validation of the IP address access ...');
 			$logger->debug('Check if whitelist IP access is enabled in the configuration ...');
 			$isEnable = get_config('white_list_ip_enable', false);
-			if($isEnable){
+			if ($isEnable) {
 				$logger->info('Whitelist IP access is enabled in the configuration');
 				$list = get_config('white_list_ip_addresses', array());
-				if(! empty($list)){
+				if (!empty($list)) {
 					//Can't use Loader::functions() at this time because teh "Loader" library is loader after the security prossessing
 					require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
 					$ip = get_ip();
-					if((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)){
+					if ((count($list) == 1 && $list[0] == '*') || in_array($ip, $list)) {
 						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
 						//wildcard to access all ip address
 						return;
 					}
-					else{
+					else {
 						// go through all whitelisted ips
 						foreach ($list as $ipaddr) {
 							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
@@ -150,7 +150,7 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
 			}
 		 }

Braces +3 added lines, -6 removed lines

@@ -60,8 +60,7 @@ 
 			if(Session::exists($key) && Session::exists($keyExpire) && Session::get($keyExpire) > $currentTime){
 				$logger->info('The CSRF token not yet expire just return it');
 				return Session::get($key);
-			}
-			else{
+			} else{
 				$newTime = $currentTime + $expire;
 				$token = sha1(uniqid()) . sha1(uniqid());
 				$logger->info('The CSRF informations are listed below: key [' .$key. '], key expire [' .$keyExpire. '], expire time [' .$expire. '], token [' .$token. ']');
@@ -123,8 +122,7 @@ 
 						$logger->info('IP address ' . $ip . ' allowed using the wildcard "*" or the full IP');
 						//wildcard to access all ip address
 						return;
-					}
-					else{
+					} else{
 						// go through all whitelisted ips
 						foreach ($list as $ipaddr) {
 							// find the wild card * in whitelisted ip (f.e. find position in "127.0.*" or "127*")
@@ -149,8 +147,7 @@ 
 						show_error('Access to this application is not allowed');
 					}
 				}
-			}
-			else{
+			} else{
 				$logger->info('Whitelist IP access is not enabled in the configuration, ignore checking');
 			}
 		 }

core/classes/Response.php

Indentation +401 added lines, -401 removed lines

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

Spacing +71 added lines, -71 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Response{
+	class Response {
 
 		/**
 		 * The list of request header to send with response
@@ -65,15 +65,15 @@ 
 		/**
 		 * Construct new response instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$currentUrl = '';
-			if (! empty($_SERVER['REQUEST_URI'])){
+			if (!empty($_SERVER['REQUEST_URI'])) {
 				$currentUrl = $_SERVER['REQUEST_URI'];
 			}
-			if (! empty($_SERVER['QUERY_STRING'])){
+			if (!empty($_SERVER['QUERY_STRING'])) {
 				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
 			}
-			$this->_currentUrl =  $currentUrl;
+			$this->_currentUrl = $currentUrl;
 					
 			$this->_currentUrlCacheKey = md5($this->_currentUrl);
 			
@@ -88,9 +88,9 @@ 
 		 * Get the logger singleton instance
 		 * @return Log the logger instance
 		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				self::$logger[0] =& class_loader('Log', 'classes');
+		private static function getLogger() {
+			if (self::$logger == null) {
+				self::$logger[0] = & class_loader('Log', 'classes');
 				self::$logger[0]->setLogger('Library::Response');
 			}
 			return self::$logger[0];
@@ -101,12 +101,12 @@ 
 		 * @param  integer $httpCode the HTTP status code
 		 * @param  array   $headers   the additional headers to add to the existing headers list
 		 */
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
+		public static function sendHeaders($httpCode = 200, array $headers = array()) {
 			set_http_status_header($httpCode);
 			self::setHeaders($headers);
-			if(! headers_sent()){
-				foreach(self::getHeaders() as $key => $value){
-					header($key .': '.$value);
+			if (!headers_sent()) {
+				foreach (self::getHeaders() as $key => $value) {
+					header($key . ': ' . $value);
 				}
 			}
 		}
@@ -115,7 +115,7 @@ 
 		 * Get the list of the headers
 		 * @return array the headers list
 		 */
-		public static function getHeaders(){
+		public static function getHeaders() {
 			return self::$headers;
 		}
 
@@ -124,7 +124,7 @@ 
 		 * @param  string $name the header name
 		 * @return string       the header value
 		 */
-		public static function getHeader($name){
+		public static function getHeader($name) {
 			return array_key_exists($name, self::$headers) ? self::$headers[$name] : null;
 		}
 
@@ -134,7 +134,7 @@ 
 		 * @param string $name  the header name
 		 * @param string $value the header value to be set
 		 */
-		public static function setHeader($name, $value){
+		public static function setHeader($name, $value) {
 			self::$headers[$name] = $value;
 		}
 
@@ -143,7 +143,7 @@ 
 		 * @param array $headers the list of the headers to set. 
 		 * Note: this will merge with the existing headers
 		 */
-		public static function setHeaders(array $headers){
+		public static function setHeaders(array $headers) {
 			self::$headers = array_merge(self::getHeaders(), $headers);
 		}
 		
@@ -151,17 +151,17 @@ 
 		 * Redirect user in the specified page
 		 * @param  string $path the URL or URI to be redirect to
 		 */
-		public static function redirect($path = ''){
+		public static function redirect($path = '') {
 			$logger = self::getLogger();
 			$url = Url::site_url($path);
-			$logger->info('Redirect to URL [' .$url. ']');
-			if(! headers_sent()){
-				header('Location: '.$url);
+			$logger->info('Redirect to URL [' . $url . ']');
+			if (!headers_sent()) {
+				header('Location: ' . $url);
 				exit;
 			}
-			else{
+			else {
 				echo '<script>
-						location.href = "'.$url.'";
+						location.href = "'.$url . '";
 					</script>';
 			}
 		}
@@ -174,10 +174,10 @@ 
 		 * @return void|string          if $return is true will return the view content otherwise
 		 * will display the view content.
 		 */
-		public function render($view, $data = null, $return = false){
+		public function render($view, $data = null, $return = false) {
 			$logger = self::getLogger();
 			//convert data to an array
-			$data = ! is_array($data) ? (array) $data : $data;
+			$data = !is_array($data) ? (array) $data : $data;
 			$view = str_ireplace('.php', '', $view);
 			$view = trim($view, '/\\');
 			$viewFile = $view . '.php';
@@ -186,42 +186,42 @@ 
 			//super instance
 			$obj = & get_instance();
 			
-			if(Module::hasModule()){
+			if (Module::hasModule()) {
 				//check in module first
 				$logger->debug('Checking the view [' . $view . '] from module list ...');
 				$mod = null;
 				//check if the request class contains module name
-				if(strpos($view, '/') !== false){
+				if (strpos($view, '/') !== false) {
 					$viewPath = explode('/', $view);
-					if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
+					if (isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())) {
 						$mod = $viewPath[0];
 						array_shift($viewPath);
 						$view = implode('/', $viewPath);
 						$viewFile = $view . '.php';
 					}
 				}
-				if(! $mod && !empty($obj->moduleName)){
+				if (!$mod && !empty($obj->moduleName)) {
 					$mod = $obj->moduleName;
 				}
-				if($mod){
+				if ($mod) {
 					$moduleViewPath = Module::findViewFullPath($view, $mod);
-					if($moduleViewPath){
+					if ($moduleViewPath) {
 						$path = $moduleViewPath;
-						$logger->info('Found view [' . $view . '] in module [' .$mod. '], the file path is [' .$moduleViewPath. '] we will used it');
+						$logger->info('Found view [' . $view . '] in module [' . $mod . '], the file path is [' . $moduleViewPath . '] we will used it');
 					}
-					else{
-						$logger->info('Cannot find view [' . $view . '] in module [' .$mod. '] using the default location');
+					else {
+						$logger->info('Cannot find view [' . $view . '] in module [' . $mod . '] using the default location');
 					}
 				}
-				else{
+				else {
 					$logger->info('The current request does not use module using the default location.');
 				}
 			}
 			$logger->info('The view file path to be loaded is [' . $path . ']');
 			$found = false;
-			if(file_exists($path)){
-				foreach(get_object_vars($obj) as $key => $value){
-					if(! isset($this->{$key})){
+			if (file_exists($path)) {
+				foreach (get_object_vars($obj) as $key => $value) {
+					if (!isset($this->{$key})) {
 						$this->{$key} = & $obj->{$key};
 					}
 				}
@@ -230,44 +230,44 @@ 
 				//need use require() instead of require_once because can load this view many time
 				require $path;
 				$content = ob_get_clean();
-				if($return){
+				if ($return) {
 					return $content;
 				}
 				$this->_pageRender .= $content;
 				$found = true;
 			}
-			if(! $found){
-				show_error('Unable to find view [' .$view . ']');
+			if (!$found) {
+				show_error('Unable to find view [' . $view . ']');
 			}
 		}
 		
 		/**
 		* Send the final page output to user
 		*/
-		public function renderFinalPage(){
+		public function renderFinalPage() {
 			$logger = self::getLogger();
 			$obj = & get_instance();
 			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
 			$dispatcher = $obj->eventdispatcher;
 			$content = $this->_pageRender;
-			if(! $content){
+			if (!$content) {
 				$logger->warning('The final view content is empty.');
 				return;
 			}
 			//dispatch
 			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
-			$content = ! empty($event->payload) ? $event->payload : null;
-			if(empty($content)){
+			$content = !empty($event->payload) ? $event->payload : null;
+			if (empty($content)) {
 				$logger->warning('The view content is empty after dispatch to event listeners.');
 			}
 			
 			//check whether need save the page into cache.
-			if($cachePageStatus){
+			if ($cachePageStatus) {
 				//current page URL
 				$url = $this->_currentUrl;
 				//Cache view Time to live in second
 				$viewCacheTtl = get_config('cache_ttl');
-				if (!empty($obj->view_cache_ttl)){
+				if (!empty($obj->view_cache_ttl)) {
 					$viewCacheTtl = $obj->view_cache_ttl;
 				}
 				//the cache handler instance
@@ -280,14 +280,14 @@ 
 				
 				//get the cache information to prepare header to send to browser
 				$cacheInfo = $cacheInstance->getInfo($cacheKey);
-				if($cacheInfo){
+				if ($cacheInfo) {
 					$lastModified = $cacheInfo['mtime'];
 					$expire = $cacheInfo['expire'];
 					$maxAge = $expire - time();
 					self::setHeader('Pragma', 'public');
 					self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-					self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-					self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
+					self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
+					self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');	
 				}
 			}
 			
@@ -299,7 +299,7 @@ 
 			
 			//compress the output if is available
 			$type = null;
-			if (self::$_canCompressOutput){
+			if (self::$_canCompressOutput) {
 				$type = 'ob_gzhandler';
 			}
 			ob_start($type);
@@ -311,7 +311,7 @@ 
 		/**
 		* Send the final page output to user if is cached
 		*/
-		public function renderFinalPageFromCache(&$cache){
+		public function renderFinalPageFromCache(&$cache) {
 			$logger = self::getLogger();
 			$url = $this->_currentUrl;					
 			//the current page cache key for identification
@@ -320,15 +320,15 @@ 
 			$logger->debug('Checking if the page content for the URL [' . $url . '] is cached ...');
 			//get the cache information to prepare header to send to browser
 			$cacheInfo = $cache->getInfo($pageCacheKey);
-			if($cacheInfo){
+			if ($cacheInfo) {
 				$lastModified = $cacheInfo['mtime'];
 				$expire = $cacheInfo['expire'];
 				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
 				self::setHeader('Pragma', 'public');
 				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
+				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
+				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
+				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
 					$logger->info('The cache page content is not yet expire for the URL [' . $url . '] send 304 header to browser');
 					self::sendHeaders(304);
 					return;
@@ -337,7 +337,7 @@ 
 				self::sendHeaders(200);
 				//get the cache content
 				$content = $cache->get($pageCacheKey);
-				if($content){
+				if ($content) {
 					$logger->info('The page content for the URL [' . $url . '] already cached just display it');
 					//load benchmark class
 					$benchmark = & class_loader('Benchmark');
@@ -351,7 +351,7 @@ 
 					///display the final output
 					//compress the output if is available
 					$type = null;
-					if (self::$_canCompressOutput){
+					if (self::$_canCompressOutput) {
 						$type = 'ob_gzhandler';
 					}
 					ob_start($type);
@@ -359,7 +359,7 @@ 
 					ob_end_flush();
 					return;
 				}
-				else{
+				else {
 					$logger->info('The page cache content for the URL [' . $url . '] is not valid may be already expired');
 					$cache->delete($pageCacheKey);
 				}
@@ -371,7 +371,7 @@ 
 		* Get the final page to be rendered
 		* @return string
 		*/
-		public function getFinalPageRendered(){
+		public function getFinalPageRendered() {
 			return $this->_pageRender;
 		}
 
@@ -379,14 +379,14 @@ 
 		 * Send the HTTP 404 error if can not found the 
 		 * routing information for the current request
 		 */
-		public static function send404(){
+		public static function send404() {
 			/********* for logs **************/
 			//can't use $obj = & get_instance()  here because the global super object will be available until
 			//the main controller is loaded even for Loader::library('xxxx');
 			$logger = self::getLogger();
-			$request =& class_loader('Request', 'classes');
-			$userAgent =& class_loader('Browser');
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
+			$request = & class_loader('Request', 'classes');
+			$userAgent = & class_loader('Browser');
+			$browser = $userAgent->getPlatform() . ', ' . $userAgent->getBrowser() . ' ' . $userAgent->getVersion();
 			
 			//here can't use Loader::functions just include the helper manually
 			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
@@ -396,10 +396,10 @@ 
 			$logger->error($str);
 			/***********************************/
 			$path = CORE_VIEWS_PATH . '404.php';
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				//compress the output if is available
 				$type = null;
-				if (self::$_canCompressOutput){
+				if (self::$_canCompressOutput) {
 					$type = 'ob_gzhandler';
 				}
 				ob_start($type);
@@ -408,8 +408,8 @@ 
 				self::sendHeaders(404);
 				echo $output;
 			}
-			else{
-				show_error('The 404 view [' .$path. '] does not exist');
+			else {
+				show_error('The 404 view [' . $path . '] does not exist');
 			}
 		}
 
@@ -417,12 +417,12 @@ 
 		 * Display the error to user
 		 * @param  array  $data the error information
 		 */
-		public static function sendError(array $data = array()){
+		public static function sendError(array $data = array()) {
 			$path = CORE_VIEWS_PATH . 'errors.php';
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				//compress the output if is available
 				$type = null;
-				if (self::$_canCompressOutput){
+				if (self::$_canCompressOutput) {
 					$type = 'ob_gzhandler';
 				}
 				ob_start($type);
@@ -432,7 +432,7 @@ 
 				self::sendHeaders(503);
 				echo $output;
 			}
-			else{
+			else {
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
 				set_http_status_header(503);
 				echo 'The error view [' . $path . '] does not exist';

Braces +6 added lines, -12 removed lines

@@ -158,8 +158,7 @@ 
 			if(! headers_sent()){
 				header('Location: '.$url);
 				exit;
-			}
-			else{
+			} else{
 				echo '<script>
 						location.href = "'.$url.'";
 					</script>';
@@ -208,12 +207,10 @@ 
 					if($moduleViewPath){
 						$path = $moduleViewPath;
 						$logger->info('Found view [' . $view . '] in module [' .$mod. '], the file path is [' .$moduleViewPath. '] we will used it');
-					}
-					else{
+					} else{
 						$logger->info('Cannot find view [' . $view . '] in module [' .$mod. '] using the default location');
 					}
-				}
-				else{
+				} else{
 					$logger->info('The current request does not use module using the default location.');
 				}
 			}
@@ -358,8 +355,7 @@ 
 					echo $content;
 					ob_end_flush();
 					return;
-				}
-				else{
+				} else{
 					$logger->info('The page cache content for the URL [' . $url . '] is not valid may be already expired');
 					$cache->delete($pageCacheKey);
 				}
@@ -407,8 +403,7 @@ 
 				$output = ob_get_clean();
 				self::sendHeaders(404);
 				echo $output;
-			}
-			else{
+			} else{
 				show_error('The 404 view [' .$path. '] does not exist');
 			}
 		}
@@ -431,8 +426,7 @@ 
 				$output = ob_get_clean();
 				self::sendHeaders(503);
 				echo $output;
-			}
-			else{
+			} else{
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
 				set_http_status_header(503);
 				echo 'The error view [' . $path . '] does not exist';

core/libraries/Pagination.php

Indentation +42 added lines, -42 removed lines

@@ -1,32 +1,32 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
     class Pagination{
         
-		/**
+        /**
          * The list of loaded config
          * @var array
          */
@@ -49,15 +49,15 @@ 
                 if (empty($config) || ! is_array($config)){
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
                 }
-				else{
-					if (! empty($overwriteConfig)){
-						$config = array_merge($config, $overwriteConfig);
-					}
-					$this->config = $config;
+                else{
+                    if (! empty($overwriteConfig)){
+                        $config = array_merge($config, $overwriteConfig);
+                    }
+                    $this->config = $config;
                     //put it gobally
-					Config::setAll($config);
-					unset($config);
-				}
+                    Config::setAll($config);
+                    unset($config);
+                }
             }
             else{
                 show_error('Unable to find the pagination configuration file');
@@ -94,11 +94,11 @@ 
             return $this->paginationQueryString;
         }
 
-         /**
-         * Set the value of the pagination query string
-         * @param string $paginationQueryString the new value
-         * @return object
-         */
+            /**
+             * Set the value of the pagination query string
+             * @param string $paginationQueryString the new value
+             * @return object
+             */
         public function setPaginationQueryString($paginationQueryString){
             $this->paginationQueryString = $paginationQueryString;
             return $this;
@@ -117,7 +117,7 @@ 
             $queryString = Url::queryString();
             $currentUrl = Url::current();
             $query = '';
-             if ($queryString == ''){
+                if ($queryString == ''){
                 $query = '?' . $pageQueryName . '=';
             }
             else{
@@ -150,7 +150,7 @@ 
          */
         public function getLink($totalRows, $currentPageNumber){
             $numberOfLink = $this->config['nb_link'];
-			$numberOfRowPerPage = $this->config['pagination_per_page'];
+            $numberOfRowPerPage = $this->config['pagination_per_page'];
             if (empty($this->paginationQueryString)){
                 //determine the pagination query string value
                 $this->determinePaginationQueryStringValue();
@@ -164,8 +164,8 @@ 
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
 			
             if ($currentPageNumber <= 0){
-				$currentPageNumber = 1;
-			}
+                $currentPageNumber = 1;
+            }
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
                 return $navbar;
             }
@@ -206,7 +206,7 @@ 
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
             }
             else if ($currentPageNumber == $numberOfPage){
-               $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
+                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
             return $navbar;

Braces +12 added lines, -24 removed lines

@@ -48,8 +48,7 @@ 
                 require_once CONFIG_PATH . 'config_pagination.php';
                 if (empty($config) || ! is_array($config)){
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
-                }
-				else{
+                } else{
 					if (! empty($overwriteConfig)){
 						$config = array_merge($config, $overwriteConfig);
 					}
@@ -58,8 +57,7 @@ 
 					Config::setAll($config);
 					unset($config);
 				}
-            }
-            else{
+            } else{
                 show_error('Unable to find the pagination configuration file');
             }
         }
@@ -119,18 +117,15 @@ 
             $query = '';
              if ($queryString == ''){
                 $query = '?' . $pageQueryName . '=';
-            }
-            else{
+            } else{
                 $tab = explode($pageQueryName . '=', $queryString);
                 $nb = count($tab);
                 if ($nb == 1){
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
-                }
-                else{
+                } else{
                     if ($tab[0] == ''){
                         $query = '?' . $pageQueryName . '=';
-                    }
-                    else{
+                    } else{
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
                     }
                 }
@@ -175,20 +170,17 @@ 
             if ($numberOfLink % 2 == 0){
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
                 $end = $currentPageNumber + ($numberOfLink / 2);
-            }
-            else{
+            } else{
                 $start = $currentPageNumber - floor($numberOfLink / 2);
                 $end = $currentPageNumber + floor($numberOfLink / 2);
             }
             if ($start <= 1){
                 $begin = 1;
                 $end = $numberOfLink;
-            }
-            else if ($start > 1 && $end < $numberOfPage){
+            } else if ($start > 1 && $end < $numberOfPage){
                 $begin = $start;
                 $end = $end;
-            }
-            else{
+            } else{
                 $begin = ($numberOfPage - $numberOfLink) + 1;
                 $end = $numberOfPage;
             }
@@ -204,8 +196,7 @@ 
             ///////////
             else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
-            }
-            else if ($currentPageNumber == $numberOfPage){
+            } else if ($currentPageNumber == $numberOfPage){
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -225,8 +216,7 @@ 
             for($i = $begin; $i <= $end; $i++){
                 if ($i == $currentPageNumber){
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' . $this->config['digit_close'];
                 }
             }
@@ -248,8 +238,7 @@ 
             for($i = $begin; $i <= $end; $i++){
                 if ($i == $currentPageNumber){
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' . $this->config['digit_close'];
                 }
             }
@@ -271,8 +260,7 @@ 
             for($i = $begin; $i <= $end; $i++){
                 if ($i == $currentPageNumber){
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
-                }
-                else{
+                } else{
                     $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' . $this->config['digit_close'];
                 }
             }

Spacing +45 added lines, -45 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-    class Pagination{
+    class Pagination {
         
 		/**
          * The list of loaded config
@@ -42,15 +42,15 @@ 
          * Create an instance of pagination
          * @param array $overwriteConfig the list of configuration to overwrite the defined configuration in config_pagination.php
          */
-        public function __construct($overwriteConfig = array()){
-            if (file_exists(CONFIG_PATH . 'config_pagination.php')){
+        public function __construct($overwriteConfig = array()) {
+            if (file_exists(CONFIG_PATH . 'config_pagination.php')) {
                 $config = array();
                 require_once CONFIG_PATH . 'config_pagination.php';
-                if (empty($config) || ! is_array($config)){
+                if (empty($config) || !is_array($config)) {
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
                 }
-				else{
-					if (! empty($overwriteConfig)){
+				else {
+					if (!empty($overwriteConfig)) {
 						$config = array_merge($config, $overwriteConfig);
 					}
 					$this->config = $config;
@@ -59,7 +59,7 @@ 
 					unset($config);
 				}
             }
-            else{
+            else {
                 show_error('Unable to find the pagination configuration file');
             }
         }
@@ -70,8 +70,8 @@ 
          * config_pagination.php
          * @param array $config the configuration to overwrite
          */
-        public function setConfig(array $config = array()){
-            if (! empty($config)){
+        public function setConfig(array $config = array()) {
+            if (!empty($config)) {
                 $this->config = array_merge($this->config, $config);
                 Config::setAll($config);
             }
@@ -82,7 +82,7 @@ 
          * 
          * @return array
          */
-        public function getConfig(){
+        public function getConfig() {
             return $this->config;
         }
 
@@ -90,7 +90,7 @@ 
          * Return the value of the pagination query string
          * @return string
          */
-        public function getPaginationQueryString(){
+        public function getPaginationQueryString() {
             return $this->paginationQueryString;
         }
 
@@ -99,7 +99,7 @@ 
          * @param string $paginationQueryString the new value
          * @return object
          */
-        public function setPaginationQueryString($paginationQueryString){
+        public function setPaginationQueryString($paginationQueryString) {
             $this->paginationQueryString = $paginationQueryString;
             return $this;
         }
@@ -112,25 +112,25 @@ 
          * 
          * @return object
          */
-        public function determinePaginationQueryStringValue(){
+        public function determinePaginationQueryStringValue() {
             $pageQueryName = $this->config['page_query_string_name'];
             $queryString = Url::queryString();
             $currentUrl = Url::current();
             $query = '';
-             if ($queryString == ''){
+             if ($queryString == '') {
                 $query = '?' . $pageQueryName . '=';
             }
-            else{
+            else {
                 $tab = explode($pageQueryName . '=', $queryString);
                 $nb = count($tab);
-                if ($nb == 1){
+                if ($nb == 1) {
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
                 }
-                else{
-                    if ($tab[0] == ''){
+                else {
+                    if ($tab[0] == '') {
                         $query = '?' . $pageQueryName . '=';
                     }
-                    else{
+                    else {
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
                     }
                 }
@@ -148,10 +148,10 @@ 
          * 
          * @return string the pagination link
          */
-        public function getLink($totalRows, $currentPageNumber){
+        public function getLink($totalRows, $currentPageNumber) {
             $numberOfLink = $this->config['nb_link'];
 			$numberOfRowPerPage = $this->config['pagination_per_page'];
-            if (empty($this->paginationQueryString)){
+            if (empty($this->paginationQueryString)) {
                 //determine the pagination query string value
                 $this->determinePaginationQueryStringValue();
             }
@@ -162,7 +162,7 @@ 
             $numberOfLink = (int) $numberOfLink;
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
 			
-            if ($currentPageNumber <= 0){
+            if ($currentPageNumber <= 0) {
 				$currentPageNumber = 1;
 			}
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
@@ -171,27 +171,27 @@ 
             $start = null;
             $end   = null;
             $begin = null;
-            if ($numberOfLink % 2 == 0){
+            if ($numberOfLink % 2 == 0) {
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
                 $end = $currentPageNumber + ($numberOfLink / 2);
             }
-            else{
+            else {
                 $start = $currentPageNumber - floor($numberOfLink / 2);
                 $end = $currentPageNumber + floor($numberOfLink / 2);
             }
-            if ($start <= 1){
+            if ($start <= 1) {
                 $begin = 1;
                 $end = $numberOfLink;
             }
-            else if ($start > 1 && $end < $numberOfPage){
+            else if ($start > 1 && $end < $numberOfPage) {
                 $begin = $start;
                 $end = $end;
             }
-            else{
+            else {
                 $begin = ($numberOfPage - $numberOfLink) + 1;
                 $end = $numberOfPage;
             }
-            if ($numberOfPage <= $numberOfLink){
+            if ($numberOfPage <= $numberOfLink) {
                 $begin = 1;
                 $end = $numberOfPage;
             }
@@ -199,14 +199,14 @@ 
             $end = (int) $end;
 
             //**
-            if ($currentPageNumber == 1){
+            if ($currentPageNumber == 1) {
                 $navbar .= $this->buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber);
             }
             ///////////
-            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
+            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage) {
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
             }
-            else if ($currentPageNumber == $numberOfPage){
+            else if ($currentPageNumber == $numberOfPage) {
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
             }
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -220,14 +220,14 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
                 }
-                else{
+                else {
                     $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' . $this->config['digit_close'];
                 }
             }
@@ -242,19 +242,19 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
             $navbar .= $this->config['previous_open'] . '<a href="' . $query . ($currentPageNumber - 1) . '">' . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
                 }
-                else{
-                    $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' . $this->config['digit_close'];
+                else {
+                    $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' . $this->config['digit_close'];
                 }
             }
-            $navbar .= $this->config['next_open']."<a href='$query".($currentPageNumber + 1)."'>".$this->config['next_text']."</a>".$this->config['next_close'];
+            $navbar .= $this->config['next_open'] . "<a href='$query" . ($currentPageNumber + 1) . "'>" . $this->config['next_text'] . "</a>" . $this->config['next_close'];
             return $navbar;
         }
 
@@ -265,15 +265,15 @@ 
          * @param  int $currentPageNumber the pagination current page number
          * @return string                    
          */
-        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber){
+        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber) {
             $navbar = null;
             $query = $this->paginationQueryString;
             $navbar .= $this->config['previous_open'] . '<a href="' . $query . ($currentPageNumber - 1) . '">' . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
-            for($i = $begin; $i <= $end; $i++){
-                if ($i == $currentPageNumber){
+            for ($i = $begin; $i <= $end; $i++) {
+                if ($i == $currentPageNumber) {
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
                 }
-                else{
+                else {
                     $navbar .= $this->config['digit_open'] . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' . $this->config['digit_close'];
                 }
             }