tnhfw / tnh-fw

core/classes/database/DatabaseQueryRunner.php

Indentation +166 added lines, -166 removed lines

@@ -1,90 +1,90 @@ 
 <?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.
-  */
-  class DatabaseQueryRunner{
+    /**
+     * 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 DatabaseQueryRunner{
       
     /**
-	* The logger instance
-	* @var object
-	*/
+     * The logger instance
+     * @var object
+     */
     private $logger            = null;
     
-  	/**
-  	 * The last query result
-  	 * @var object
-  	*/
-  	private $queryResult       = null;
+        /**
+         * The last query result
+         * @var object
+         */
+        private $queryResult       = null;
   	
-  	/**
-    * The benchmark instance
-    * @var object
-    */
+        /**
+         * The benchmark instance
+         * @var object
+         */
     private $benchmarkInstance = null;
     
     /**
-	 * The SQL query statment to execute
-	 * @var string
-	*/
+     * The SQL query statment to execute
+     * @var string
+     */
     private $query             = null;
     
     /**
-	 * Indicate if we need return result as list (boolean) 
+     * Indicate if we need return result as list (boolean) 
      * or the data used to replace the placeholder (array)
-	 * @var array|boolean
-	 */
-     private $all               = true;
+     * @var array|boolean
+     */
+        private $all               = true;
      
      
-     /**
-	   * Indicate if we need return result as array or not
-     * @var boolean
-	   */
-     private $returnAsArray     = true;
+        /**
+         * Indicate if we need return result as array or not
+         * @var boolean
+         */
+        private $returnAsArray     = true;
      
-     /**
-     * The last PDOStatment instance
-     * @var object
-     */
-     private $pdoStatment       = null;
+        /**
+         * The last PDOStatment instance
+         * @var object
+         */
+        private $pdoStatment       = null;
      
-     /**
-  	 * The error returned for the last query
-  	 * @var string
-  	 */
-     private $error             = null;
+        /**
+         * The error returned for the last query
+         * @var string
+         */
+        private $error             = null;
 	
     /**
      * The PDO instance
      * @var object
-    */
+     */
     private $pdo                = null;
   
     /**
      * The database driver name used
      * @var string
-    */
+     */
     private $driver             = null;
 
 
@@ -98,7 +98,7 @@ 
      */
     public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
         if (is_object($pdo)){
-          $this->pdo = $pdo;
+            $this->pdo = $pdo;
         }
         $this->query = $query;
         $this->returnAsList = $returnAsList;
@@ -116,16 +116,16 @@ 
         //reset instance
         $this->reset();
        
-       //for database query execution time
+        //for database query execution time
         $benchmarkMarkerKey = $this->getBenchmarkKey();
         if (! is_object($this->benchmarkInstance)){
-          $this->benchmarkInstance = & class_loader('Benchmark');
+            $this->benchmarkInstance = & class_loader('Benchmark');
         }
         
         $this->logger->info(
-                          'Execute SQL query [' . $this->query . '], return type: ' 
-                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
-                          . ($this->returnAsList ? 'YES':'NO')
+                            'Execute SQL query [' . $this->query . '], return type: ' 
+                            . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
+                            . ($this->returnAsList ? 'YES':'NO')
                         );
 
         $this->benchmarkInstance->mark('DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')');                
@@ -136,101 +136,101 @@ 
         $responseTime = $this->benchmarkInstance->elapsedTime(
                                                                 'DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')', 
                                                                 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')'
-                                                              );
-		    //TODO use the configuration value for the high response time currently is 1 second
+                                                                );
+            //TODO use the configuration value for the high response time currently is 1 second
         if ($responseTime >= 1 ){
             $this->logger->warning(
                                     'High response time while processing database query [' . $this->query . ']. 
                                      The response time is [' .$responseTime. '] sec.'
-                                  );
+                                    );
         }
 		
         if ($this->pdoStatment !== false){
-          $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
-          if($isSqlSELECTQuery){
-              $this->setResultForSelect();              
-          }
-          else{
-              $this->setResultForNonSelect();
-          }
-          return $this->queryResult;
+            $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
+            if($isSqlSELECTQuery){
+                $this->setResultForSelect();              
+            }
+            else{
+                $this->setResultForNonSelect();
+            }
+            return $this->queryResult;
         }
         $this->setQueryRunnerError();
     }
 	
-   /**
-   * Return the result for SELECT query
-   * @see DatabaseQueryRunner::execute
-   */
+    /**
+     * Return the result for SELECT query
+     * @see DatabaseQueryRunner::execute
+     */
     protected function setResultForSelect(){
-      //if need return all result like list of record
-      $result = null;
-      $numRows = 0;
-      $fetchMode = PDO::FETCH_OBJ;
-      if($this->returnAsArray){
+        //if need return all result like list of record
+        $result = null;
+        $numRows = 0;
+        $fetchMode = PDO::FETCH_OBJ;
+        if($this->returnAsArray){
         $fetchMode = PDO::FETCH_ASSOC;
-      }
-      if ($this->returnAsList){
-          $result = $this->pdoStatment->fetchAll($fetchMode);
-      }
-      else{
-          $result = $this->pdoStatment->fetch($fetchMode);
-      }
-      //Sqlite and pgsql always return 0 when using rowCount()
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+        }
+        if ($this->returnAsList){
+            $result = $this->pdoStatment->fetchAll($fetchMode);
+        }
+        else{
+            $result = $this->pdoStatment->fetch($fetchMode);
+        }
+        //Sqlite and pgsql always return 0 when using rowCount()
+        if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $numRows = count($result);  
-      }
-      else{
+        }
+        else{
         $numRows = $this->pdoStatment->rowCount(); 
-      }
-      if(! is_object($this->queryResult)){
-          $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
-      }
-      $this->queryResult->setResult($result);
-      $this->queryResult->setNumRows($numRows);
+        }
+        if(! is_object($this->queryResult)){
+            $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
+        }
+        $this->queryResult->setResult($result);
+        $this->queryResult->setNumRows($numRows);
     }
 
     /**
-   * Return the result for non SELECT query
-   * @see DatabaseQueryRunner::execute
-   */
+     * Return the result for non SELECT query
+     * @see DatabaseQueryRunner::execute
+     */
     protected function setResultForNonSelect(){
-      //Sqlite and pgsql always return 0 when using rowCount()
-      $result = false;
-      $numRows = 0;
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+        //Sqlite and pgsql always return 0 when using rowCount()
+        $result = false;
+        $numRows = 0;
+        if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
-      }
-      else{
-          //to test the result for the query like UPDATE, INSERT, DELETE
-          $result  = $this->pdoStatment->rowCount() >= 0; 
-          $numRows = $this->pdoStatment->rowCount(); 
-      }
-      if(! is_object($this->queryResult)){
-          $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
-      }
-      $this->queryResult->setResult($result);
-      $this->queryResult->setNumRows($numRows);
+        }
+        else{
+            //to test the result for the query like UPDATE, INSERT, DELETE
+            $result  = $this->pdoStatment->rowCount() >= 0; 
+            $numRows = $this->pdoStatment->rowCount(); 
+        }
+        if(! is_object($this->queryResult)){
+            $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
+        }
+        $this->queryResult->setResult($result);
+        $this->queryResult->setNumRows($numRows);
     }
 
 
-	/**
+    /**
      * Return the benchmark instance
      * @return Benchmark
      */
     public function getBenchmark(){
-      return $this->benchmarkInstance;
+        return $this->benchmarkInstance;
     }
 
     /**
      * Set the benchmark instance
      * @param Benchmark $benchmark the benchmark object
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setBenchmark($benchmark){
-      $this->benchmarkInstance = $benchmark;
-      return $this;
+        $this->benchmarkInstance = $benchmark;
+        return $this;
     }
     
     /**
@@ -239,18 +239,18 @@ 
      * @return object DatabaseQueryResult
      */
     public function getQueryResult(){
-      return $this->queryResult;
+        return $this->queryResult;
     }
 
     /**
      * Set the database query result instance
      * @param object $queryResult the query result
      *
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setQueryResult(DatabaseQueryResult $queryResult){
-      $this->queryResult = $queryResult;
-      return $this;
+        $this->queryResult = $queryResult;
+        return $this;
     }
     
     /**
@@ -258,17 +258,17 @@ 
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
     
     /**
@@ -276,7 +276,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
     
     /**
@@ -285,8 +285,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setQuery($query){
-       $this->query = $query;
-       return $this;
+        $this->query = $query;
+        return $this;
     }
     
     /**
@@ -295,8 +295,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnType($returnType){
-       $this->returnAsList = $returnType;
-       return $this;
+        $this->returnAsList = $returnType;
+        return $this;
     }
     
     /**
@@ -305,8 +305,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnAsArray($status = true){
-       $this->returnAsArray = $status;
-       return $this;
+        $this->returnAsArray = $status;
+        return $this;
     }
     
     /**
@@ -314,7 +314,7 @@ 
      * @return string
      */
     public function getQueryError(){
-      return $this->error;
+        return $this->error;
     }
 
     /**
@@ -322,7 +322,7 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
@@ -331,16 +331,16 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setPdo(PDO $pdo = null){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
   
-     /**
-     * Return the database driver
-     * @return string
-     */
+        /**
+         * Return the database driver
+         * @return string
+         */
     public function getDriver(){
-      return $this->driver;
+        return $this->driver;
     }
 
     /**
@@ -349,8 +349,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setDriver($driver){
-      $this->driver = $driver;
-      return $this;
+        $this->driver = $driver;
+        return $this;
     }
     
     /**
@@ -359,18 +359,18 @@ 
      *  @return string
      */
     protected function getBenchmarkKey(){
-      return md5($this->query . $this->returnAsList . $this->returnAsArray);
+        return md5($this->query . $this->returnAsList . $this->returnAsArray);
     }
     
     /**
      * Set error for database query execution
      */
     protected function setQueryRunnerError(){
-      $error = $this->pdo->errorInfo();
-      $this->error = isset($error[2]) ? $error[2] : '';
-      $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
-	  //show error message
-      show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error');
+        $error = $this->pdo->errorInfo();
+        $this->error = isset($error[2]) ? $error[2] : '';
+        $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
+        //show error message
+        show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error');
     }
     
     /**
@@ -378,19 +378,19 @@ 
      * @param object $logger the Log instance if not null
      */
     protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){
-      if ($logger !== null){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::DatabaseQueryRunner');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::DatabaseQueryRunner');
+        }
     }
     
     
     /**
-    * Reset the instance before run each query
-    */
+     * Reset the instance before run each query
+     */
     private function reset(){
         $this->error = null;
         $this->pdoStatment = null;

Spacing +54 added lines, -54 removed lines

@@ -23,19 +23,19 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class DatabaseQueryRunner{
+  class DatabaseQueryRunner {
       
     /**
 	* The logger instance
 	* @var object
 	*/
-    private $logger            = null;
+    private $logger = null;
     
   	/**
   	 * The last query result
   	 * @var object
   	*/
-  	private $queryResult       = null;
+  	private $queryResult = null;
   	
   	/**
     * The benchmark instance
@@ -47,45 +47,45 @@ 
 	 * The SQL query statment to execute
 	 * @var string
 	*/
-    private $query             = null;
+    private $query = null;
     
     /**
 	 * Indicate if we need return result as list (boolean) 
      * or the data used to replace the placeholder (array)
 	 * @var array|boolean
 	 */
-     private $all               = true;
+     private $all = true;
      
      
      /**
 	   * Indicate if we need return result as array or not
      * @var boolean
 	   */
-     private $returnAsArray     = true;
+     private $returnAsArray = true;
      
      /**
      * The last PDOStatment instance
      * @var object
      */
-     private $pdoStatment       = null;
+     private $pdoStatment = null;
      
      /**
   	 * The error returned for the last query
   	 * @var string
   	 */
-     private $error             = null;
+     private $error = null;
 	
     /**
      * The PDO instance
      * @var object
     */
-    private $pdo                = null;
+    private $pdo = null;
   
     /**
      * The database driver name used
      * @var string
     */
-    private $driver             = null;
+    private $driver = null;
 
 
 	
@@ -96,8 +96,8 @@ 
      * @param boolean $returnAsList if need return as list or just one row
      * @param boolean $returnAsArray whether to return the result as array or not
      */
-    public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
-        if (is_object($pdo)){
+    public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false) {
+        if (is_object($pdo)) {
           $this->pdo = $pdo;
         }
         $this->query = $query;
@@ -112,20 +112,20 @@ 
      * 
      * @return object|void
      */
-    public function execute(){
+    public function execute() {
         //reset instance
         $this->reset();
        
        //for database query execution time
         $benchmarkMarkerKey = $this->getBenchmarkKey();
-        if (! is_object($this->benchmarkInstance)){
+        if (!is_object($this->benchmarkInstance)) {
           $this->benchmarkInstance = & class_loader('Benchmark');
         }
         
         $this->logger->info(
                           'Execute SQL query [' . $this->query . '], return type: ' 
-                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') .', return as list: ' 
-                          . ($this->returnAsList ? 'YES':'NO')
+                          . ($this->returnAsArray ? 'ARRAY' : 'OBJECT') . ', return as list: ' 
+                          . ($this->returnAsList ? 'YES' : 'NO')
                         );
 
         $this->benchmarkInstance->mark('DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')');                
@@ -138,19 +138,19 @@ 
                                                                 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')'
                                                               );
 		    //TODO use the configuration value for the high response time currently is 1 second
-        if ($responseTime >= 1 ){
+        if ($responseTime >= 1) {
             $this->logger->warning(
                                     'High response time while processing database query [' . $this->query . ']. 
-                                     The response time is [' .$responseTime. '] sec.'
+                                     The response time is [' .$responseTime . '] sec.'
                                   );
         }
 		
-        if ($this->pdoStatment !== false){
+        if ($this->pdoStatment !== false) {
           $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
-          if($isSqlSELECTQuery){
+          if ($isSqlSELECTQuery) {
               $this->setResultForSelect();              
           }
-          else{
+          else {
               $this->setResultForNonSelect();
           }
           return $this->queryResult;
@@ -162,28 +162,28 @@ 
    * Return the result for SELECT query
    * @see DatabaseQueryRunner::execute
    */
-    protected function setResultForSelect(){
+    protected function setResultForSelect() {
       //if need return all result like list of record
       $result = null;
       $numRows = 0;
       $fetchMode = PDO::FETCH_OBJ;
-      if($this->returnAsArray){
+      if ($this->returnAsArray) {
         $fetchMode = PDO::FETCH_ASSOC;
       }
-      if ($this->returnAsList){
+      if ($this->returnAsList) {
           $result = $this->pdoStatment->fetchAll($fetchMode);
       }
-      else{
+      else {
           $result = $this->pdoStatment->fetch($fetchMode);
       }
       //Sqlite and pgsql always return 0 when using rowCount()
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+      if (in_array($this->driver, array('sqlite', 'pgsql'))) {
         $numRows = count($result);  
       }
-      else{
+      else {
         $numRows = $this->pdoStatment->rowCount(); 
       }
-      if(! is_object($this->queryResult)){
+      if (!is_object($this->queryResult)) {
           $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
       }
       $this->queryResult->setResult($result);
@@ -194,20 +194,20 @@ 
    * Return the result for non SELECT query
    * @see DatabaseQueryRunner::execute
    */
-    protected function setResultForNonSelect(){
+    protected function setResultForNonSelect() {
       //Sqlite and pgsql always return 0 when using rowCount()
       $result = false;
       $numRows = 0;
-      if (in_array($this->driver, array('sqlite', 'pgsql'))){
+      if (in_array($this->driver, array('sqlite', 'pgsql'))) {
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
       }
-      else{
+      else {
           //to test the result for the query like UPDATE, INSERT, DELETE
           $result  = $this->pdoStatment->rowCount() >= 0; 
           $numRows = $this->pdoStatment->rowCount(); 
       }
-      if(! is_object($this->queryResult)){
+      if (!is_object($this->queryResult)) {
           $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database');
       }
       $this->queryResult->setResult($result);
@@ -219,7 +219,7 @@ 
      * Return the benchmark instance
      * @return Benchmark
      */
-    public function getBenchmark(){
+    public function getBenchmark() {
       return $this->benchmarkInstance;
     }
 
@@ -228,7 +228,7 @@ 
      * @param Benchmark $benchmark the benchmark object
 	 * @return object DatabaseQueryRunner
      */
-    public function setBenchmark($benchmark){
+    public function setBenchmark($benchmark) {
       $this->benchmarkInstance = $benchmark;
       return $this;
     }
@@ -238,7 +238,7 @@ 
      *
      * @return object DatabaseQueryResult
      */
-    public function getQueryResult(){
+    public function getQueryResult() {
       return $this->queryResult;
     }
 
@@ -248,7 +248,7 @@ 
      *
 	 * @return object DatabaseQueryRunner
      */
-    public function setQueryResult(DatabaseQueryResult $queryResult){
+    public function setQueryResult(DatabaseQueryResult $queryResult) {
       $this->queryResult = $queryResult;
       return $this;
     }
@@ -257,7 +257,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -266,7 +266,7 @@ 
      * @param Log $logger the log object
 	 * @return object DatabaseQueryRunner
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -275,7 +275,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
       return $this->query;
     }
     
@@ -284,7 +284,7 @@ 
      * @param string $query the SQL query to set
      * @return object DatabaseQueryRunner
      */
-    public function setQuery($query){
+    public function setQuery($query) {
        $this->query = $query;
        return $this;
     }
@@ -294,7 +294,7 @@ 
      * @param boolean $returnType
      * @return object DatabaseQueryRunner
      */
-    public function setReturnType($returnType){
+    public function setReturnType($returnType) {
        $this->returnAsList = $returnType;
        return $this;
     }
@@ -304,7 +304,7 @@ 
      * @param boolean $status the status if true will return as array
      * @return object DatabaseQueryRunner
      */
-    public function setReturnAsArray($status = true){
+    public function setReturnAsArray($status = true) {
        $this->returnAsArray = $status;
        return $this;
     }
@@ -313,7 +313,7 @@ 
      * Return the error for last query execution
      * @return string
      */
-    public function getQueryError(){
+    public function getQueryError() {
       return $this->error;
     }
 
@@ -321,7 +321,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -330,7 +330,7 @@ 
      * @param PDO $pdo the pdo object
      * @return object DatabaseQueryRunner
      */
-    public function setPdo(PDO $pdo = null){
+    public function setPdo(PDO $pdo = null) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -339,7 +339,7 @@ 
      * Return the database driver
      * @return string
      */
-    public function getDriver(){
+    public function getDriver() {
       return $this->driver;
     }
 
@@ -348,7 +348,7 @@ 
      * @param string $driver the new driver
      * @return object DatabaseQueryRunner
      */
-    public function setDriver($driver){
+    public function setDriver($driver) {
       $this->driver = $driver;
       return $this;
     }
@@ -358,14 +358,14 @@ 
      * 
      *  @return string
      */
-    protected function getBenchmarkKey(){
+    protected function getBenchmarkKey() {
       return md5($this->query . $this->returnAsList . $this->returnAsArray);
     }
     
     /**
      * Set error for database query execution
      */
-    protected function setQueryRunnerError(){
+    protected function setQueryRunnerError() {
       $error = $this->pdo->errorInfo();
       $this->error = isset($error[2]) ? $error[2] : '';
       $this->logger->error('The database query execution got an error: ' . stringfy_vars($error));
@@ -377,12 +377,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::DatabaseQueryRunner');
       }
     }
@@ -391,7 +391,7 @@ 
     /**
     * Reset the instance before run each query
     */
-    private function reset(){
+    private function reset() {
         $this->error = null;
         $this->pdoStatment = null;
     }

Braces +5 added lines, -10 removed lines

@@ -149,8 +149,7 @@ 
           $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
           if($isSqlSELECTQuery){
               $this->setResultForSelect();              
-          }
-          else{
+          } else{
               $this->setResultForNonSelect();
           }
           return $this->queryResult;
@@ -172,15 +171,13 @@ 
       }
       if ($this->returnAsList){
           $result = $this->pdoStatment->fetchAll($fetchMode);
-      }
-      else{
+      } else{
           $result = $this->pdoStatment->fetch($fetchMode);
       }
       //Sqlite and pgsql always return 0 when using rowCount()
       if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $numRows = count($result);  
-      }
-      else{
+      } else{
         $numRows = $this->pdoStatment->rowCount(); 
       }
       if(! is_object($this->queryResult)){
@@ -201,8 +198,7 @@ 
       if (in_array($this->driver, array('sqlite', 'pgsql'))){
         $result = true; //to test the result for the query like UPDATE, INSERT, DELETE
         $numRows = 1; //TODO use the correct method to get the exact affected row
-      }
-      else{
+      } else{
           //to test the result for the query like UPDATE, INSERT, DELETE
           $result  = $this->pdoStatment->rowCount() >= 0; 
           $numRows = $this->pdoStatment->rowCount(); 
@@ -380,8 +376,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::DatabaseQueryRunner');
       }

core/classes/database/Database.php

Indentation +325 added lines, -325 removed lines

@@ -1,119 +1,119 @@ 
 <?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.
-  */
-  class Database{
+    /**
+     * 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 Database{
 	
-  	/**
-  	 * The PDO instance
-  	 * @var object
-  	*/
+        /**
+         * The PDO instance
+         * @var object
+         */
     private $pdo                 = null;
     
-  	/**
-  	 * The database name used for the application
-  	 * @var string
-  	*/
-	  private $databaseName        = null;
+        /**
+         * The database name used for the application
+         * @var string
+         */
+        private $databaseName        = null;
 	
-  	/**
-  	 * The number of rows returned by the last query
-  	 * @var int
-  	*/
+        /**
+         * The number of rows returned by the last query
+         * @var int
+         */
     private $numRows             = 0;
 	
-  	/**
-  	 * The last insert id for the primary key column that have auto increment or sequence
-  	 * @var mixed
-  	*/
+        /**
+         * The last insert id for the primary key column that have auto increment or sequence
+         * @var mixed
+         */
     private $insertId            = null;
 	
-  	/**
-  	 * The full SQL query statment after build for each command
-  	 * @var string
-  	*/
+        /**
+         * The full SQL query statment after build for each command
+         * @var string
+         */
     private $query               = null;
 	
-  	/**
-  	 * The result returned for the last query
-  	 * @var mixed
-  	*/
+        /**
+         * The result returned for the last query
+         * @var mixed
+         */
     private $result              = array();
 	
-  	/**
-  	 * The cache default time to live in second. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
-  	private $cacheTtl             = 0;
+        /**
+         * The cache default time to live in second. 0 means no need to use the cache feature
+         * @var int
+         */
+        private $cacheTtl             = 0;
 	
-  	/**
-  	 * The cache current time to live. 0 means no need to use the cache feature
-  	 * @var int
-  	*/
+        /**
+         * The cache current time to live. 0 means no need to use the cache feature
+         * @var int
+         */
     private $temporaryCacheTtl   = 0;
 	
-  	/**
-  	 * The number of executed query for the current request
-  	 * @var int
-  	*/
+        /**
+         * The number of executed query for the current request
+         * @var int
+         */
     private $queryCount          = 0;
 	
-  	/**
-  	 * The default data to be used in the statments query INSERT, UPDATE
-  	 * @var array
-  	*/
+        /**
+         * The default data to be used in the statments query INSERT, UPDATE
+         * @var array
+         */
     private $data                = array();
 	
-  	/**
-  	 * The database configuration
-  	 * @var array
-  	*/
+        /**
+         * The database configuration
+         * @var array
+         */
     private $config              = array();
 	
-  	/**
-  	 * The logger instance
-  	 * @var object
-  	 */
+        /**
+         * The logger instance
+         * @var object
+         */
     private $logger              = null;
 
     /**
-    * The cache instance
-    * @var object
-    */
+     * The cache instance
+     * @var object
+     */
     private $cacheInstance       = null;
 
     
-  	/**
-    * The DatabaseQueryBuilder instance
-    * @var object
-    */
+        /**
+         * The DatabaseQueryBuilder instance
+         * @var object
+         */
     private $queryBuilder        = null;
     
     /**
-    * The DatabaseQueryRunner instance
-    * @var object
-    */
+     * The DatabaseQueryRunner instance
+     * @var object
+     */
     private $queryRunner         = null;
 
 
@@ -125,8 +125,8 @@ 
         //Set Log instance to use
         $this->setLoggerFromParamOrCreateNewInstance(null);
 		
-    		//Set DatabaseQueryBuilder instance to use
-    		$this->setQueryBuilderFromParamOrCreateNewInstance(null);
+            //Set DatabaseQueryBuilder instance to use
+            $this->setQueryBuilderFromParamOrCreateNewInstance(null);
 
         //Set DatabaseQueryRunner instance to use
         $this->setQueryRunnerFromParamOrCreateNewInstance(null);
@@ -143,22 +143,22 @@ 
      * @return bool 
      */
     public function connect(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         try{
             $this->pdo = new PDO($this->getDsnFromDriver(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
-          }
-          catch (PDOException $e){
+            }
+            catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 
@@ -167,7 +167,7 @@ 
      * @return int
      */
     public function numRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
@@ -175,7 +175,7 @@ 
      * @return mixed
      */
     public function insertId(){
-      return $this->insertId;
+        return $this->insertId;
     }
 
 
@@ -186,13 +186,13 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function get($returnSQLQueryOrResultType = false){
-      $this->getQueryBuilder()->limit(1);
-      $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+        $this->getQueryBuilder()->limit(1);
+        $query = $this->getAll(true);
+        if ($returnSQLQueryOrResultType === true){
         return $query;
-      } else {
+        } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
-      }
+        }
     }
 
     /**
@@ -202,11 +202,11 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function getAll($returnSQLQueryOrResultType = false){
-	   $query = $this->getQueryBuilder()->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
-      	return $query;
-      }
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
+        $query = $this->getQueryBuilder()->getQuery();
+        if ($returnSQLQueryOrResultType === true){
+            return $query;
+        }
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
     }
 
     /**
@@ -216,19 +216,19 @@ 
      * @return mixed          the insert id of the new record or null
      */
     public function insert($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+        if (empty($data) && $this->getData()){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
-      }
-      $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
-      $result = $this->query($query);
-      if ($result){
+        }
+        $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
+        $result = $this->query($query);
+        if ($result){
         $this->insertId = $this->pdo->lastInsertId();
-		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
+            //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
         return ! $this->insertId() ? true : $this->insertId();
-      }
-      return false;
+        }
+        return false;
     }
 
     /**
@@ -238,13 +238,13 @@ 
      * @return mixed          the update status
      */
     public function update($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+        if (empty($data) && $this->getData()){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
-      }
-      $query = $this->getQueryBuilder()->update($data, $escape)->getQuery();
-      return $this->query($query);
+        }
+        $query = $this->getQueryBuilder()->update($data, $escape)->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -252,8 +252,8 @@ 
      * @return mixed the delete status
      */
     public function delete(){
-		$query = $this->getQueryBuilder()->delete()->getQuery();
-    	return $this->query($query);
+        $query = $this->getQueryBuilder()->delete()->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -262,21 +262,21 @@ 
      * @return object        the current Database instance
      */
     public function setCache($ttl = 0){
-      if ($ttl > 0){
+        if ($ttl > 0){
         $this->cacheTtl = $ttl;
         $this->temporaryCacheTtl = $ttl;
-      }
-      return $this;
+        }
+        return $this;
     }
 	
-	/**
-	 * Enabled cache temporary for the current query not globally	
-	 * @param  integer $ttl the cache time to live in second
-	 * @return object        the current Database instance
-	 */
-  	public function cached($ttl = 0){
+    /**
+     * Enabled cache temporary for the current query not globally	
+     * @param  integer $ttl the cache time to live in second
+     * @return object        the current Database instance
+     */
+        public function cached($ttl = 0){
         if ($ttl > 0){
-          $this->temporaryCacheTtl = $ttl;
+            $this->temporaryCacheTtl = $ttl;
         }
         return $this;
     }
@@ -288,7 +288,7 @@ 
      * @return mixed       the data after escaped or the same data if not
      */
     public function escape($data, $escaped = true){
-      return $escaped ? 
+        return $escaped ? 
                       $this->pdo->quote(trim($data)) 
                       : $data; 
     }
@@ -298,7 +298,7 @@ 
      * @return int
      */
     public function queryCount(){
-      return $this->queryCount;
+        return $this->queryCount;
     }
 
     /**
@@ -306,7 +306,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
 
     /**
@@ -314,7 +314,7 @@ 
      * @return string
      */
     public function getDatabaseName(){
-      return $this->databaseName;
+        return $this->databaseName;
     }
 
     /**
@@ -322,17 +322,17 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
      * Set the PDO instance
      * @param object $pdo the pdo object
-	 * @return object Database
+     * @return object Database
      */
     public function setPdo(PDO $pdo){
-      $this->pdo = $pdo;
-      return $this;
+        $this->pdo = $pdo;
+        return $this;
     }
 
 
@@ -341,44 +341,44 @@ 
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object Database
+     * @return object Database
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
 
-     /**
-     * Return the cache instance
-     * @return CacheInterface
-     */
+        /**
+         * Return the cache instance
+         * @return CacheInterface
+         */
     public function getCacheInstance(){
-      return $this->cacheInstance;
+        return $this->cacheInstance;
     }
 
     /**
      * Set the cache instance
      * @param CacheInterface $cache the cache object
-	 * @return object Database
+     * @return object Database
      */
     public function setCacheInstance($cache){
-      $this->cacheInstance = $cache;
-      return $this;
+        $this->cacheInstance = $cache;
+        return $this;
     }
 	
 	
-	   /**
-     * Return the DatabaseQueryBuilder instance
-     * @return object DatabaseQueryBuilder
-     */
+        /**
+         * Return the DatabaseQueryBuilder instance
+         * @return object DatabaseQueryBuilder
+         */
     public function getQueryBuilder(){
-      return $this->queryBuilder;
+        return $this->queryBuilder;
     }
 
     /**
@@ -386,8 +386,8 @@ 
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
-      $this->queryBuilder = $queryBuilder;
-      return $this;
+        $this->queryBuilder = $queryBuilder;
+        return $this;
     }
     
     /**
@@ -395,7 +395,7 @@ 
      * @return object DatabaseQueryRunner
      */
     public function getQueryRunner(){
-      return $this->queryRunner;
+        return $this->queryRunner;
     }
 
     /**
@@ -403,8 +403,8 @@ 
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
-      $this->queryRunner = $queryRunner;
-      return $this;
+        $this->queryRunner = $queryRunner;
+        return $this;
     }
 
     /**
@@ -412,7 +412,7 @@ 
      * @return array
      */
     public function getData(){
-      return $this->data;
+        return $this->data;
     }
 
     /**
@@ -423,51 +423,51 @@ 
      * @return object        the current Database instance
      */
     public function setData($key, $value = null, $escape = true){
-  	  if(is_array($key)){
-    		foreach($key as $k => $v){
-    			$this->setData($k, $v, $escape);
-    		}	
-  	  } else {
+        if(is_array($key)){
+            foreach($key as $k => $v){
+                $this->setData($k, $v, $escape);
+            }	
+        } else {
         $this->data[$key] = $this->escape($value, $escape);
-  	  }
-      return $this;
+        }
+        return $this;
     }
 
-     /**
-     * Execute an SQL query
-     * @param  string  $query the query SQL string
-     * @param  boolean $returnAsList  indicate whether to return all record or just one row 
-     * @param  boolean $returnAsArray return the result as array or not
-     * @return mixed         the query result
-     */
+        /**
+         * Execute an SQL query
+         * @param  string  $query the query SQL string
+         * @param  boolean $returnAsList  indicate whether to return all record or just one row 
+         * @param  boolean $returnAsArray return the result as array or not
+         * @return mixed         the query result
+         */
     public function query($query, $returnAsList = true, $returnAsArray = false){
-      $this->reset();
-      $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
-      //If is the SELECT query
-      $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
+        $this->reset();
+        $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
+        //If is the SELECT query
+        $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false;
 
-      //cache expire time
-      $cacheExpire = $this->temporaryCacheTtl;
+        //cache expire time
+        $cacheExpire = $this->temporaryCacheTtl;
       
-      //return to the initial cache time
-      $this->temporaryCacheTtl = $this->cacheTtl;
+        //return to the initial cache time
+        $this->temporaryCacheTtl = $this->cacheTtl;
       
-      //config for cache
-      $cacheEnable = get_config('cache_enable');
+        //config for cache
+        $cacheEnable = get_config('cache_enable');
       
-      //the database cache content
-      $cacheContent = null;
+        //the database cache content
+        $cacheContent = null;
 
-      //if can use cache feature for this query
-      $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
+        //if can use cache feature for this query
+        $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
-          $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
-          $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
-      }
+        if ($dbCacheStatus && $isSqlSELECTQuery){
+            $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
+            $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
+        }
       
-      if ( !$cacheContent){
-  	   	//count the number of query execution to server
+        if ( !$cacheContent){
+                //count the number of query execution to server
         $this->queryCount++;
         
         $this->queryRunner->setQuery($query);
@@ -484,35 +484,35 @@ 
                                             $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray), 
                                             $this->result, 
                                             $cacheExpire
-                                          );
+                                            );
             if (! $this->result){
-              $this->logger->info('No result where found for the query [' . $query . ']');
+                $this->logger->info('No result where found for the query [' . $query . ']');
             }
-          }
+            }
+        }
+        } else if ($isSqlSELECTQuery){
+            $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+            $this->result = $cacheContent;
+            $this->numRows = count($this->result);
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
-          $this->result = $cacheContent;
-          $this->numRows = count($this->result);
-      }
-      return $this->result;
+        return $this->result;
     }
 	
 	
-	 /**
-	 * Return the database configuration
-	 * @return array
-	 */
-  	public  function getDatabaseConfiguration(){
-  	  return $this->config;
-  	}
-
-   /**
-    * Setting the database 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 database configuration file
-	  * @return object Database
-    */
+        /**
+         * Return the database configuration
+         * @return array
+         */
+        public  function getDatabaseConfiguration(){
+        return $this->config;
+        }
+
+    /**
+     * Setting the database 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 database configuration file
+     * @return object Database
+     */
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
         $db = array();
         if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
@@ -525,50 +525,50 @@ 
         
         //default configuration
         $config = array(
-          'driver' => 'mysql',
-          'username' => 'root',
-          'password' => '',
-          'database' => '',
-          'hostname' => 'localhost',
-          'charset' => 'utf8',
-          'collation' => 'utf8_general_ci',
-          'prefix' => '',
-          'port' => ''
+            'driver' => 'mysql',
+            'username' => 'root',
+            'password' => '',
+            'database' => '',
+            'hostname' => 'localhost',
+            'charset' => 'utf8',
+            'collation' => 'utf8_general_ci',
+            'prefix' => '',
+            'port' => ''
         );
 		
-    	$config = array_merge($config, $db);
-    	//determine the port using the hostname like localhost:3307
-      //hostname will be "localhost", and port "3307"
-      $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
-  		  $config['hostname'] = $p[0];
-  		  $config['port'] = $p[1];
-  		}
+        $config = array_merge($config, $db);
+        //determine the port using the hostname like localhost:3307
+        //hostname will be "localhost", and port "3307"
+        $p = explode(':', $config['hostname']);
+        if (count($p) >= 2){
+            $config['hostname'] = $p[0];
+            $config['port'] = $p[1];
+            }
 		
-		 $this->databaseName = $config['database'];
-		 $this->config = $config;
-		 $this->logger->info(
-								'The database configuration are listed below: ' 
-								. stringfy_vars(array_merge(
-															$this->config, 
-															array('password' => string_hidden($this->config['password']))
-												))
-							);
+            $this->databaseName = $config['database'];
+            $this->config = $config;
+            $this->logger->info(
+                                'The database configuration are listed below: ' 
+                                . stringfy_vars(array_merge(
+                                                            $this->config, 
+                                                            array('password' => string_hidden($this->config['password']))
+                                                ))
+                            );
 	  
-		 //Now connect to the database
-		 $this->connect();
+            //Now connect to the database
+            $this->connect();
 		 
-     //do update of QueryRunner and Builder
-     $this->updateQueryBuilderAndRunnerProperties();
+        //do update of QueryRunner and Builder
+        $this->updateQueryBuilderAndRunnerProperties();
 
-		 return $this;
+            return $this;
     }
 
     /**
      * Close the connexion
      */
     public function close(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
     /**
@@ -576,18 +576,18 @@ 
      * @return void
      */
     protected function updateQueryBuilderAndRunnerProperties(){
-       //update queryBuilder with some properties needed
-     if(is_object($this->queryBuilder)){
+        //update queryBuilder with some properties needed
+        if(is_object($this->queryBuilder)){
         $this->queryBuilder->setDriver($this->config['driver']);
         $this->queryBuilder->setPrefix($this->config['prefix']);
         $this->queryBuilder->setPdo($this->pdo);
-     }
+        }
 
-      //update queryRunner with some properties needed
-     if(is_object($this->queryRunner)){
+        //update queryRunner with some properties needed
+        if(is_object($this->queryRunner)){
         $this->queryRunner->setDriver($this->config['driver']);
         $this->queryRunner->setPdo($this->pdo);
-     }
+        }
     }
 	
 
@@ -596,24 +596,24 @@ 
      * @return string the DSN string
      */
     protected function getDsnFromDriver(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         $driver = $config['driver'];
         $driverDsnMap = array(
-                              'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
-                                          . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '') 
-                                          . 'dbname=' . $config['database'],
-                              'pgsql' => 'pgsql:host=' . $config['hostname'] . ';' 
-                                          . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '')
-                                          . 'dbname=' . $config['database'],
-                              'sqlite' => 'sqlite:' . $config['database'],
-                              'oracle' => 'oci:dbname=' . $config['hostname'] 
+                                'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
+                                            . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '') 
+                                            . 'dbname=' . $config['database'],
+                                'pgsql' => 'pgsql:host=' . $config['hostname'] . ';' 
+                                            . (($config['port']) != '' ? 'port=' . $config['port'] . ';' : '')
+                                            . 'dbname=' . $config['database'],
+                                'sqlite' => 'sqlite:' . $config['database'],
+                                'oracle' => 'oci:dbname=' . $config['hostname'] 
                                             . (($config['port']) != '' ? ':' . $config['port'] : '')
                                             . '/' . $config['database']
-                              );
+                                );
         return isset($driverDsnMap[$driver]) ? $driverDsnMap[$driver] : '';
-      }                   
-      return null;
+        }                   
+        return null;
     }
 
     /**
@@ -625,11 +625,11 @@ 
     protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
         if (! is_object($this->cacheInstance)){
-    			//can not call method with reference in argument
-    			//like $this->setCacheInstance(& get_instance()->cache);
-    			//use temporary variable
-    			$instance = & get_instance()->cache;
-    			$this->cacheInstance = $instance;
+                //can not call method with reference in argument
+                //like $this->setCacheInstance(& get_instance()->cache);
+                //use temporary variable
+                $instance = & get_instance()->cache;
+                $this->cacheInstance = $instance;
         }
         return $this->cacheInstance->get($cacheKey);
     }
@@ -641,87 +641,87 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
+        protected function setCacheContentForQuery($query, $key, $result, $expire){
         $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
         if (! is_object($this->cacheInstance)){
-  				//can not call method with reference in argument
-  				//like $this->setCacheInstance(& get_instance()->cache);
-  				//use temporary variable
-  				$instance = & get_instance()->cache;
-  				$this->cacheInstance = $instance;
-  			}
+                    //can not call method with reference in argument
+                    //like $this->setCacheInstance(& get_instance()->cache);
+                    //use temporary variable
+                    $instance = & get_instance()->cache;
+                    $this->cacheInstance = $instance;
+                }
         $this->cacheInstance->set($key, $result, $expire);
-     }
+        }
 
     
-	 /**
-     * Return the cache key for the given query
-     * @see Database::query
-     * 
-     *  @return string
-     */
+        /**
+         * Return the cache key for the given query
+         * @see Database::query
+         * 
+         *  @return string
+         */
     protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
-      return md5($query . $returnAsList . $returnAsArray);
+        return md5($query . $returnAsList . $returnAsArray);
     }
     
-	   /**
-     * Set the Log instance using argument or create new instance
-     * @param object $logger the Log instance if not null
-     */
+        /**
+         * 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){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::Database');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Database');
+        }
     }
 	
-   /**
-   * Set the DatabaseQueryBuilder instance using argument or create new instance
-   * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
-   */
-	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
-	  if ($queryBuilder !== null){
+    /**
+     * Set the DatabaseQueryBuilder instance using argument or create new instance
+     * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
+     */
+    protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
+        if ($queryBuilder !== null){
         $this->queryBuilder = $queryBuilder;
-	  }
-	  else{
-		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
-	  }
-	}
-
-  /**
-   * Set the DatabaseQueryRunner instance using argument or create new instance
-   * @param object $queryRunner the DatabaseQueryRunner instance if not null
-   */
-  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
+        }
+        else{
+            $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
+        }
+    }
+
+    /**
+     * Set the DatabaseQueryRunner instance using argument or create new instance
+     * @param object $queryRunner the DatabaseQueryRunner instance if not null
+     */
+    protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
     if ($queryRunner !== null){
         $this->queryRunner = $queryRunner;
     }
     else{
-      $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+        $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+    }
     }
-  }
 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
     private function reset(){
-	   //query builder reset
-      $this->getQueryBuilder()->reset();
-      $this->numRows  = 0;
-      $this->insertId = null;
-      $this->query    = null;
-      $this->result   = array();
-      $this->data     = array();
+        //query builder reset
+        $this->getQueryBuilder()->reset();
+        $this->numRows  = 0;
+        $this->insertId = null;
+        $this->query    = null;
+        $this->result   = array();
+        $this->data     = array();
     }
 
     /**
      * The class destructor
      */
     public function __destruct(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
 }

Spacing +94 added lines, -94 removed lines

@@ -23,105 +23,105 @@ 
    * along with this program; if not, write to the Free Software
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
-  class Database{
+  class Database {
 	
   	/**
   	 * The PDO instance
   	 * @var object
   	*/
-    private $pdo                 = null;
+    private $pdo = null;
     
   	/**
   	 * The database name used for the application
   	 * @var string
   	*/
-	  private $databaseName        = null;
+	  private $databaseName = null;
 	
   	/**
   	 * The number of rows returned by the last query
   	 * @var int
   	*/
-    private $numRows             = 0;
+    private $numRows = 0;
 	
   	/**
   	 * The last insert id for the primary key column that have auto increment or sequence
   	 * @var mixed
   	*/
-    private $insertId            = null;
+    private $insertId = null;
 	
   	/**
   	 * The full SQL query statment after build for each command
   	 * @var string
   	*/
-    private $query               = null;
+    private $query = null;
 	
   	/**
   	 * The result returned for the last query
   	 * @var mixed
   	*/
-    private $result              = array();
+    private $result = array();
 	
   	/**
   	 * The cache default time to live in second. 0 means no need to use the cache feature
   	 * @var int
   	*/
-  	private $cacheTtl             = 0;
+  	private $cacheTtl = 0;
 	
   	/**
   	 * The cache current time to live. 0 means no need to use the cache feature
   	 * @var int
   	*/
-    private $temporaryCacheTtl   = 0;
+    private $temporaryCacheTtl = 0;
 	
   	/**
   	 * The number of executed query for the current request
   	 * @var int
   	*/
-    private $queryCount          = 0;
+    private $queryCount = 0;
 	
   	/**
   	 * The default data to be used in the statments query INSERT, UPDATE
   	 * @var array
   	*/
-    private $data                = array();
+    private $data = array();
 	
   	/**
   	 * The database configuration
   	 * @var array
   	*/
-    private $config              = array();
+    private $config = array();
 	
   	/**
   	 * The logger instance
   	 * @var object
   	 */
-    private $logger              = null;
+    private $logger = null;
 
     /**
     * The cache instance
     * @var object
     */
-    private $cacheInstance       = null;
+    private $cacheInstance = null;
 
     
   	/**
     * The DatabaseQueryBuilder instance
     * @var object
     */
-    private $queryBuilder        = null;
+    private $queryBuilder = null;
     
     /**
     * The DatabaseQueryRunner instance
     * @var object
     */
-    private $queryRunner         = null;
+    private $queryRunner = null;
 
 
     /**
      * Construct new database
      * @param array $overwriteConfig the config to overwrite with the config set in database.php
      */
-    public function __construct($overwriteConfig = array()){
+    public function __construct($overwriteConfig = array()) {
         //Set Log instance to use
         $this->setLoggerFromParamOrCreateNewInstance(null);
 		
@@ -142,17 +142,17 @@ 
      * This is used to connect to database
      * @return bool 
      */
-    public function connect(){
+    public function connect() {
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
-        try{
+      if (!empty($config)) {
+        try {
             $this->pdo = new PDO($this->getDsnFromDriver(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
           }
-          catch (PDOException $e){
+          catch (PDOException $e) {
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -166,7 +166,7 @@ 
      * Return the number of rows returned by the current query
      * @return int
      */
-    public function numRows(){
+    public function numRows() {
       return $this->numRows;
     }
 
@@ -174,7 +174,7 @@ 
      * Return the last insert id value
      * @return mixed
      */
-    public function insertId(){
+    public function insertId() {
       return $this->insertId;
     }
 
@@ -185,10 +185,10 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function get($returnSQLQueryOrResultType = false){
+    public function get($returnSQLQueryOrResultType = false) {
       $this->getQueryBuilder()->limit(1);
       $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+      if ($returnSQLQueryOrResultType === true) {
         return $query;
       } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
@@ -201,9 +201,9 @@ 
      * If is string will determine the result type "array" or "object"
      * @return mixed       the query SQL string or the record result
      */
-    public function getAll($returnSQLQueryOrResultType = false){
+    public function getAll($returnSQLQueryOrResultType = false) {
 	   $query = $this->getQueryBuilder()->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
+	   if ($returnSQLQueryOrResultType === true) {
       	return $query;
       }
       return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
@@ -215,18 +215,18 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the insert id of the new record or null
      */
-    public function insert($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+    public function insert($data = array(), $escape = true) {
+      if (empty($data) && $this->getData()) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
       }
       $query = $this->getQueryBuilder()->insert($data, $escape)->getQuery();
       $result = $this->query($query);
-      if ($result){
+      if ($result) {
         $this->insertId = $this->pdo->lastInsertId();
 		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
-        return ! $this->insertId() ? true : $this->insertId();
+        return !$this->insertId() ? true : $this->insertId();
       }
       return false;
     }
@@ -237,8 +237,8 @@ 
      * @param  boolean $escape  whether to escape or not the values
      * @return mixed          the update status
      */
-    public function update($data = array(), $escape = true){
-      if (empty($data) && $this->getData()){
+    public function update($data = array(), $escape = true) {
+      if (empty($data) && $this->getData()) {
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->getData();
@@ -251,7 +251,7 @@ 
      * Delete the record in database
      * @return mixed the delete status
      */
-    public function delete(){
+    public function delete() {
 		$query = $this->getQueryBuilder()->delete()->getQuery();
     	return $this->query($query);
     }
@@ -261,8 +261,8 @@ 
      * @param integer $ttl the cache time to live in second
      * @return object        the current Database instance
      */
-    public function setCache($ttl = 0){
-      if ($ttl > 0){
+    public function setCache($ttl = 0) {
+      if ($ttl > 0) {
         $this->cacheTtl = $ttl;
         $this->temporaryCacheTtl = $ttl;
       }
@@ -274,8 +274,8 @@ 
 	 * @param  integer $ttl the cache time to live in second
 	 * @return object        the current Database instance
 	 */
-  	public function cached($ttl = 0){
-        if ($ttl > 0){
+  	public function cached($ttl = 0) {
+        if ($ttl > 0) {
           $this->temporaryCacheTtl = $ttl;
         }
         return $this;
@@ -287,7 +287,7 @@ 
      * @param boolean $escaped whether we can do escape of not 
      * @return mixed       the data after escaped or the same data if not
      */
-    public function escape($data, $escaped = true){
+    public function escape($data, $escaped = true) {
       return $escaped ? 
                       $this->pdo->quote(trim($data)) 
                       : $data; 
@@ -297,7 +297,7 @@ 
      * Return the number query executed count for the current request
      * @return int
      */
-    public function queryCount(){
+    public function queryCount() {
       return $this->queryCount;
     }
 
@@ -305,7 +305,7 @@ 
      * Return the current query SQL string
      * @return string
      */
-    public function getQuery(){
+    public function getQuery() {
       return $this->query;
     }
 
@@ -313,7 +313,7 @@ 
      * Return the application database name
      * @return string
      */
-    public function getDatabaseName(){
+    public function getDatabaseName() {
       return $this->databaseName;
     }
 
@@ -321,7 +321,7 @@ 
      * Return the PDO instance
      * @return object
      */
-    public function getPdo(){
+    public function getPdo() {
       return $this->pdo;
     }
 
@@ -330,7 +330,7 @@ 
      * @param object $pdo the pdo object
 	 * @return object Database
      */
-    public function setPdo(PDO $pdo){
+    public function setPdo(PDO $pdo) {
       $this->pdo = $pdo;
       return $this;
     }
@@ -340,7 +340,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -349,7 +349,7 @@ 
      * @param Log $logger the log object
 	 * @return object Database
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -358,7 +358,7 @@ 
      * Return the cache instance
      * @return CacheInterface
      */
-    public function getCacheInstance(){
+    public function getCacheInstance() {
       return $this->cacheInstance;
     }
 
@@ -367,7 +367,7 @@ 
      * @param CacheInterface $cache the cache object
 	 * @return object Database
      */
-    public function setCacheInstance($cache){
+    public function setCacheInstance($cache) {
       $this->cacheInstance = $cache;
       return $this;
     }
@@ -377,7 +377,7 @@ 
      * Return the DatabaseQueryBuilder instance
      * @return object DatabaseQueryBuilder
      */
-    public function getQueryBuilder(){
+    public function getQueryBuilder() {
       return $this->queryBuilder;
     }
 
@@ -385,7 +385,7 @@ 
      * Set the DatabaseQueryBuilder instance
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
-    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
+    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder) {
       $this->queryBuilder = $queryBuilder;
       return $this;
     }
@@ -394,7 +394,7 @@ 
      * Return the DatabaseQueryRunner instance
      * @return object DatabaseQueryRunner
      */
-    public function getQueryRunner(){
+    public function getQueryRunner() {
       return $this->queryRunner;
     }
 
@@ -402,7 +402,7 @@ 
      * Set the DatabaseQueryRunner instance
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
-    public function setQueryRunner(DatabaseQueryRunner $queryRunner){
+    public function setQueryRunner(DatabaseQueryRunner $queryRunner) {
       $this->queryRunner = $queryRunner;
       return $this;
     }
@@ -411,7 +411,7 @@ 
      * Return the data to be used for insert, update, etc.
      * @return array
      */
-    public function getData(){
+    public function getData() {
       return $this->data;
     }
 
@@ -422,9 +422,9 @@ 
      * @param boolean $escape whether to escape or not the $value
      * @return object        the current Database instance
      */
-    public function setData($key, $value = null, $escape = true){
-  	  if(is_array($key)){
-    		foreach($key as $k => $v){
+    public function setData($key, $value = null, $escape = true) {
+  	  if (is_array($key)) {
+    		foreach ($key as $k => $v) {
     			$this->setData($k, $v, $escape);
     		}	
   	  } else {
@@ -440,7 +440,7 @@ 
      * @param  boolean $returnAsArray return the result as array or not
      * @return mixed         the query result
      */
-    public function query($query, $returnAsList = true, $returnAsArray = false){
+    public function query($query, $returnAsList = true, $returnAsArray = false) {
       $this->reset();
       $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
       //If is the SELECT query
@@ -461,12 +461,12 @@ 
       //if can use cache feature for this query
       $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
     
-      if ($dbCacheStatus && $isSqlSELECTQuery){
+      if ($dbCacheStatus && $isSqlSELECTQuery) {
           $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
           $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
       }
       
-      if ( !$cacheContent){
+      if (!$cacheContent) {
   	   	//count the number of query execution to server
         $this->queryCount++;
         
@@ -475,23 +475,23 @@ 
         $this->queryRunner->setReturnAsArray($returnAsArray);
         
         $queryResult = $this->queryRunner->execute();
-        if (is_object($queryResult)){
+        if (is_object($queryResult)) {
             $this->result  = $queryResult->getResult();
             $this->numRows = $queryResult->getNumRows();
-            if ($isSqlSELECTQuery && $dbCacheStatus){
+            if ($isSqlSELECTQuery && $dbCacheStatus) {
                 $this->setCacheContentForQuery(
                                             $this->query, 
                                             $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray), 
                                             $this->result, 
                                             $cacheExpire
                                           );
-            if (! $this->result){
+            if (!$this->result) {
               $this->logger->info('No result where found for the query [' . $query . ']');
             }
           }
         }
-      } else if ($isSqlSELECTQuery){
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
+      } else if ($isSqlSELECTQuery) {
+          $this->logger->info('The result for query [' . $this->query . '] already cached use it');
           $this->result = $cacheContent;
           $this->numRows = count($this->result);
       }
@@ -503,7 +503,7 @@ 
 	 * Return the database configuration
 	 * @return array
 	 */
-  	public  function getDatabaseConfiguration(){
+  	public  function getDatabaseConfiguration() {
   	  return $this->config;
   	}
 
@@ -513,9 +513,9 @@ 
     * @param boolean $useConfigFile whether to use database configuration file
 	  * @return object Database
     */
-    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true){
+    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true) {
         $db = array();
-        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')) {
             //here don't use require_once because somewhere user can create database instance directly
             require CONFIG_PATH . 'database.php';
         }
@@ -540,7 +540,7 @@ 
     	//determine the port using the hostname like localhost:3307
       //hostname will be "localhost", and port "3307"
       $p = explode(':', $config['hostname']);
-  	  if (count($p) >= 2){
+  	  if (count($p) >= 2) {
   		  $config['hostname'] = $p[0];
   		  $config['port'] = $p[1];
   		}
@@ -567,7 +567,7 @@ 
     /**
      * Close the connexion
      */
-    public function close(){
+    public function close() {
       $this->pdo = null;
     }
 
@@ -575,16 +575,16 @@ 
      * Update the DatabaseQueryBuilder and DatabaseQueryRunner properties
      * @return void
      */
-    protected function updateQueryBuilderAndRunnerProperties(){
+    protected function updateQueryBuilderAndRunnerProperties() {
        //update queryBuilder with some properties needed
-     if(is_object($this->queryBuilder)){
+     if (is_object($this->queryBuilder)) {
         $this->queryBuilder->setDriver($this->config['driver']);
         $this->queryBuilder->setPrefix($this->config['prefix']);
         $this->queryBuilder->setPdo($this->pdo);
      }
 
       //update queryRunner with some properties needed
-     if(is_object($this->queryRunner)){
+     if (is_object($this->queryRunner)) {
         $this->queryRunner->setDriver($this->config['driver']);
         $this->queryRunner->setPdo($this->pdo);
      }
@@ -595,9 +595,9 @@ 
      * This method is used to get the PDO DSN string using the configured driver
      * @return string the DSN string
      */
-    protected function getDsnFromDriver(){
+    protected function getDsnFromDriver() {
       $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+      if (!empty($config)) {
         $driver = $config['driver'];
         $driverDsnMap = array(
                               'mysql' => 'mysql:host=' . $config['hostname'] . ';' 
@@ -622,9 +622,9 @@ 
      *      
      * @return mixed
      */
-    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray) {
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
-        if (! is_object($this->cacheInstance)){
+        if (!is_object($this->cacheInstance)) {
     			//can not call method with reference in argument
     			//like $this->setCacheInstance(& get_instance()->cache);
     			//use temporary variable
@@ -641,9 +641,9 @@ 
      * @param mixed $result the query result to save
      * @param int $expire the cache TTL
      */
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
-        $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
-        if (! is_object($this->cacheInstance)){
+     protected function setCacheContentForQuery($query, $key, $result, $expire) {
+        $this->logger->info('Save the result for query [' . $query . '] into cache for future use');
+        if (!is_object($this->cacheInstance)) {
   				//can not call method with reference in argument
   				//like $this->setCacheInstance(& get_instance()->cache);
   				//use temporary variable
@@ -660,7 +660,7 @@ 
      * 
      *  @return string
      */
-    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
+    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray) {
       return md5($query . $returnAsList . $returnAsArray);
     }
     
@@ -668,12 +668,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::Database');
       }
     }
@@ -682,12 +682,12 @@ 
    * Set the DatabaseQueryBuilder instance using argument or create new instance
    * @param object $queryBuilder the DatabaseQueryBuilder instance if not null
    */
-	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
-	  if ($queryBuilder !== null){
+	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null) {
+	  if ($queryBuilder !== null) {
         $this->queryBuilder = $queryBuilder;
 	  }
-	  else{
-		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
+	  else {
+		  $this->queryBuilder = & class_loader('DatabaseQueryBuilder', 'classes/database');
 	  }
 	}
 
@@ -695,19 +695,19 @@ 
    * Set the DatabaseQueryRunner instance using argument or create new instance
    * @param object $queryRunner the DatabaseQueryRunner instance if not null
    */
-  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
-    if ($queryRunner !== null){
+  protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null) {
+    if ($queryRunner !== null) {
         $this->queryRunner = $queryRunner;
     }
-    else{
-      $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
+    else {
+      $this->queryRunner = & class_loader('DatabaseQueryRunner', 'classes/database');
     }
   }
 
     /**
      * Reset the database class attributs to the initail values before each query.
      */
-    private function reset(){
+    private function reset() {
 	   //query builder reset
       $this->getQueryBuilder()->reset();
       $this->numRows  = 0;
@@ -720,7 +720,7 @@ 
     /**
      * The class destructor
      */
-    public function __destruct(){
+    public function __destruct() {
       $this->pdo = null;
     }
 

Braces +4 added lines, -8 removed lines

@@ -151,8 +151,7 @@ 
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
             $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
             return true;
-          }
-          catch (PDOException $e){
+          } catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
@@ -671,8 +670,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::Database');
       }
@@ -685,8 +683,7 @@ 
 	protected function setQueryBuilderFromParamOrCreateNewInstance(DatabaseQueryBuilder $queryBuilder = null){
 	  if ($queryBuilder !== null){
         $this->queryBuilder = $queryBuilder;
-	  }
-	  else{
+	  } else{
 		  $this->queryBuilder =& class_loader('DatabaseQueryBuilder', 'classes/database');
 	  }
 	}
@@ -698,8 +695,7 @@ 
   protected function setQueryRunnerFromParamOrCreateNewInstance(DatabaseQueryRunner $queryRunner = null){
     if ($queryRunner !== null){
         $this->queryRunner = $queryRunner;
-    }
-    else{
+    } else{
       $this->queryRunner =& class_loader('DatabaseQueryRunner', 'classes/database');
     }
   }

core/classes/Router.php

Indentation +378 added lines, -378 removed lines

@@ -1,393 +1,393 @@ 
 <?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 Router {
+    class Router {
 		
-		/**
-		* @var array $pattern: The list of URIs to validate against
-		*/
-		private $pattern = array();
+        /**
+         * @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 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 $uriTrim: The char to remove from the URIs
+         */
+        protected $uriTrim = '/\^$';
 
-		/**
-		 * The module name of the current request
-		 * @var string
-		 */
-		protected $module = null;
+        /**
+         * 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 name of the current request
+         * @var string
+         */
+        protected $controller = null;
 
-		/**
-		 * The controller path
-		 * @var string
-		 */
-		protected $controllerPath = null;
+        /**
+         * The controller path
+         * @var string
+         */
+        protected $controllerPath = null;
 
-		/**
-		 * The method name. The default value is "index"
-		 * @var string
-		 */
-		protected $method = 'index';
+        /**
+         * 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 argument to pass to the method
+         * @var array
+         */
+        protected $args = array();
 
-		/**
-		 * List of routes configurations
-		 * @var array
-		 */
-		protected $routes = array();
+        /**
+         * List of routes configurations
+         * @var array
+         */
+        protected $routes = array();
 
-		/**
-		 * The segments array for the current request
-		 * @var array
-		 */
-		protected $segments;
+        /**
+         * The segments array for the current request
+         * @var array
+         */
+        protected $segments;
 
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private $logger;
 
-		/**
-		 * Construct the new Router instance
-		 */
-		public function __construct(){
-			$this->setLoggerFromParamOrCreateNewInstance(null);
+        /**
+         * 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));
+            //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 parameters
-			$this->setRouteParams();
-		}
+            //Set route parameters
+            $this->setRouteParams();
+        }
 
-		/**
-		* Add the URI and callback to the list of URIs to validate
-		*
-		* @param string $uri the request URI
-		* @param object $callback the callback function
-		*/
-		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;
-		}
+        /**
+         * Add the URI and callback to the list of URIs to validate
+         *
+         * @param string $uri the request URI
+         * @param object $callback the callback function
+         */
+        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;
+        }
 
-		/**
-		 * Get the module name
-		 * @return string
-		 */
-		public function getModule(){
-			return $this->module;
-		}
+        /**
+         * 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 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 file path
+         * @return string
+         */
+        public function getControllerPath(){
+            return $this->controllerPath;
+        }
 
-		/**
-		 * Get the controller method
-		 * @return string
-		 */
-		public function getMethod(){
-			return $this->method;
-		}
+        /**
+         * 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 request arguments
+         * @return array
+         */
+        public function getArgs(){
+            return $this->args;
+        }
 
-		/**
-		 * Get the URL segments array
-		 * @return array
-		 */
-		public function getSegments(){
-			return $this->segments;
-		}
+        /**
+         * Get the URL segments array
+         * @return array
+         */
+        public function getSegments(){
+            return $this->segments;
+        }
 
-		/**
-		 * Routing the request to the correspondant module/controller/method if exists
-		 * otherwise send 404 error.
-		 */
-		public function run() {
-			$benchmark =& class_loader('Benchmark');
-			$benchmark->mark('ROUTING_PROCESS_START');
-			$this->logger->debug('Routing process start ...');
-			$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;
-			}
-			else{
-				$this->logger->info('The request URI does not contain the front controller');
-			}
-			$uri = implode('/', $segment);
-			$this->logger->info('The final Request URI is [' . $uri . ']' );
-			//generic routes
-			$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->getController() && $this->getModule()){
-				$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->getModule();
-			}
-			//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->getController()){
-				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
-				$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(! $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->getController()), $this->getModule());
-								if(! $path){
-									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
-									$this->controller = $this->getModule();
-								}
-								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->getController() && $this->getModule()){
-				$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->getModule();
-			}
-			//did we set the controller, so set the controller path
-			if($this->getController() && ! $this->getControllerPath()){
-				$this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
-				//if it is the module controller
-				if($this->getModule()){
-					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-				}
-				else{
-					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
-				}
-			}
-			$controller = ucfirst($this->getController());
-			$this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
-			$classFilePath = $this->getControllerPath();
-			$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
-			$benchmark->mark('ROUTING_PROCESS_END');
-			$e404 = false;
-			if(file_exists($classFilePath)){
-				require_once $classFilePath;
-				if(! class_exists($controller, false)){
-					$e404 = true;
-					$this->logger->info('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->info('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->getArgs());
-						$obj = & get_instance();
-						//render the final page to user
-						$this->logger->info('Render the final output to the browser');
-						$obj->response->renderFinalPage();
-					}
-				}
-			}
-			else{
-				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
-				$e404 = true;
-			}
-			if($e404){
-				$response =& class_loader('Response', 'classes');
-				$response->send404();
-			}
-		}
+        /**
+         * Routing the request to the correspondant module/controller/method if exists
+         * otherwise send 404 error.
+         */
+        public function run() {
+            $benchmark =& class_loader('Benchmark');
+            $benchmark->mark('ROUTING_PROCESS_START');
+            $this->logger->debug('Routing process start ...');
+            $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;
+            }
+            else{
+                $this->logger->info('The request URI does not contain the front controller');
+            }
+            $uri = implode('/', $segment);
+            $this->logger->info('The final Request URI is [' . $uri . ']' );
+            //generic routes
+            $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->getController() && $this->getModule()){
+                $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->getModule();
+            }
+            //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->getController()){
+                $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
+                $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(! $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->getController()), $this->getModule());
+                                if(! $path){
+                                    $this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
+                                    $this->controller = $this->getModule();
+                                }
+                                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->getController() && $this->getModule()){
+                $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->getModule();
+            }
+            //did we set the controller, so set the controller path
+            if($this->getController() && ! $this->getControllerPath()){
+                $this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
+                //if it is the module controller
+                if($this->getModule()){
+                    $this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
+                }
+                else{
+                    $this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
+                }
+            }
+            $controller = ucfirst($this->getController());
+            $this->logger->info('The routing information are: module [' . $this->getModule() . '], controller [' . $controller . '], method [' . $this->getMethod() . '], args [' . stringfy_vars($this->args) . ']');
+            $classFilePath = $this->getControllerPath();
+            $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
+            $benchmark->mark('ROUTING_PROCESS_END');
+            $e404 = false;
+            if(file_exists($classFilePath)){
+                require_once $classFilePath;
+                if(! class_exists($controller, false)){
+                    $e404 = true;
+                    $this->logger->info('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->info('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->getArgs());
+                        $obj = & get_instance();
+                        //render the final page to user
+                        $this->logger->info('Render the final output to the browser');
+                        $obj->response->renderFinalPage();
+                    }
+                }
+            }
+            else{
+                $this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
+                $e404 = true;
+            }
+            if($e404){
+                $response =& class_loader('Response', 'classes');
+                $response->send404();
+            }
+        }
 
-	/**
+    /**
      * Return the Log instance
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object
+     * @return object
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
 
     /**
-    * 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
-    */
+     * 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')){
@@ -395,45 +395,45 @@ 
         }
         $route = array_merge($route, $overwriteConfig);
         $this->routes = $route;
-		return $this;
+        return $this;
     }
 
     /**
      * Set the route paramaters using the configuration
      */
     protected function setRouteParams(){
-    	//adding route
-		foreach($this->routes as $pattern => $callback){
-			$this->add($pattern, $callback);
-		}
+        //adding route
+        foreach($this->routes as $pattern => $callback){
+            $this->add($pattern, $callback);
+        }
 		
-		//here use directly the variable $_SERVER
-		$uri = isset($_SERVER['REQUEST_URI']) ? $_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 . ']' );
-			$uri = str_ireplace($suffix, '', $uri);
-		} 
-		if (strpos($uri, '?') !== false){
-			$uri = substr($uri, 0, strpos($uri, '?'));
-		}
-		$uri = trim($uri, $this->uriTrim);
-		$this->segments = explode('/', $uri);
-	}
+        //here use directly the variable $_SERVER
+        $uri = isset($_SERVER['REQUEST_URI']) ? $_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 . ']' );
+            $uri = str_ireplace($suffix, '', $uri);
+        } 
+        if (strpos($uri, '?') !== false){
+            $uri = substr($uri, 0, strpos($uri, '?'));
+        }
+        $uri = trim($uri, $this->uriTrim);
+        $this->segments = explode('/', $uri);
+    }
 
-	/**
+    /**
      * 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){
+        if ($logger !== null){
         $this->logger = $logger;
-      }
-      else{
-          $this->logger =& class_loader('Log', 'classes');
-          $this->logger->setLogger('Library::Router');
-      }
+        }
+        else{
+            $this->logger =& class_loader('Log', 'classes');
+            $this->logger->setLogger('Library::Router');
+        }
     }
 }

Spacing +60 added lines, -60 removed lines

@@ -92,13 +92,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 @@ 
 		*/
 		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;
@@ -128,7 +128,7 @@ 
 		 * Get the module name
 		 * @return string
 		 */
-		public function getModule(){
+		public function getModule() {
 			return $this->module;
 		}
 		
@@ -136,7 +136,7 @@ 
 		 * Get the controller name
 		 * @return string
 		 */
-		public function getController(){
+		public function getController() {
 			return $this->controller;
 		}
 
@@ -144,7 +144,7 @@ 
 		 * Get the controller file path
 		 * @return string
 		 */
-		public function getControllerPath(){
+		public function getControllerPath() {
 			return $this->controllerPath;
 		}
 
@@ -152,7 +152,7 @@ 
 		 * Get the controller method
 		 * @return string
 		 */
-		public function getMethod(){
+		public function getMethod() {
 			return $this->method;
 		}
 
@@ -160,7 +160,7 @@ 
 		 * Get the request arguments
 		 * @return array
 		 */
-		public function getArgs(){
+		public function getArgs() {
 			return $this->args;
 		}
 
@@ -168,7 +168,7 @@ 
 		 * Get the URL segments array
 		 * @return array
 		 */
-		public function getSegments(){
+		public function getSegments() {
 			return $this->segments;
 		}
 
@@ -177,27 +177,27 @@ 
 		 * otherwise send 404 error.
 		 */
 		public function run() {
-			$benchmark =& class_loader('Benchmark');
+			$benchmark = & class_loader('Benchmark');
 			$benchmark->mark('ROUTING_PROCESS_START');
 			$this->logger->debug('Routing process start ...');
 			$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;
 			}
-			else{
+			else {
 				$this->logger->info('The request URI does not contain the front controller');
 			}
 			$uri = implode('/', $segment);
-			$this->logger->info('The final Request URI is [' . $uri . ']' );
+			$this->logger->info('The final Request URI is [' . $uri . ']');
 			//generic routes
 			$pattern = array(':num', ':alpha', ':alnum', ':any');
 			$replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*');
@@ -211,20 +211,20 @@ 
 					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]. ']');
+					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;
@@ -234,73 +234,73 @@ 
 				}
 			}
 			//first if the controller is not set and the module is set use the module name as the controller
-			if(! $this->getController() && $this->getModule()){
+			if (!$this->getController() && $this->getModule()) {
 				$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->getModule();
 			}
 			//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->getController()){
+			if (!$this->getController()) {
 				$this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters');
 				$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(! $modules){
+					if (!$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->getController()), $this->getModule());
-								if(! $path){
+								if (!$path) {
 									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
 									$this->controller = $this->getModule();
 								}
-								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);
 							}
@@ -310,18 +310,18 @@ 
 					}
 				}
 			}
-			if(! $this->getController() && $this->getModule()){
+			if (!$this->getController() && $this->getModule()) {
 				$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->getModule();
 			}
 			//did we set the controller, so set the controller path
-			if($this->getController() && ! $this->getControllerPath()){
+			if ($this->getController() && !$this->getControllerPath()) {
 				$this->logger->debug('Setting the file path for the controller [' . $this->getController() . ']');
 				//if it is the module controller
-				if($this->getModule()){
+				if ($this->getModule()) {
 					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
 				}
-				else{
+				else {
 					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
 				}
 			}
@@ -331,20 +331,20 @@ 
 			$this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...');
 			$benchmark->mark('ROUTING_PROCESS_END');
 			$e404 = false;
-			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->info('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']');
+					$this->logger->info('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->info('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->getArgs());
 						$obj = & get_instance();
@@ -354,12 +354,12 @@ 
 					}
 				}
 			}
-			else{
+			else {
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
-			if($e404){
-				$response =& class_loader('Response', 'classes');
+			if ($e404) {
+				$response = & class_loader('Response', 'classes');
 				$response->send404();
 			}
 		}
@@ -368,7 +368,7 @@ 
      * Return the Log instance
      * @return Log
      */
-    public function getLogger(){
+    public function getLogger() {
       return $this->logger;
     }
 
@@ -377,7 +377,7 @@ 
      * @param Log $logger the log object
 	 * @return object
      */
-    public function setLogger($logger){
+    public function setLogger($logger) {
       $this->logger = $logger;
       return $this;
     }
@@ -388,9 +388,9 @@ 
     * @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);
@@ -401,9 +401,9 @@ 
     /**
      * Set the route paramaters using the configuration
      */
-    protected function setRouteParams(){
+    protected function setRouteParams() {
     	//adding route
-		foreach($this->routes as $pattern => $callback){
+		foreach ($this->routes as $pattern => $callback) {
 			$this->add($pattern, $callback);
 		}
 		
@@ -413,10 +413,10 @@ 
 		//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 . ']');
 			$uri = str_ireplace($suffix, '', $uri);
 		} 
-		if (strpos($uri, '?') !== false){
+		if (strpos($uri, '?') !== false) {
 			$uri = substr($uri, 0, strpos($uri, '?'));
 		}
 		$uri = trim($uri, $this->uriTrim);
@@ -427,12 +427,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 +10 added lines, -20 removed lines

@@ -192,8 +192,7 @@ 
 				$this->logger->info('The request URI contains the front controller');
 				array_shift($segment);
 				$this->segments = $segment;
-			}
-			else{
+			} else{
 				$this->logger->info('The request URI does not contain the front controller');
 			}
 			$uri = implode('/', $segment);
@@ -215,8 +214,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]);
 					}
@@ -263,8 +261,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] . ']');
@@ -278,8 +275,7 @@ 
 								if(! $path){
 									$this->logger->info('The controller [' . $this->getController() . '] not found in the module, may be will use the module [' . $this->getModule() . '] as controller');
 									$this->controller = $this->getModule();
-								}
-								else{
+								} else{
 									$this->controllerPath = $path;
 									array_shift($segment);
 								}
@@ -291,8 +287,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])){
@@ -320,8 +315,7 @@ 
 				//if it is the module controller
 				if($this->getModule()){
 					$this->controllerPath = Module::findControllerFullPath(ucfirst($this->getController()), $this->getModule());
-				}
-				else{
+				} else{
 					$this->controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->getController()) . '.php';
 				}
 			}
@@ -336,15 +330,13 @@ 
 				if(! class_exists($controller, false)){
 					$e404 = true;
 					$this->logger->info('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->info('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->getArgs());
 						$obj = & get_instance();
@@ -353,8 +345,7 @@ 
 						$obj->response->renderFinalPage();
 					}
 				}
-			}
-			else{
+			} else{
 				$this->logger->info('The controller file path [' . $classFilePath . '] does not exist');
 				$e404 = true;
 			}
@@ -430,8 +421,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/Log.php

Indentation +236 added lines, -236 removed lines

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

Spacing +33 added lines, -33 removed lines

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

Braces +9 added lines, -18 removed lines

@@ -215,20 +215,15 @@ 
 			//the default value is NONE, so means no need test for NONE
 			if($level == 'fatal'){
 				$value = self::FATAL;
-			}
-			else if($level == 'error'){
+			} else if($level == 'error'){
 				$value = self::ERROR;
-			}
-			else if($level == 'warning' || $level == 'warn'){
+			} else if($level == 'warning' || $level == 'warn'){
 				$value = self::WARNING;
-			}
-			else if($level == 'info'){
+			} else if($level == 'info'){
 				$value = self::INFO;
-			}
-			else if($level == 'debug'){
+			} else if($level == 'debug'){
 				$value = self::DEBUG;
-			}
-			else if($level == 'all'){
+			} else if($level == 'all'){
 				$value = self::ALL;
 			}
 			return $value;
@@ -245,17 +240,13 @@ 
 			//the default value is NONE, so means no need test for NONE
 			if($level == self::FATAL){
 				$value = 'FATAL';
-			}
-			else if($level == self::ERROR){
+			} else if($level == self::ERROR){
 				$value = 'ERROR';
-			}
-			else if($level == self::WARNING){
+			} else if($level == self::WARNING){
 				$value = 'WARNING';
-			}
-			else if($level == self::INFO){
+			} else if($level == self::INFO){
 				$value = 'INFO';
-			}
-			else if($level == self::DEBUG){
+			} else if($level == self::DEBUG){
 				$value = 'DEBUG';
 			}
 			//no need for ALL

core/libraries/Assets.php

Indentation +154 added lines, -154 removed lines

@@ -1,168 +1,168 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	/**
-	 *  @file Assets.php
-	 *    
-	 *  This class contains static methods for generating static content links (images, Javascript, CSS, etc.).
-	 *  
-	 *  @package	core	
-	 *  @author	Tony NGUEREZA
-	 *  @copyright	Copyright (c) 2017
-	 *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
-	 *  @link	http://www.iacademy.cf
-	 *  @version 1.0.0
-	 *  @since 1.0.0
-	 *  @filesource
-	 */
-	class Assets{
+    /**
+     *  @file Assets.php
+     *    
+     *  This class contains static methods for generating static content links (images, Javascript, CSS, etc.).
+     *  
+     *  @package	core	
+     *  @author	Tony NGUEREZA
+     *  @copyright	Copyright (c) 2017
+     *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
+     *  @link	http://www.iacademy.cf
+     *  @version 1.0.0
+     *  @since 1.0.0
+     *  @filesource
+     */
+    class Assets{
 		
-		/**
-		 * The logger instance
-		 * @var Log
-		 */
-		private static $logger;
+        /**
+         * The logger instance
+         * @var Log
+         */
+        private static $logger;
 
-		/**
-		 * The signleton of the logger
-		 * @return Object the Log instance
-		 */
-		private static function getLogger(){
-			if(self::$logger == null){
-				//can't assign reference to static variable
-				self::$logger[0] =& class_loader('Log', 'classes');
-				self::$logger[0]->setLogger('Library::Assets');
-			}
-			return self::$logger[0];
-		}
+        /**
+         * The signleton of the logger
+         * @return Object the Log instance
+         */
+        private static function getLogger(){
+            if(self::$logger == null){
+                //can't assign reference to static variable
+                self::$logger[0] =& class_loader('Log', 'classes');
+                self::$logger[0]->setLogger('Library::Assets');
+            }
+            return self::$logger[0];
+        }
 
 
-		/**
-		 *  Generate the link of the assets file.
-		 *  
-		 *  Generates the absolute link of a file inside ASSETS_PATH folder.
-		 *  For example :
-		 *  	echo Assets::path('foo/bar/css/style.css'); => http://mysite.com/assets/foo/bar/css/style.css
-		 *  Note:
-		 *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
-		 *  
-		 *  @param string $asset the name of the assets file path with the extension.
-		 *  @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist.
-		 */
-		public static function path($asset){
-			$logger = self::getLogger();	
-			$path = ASSETS_PATH . $asset;
+        /**
+         *  Generate the link of the assets file.
+         *  
+         *  Generates the absolute link of a file inside ASSETS_PATH folder.
+         *  For example :
+         *  	echo Assets::path('foo/bar/css/style.css'); => http://mysite.com/assets/foo/bar/css/style.css
+         *  Note:
+         *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
+         *  
+         *  @param string $asset the name of the assets file path with the extension.
+         *  @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist.
+         */
+        public static function path($asset){
+            $logger = self::getLogger();	
+            $path = ASSETS_PATH . $asset;
 			
-			$logger->debug('Including the Assets file [' . $path . ']');
-			//Check if the file exists
-			if(file_exists($path)){
-				$logger->info('Assets file [' . $path . '] included successfully');
-				return Url::base_url($path);
-			}
-			$logger->warning('Assets file [' . $path . '] does not exist');
-			return null;
-		}
+            $logger->debug('Including the Assets file [' . $path . ']');
+            //Check if the file exists
+            if(file_exists($path)){
+                $logger->info('Assets file [' . $path . '] included successfully');
+                return Url::base_url($path);
+            }
+            $logger->warning('Assets file [' . $path . '] does not exist');
+            return null;
+        }
 		
-		/**
-		 *  Generate the link of the css file.
-		 *  
-		 *  Generates the absolute link of a file containing the CSS style.
-		 *  For example :
-		 *  	echo Assets::css('mystyle'); => http://mysite.com/assets/css/mystyle.css
-		 *  Note:
-		 *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
-		 *  
-		 *  @param $path the name of the css file without the extension.
-		 *  @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist.
-		 */
-		public static function css($path){
-			$logger = self::getLogger();
-			/*
+        /**
+         *  Generate the link of the css file.
+         *  
+         *  Generates the absolute link of a file containing the CSS style.
+         *  For example :
+         *  	echo Assets::css('mystyle'); => http://mysite.com/assets/css/mystyle.css
+         *  Note:
+         *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
+         *  
+         *  @param $path the name of the css file without the extension.
+         *  @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist.
+         */
+        public static function css($path){
+            $logger = self::getLogger();
+            /*
 			* if the file name contains the ".css" extension, replace it with 
 			* an empty string for better processing.
 			*/
-			$path = str_ireplace('.css', '', $path);
-			$path = ASSETS_PATH . 'css/' . $path . '.css';
+            $path = str_ireplace('.css', '', $path);
+            $path = ASSETS_PATH . 'css/' . $path . '.css';
 			
-			$logger->debug('Including the Assets file [' . $path . '] for CSS');
-			//Check if the file exists
-			if(file_exists($path)){
-				$logger->info('Assets file [' . $path . '] for CSS included successfully');
-				return Url::base_url($path);
-			}
-			$logger->warning('Assets file [' . $path . '] for CSS does not exist');
-			return null;
-		}
+            $logger->debug('Including the Assets file [' . $path . '] for CSS');
+            //Check if the file exists
+            if(file_exists($path)){
+                $logger->info('Assets file [' . $path . '] for CSS included successfully');
+                return Url::base_url($path);
+            }
+            $logger->warning('Assets file [' . $path . '] for CSS does not exist');
+            return null;
+        }
 
-		/**
-		 *  Generate the link of the javascript file.
-		 *  
-		 *  Generates the absolute link of a file containing the javascript.
-		 *  For example :
-		 *  	echo Assets::js('myscript'); => http://mysite.com/assets/js/myscript.js
-		 *  Note:
-		 *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
-		 *  
-		 *  @param $path the name of the javascript file without the extension.
-		 *  @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist.
-		 */
-		public static function js($path){
-			$logger = self::getLogger();
-			$path = str_ireplace('.js', '', $path);
-			$path = ASSETS_PATH . 'js/' . $path . '.js';
-			$logger->debug('Including the Assets file [' . $path . '] for javascript');
-			if(file_exists($path)){
-				$logger->info('Assets file [' . $path . '] for Javascript included successfully');
-				return Url::base_url($path);
-			}
-			$logger->warning('Assets file [' . $path . '] for Javascript does not exist');
-			return null;
-		}
+        /**
+         *  Generate the link of the javascript file.
+         *  
+         *  Generates the absolute link of a file containing the javascript.
+         *  For example :
+         *  	echo Assets::js('myscript'); => http://mysite.com/assets/js/myscript.js
+         *  Note:
+         *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
+         *  
+         *  @param $path the name of the javascript file without the extension.
+         *  @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist.
+         */
+        public static function js($path){
+            $logger = self::getLogger();
+            $path = str_ireplace('.js', '', $path);
+            $path = ASSETS_PATH . 'js/' . $path . '.js';
+            $logger->debug('Including the Assets file [' . $path . '] for javascript');
+            if(file_exists($path)){
+                $logger->info('Assets file [' . $path . '] for Javascript included successfully');
+                return Url::base_url($path);
+            }
+            $logger->warning('Assets file [' . $path . '] for Javascript does not exist');
+            return null;
+        }
 
-		/**
-		 *  Generate the link of the image file.
-		 *  
-		 *  Generates the absolute link of a file containing the image.
-		 *  For example :
-		 *  	echo Assets::img('myimage.png'); => http://mysite.com/assets/images/myimage.png
-		 *  Note:
-		 *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
-		 *  
-		 *  @param $path the name of the image file with the extension.
-		 *  @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist.
-		 */
-		public static function img($path){
-			$logger = self::getLogger();
-			$path = ASSETS_PATH . 'images/' . $path;
-			$logger->debug('Including the Assets file [' . $path . '] for image');
-			if(file_exists($path)){
-				$logger->info('Assets file [' . $path . '] for image included successfully');
-				return Url::base_url($path);
-			}
-			$logger->warning('Assets file [' . $path . '] for image does not exist');
-			return null;
-		}
-	}
+        /**
+         *  Generate the link of the image file.
+         *  
+         *  Generates the absolute link of a file containing the image.
+         *  For example :
+         *  	echo Assets::img('myimage.png'); => http://mysite.com/assets/images/myimage.png
+         *  Note:
+         *  The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH.
+         *  
+         *  @param $path the name of the image file with the extension.
+         *  @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist.
+         */
+        public static function img($path){
+            $logger = self::getLogger();
+            $path = ASSETS_PATH . 'images/' . $path;
+            $logger->debug('Including the Assets file [' . $path . '] for image');
+            if(file_exists($path)){
+                $logger->info('Assets file [' . $path . '] for image included successfully');
+                return Url::base_url($path);
+            }
+            $logger->warning('Assets file [' . $path . '] for image does not exist');
+            return null;
+        }
+    }

Spacing +12 added lines, -12 removed lines

@@ -38,7 +38,7 @@ 
 	 *  @since 1.0.0
 	 *  @filesource
 	 */
-	class Assets{
+	class Assets {
 		
 		/**
 		 * The logger instance
@@ -50,10 +50,10 @@ 
 		 * The signleton of the logger
 		 * @return Object the Log instance
 		 */
-		private static function getLogger(){
-			if(self::$logger == null){
+		private static function getLogger() {
+			if (self::$logger == null) {
 				//can't assign reference to static variable
-				self::$logger[0] =& class_loader('Log', 'classes');
+				self::$logger[0] = & class_loader('Log', 'classes');
 				self::$logger[0]->setLogger('Library::Assets');
 			}
 			return self::$logger[0];
@@ -72,13 +72,13 @@ 
 		 *  @param string $asset the name of the assets file path with the extension.
 		 *  @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist.
 		 */
-		public static function path($asset){
+		public static function path($asset) {
 			$logger = self::getLogger();	
 			$path = ASSETS_PATH . $asset;
 			
 			$logger->debug('Including the Assets file [' . $path . ']');
 			//Check if the file exists
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				$logger->info('Assets file [' . $path . '] included successfully');
 				return Url::base_url($path);
 			}
@@ -98,7 +98,7 @@ 
 		 *  @param $path the name of the css file without the extension.
 		 *  @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist.
 		 */
-		public static function css($path){
+		public static function css($path) {
 			$logger = self::getLogger();
 			/*
 			* if the file name contains the ".css" extension, replace it with 
@@ -109,7 +109,7 @@ 
 			
 			$logger->debug('Including the Assets file [' . $path . '] for CSS');
 			//Check if the file exists
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				$logger->info('Assets file [' . $path . '] for CSS included successfully');
 				return Url::base_url($path);
 			}
@@ -129,12 +129,12 @@ 
 		 *  @param $path the name of the javascript file without the extension.
 		 *  @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist.
 		 */
-		public static function js($path){
+		public static function js($path) {
 			$logger = self::getLogger();
 			$path = str_ireplace('.js', '', $path);
 			$path = ASSETS_PATH . 'js/' . $path . '.js';
 			$logger->debug('Including the Assets file [' . $path . '] for javascript');
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				$logger->info('Assets file [' . $path . '] for Javascript included successfully');
 				return Url::base_url($path);
 			}
@@ -154,11 +154,11 @@ 
 		 *  @param $path the name of the image file with the extension.
 		 *  @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist.
 		 */
-		public static function img($path){
+		public static function img($path) {
 			$logger = self::getLogger();
 			$path = ASSETS_PATH . 'images/' . $path;
 			$logger->debug('Including the Assets file [' . $path . '] for image');
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				$logger->info('Assets file [' . $path . '] for image included successfully');
 				return Url::base_url($path);
 			}

core/constants.php

Indentation +72 added lines, -72 removed lines

@@ -1,81 +1,81 @@
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
-	 * TNH Framework
-	 *
-	 * A simple PHP framework using HMVC architecture
-	 *
-	 * This content is released under the GNU GPL License (GPL)
-	 *
-	 * Copyright (C) 2017 Tony NGUEREZA
-	 *
-	 * This program is free software; you can redistribute it and/or
-	 * modify it under the terms of the GNU General Public License
-	 * as published by the Free Software Foundation; either version 3
-	 * of the License, or (at your option) any later version.
-	 *
-	 * This program is distributed in the hope that it will be useful,
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-	 * GNU General Public License for more details.
-	 *
-	 * You should have received a copy of the GNU General Public License
-	 * along with this program; if not, write to the Free Software
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-	*/
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
 
-	/**
-	 *  @file constants.php
-	 *    
-	 *  This file contains the declaration of most of the constants used in the system, 
-	 *  for example: the version, the name of the framework, etc.
-	 *  
-	 *  @package	core	
-	 *  @author	Tony NGUEREZA
-	 *  @copyright	Copyright (c) 2017
-	 *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
-	 *  @link	http://www.iacademy.cf
-	 *  @version 1.0.0
-	 *  @filesource
-	 */
+    /**
+     *  @file constants.php
+     *    
+     *  This file contains the declaration of most of the constants used in the system, 
+     *  for example: the version, the name of the framework, etc.
+     *  
+     *  @package	core	
+     *  @author	Tony NGUEREZA
+     *  @copyright	Copyright (c) 2017
+     *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
+     *  @link	http://www.iacademy.cf
+     *  @version 1.0.0
+     *  @filesource
+     */
 
-	/**
-	 *  The framework name
-	 */
-	define('TNH_NAME', 'TNH Framework');
+    /**
+     *  The framework name
+     */
+    define('TNH_NAME', 'TNH Framework');
 
-	/**
-	 *  The version of the framework in X.Y.Z format (Major, minor and bugs). 
-	 *  If there is the presence of the word "dev", it means that 
-	 *  it is a version under development.
-	 */
-	define('TNH_VERSION', '1.0.0-dev');
+    /**
+     *  The version of the framework in X.Y.Z format (Major, minor and bugs). 
+     *  If there is the presence of the word "dev", it means that 
+     *  it is a version under development.
+     */
+    define('TNH_VERSION', '1.0.0-dev');
 
-	/**
-	 *  The date of publication or release of the framework
-	 */
-	define('TNH_RELEASE_DATE', '2017/02/05');
+    /**
+     *  The date of publication or release of the framework
+     */
+    define('TNH_RELEASE_DATE', '2017/02/05');
 
-	/**
-	 *  The author of the framework, the person who developed the framework.
-	 */
-	define('TNH_AUTHOR', 'Tony NGUEREZA');
+    /**
+     *  The author of the framework, the person who developed the framework.
+     */
+    define('TNH_AUTHOR', 'Tony NGUEREZA');
 
-	/**
-	 *  Email address of the author of the framework.
-	 */
-	define('TNH_AUTHOR_EMAIL', 'nguerezatony@gmail.com');
+    /**
+     *  Email address of the author of the framework.
+     */
+    define('TNH_AUTHOR_EMAIL', 'nguerezatony@gmail.com');
 
-	/**
-	 *  The minimum PHP version required to use the framework. 
-	 *  If the version of PHP installed is lower, then the application will not work.
-	 *  Note: we use the PHP version_compare function to compare the required version with 
-	 *  the version installed on your system.
-	 */
-	define('TNH_REQUIRED_PHP_MIN_VERSION', '5.4');
+    /**
+     *  The minimum PHP version required to use the framework. 
+     *  If the version of PHP installed is lower, then the application will not work.
+     *  Note: we use the PHP version_compare function to compare the required version with 
+     *  the version installed on your system.
+     */
+    define('TNH_REQUIRED_PHP_MIN_VERSION', '5.4');
 
-	/**
-	 *  The maximum version of PHP required to use the framework. 
-	 *  If the version of PHP installed is higher than the required one, then the application will not work.
-	 */
-	define('TNH_REQUIRED_PHP_MAX_VERSION', '7.1');
\ No newline at end of file
+    /**
+     *  The maximum version of PHP required to use the framework. 
+     *  If the version of PHP installed is higher than the required one, then the application will not work.
+     */
+    define('TNH_REQUIRED_PHP_MAX_VERSION', '7.1');
\ No newline at end of file