tnhfw / tnh-fw

core/libraries/PDF.php

Indentation +72 added lines, -72 removed lines

@@ -1,80 +1,80 @@
 <?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.
+     */
 
-	/**
-	 * PDF library to generate PDF document using the library DOMPDF
-	 */
-	class PDF extends BaseClass{
+    /**
+     * PDF library to generate PDF document using the library DOMPDF
+     */
+    class PDF extends BaseClass{
 		
-		/**
-		 * The dompdf instance
-		 * @var Dompdf
-		 */
-		private $dompdf = null;
+        /**
+         * The dompdf instance
+         * @var Dompdf
+         */
+        private $dompdf = null;
 		
-		/**
-		 * Create PDF library instance
-		 */
-		public function __construct(){
-			parent::__construct();
+        /**
+         * Create PDF library instance
+         */
+        public function __construct(){
+            parent::__construct();
 
-			require_once VENDOR_PATH.'dompdf/dompdf_config.inc.php';
-			$this->dompdf = new Dompdf();
-		}
+            require_once VENDOR_PATH.'dompdf/dompdf_config.inc.php';
+            $this->dompdf = new Dompdf();
+        }
 
-		/**
-		 * Generate PDF document
-		 * @param  string  $html        the HTML content to use for generation
-		 * @param  string  $filename    the generated PDF document filename
-		 * @param  boolean $stream      if need send the generated PDF to browser for download
-		 * @param  string  $paper       the PDF document paper type like 'A4', 'A5', 'letter', etc.
-		 * @param  string  $orientation the PDF document orientation like 'portrait', 'landscape'
-		 * @return string|void               if $stream is true send PDF document to browser for download, else return the generated PDF
-		 * content like to join in Email attachment of for other purpose use.
-		 */
-		public function generate($html, $filename = 'output.pdf', $stream = true, $paper = 'A4', $orientation = 'portrait'){
-			$this->logger->info('Generating of PDF document: filename [' .$filename. '], stream [' .($stream ? 'TRUE':'FALSE'). '], paper [' .$paper. '], orientation [' .$orientation. ']');
-			$this->dompdf->load_html($html);
-			$this->dompdf->set_paper($paper, $orientation);
-			$this->dompdf->render();
-			if($stream){
-				$this->dompdf->stream($filename);
-			}
-			else{
-				return $this->dompdf->output();
-			}
-		}
+        /**
+         * Generate PDF document
+         * @param  string  $html        the HTML content to use for generation
+         * @param  string  $filename    the generated PDF document filename
+         * @param  boolean $stream      if need send the generated PDF to browser for download
+         * @param  string  $paper       the PDF document paper type like 'A4', 'A5', 'letter', etc.
+         * @param  string  $orientation the PDF document orientation like 'portrait', 'landscape'
+         * @return string|void               if $stream is true send PDF document to browser for download, else return the generated PDF
+         * content like to join in Email attachment of for other purpose use.
+         */
+        public function generate($html, $filename = 'output.pdf', $stream = true, $paper = 'A4', $orientation = 'portrait'){
+            $this->logger->info('Generating of PDF document: filename [' .$filename. '], stream [' .($stream ? 'TRUE':'FALSE'). '], paper [' .$paper. '], orientation [' .$orientation. ']');
+            $this->dompdf->load_html($html);
+            $this->dompdf->set_paper($paper, $orientation);
+            $this->dompdf->render();
+            if($stream){
+                $this->dompdf->stream($filename);
+            }
+            else{
+                return $this->dompdf->output();
+            }
+        }
 		
-		/**
-		* Return the instance of Dompdf
-		*
-		* @return object the dompdf instance
-		*/
-		public function getDompdf(){
-			return $this->dompdf;
-		}
+        /**
+         * Return the instance of Dompdf
+         *
+         * @return object the dompdf instance
+         */
+        public function getDompdf(){
+            return $this->dompdf;
+        }
 		
-	}
+    }

core/libraries/FormValidation.php

Indentation +94 added lines, -94 removed lines

@@ -22,10 +22,10 @@ 
      * 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 FormValidation extends BaseClass{
+        class FormValidation extends BaseClass{
 		 
         /**
          * The form validation status
@@ -60,7 +60,7 @@ 
          */
         protected $_eachErrorDelimiter   = array('<p class="error">', '</p>');
         
-		/**
+        /**
          * Indicated if need force the validation to be failed
          * @var boolean
          */
@@ -93,7 +93,7 @@ 
         public function __construct() {
             parent::__construct();
            
-		   //Load form validation language message
+            //Load form validation language message
             Loader::lang('form_validation');
             $obj = & get_instance();
             $this->_errorsMessages  = array(
@@ -155,13 +155,13 @@ 
         /**
          * Set the form validation data
          * @param array $data the values to be validated
-		 *
+         *
          * @return FormValidation Current instance of object.
          */
         public function setData(array $data){
             $this->logger->debug('Setting the form validation data, the values are: ' . stringfy_vars($data));
             $this->data = $data;
-			return $this;
+            return $this;
         }
 
         /**
@@ -172,11 +172,11 @@ 
             return $this->data;
         }
 
-		/**
-		* Get the validation function name to validate a rule
-		*
-		* @return string the function name
-		*/
+        /**
+         * Get the validation function name to validate a rule
+         *
+         * @return string the function name
+         */
         protected function _toCallCase($funcName, $prefix='_validate') {
             $funcName = strtolower($funcName);
             $finalFuncName = $prefix;
@@ -246,12 +246,12 @@ 
             $this->_forceFail = false;
 
             foreach ($this->getData() as $inputName => $inputVal) {
-    			if(is_array($this->data[$inputName])){
-    				$this->data[$inputName] = array_map('trim', $this->data[$inputName]);
-    			}
-    			else{
-    				$this->data[$inputName] = trim($this->data[$inputName]);
-    			}
+                if(is_array($this->data[$inputName])){
+                    $this->data[$inputName] = array_map('trim', $this->data[$inputName]);
+                }
+                else{
+                    $this->data[$inputName] = trim($this->data[$inputName]);
+                }
 
                 if (array_key_exists($inputName, $this->_rules)) {
                     foreach ($this->_parseRuleString($this->_rules[$inputName]) as $eachRule) {
@@ -267,7 +267,7 @@ 
          *
          * @param string $inputField Name of the field or the data key to add a rule to
          * @param string $ruleSets PIPE seperated string of rules
-		 *
+         *
          * @return FormValidation Current instance of object.
          */
         public function setRule($inputField, $inputLabel, $ruleSets) {
@@ -281,8 +281,8 @@ 
          * Takes an array of rules and uses setRule() to set them, accepts an array
          * of rule names rather than a pipe-delimited string as well.
          * @param array $ruleSets
-		 *
-		 * @return FormValidation Current instance of object.
+         *
+         * @return FormValidation Current instance of object.
          */
         public function setRules(array $ruleSets) {
             foreach ($ruleSets as $ruleSet) {
@@ -304,7 +304,7 @@ 
          * @param string $start Before block of errors gets displayed, HTML allowed.
          * @param string $end After the block of errors gets displayed, HTML allowed.
          *
-		 * @return FormValidation Current instance of object.
+         * @return FormValidation Current instance of object.
          */
         public function setErrorsDelimiter($start, $end) {
             $this->_allErrorsDelimiter[0] = $start;
@@ -319,7 +319,7 @@ 
          * @param string $start Displayed before each error.
          * @param string $end Displayed after each error.
          * 
-		 * @return FormValidation Current instance of object.
+         * @return FormValidation Current instance of object.
          */
         public function setErrorDelimiter($start, $end) {
             $this->_eachErrorDelimiter[0] = $start;
@@ -327,21 +327,21 @@ 
             return $this;
         }
 
-		/**
-		* Get the each errors delimiters
-		*
-		* @return array
-		*/
-    	public function getErrorDelimiter() {
+        /**
+         * Get the each errors delimiters
+         *
+         * @return array
+         */
+        public function getErrorDelimiter() {
             return $this->_eachErrorDelimiter;
         }
 
-		/**
-		* Get the all errors delimiters
-		*
-		* @return array
-		*/
-    	public function getErrorsDelimiter() {
+        /**
+         * Get the all errors delimiters
+         *
+         * @return array
+         */
+        public function getErrorsDelimiter() {
             return $this->_allErrorsDelimiter;
         }
 
@@ -379,7 +379,7 @@ 
          *
          * @param string $inputName The form input name or data key
          * @param string $errorMessage Error to display
-		 *
+         *
          * @return formValidation Current instance of the object
          */
         public function setCustomError($inputName, $errorMessage) {
@@ -416,17 +416,17 @@ 
          *
          * @param boolean $limit number of error to display or return
          * @param boolean $echo Whether or not the values are to be returned or displayed
-		 *
+         *
          * @return string Errors formatted for output
          */
         public function displayErrors($limit = null, $echo = true) {
             list($errorsStart, $errorsEnd) = $this->_allErrorsDelimiter;
             list($errorStart, $errorEnd) = $this->_eachErrorDelimiter;
             $errorOutput = $errorsStart;
-    		$i = 0;
+            $i = 0;
             if (!empty($this->_errors)) {
                 foreach ($this->_errors as $fieldName => $error) {
-        	    	if ($i === $limit) { 
+                    if ($i === $limit) { 
                         break; 
                     }
                     $errorOutput .= $errorStart;
@@ -454,7 +454,7 @@ 
          * Breaks up a PIPE seperated string of rules, and puts them into an array.
          *
          * @param string $ruleString String to be parsed.
-		 *
+         *
          * @return array Array of each value in original string.
          */
         protected function _parseRuleString($ruleString) {
@@ -467,10 +467,10 @@ 
                 $rule = '#regex\[\/(.*)\/([a-zA-Z0-9]?)\]#';
                 preg_match($rule, $ruleString, $regexRule);
                 $ruleStringTemp = preg_replace($rule, '', $ruleString);
-                 if(!empty($regexRule[0])){
-                     $ruleSets[] = $regexRule[0];
-                 }
-                 $ruleStringRegex = explode('|', $ruleStringTemp);
+                    if(!empty($regexRule[0])){
+                        $ruleSets[] = $regexRule[0];
+                    }
+                    $ruleStringRegex = explode('|', $ruleStringTemp);
                 foreach ($ruleStringRegex as $rule) {
                     $rule = trim($rule);
                     if($rule){
@@ -486,7 +486,7 @@ 
                 } else {
                     $ruleSets[] = $ruleString;
                 }
-             }
+                }
             return $ruleSets;
         }
 
@@ -494,7 +494,7 @@ 
          * Returns whether or not a field obtains the rule "required".
          *
          * @param string $fieldName Field to check if required.
-		 *
+         *
          * @return boolean Whether or not the field is required.
          */
         protected function _fieldIsRequired($fieldName) {
@@ -529,13 +529,13 @@ 
             return;
         }
 
-		/**
-		* Set error for the given field or key
-		*
-		* @param string $inputName the input or key name
-		* @param string $ruleName the rule name
-		* @param array|string $replacements
-		*/
+        /**
+         * Set error for the given field or key
+         *
+         * @param string $inputName the input or key name
+         * @param string $ruleName the rule name
+         * @param array|string $replacements
+         */
         protected function _setError($inputName, $ruleName, $replacements = array()) {
             $rulePhraseKeyParts = explode(',', $ruleName);
             $rulePhrase = null;
@@ -552,7 +552,7 @@ 
             }
             // Type cast to array in case it's a string
             $replacements = (array) $replacements;
-			$replacementCount = count($replacements);
+            $replacementCount = count($replacements);
             for ($i = 1; $i <= $replacementCount; $i++) {
                 $key = $i - 1;
                 $rulePhrase = str_replace('%' . $i, $replacements[$key], $rulePhrase);
@@ -570,11 +570,11 @@ 
          *
          * @param type $inputArg
          * @param string $callbackFunc
-		 *
+         *
          * @return mixed
          */
         protected function _runCallback($inputArg, $callbackFunc) {
-			return eval('return ' . $callbackFunc . '("' . $inputArg . '");');
+            return eval('return ' . $callbackFunc . '("' . $inputArg . '");');
         }
 
         /**
@@ -583,7 +583,7 @@ 
          * arguments.
          *
          * @param string $callbackFunc
-		 *
+         *
          * @return mixed
          */
         protected function _runEmptyCallback($callbackFunc) {
@@ -594,7 +594,7 @@ 
          * Gets a specific label of a specific field input name.
          *
          * @param string $inputName
-		 *
+         *
          * @return string
          */
         protected function _getLabel($inputName) {
@@ -607,7 +607,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("required")
          * @param  array  $ruleArgs  the rules argument
          */
-		protected function _validateRequired($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateRequired($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if(array_key_exists(1, $ruleArgs) && function_exists($ruleArgs[1])) {
                 $callbackReturn = $this->_runEmptyCallback($ruleArgs[1]);
@@ -615,8 +615,8 @@ 
                     $this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
                 }
             } 
-			else if($inputVal == '') {
-				$this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
+            else if($inputVal == '') {
+                $this->_setError($inputName, $ruleName, $this->_getLabel($inputName));
             }
         }
 
@@ -640,10 +640,10 @@ 
          */
         protected function _validateCallback($inputName, $ruleName, array $ruleArgs) {
             if (function_exists($ruleArgs[1]) && !empty($this->data[$inputName])) {
-				$result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]);
-				if(! $result){
-					$this->_setError($inputName, $ruleName, array($this->_getLabel($inputName)));
-				}
+                $result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]);
+                if(! $result){
+                    $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName)));
+                }
             }
         }
 
@@ -675,7 +675,7 @@ 
                         continue;
                     }
                 } 
-				else{
+                else{
                     if ($inputVal == $doNotEqual) {
                         $this->_setError($inputName, $ruleName . ',string', array($this->_getLabel($inputName), $doNotEqual));
                         continue;
@@ -767,7 +767,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("less_than")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if ($inputVal >= $ruleArgs[1]) { 
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -783,7 +783,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("greater_than")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if ($inputVal <= $ruleArgs[1]) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -799,7 +799,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("numeric")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if (! is_numeric($inputVal)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -815,18 +815,18 @@ 
          * @param  string $ruleName  the rule name for this validation ("exists")
          * @param  array  $ruleArgs  the rules argument
          */
-		protected function _validateExists($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateExists($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		if (! is_object($this->databaseInstance)){
+            if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
                 if(isset($obj->database)){
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		list($table, $column) = explode('.', $ruleArgs[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-    			                                       ->where($column, $inputVal);
-    		$this->databaseInstance->get();
+            list($table, $column) = explode('.', $ruleArgs[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal);
+            $this->databaseInstance->get();
             if ($this->databaseInstance->numRows() <= 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
@@ -841,7 +841,7 @@ 
          * @param  string $ruleName  the rule name for this validation ("is_unique")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
             if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
@@ -849,11 +849,11 @@ 
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		list($table, $column) = explode('.', $ruleArgs[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-    			                                      ->where($column, $inputVal);
-    		$this->databaseInstance->get();
-    		if ($this->databaseInstance->numRows() > 0) {
+            list($table, $column) = explode('.', $ruleArgs[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal);
+            $this->databaseInstance->get();
+            if ($this->databaseInstance->numRows() > 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
                 }
@@ -867,25 +867,25 @@ 
          * @param  string $ruleName  the rule name for this validation ("is_unique_update")
          * @param  array  $ruleArgs  the rules argument
          */
-    	protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) {
+        protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		if (! is_object($this->databaseInstance)){
+            if (! is_object($this->databaseInstance)){
                 $obj = & get_instance();
                 if(isset($obj->database)){
                     $this->databaseInstance = $obj->database;
                 } 
             }
-    		$data = explode(',', $ruleArgs[1]);
-    		if(count($data) < 2){
-    			return;
-    		}
-    		list($table, $column) = explode('.', $data[0]);
-    		list($field, $val)    = explode('=', $data[1]);
-    		$this->databaseInstance->getQueryBuilder()->from($table)
-                                			          ->where($column, $inputVal)
-                                            		  ->where($field, '!=', trim($val));
+            $data = explode(',', $ruleArgs[1]);
+            if(count($data) < 2){
+                return;
+            }
+            list($table, $column) = explode('.', $data[0]);
+            list($field, $val)    = explode('=', $data[1]);
+            $this->databaseInstance->getQueryBuilder()->from($table)
+                                                        ->where($column, $inputVal)
+                                                        ->where($field, '!=', trim($val));
             $this->databaseInstance->get();
-    		if ($this->databaseInstance->numRows() > 0) {
+            if ($this->databaseInstance->numRows() > 0) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;
                 }
@@ -901,7 +901,7 @@ 
          */
         protected function _validateInList($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		$list = explode(',', $ruleArgs[1]);
+            $list = explode(',', $ruleArgs[1]);
             $list = array_map('trim', $list);
             if (! in_array($inputVal, $list)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
@@ -919,7 +919,7 @@ 
          */
         protected function _validateRegex($inputName, $ruleName, array $ruleArgs) {
             $inputVal = $this->post($inputName);
-    		$regex = $ruleArgs[1];
+            $regex = $ruleArgs[1];
             if (! preg_match($regex, $inputVal)) {
                 if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) {
                     return;

core/libraries/Upload.php

Indentation +293 added lines, -293 removed lines

@@ -22,139 +22,139 @@ 
      * 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.
-    */
+     */
 
 
 
     /**
-    *    Upload
-    *
-    *    A complete class to upload files with php 5 or higher, but the best: very simple to use.
-    *
-    *    @author Olaf Erlandsen <info@webdevfreelance.com>
-    *    @author http://www.webdevfreelance.com/
-    *
-    *    @package FileUpload
-    *    @version 1.5
-    */
+     *    Upload
+     *
+     *    A complete class to upload files with php 5 or higher, but the best: very simple to use.
+     *
+     *    @author Olaf Erlandsen <info@webdevfreelance.com>
+     *    @author http://www.webdevfreelance.com/
+     *
+     *    @package FileUpload
+     *    @version 1.5
+     */
     class Upload extends BaseClass{
 
         /**
-        *   Version
-        *
-        *   @since      1.5
-        *   @version    1.0
-        */
+         *   Version
+         *
+         *   @since      1.5
+         *   @version    1.0
+         */
         const VERSION = '1.5';
 
         /**
-        *    Upload function name
-        *    Remember:
-        *        Default function: move_uploaded_file
-        *        Native options:
-        *            - move_uploaded_file (Default and best option)
-        *            - copy
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        string
-        */
+         *    Upload function name
+         *    Remember:
+         *        Default function: move_uploaded_file
+         *        Native options:
+         *            - move_uploaded_file (Default and best option)
+         *            - copy
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        string
+         */
         private $upload_function = 'move_uploaded_file';
 
         /**
-        *    Array with the information obtained from the
-        *    variable $_FILES or $HTTP_POST_FILES.
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        array
-        */
+         *    Array with the information obtained from the
+         *    variable $_FILES or $HTTP_POST_FILES.
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        array
+         */
         private $file_array    = array();
 
         /**
-        *    If the file you are trying to upload already exists it will
-        *    be overwritten if you set the variable to true.
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        boolean
-        */
+         *    If the file you are trying to upload already exists it will
+         *    be overwritten if you set the variable to true.
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        boolean
+         */
         private $overwrite_file = false;
 
         /**
-        *    Input element
-        *    Example:
-        *        <input type="file" name="file" />
-        *    Result:
-        *        FileUpload::$input = file
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        string
-        */
+         *    Input element
+         *    Example:
+         *        <input type="file" name="file" />
+         *    Result:
+         *        FileUpload::$input = file
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        string
+         */
         private $input;
 
         /**
-        *    Path output
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        string
-        */
+         *    Path output
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        string
+         */
         private $destination_directory;
 
         /**
-        *    Output filename
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        string
-        */
+         *    Output filename
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        string
+         */
         private $filename;
 
         /**
-        *    Max file size
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        float
-        */
+         *    Max file size
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        float
+         */
         private $max_file_size= 0.0;
 
         /**
-        *    List of allowed mime types
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        array
-        */
+         *    List of allowed mime types
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        array
+         */
         private $allowed_mime_types = array();
 
         /**
-        *    Callbacks
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        array
-        */
+         *    Callbacks
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        array
+         */
         private $callbacks = array('before' => null, 'after' => null);
 
         /**
-        *    File object
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        object
-        */
+         *    File object
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        object
+         */
         private $file;
 
         /**
-        *    Helping mime types
-        *
-        *    @since        1.0
-        *    @version    1.0
-        *    @var        array
-        */
+         *    Helping mime types
+         *
+         *    @since        1.0
+         *    @version    1.0
+         *    @var        array
+         */
         private $mime_helping = array(
             'text'      =>    array('text/plain',),
             'image'     =>    array(
@@ -204,13 +204,13 @@ 
 
 
         /**
-        *    Construct
-        *
-        *    @since     0.1
-        *    @version   1.0.1
-        *    @return    object
-        *    @method    object    __construct
-        */
+         *    Construct
+         *
+         *    @since     0.1
+         *    @version   1.0.1
+         *    @return    object
+         *    @method    object    __construct
+         */
         public function __construct(){
             parent::__construct();
 
@@ -253,17 +253,17 @@ 
             $this->logger->info('The upload file information are : ' .stringfy_vars($this->file_array));
         }
         /**
-        *    Set input.
-        *    If you have $_FILES["file"], you must use the key "file"
-        *    Example:
-        *        $object->setInput("file");
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     string      $input
-        *    @return    object
-        *    @method    boolean     setInput
-        */
+         *    Set input.
+         *    If you have $_FILES["file"], you must use the key "file"
+         *    Example:
+         *        $object->setInput("file");
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     string      $input
+         *    @return    object
+         *    @method    boolean     setInput
+         */
         public function setInput($input)
         {
             if (!empty($input) && (is_string($input) || is_numeric($input) )) {
@@ -272,18 +272,18 @@ 
             return $this;
         }
         /**
-        *    Set new filename
-        *    Example:
-        *        FileUpload::setFilename("new file.txt")
-        *    Remember:
-        *        Use %s to retrive file extension
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     string      $filename
-        *    @return    object
-        *    @method    boolean     setFilename
-        */
+         *    Set new filename
+         *    Example:
+         *        FileUpload::setFilename("new file.txt")
+         *    Remember:
+         *        Use %s to retrive file extension
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     string      $filename
+         *    @return    object
+         *    @method    boolean     setFilename
+         */
         public function setFilename($filename)
         {
             if ($this->isFilename($filename)) {
@@ -292,14 +292,14 @@ 
             return $this;
         }
         /**
-        *    Set automatic filename
-        *
-        *    @since     1.0
-        *    @version   1.5
-        *    @param     string      $extension
-        *    @return    object
-        *    @method    boolean     setAutoFilename
-        */
+         *    Set automatic filename
+         *
+         *    @since     1.0
+         *    @version   1.5
+         *    @param     string      $extension
+         *    @return    object
+         *    @method    boolean     setAutoFilename
+         */
         public function setAutoFilename()
         {
             $this->filename = sha1(mt_rand(1, 9999).uniqid());
@@ -307,14 +307,14 @@ 
             return $this;
         }
         /**
-        *    Set file size limit
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     double     $file_size
-        *    @return    object
-        *    @method    boolean     setMaxFileSize
-        */
+         *    Set file size limit
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     double     $file_size
+         *    @return    object
+         *    @method    boolean     setMaxFileSize
+         */
         public function setMaxFileSize($file_size)
         {
             $file_size = $this->sizeInBytes($file_size);
@@ -330,14 +330,14 @@ 
             return $this;
         }
         /**
-        *    Set array mime types
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     array       $mimes
-        *    @return    object
-        *    @method    boolean     setAllowedMimeTypes
-        */
+         *    Set array mime types
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     array       $mimes
+         *    @return    object
+         *    @method    boolean     setAllowedMimeTypes
+         */
         public function setAllowedMimeTypes(array $mimes)
         {
             if (count($mimes) > 0) {
@@ -346,14 +346,14 @@ 
             return $this;
         }
         /**
-        *    Set input callback
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     mixed       $callback
-        *    @return    object
-        *    @method    boolean     setCallbackInput
-        */
+         *    Set input callback
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     mixed       $callback
+         *    @return    object
+         *    @method    boolean     setCallbackInput
+         */
         public function setCallbackInput($callback)
         {
             if (is_callable($callback, false)) {
@@ -362,14 +362,14 @@ 
             return $this;
         }
         /**
-        *    Set output callback
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     mixed       $callback
-        *    @return    object
-        *    @method    boolean     setCallbackOutput
-        */
+         *    Set output callback
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     mixed       $callback
+         *    @return    object
+         *    @method    boolean     setCallbackOutput
+         */
         public function setCallbackOutput($callback)
         {
             if (is_callable($callback, false)) {
@@ -378,14 +378,14 @@ 
             return $this;
         }
         /**
-        *    Append a mime type to allowed mime types
-        *
-        *    @since     1.0
-        *    @version   1.0.1
-        *    @param     string      $mime
-        *    @return    object
-        *    @method    boolean     setAllowMimeType
-        */
+         *    Append a mime type to allowed mime types
+         *
+         *    @since     1.0
+         *    @version   1.0.1
+         *    @param     string      $mime
+         *    @return    object
+         *    @method    boolean     setAllowMimeType
+         */
         public function setAllowMimeType($mime)
         {
             if (!empty($mime) && is_string($mime)) {
@@ -395,13 +395,13 @@ 
             return $this;
         }
         /**
-        *    Set allowed mime types from mime helping
-        *
-        *    @since     1.0.1
-        *    @version   1.0.1
-        *    @return    object
-        *    @method    boolean    setMimeHelping
-        */
+         *    Set allowed mime types from mime helping
+         *
+         *    @since     1.0.1
+         *    @version   1.0.1
+         *    @return    object
+         *    @method    boolean    setMimeHelping
+         */
         public function setMimeHelping($name)
         {
             if (!empty($name) && is_string($name)) {
@@ -412,17 +412,17 @@ 
             return $this;
         }
         /**
-        *    Set function to upload file
-        *    Examples:
-        *        1.- FileUpload::setUploadFunction("move_uploaded_file");
-        *        2.- FileUpload::setUploadFunction("copy");
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     string      $function
-        *    @return    object
-        *    @method    boolean     setUploadFunction
-        */
+         *    Set function to upload file
+         *    Examples:
+         *        1.- FileUpload::setUploadFunction("move_uploaded_file");
+         *        2.- FileUpload::setUploadFunction("copy");
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     string      $function
+         *    @return    object
+         *    @method    boolean     setUploadFunction
+         */
         public function setUploadFunction($function)
         {
             if (!empty($function) && (is_array($function) || is_string($function) )) {
@@ -433,13 +433,13 @@ 
             return $this;
         }
         /**
-        *    Clear allowed mime types cache
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @return    object
-        *    @method    boolean    clearAllowedMimeTypes
-        */
+         *    Clear allowed mime types cache
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @return    object
+         *    @method    boolean    clearAllowedMimeTypes
+         */
         public function clearAllowedMimeTypes()
         {
             $this->allowed_mime_types = array();
@@ -447,15 +447,15 @@ 
             return $this;
         }
         /**
-        *    Set destination output
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     string      $destination_directory      Destination path
-        *    @param     boolean     $create_if_not_exist
-        *    @return    object
-        *    @method    boolean     setDestinationDirectory
-        */
+         *    Set destination output
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     string      $destination_directory      Destination path
+         *    @param     boolean     $create_if_not_exist
+         *    @return    object
+         *    @method    boolean     setDestinationDirectory
+         */
         public function setDestinationDirectory($destination_directory, $create_if_not_exist = false) {
             $destination_directory = realpath($destination_directory);
             if (substr($destination_directory, -1) != DIRECTORY_SEPARATOR) {
@@ -479,14 +479,14 @@ 
             return $this;
         }
         /**
-        *    Check file exists
-        *
-        *    @since      1.0
-        *    @version    1.0.1
-        *    @param      string     $file_destination
-        *    @return     boolean
-        *    @method     boolean    fileExists
-        */
+         *    Check file exists
+         *
+         *    @since      1.0
+         *    @version    1.0.1
+         *    @param      string     $file_destination
+         *    @return     boolean
+         *    @method     boolean    fileExists
+         */
         public function fileExists($file_destination)
         {
             if ($this->isFilename($file_destination)) {
@@ -495,14 +495,14 @@ 
             return false;
         }
         /**
-        *    Check dir exists
-        *
-        *    @since        1.0
-        *    @version    1.0.1
-        *    @param      string     $path
-        *    @return     boolean
-        *    @method     boolean    dirExists
-        */
+         *    Check dir exists
+         *
+         *    @since        1.0
+         *    @version    1.0.1
+         *    @param      string     $path
+         *    @return     boolean
+         *    @method     boolean    dirExists
+         */
         public function dirExists($path)
         {
             if ($this->isDirpath($path)) {
@@ -511,29 +511,29 @@ 
             return false;
         }
         /**
-        *    Check valid filename
-        *
-        *    @since     1.0
-        *    @version   1.0.1
-        *    @param     string      $filename
-        *    @return    boolean
-        *    @method    boolean     isFilename
-        */
+         *    Check valid filename
+         *
+         *    @since     1.0
+         *    @version   1.0.1
+         *    @param     string      $filename
+         *    @return    boolean
+         *    @method    boolean     isFilename
+         */
         public function isFilename($filename)
         {
             $filename = basename($filename);
             return (!empty($filename) && (is_string( $filename) || is_numeric($filename)));
         }
         /**
-        *    Validate mime type with allowed mime types,
-        *    but if allowed mime types is empty, this method return true
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @param     string      $mime
-        *    @return    boolean
-        *    @method    boolean     checkMimeType
-        */
+         *    Validate mime type with allowed mime types,
+         *    but if allowed mime types is empty, this method return true
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @param     string      $mime
+         *    @return    boolean
+         *    @method    boolean     checkMimeType
+         */
         public function checkMimeType($mime)
         {
             if (count($this->allowed_mime_types) == 0) {
@@ -542,26 +542,26 @@ 
             return in_array(strtolower($mime), $this->allowed_mime_types);
         }
         /**
-        *    Retrive status of upload
-        *
-        *    @since     1.0
-        *    @version   1.0
-        *    @return    boolean
-        *    @method    boolean    getStatus
-        */
+         *    Retrive status of upload
+         *
+         *    @since     1.0
+         *    @version   1.0
+         *    @return    boolean
+         *    @method    boolean    getStatus
+         */
         public function getStatus()
         {
             return $this->file['status'];
         }
         /**
-        *    Check valid path
-        *
-        *    @since        1.0
-        *    @version    1.0.1
-        *    @param        string    $filename
-        *    @return     boolean
-        *    @method     boolean    isDirpath
-        */
+         *    Check valid path
+         *
+         *    @since        1.0
+         *    @version    1.0.1
+         *    @param        string    $filename
+         *    @return     boolean
+         *    @method     boolean    isDirpath
+         */
         public function isDirpath($path)
         {
             if (!empty( $path) && (is_string( $path) || is_numeric($path) )) {
@@ -574,26 +574,26 @@ 
             return false;
         }
         /**
-        *    Allow overwriting files
-        *
-        *    @since      1.0
-        *    @version    1.0
-        *    @return     object
-        *    @method     boolean    allowOverwriting
-        */
+         *    Allow overwriting files
+         *
+         *    @since      1.0
+         *    @version    1.0
+         *    @return     object
+         *    @method     boolean    allowOverwriting
+         */
         public function allowOverwriting()
         {
             $this->overwrite_file = true;
             return $this;
         }
         /**
-        *    File info
-        *
-        *    @since      1.0
-        *    @version    1.0
-        *    @return     object
-        *    @method     object    getInfo
-        */
+         *    File info
+         *
+         *    @since      1.0
+         *    @version    1.0
+         *    @return     object
+         *    @method     object    getInfo
+         */
         public function getInfo()
         {
             return (object)$this->file;
@@ -611,13 +611,13 @@ 
 
         
         /**
-        *    Upload file
-        *
-        *    @since     1.0
-        *    @version   1.0.1
-        *    @return    boolean
-        *    @method    boolean    save
-        */
+         *    Upload file
+         *
+         *    @since     1.0
+         *    @version   1.0.1
+         *    @return    boolean
+         *    @method    boolean    save
+         */
         public function save(){
             if (count($this->file_array) > 0 && array_key_exists($this->input, $this->file_array)) {
                 // set original filename if not have a new name
@@ -674,15 +674,15 @@ 
 
 
         /**
-        *    File size for humans.
-        *
-        *    @since      1.0
-        *    @version    1.0
-        *    @param      integer    $bytes
-        *    @param      integer    $precision
-        *    @return     string
-        *    @method     string     sizeFormat
-        */
+         *    File size for humans.
+         *
+         *    @since      1.0
+         *    @version    1.0
+         *    @param      integer    $bytes
+         *    @param      integer    $precision
+         *    @return     string
+         *    @method     string     sizeFormat
+         */
         public function sizeFormat($size, $precision = 2)
         {
             if($size > 0){
@@ -695,14 +695,14 @@ 
 
         
         /**
-        *    Convert human file size to bytes
-        *
-        *    @since      1.0
-        *    @version    1.0.1
-        *    @param      integer|double    $size
-        *    @return     integer|double
-        *    @method     string     sizeInBytes
-        */
+         *    Convert human file size to bytes
+         *
+         *    @since      1.0
+         *    @version    1.0.1
+         *    @param      integer|double    $size
+         *    @return     integer|double
+         *    @method     string     sizeInBytes
+         */
         public function sizeInBytes($size)
         {
             $unit = 'B';
@@ -754,7 +754,7 @@ 
                 return true;
             }
 
-             //check for php upload error
+                //check for php upload error
             if(is_numeric($this->file['error']) && $this->file['error'] > 0){
                 $this->setError($this->getPhpUploadErrorMessageByCode($this->file['error']));
                 return true;
@@ -766,7 +766,7 @@ 
                 return true;
             }
 
-             // Check file size
+                // Check file size
             if ($this->max_file_size > 0 && $this->max_file_size < $this->file['size']) {
                 $this->setError(sprintf($this->error_messages['max_file_size'], $this->sizeFormat($this->max_file_size)));
                 return true;

core/libraries/Assets.php

Indentation +137 added lines, -137 removed lines

@@ -1,149 +1,149 @@
 <?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 extends BaseStaticClass{
+    /**
+     *  @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 extends BaseStaticClass{
 
 
-		/**
-		 *  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 string $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 string $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 string $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 string $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 string $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 string $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;
+        }
+    }

core/libraries/Cookie.php

Indentation +85 added lines, -85 removed lines

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

core/classes/Module.php

Indentation +228 added lines, -228 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-	defined('ROOT_PATH') || exit('Access denied');
-	/**
+    defined('ROOT_PATH') || exit('Access denied');
+    /**
      * TNH Framework
      *
      * A simple PHP framework using HMVC architecture
@@ -22,252 +22,252 @@ 
      * 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 Module extends BaseStaticClass{
+    class Module extends BaseStaticClass{
 		
-		/**
-		 * list of loaded module
-		 * @var array
-		 */
-		private static $list = array();
+        /**
+         * list of loaded module
+         * @var array
+         */
+        private static $list = array();
 
-		/**
-		 * Initialise the module list by scanning the directory MODULE_PATH
-		 */
-		public function init(){
-			$logger = self::getLogger();
-			$logger->debug('Check if the application contains the modules ...');
-			$moduleDir = opendir(MODULE_PATH);
-			if (is_resource($moduleDir)){
-				while(($module = readdir($moduleDir)) !== false){
-					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
-						self::$list[] = $module;
-					}
-					else{
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
-					}
-				}
-				closedir($moduleDir);
-			}
-			ksort(self::$list);
+        /**
+         * Initialise the module list by scanning the directory MODULE_PATH
+         */
+        public function init(){
+            $logger = self::getLogger();
+            $logger->debug('Check if the application contains the modules ...');
+            $moduleDir = opendir(MODULE_PATH);
+            if (is_resource($moduleDir)){
+                while(($module = readdir($moduleDir)) !== false){
+                    if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
+                        self::$list[] = $module;
+                    }
+                    else{
+                        $logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
+                    }
+                }
+                closedir($moduleDir);
+            }
+            ksort(self::$list);
 			
-			if (! empty(self::$list)){
-				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
-			}
-		}
+            if (! empty(self::$list)){
+                $logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
+            }
+        }
 		
 
-		/**
-		 * Add new module in the list
-		 * @param string $name the name of the module
-		 *
-		 * @return object the current instance
-		 */
-		public function add($name){
-			self::$list[] = $name;
-			return $this;
-		}
+        /**
+         * Add new module in the list
+         * @param string $name the name of the module
+         *
+         * @return object the current instance
+         */
+        public function add($name){
+            self::$list[] = $name;
+            return $this;
+        }
 		
-		/**
-		 * Get the list of the custom autoload configuration from module if exists
-		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
-		 */
-		public static function getModulesAutoloadConfig(){
-			$logger = self::getLogger();
-			if (empty(self::$list)){
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$autoloads = array();
-			$autoloads['libraries'] = array();
-			$autoloads['config']    = array();
-			$autoloads['models']    = array();
-			$autoloads['functions'] = array();
-			$autoloads['languages'] = array();
+        /**
+         * Get the list of the custom autoload configuration from module if exists
+         * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
+         */
+        public static function getModulesAutoloadConfig(){
+            $logger = self::getLogger();
+            if (empty(self::$list)){
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $autoloads = array();
+            $autoloads['libraries'] = array();
+            $autoloads['config']    = array();
+            $autoloads['models']    = array();
+            $autoloads['functions'] = array();
+            $autoloads['languages'] = array();
 			
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
-				if (file_exists($file)){
-					$autoload = array();
-					require_once $file;
-					if (! empty($autoload) && is_array($autoload)){
-						$autoloads = array_merge_recursive($autoloads, $autoload);
-						unset($autoload);
-					}
-				}
-			}
-			return $autoloads;
-		}
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
+                if (file_exists($file)){
+                    $autoload = array();
+                    require_once $file;
+                    if (! empty($autoload) && is_array($autoload)){
+                        $autoloads = array_merge_recursive($autoloads, $autoload);
+                        unset($autoload);
+                    }
+                }
+            }
+            return $autoloads;
+        }
 
-		/**
-		 * Get the list of the custom routes configuration from module if exists
-		 * @return array|boolean the routes list or false if no module contains the routes configuration
-		 */
-		public static function getModulesRoutesConfig(){
-			$logger = self::getLogger();
-			if (empty(self::$list)){
-				$logger->info('No module was loaded skipping.');
-				return false;
-			}
-			$routes = array();
-			foreach (self::$list as $module) {
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
-				if (file_exists($file)){
-					$route = array();
-					require_once $file;
-					if (! empty($route) && is_array($route)){
-						$routes = array_merge($routes, $route);
-						unset($route);
-					}
-				}
-			}
-			return $routes;
-		}
+        /**
+         * Get the list of the custom routes configuration from module if exists
+         * @return array|boolean the routes list or false if no module contains the routes configuration
+         */
+        public static function getModulesRoutesConfig(){
+            $logger = self::getLogger();
+            if (empty(self::$list)){
+                $logger->info('No module was loaded skipping.');
+                return false;
+            }
+            $routes = array();
+            foreach (self::$list as $module) {
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
+                if (file_exists($file)){
+                    $route = array();
+                    require_once $file;
+                    if (! empty($route) && is_array($route)){
+                        $routes = array_merge($routes, $route);
+                        unset($route);
+                    }
+                }
+            }
+            return $routes;
+        }
 
 
-		/**
-		 * Check if in module list can have this controller
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
-		 */
-		public static function findControllerFullPath($class, $module = null){
-			return self::findClassInModuleFullFilePath($class, $module, 'controllers');
-		}
+        /**
+         * Check if in module list can have this controller
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this controller, path the full path of the controller
+         */
+        public static function findControllerFullPath($class, $module = null){
+            return self::findClassInModuleFullFilePath($class, $module, 'controllers');
+        }
 
-		/**
-		 * Check if in module list can have this model
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this model, return the full path of this model
-		 */
-		public static function findModelFullPath($class, $module = null){
-			return self::findClassInModuleFullFilePath($class, $module, 'models');
-		}
+        /**
+         * Check if in module list can have this model
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this model, return the full path of this model
+         */
+        public static function findModelFullPath($class, $module = null){
+            return self::findClassInModuleFullFilePath($class, $module, 'models');
+        }
 
-		/**
-		 * Check if in module list can have this library
-		 * @see Module::findClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
-		 */
-		public static function findLibraryFullPath($class, $module = null){
-			return self::findClassInModuleFullFilePath($class, $module, 'libraries');
-		}
+        /**
+         * Check if in module list can have this library
+         * @see Module::findClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this library,  return the full path of this library
+         */
+        public static function findLibraryFullPath($class, $module = null){
+            return self::findClassInModuleFullFilePath($class, $module, 'libraries');
+        }
 
 		
-		/**
-		 * Check if in module list can have this config
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
-		 */
-		public static function findConfigFullPath($configuration, $module = null){
-			return self::findNonClassInModuleFullFilePath($configuration, $module, 'config');
-		}
+        /**
+         * Check if in module list can have this config
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
+         */
+        public static function findConfigFullPath($configuration, $module = null){
+            return self::findNonClassInModuleFullFilePath($configuration, $module, 'config');
+        }
 
-		/**
-		 * Check if in module list can have this helper
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
-		 */
-		public static function findFunctionFullPath($helper, $module = null){
-			return self::findNonClassInModuleFullFilePath($helper, $module, 'functions');
-		}
+        /**
+         * Check if in module list can have this helper
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
+         */
+        public static function findFunctionFullPath($helper, $module = null){
+            return self::findNonClassInModuleFullFilePath($helper, $module, 'functions');
+        }
 
-		/**
-		 * Check if in module list can have this view
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this view, path the full path of the view
-		 */
-		public static function findViewFullPath($view, $module = null){
-			return self::findNonClassInModuleFullFilePath($view, $module, 'views');
-		}
+        /**
+         * Check if in module list can have this view
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this view, path the full path of the view
+         */
+        public static function findViewFullPath($view, $module = null){
+            return self::findNonClassInModuleFullFilePath($view, $module, 'views');
+        }
 
-		/**
-		 * Check if in module list can have this language
-		 * @see  Module::findNonClassInModuleFullFilePath
-		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
-		 */
-		public static function findLanguageFullPath($language, $appLang, $module = null){
-			return self::findNonClassInModuleFullFilePath($language, $module, 'lang', $appLang);
-		}
+        /**
+         * Check if in module list can have this language
+         * @see  Module::findNonClassInModuleFullFilePath
+         * @return boolean|string  false or null if no module have this language,  return the full path of this language
+         */
+        public static function findLanguageFullPath($language, $appLang, $module = null){
+            return self::findNonClassInModuleFullFilePath($language, $module, 'lang', $appLang);
+        }
 
-		/**
-		 * Get the list of module loaded
-		 * @return array the module list
-		 */
-		public static function getModuleList(){
-			return self::$list;
-		}
+        /**
+         * Get the list of module loaded
+         * @return array the module list
+         */
+        public static function getModuleList(){
+            return self::$list;
+        }
 
-		/**
-		 * Check if the application has an module
-		 * @return boolean
-		 */
-		public static function hasModule(){
-			return !empty(self::$list);
-		}
+        /**
+         * Check if the application has an module
+         * @return boolean
+         */
+        public static function hasModule(){
+            return !empty(self::$list);
+        }
 
-		/**
-		 * Check if in module list can have the model, controller, library
-		 * @param  string $class the class name of library, model, controller
-		 * @param string $module the module name
-		 * @param string $type the name of the type "controllers", "libraries", "models"
-		 * @return boolean|string  false or null if no module 
-		 * have this class, return the full path of the class
-		 */
-		protected static function findClassInModuleFullFilePath($class, $module, $type){
-			$logger = self::getLogger();
-		    $class = str_ireplace('.php', '', $class);
-		    $class = ucfirst($class);
-		    $classFile = $class.'.php';
-		    $logger->debug('Checking the class [' . $class . '] in module [' . $module . '] for [' . $type . '] ...');
-		    $filePath = MODULE_PATH . $module . DS . $type . DS . $classFile;
-		    if (file_exists($filePath)){
-		        $logger->info('Found class [' . $class . '] in module [' . $module . '] for [' . $type . '] the file path is [' .$filePath. ']');
-		        return $filePath;
-		    }
-		    $logger->info('Class [' . $class . '] does not exist in the module [' .$module. '] for [' . $type . ']');
-		    return false;
-		}
+        /**
+         * Check if in module list can have the model, controller, library
+         * @param  string $class the class name of library, model, controller
+         * @param string $module the module name
+         * @param string $type the name of the type "controllers", "libraries", "models"
+         * @return boolean|string  false or null if no module 
+         * have this class, return the full path of the class
+         */
+        protected static function findClassInModuleFullFilePath($class, $module, $type){
+            $logger = self::getLogger();
+            $class = str_ireplace('.php', '', $class);
+            $class = ucfirst($class);
+            $classFile = $class.'.php';
+            $logger->debug('Checking the class [' . $class . '] in module [' . $module . '] for [' . $type . '] ...');
+            $filePath = MODULE_PATH . $module . DS . $type . DS . $classFile;
+            if (file_exists($filePath)){
+                $logger->info('Found class [' . $class . '] in module [' . $module . '] for [' . $type . '] the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Class [' . $class . '] does not exist in the module [' .$module. '] for [' . $type . ']');
+            return false;
+        }
 
-		/**
-		 * Check if in module list can have the config, view, helper, language
-		 * @param string $name the name of config, view, helper, language
-		 * @param string $module the module name
-		 * @param string $type the name of the type "config", "functions", "views", "lang"
-		 * @param string|null $appLang the application language. This is use only when $type = "lang"
-		 * @return boolean|string  false or null if no module 
-		 * have this resource, return the full path of the resource
-		 */
-		protected static function findNonClassInModuleFullFilePath($name, $module, $type, $appLang = null){
-		    $logger = self::getLogger();
-		    $name = str_ireplace('.php', '', $name);
-		    $file = $name.'.php';
-		    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		    switch($type){
-		        case 'functions':
-		            $name = str_ireplace('function_', '', $name);
-		            $file = 'function_'.$name.'.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		        break;
-		        case 'views':
-		            $name = trim($name, '/\\');
-		            $name = str_ireplace('/', DS, $name);
-		            $file = $name . '.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
-		        break;
-		        case 'lang':
-		            $name = str_ireplace('lang_', '', $name);
-		            $file = 'lang_'.$name.'.php';
-		            $filePath = MODULE_PATH . $module . DS . $type . DS . $appLang . DS . $file;
-		        break;
-		    }
-		    $logger->debug('Checking resource [' . $name . '] in module [' .$module. '] for [' . $type . '] ...');
-		    if (file_exists($filePath)){
-		        $logger->info('Found resource [' . $name . '] in module [' .$module. '] for [' . $type . '] the file path is [' .$filePath. ']');
-		        return $filePath;
-		    }
-		    $logger->info('Resource [' . $name . '] does not exist in the module [' .$module. '] for [' . $type . ']');
-		    return false;
-		}
+        /**
+         * Check if in module list can have the config, view, helper, language
+         * @param string $name the name of config, view, helper, language
+         * @param string $module the module name
+         * @param string $type the name of the type "config", "functions", "views", "lang"
+         * @param string|null $appLang the application language. This is use only when $type = "lang"
+         * @return boolean|string  false or null if no module 
+         * have this resource, return the full path of the resource
+         */
+        protected static function findNonClassInModuleFullFilePath($name, $module, $type, $appLang = null){
+            $logger = self::getLogger();
+            $name = str_ireplace('.php', '', $name);
+            $file = $name.'.php';
+            $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+            switch($type){
+                case 'functions':
+                    $name = str_ireplace('function_', '', $name);
+                    $file = 'function_'.$name.'.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+                break;
+                case 'views':
+                    $name = trim($name, '/\\');
+                    $name = str_ireplace('/', DS, $name);
+                    $file = $name . '.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $file;
+                break;
+                case 'lang':
+                    $name = str_ireplace('lang_', '', $name);
+                    $file = 'lang_'.$name.'.php';
+                    $filePath = MODULE_PATH . $module . DS . $type . DS . $appLang . DS . $file;
+                break;
+            }
+            $logger->debug('Checking resource [' . $name . '] in module [' .$module. '] for [' . $type . '] ...');
+            if (file_exists($filePath)){
+                $logger->info('Found resource [' . $name . '] in module [' .$module. '] for [' . $type . '] the file path is [' .$filePath. ']');
+                return $filePath;
+            }
+            $logger->info('Resource [' . $name . '] does not exist in the module [' .$module. '] for [' . $type . ']');
+            return false;
+        }
 
-	}
+    }

core/classes/Config.php

Indentation +148 added lines, -148 removed lines

@@ -1,160 +1,160 @@
 <?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 Config extends BaseStaticClass{
+    class Config extends BaseStaticClass{
 		
-		/**
-		 * The list of loaded configuration
-		 * @var array
-		 */
-		private static $config = array();
+        /**
+         * The list of loaded configuration
+         * @var array
+         */
+        private static $config = array();
 
-		/**
-		 * Initialize the configuration by loading all the configuration from config file
-		 */
-		public static function init(){
-			$logger = self::getLogger();
-			$logger->debug('Initialization of the configuration');
-			self::$config = & load_configurations();
-			self::setBaseUrlUsingServerVar();
-			if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
-				$logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
-			}
-			$logger->info('Configuration initialized successfully');
-			$logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
-		}
+        /**
+         * Initialize the configuration by loading all the configuration from config file
+         */
+        public static function init(){
+            $logger = self::getLogger();
+            $logger->debug('Initialization of the configuration');
+            self::$config = & load_configurations();
+            self::setBaseUrlUsingServerVar();
+            if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){
+                $logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance');
+            }
+            $logger->info('Configuration initialized successfully');
+            $logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config));
+        }
 
-		/**
-		 * Get the configuration item value
-		 * @param  string $item    the configuration item name to get
-		 * @param  mixed $default the default value to use if can not find the config item in the list
-		 * @return mixed          the config value if exist or the default value
-		 */
-		public static function get($item, $default = null){
-			$logger = self::getLogger();
-			if(array_key_exists($item, self::$config)){
-				return self::$config[$item];
-			}
-			$logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
-			return $default;
-		}
+        /**
+         * Get the configuration item value
+         * @param  string $item    the configuration item name to get
+         * @param  mixed $default the default value to use if can not find the config item in the list
+         * @return mixed          the config value if exist or the default value
+         */
+        public static function get($item, $default = null){
+            $logger = self::getLogger();
+            if(array_key_exists($item, self::$config)){
+                return self::$config[$item];
+            }
+            $logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']');
+            return $default;
+        }
 
-		/**
-		 * Set the configuration item value
-		 * @param string $item  the config item name to set
-		 * @param mixed $value the config item value
-		 */
-		public static function set($item, $value){
-			self::$config[$item] = $value;
-		}
+        /**
+         * Set the configuration item value
+         * @param string $item  the config item name to set
+         * @param mixed $value the config item value
+         */
+        public static function set($item, $value){
+            self::$config[$item] = $value;
+        }
 
-		/**
-		 * Get all the configuration values
-		 * @return array the config values
-		 */
-		public static function getAll(){
-			return self::$config;
-		}
+        /**
+         * Get all the configuration values
+         * @return array the config values
+         */
+        public static function getAll(){
+            return self::$config;
+        }
 
-		/**
-		 * Set the configuration values bu merged with the existing configuration
-		 * @param array $config the config values to add in the configuration list
-		 */
-		public static function setAll(array $config = array()){
-			self::$config = array_merge(self::$config, $config);
-		}
+        /**
+         * Set the configuration values bu merged with the existing configuration
+         * @param array $config the config values to add in the configuration list
+         */
+        public static function setAll(array $config = array()){
+            self::$config = array_merge(self::$config, $config);
+        }
 
-		/**
-		 * Delete the configuration item in the list
-		 * @param  string $item the config item name to be deleted
-		 * @return boolean true if the item exists and is deleted successfully otherwise will return false.
-		 */
-		public static function delete($item){
-			$logger = self::getLogger();
-			if(array_key_exists($item, self::$config)){
-				$logger->info('Delete config item ['.$item.']');
-				unset(self::$config[$item]);
-				return true;
-			}
-			else{
-				$logger->warning('Config item ['.$item.'] to be deleted does not exists');
-				return false;
-			}
-		}
+        /**
+         * Delete the configuration item in the list
+         * @param  string $item the config item name to be deleted
+         * @return boolean true if the item exists and is deleted successfully otherwise will return false.
+         */
+        public static function delete($item){
+            $logger = self::getLogger();
+            if(array_key_exists($item, self::$config)){
+                $logger->info('Delete config item ['.$item.']');
+                unset(self::$config[$item]);
+                return true;
+            }
+            else{
+                $logger->warning('Config item ['.$item.'] to be deleted does not exists');
+                return false;
+            }
+        }
 
-		/**
-		 * Load the configuration file. This an alias to Loader::config()
-		 * @param  string $config the config name to be loaded
-		 */
-		public static function load($config){
-			Loader::config($config);
-		}
+        /**
+         * Load the configuration file. This an alias to Loader::config()
+         * @param  string $config the config name to be loaded
+         */
+        public static function load($config){
+            Loader::config($config);
+        }
 
-		/**
-		 * Set the configuration for "base_url" if is not set in the configuration
-		 */
-		private static function setBaseUrlUsingServerVar(){
-			$logger = self::getLogger();
-			if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){
-				if(ENVIRONMENT == 'production'){
-					$logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
-				}
-				$baseUrl = null;
-				$protocol = 'http';
-				if(is_https()){
-					$protocol = 'https';
-				}
-				$protocol .='://';
+        /**
+         * Set the configuration for "base_url" if is not set in the configuration
+         */
+        private static function setBaseUrlUsingServerVar(){
+            $logger = self::getLogger();
+            if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){
+                if(ENVIRONMENT == 'production'){
+                    $logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time');
+                }
+                $baseUrl = null;
+                $protocol = 'http';
+                if(is_https()){
+                    $protocol = 'https';
+                }
+                $protocol .='://';
 
-				if (isset($_SERVER['SERVER_ADDR'])){
-					$baseUrl = $_SERVER['SERVER_ADDR'];
-					//check if the server is running under IPv6
-					if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
-						$baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
-					}
-					$serverPort = 80;
-					if (isset($_SERVER['SERVER_PORT'])) {
-						$serverPort = $_SERVER['SERVER_PORT'];
-					}
-					$port = '';
-					if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){
-						$port = ':'.$serverPort;
-					}
-					$baseUrl = $protocol . $baseUrl . $port . substr(
-																		$_SERVER['SCRIPT_NAME'], 
-																		0, 
-																		strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
-																	);
-				}
-				else{
-					$logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
-					$baseUrl = 'http://localhost/';
-				}
-				self::set('base_url', $baseUrl);
-			}
-			self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
-		}
-	}
+                if (isset($_SERVER['SERVER_ADDR'])){
+                    $baseUrl = $_SERVER['SERVER_ADDR'];
+                    //check if the server is running under IPv6
+                    if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){
+                        $baseUrl = '['.$_SERVER['SERVER_ADDR'].']';
+                    }
+                    $serverPort = 80;
+                    if (isset($_SERVER['SERVER_PORT'])) {
+                        $serverPort = $_SERVER['SERVER_PORT'];
+                    }
+                    $port = '';
+                    if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){
+                        $port = ':'.$serverPort;
+                    }
+                    $baseUrl = $protocol . $baseUrl . $port . substr(
+                                                                        $_SERVER['SCRIPT_NAME'], 
+                                                                        0, 
+                                                                        strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME']))
+                                                                    );
+                }
+                else{
+                    $logger->warning('Can not determine the application base URL automatically, use http://localhost as default');
+                    $baseUrl = 'http://localhost/';
+                }
+                self::set('base_url', $baseUrl);
+            }
+            self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/';
+        }
+    }

core/classes/database/DatabaseQueryRunner.php

Indentation +156 added lines, -156 removed lines

@@ -1,85 +1,85 @@ 
 <?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 extends BaseClass{
+    /**
+     * 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 extends BaseClass{
       
    
-  	/**
-  	 * 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 $returnAsList     = true;
+     * @var array|boolean
+     */
+        private $returnAsList     = 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;
 
 
@@ -94,7 +94,7 @@ 
     public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
         parent::__construct();
         if (is_object($pdo)){
-          $this->pdo = $pdo;
+            $this->pdo = $pdo;
         }
         $this->query         = $query;
         $this->returnAsList  = $returnAsList;
@@ -112,10 +112,10 @@ 
         //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 . ']');
@@ -128,101 +128,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;
     }
     
     /**
@@ -231,18 +231,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;
     }
     
     /**
@@ -250,7 +250,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
     
     /**
@@ -259,8 +259,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setQuery($query){
-       $this->query = $query;
-       return $this;
+        $this->query = $query;
+        return $this;
     }
     
     /**
@@ -269,8 +269,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnType($returnType){
-       $this->returnAsList = $returnType;
-       return $this;
+        $this->returnAsList = $returnType;
+        return $this;
     }
     
     /**
@@ -279,8 +279,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnAsArray($status = true){
-       $this->returnAsArray = $status;
-       return $this;
+        $this->returnAsArray = $status;
+        return $this;
     }
     
     /**
@@ -288,7 +288,7 @@ 
      * @return string
      */
     public function getQueryError(){
-      return $this->error;
+        return $this->error;
     }
 
     /**
@@ -296,7 +296,7 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
@@ -305,16 +305,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;
     }
 
     /**
@@ -323,8 +323,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setDriver($driver){
-      $this->driver = $driver;
-      return $this;
+        $this->driver = $driver;
+        return $this;
     }
     
     /**
@@ -333,18 +333,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');
     }
     
     /**
@@ -352,19 +352,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;

core/classes/database/Database.php

Indentation +322 added lines, -322 removed lines

@@ -1,113 +1,113 @@ 
 <?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 extends BaseClass{
+    /**
+     * 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 extends BaseClass{
 	
-  	/**
-  	 * 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 cache instance
-    * @var object
-    */
+     * The cache instance
+     * @var object
+     */
     private $cacheInstance       = null;
 
     
-  	/**
-    * The DatabaseQueryBuilder instance
-    * @var object
-    */
+        /**
+         * The DatabaseQueryBuilder instance
+         * @var object
+         */
     protected $queryBuilder        = null;
     
     /**
-    * The DatabaseQueryRunner instance
-    * @var object
-    */
+     * The DatabaseQueryRunner instance
+     * @var object
+     */
     protected $queryRunner         = null;
 
 
@@ -119,7 +119,7 @@ 
     public function __construct($overwriteConfig = array(), $autoConnect = true){
         parent::__construct();
 		
-    		//Set DatabaseQueryBuilder instance to use
+            //Set DatabaseQueryBuilder instance to use
         $this->setDependencyInstanceFromParamOrCreate('queryBuilder', null, 'DatabaseQueryBuilder', 'classes/database');
        
         //Set DatabaseQueryRunner instance to use
@@ -137,8 +137,8 @@ 
      * @return bool 
      */
     public function connect(){
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         try{
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
@@ -149,14 +149,14 @@ 
             $this->updateQueryBuilderAndRunnerProperties();
 
             return is_object($this->pdo);
-          }
-          catch (PDOException $e){
+            }
+            catch (PDOException $e){
             $this->logger->fatal($e->getMessage());
             show_error('Cannot connect to Database.');
             return false;
-          }
-      }
-      return false;
+            }
+        }
+        return false;
     }
 
 
@@ -165,7 +165,7 @@ 
      * @return int
      */
     public function numRows(){
-      return $this->numRows;
+        return $this->numRows;
     }
 
     /**
@@ -173,7 +173,7 @@ 
      * @return mixed
      */
     public function insertId(){
-      return $this->insertId;
+        return $this->insertId;
     }
 
 
@@ -184,13 +184,13 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function get($returnSQLQueryOrResultType = false){
-      $this->queryBuilder->limit(1);
-      $query = $this->getAll(true);
-      if ($returnSQLQueryOrResultType === true){
+        $this->queryBuilder->limit(1);
+        $query = $this->getAll(true);
+        if ($returnSQLQueryOrResultType === true){
         return $query;
-      } else {
+        } else {
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
-      }
+        }
     }
 
     /**
@@ -200,11 +200,11 @@ 
      * @return mixed       the query SQL string or the record result
      */
     public function getAll($returnSQLQueryOrResultType = false){
-	   $query = $this->queryBuilder->getQuery();
-	   if ($returnSQLQueryOrResultType === true){
-      	return $query;
-      }
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
+        $query = $this->queryBuilder->getQuery();
+        if ($returnSQLQueryOrResultType === true){
+            return $query;
+        }
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
     }
 
     /**
@@ -214,19 +214,19 @@ 
      * @return mixed          the insert id of the new record or null
      */
     public function insert($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->insert($data, $escape)->getQuery();
-      $result = $this->query($query);
-      if ($result){
+        }
+        $query = $this->queryBuilder->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;
     }
 
     /**
@@ -236,13 +236,13 @@ 
      * @return mixed          the update status
      */
     public function update($data = array(), $escape = true){
-      if (empty($data) && ! empty($this->data)){
+        if (empty($data) && ! empty($this->data)){
         //as when using $this->setData() may be the data already escaped
         $escape = false;
         $data = $this->data;
-      }
-      $query = $this->queryBuilder->update($data, $escape)->getQuery();
-      return $this->query($query);
+        }
+        $query = $this->queryBuilder->update($data, $escape)->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -250,8 +250,8 @@ 
      * @return mixed the delete status
      */
     public function delete(){
-		  $query = $this->queryBuilder->delete()->getQuery();
-    	return $this->query($query);
+            $query = $this->queryBuilder->delete()->getQuery();
+        return $this->query($query);
     }
 
     /**
@@ -260,17 +260,17 @@ 
      * @return object        the current Database instance
      */
     public function setCache($ttl = 0){
-      $this->cacheTtl = $ttl;
-      $this->temporaryCacheTtl = $ttl;
-      return $this;
+        $this->cacheTtl = $ttl;
+        $this->temporaryCacheTtl = $ttl;
+        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){
         $this->temporaryCacheTtl = $ttl;
         return $this;
     }
@@ -283,11 +283,11 @@ 
      * need escaped
      */
     public function escape($data, $escaped = true){
-      $data = trim($data);
-      if($escaped){
+        $data = trim($data);
+        if($escaped){
         return $this->pdo->quote($data);
-      }
-      return $data; 
+        }
+        return $data; 
     }
 
     /**
@@ -295,7 +295,7 @@ 
      * @return int
      */
     public function queryCount(){
-      return $this->queryCount;
+        return $this->queryCount;
     }
 
     /**
@@ -303,7 +303,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
 
     /**
@@ -311,7 +311,7 @@ 
      * @return string
      */
     public function getDatabaseName(){
-      return $this->databaseName;
+        return $this->databaseName;
     }
 
     /**
@@ -319,44 +319,44 @@ 
      * @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;
     }
 
-     /**
-     * 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;
     }
 
     /**
@@ -364,8 +364,8 @@ 
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
      */
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
-      $this->queryBuilder = $queryBuilder;
-      return $this;
+        $this->queryBuilder = $queryBuilder;
+        return $this;
     }
     
     /**
@@ -373,7 +373,7 @@ 
      * @return object DatabaseQueryRunner
      */
     public function getQueryRunner(){
-      return $this->queryRunner;
+        return $this->queryRunner;
     }
 
     /**
@@ -381,8 +381,8 @@ 
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
      */
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
-      $this->queryRunner = $queryRunner;
-      return $this;
+        $this->queryRunner = $queryRunner;
+        return $this;
     }
 
     /**
@@ -390,7 +390,7 @@ 
      * @return array
      */
     public function getData(){
-      return $this->data;
+        return $this->data;
     }
 
     /**
@@ -401,62 +401,62 @@ 
      * @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');
+        $this->reset();
+        $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
+        //If is the SELECT query
+        $isSqlSELECTQuery = stristr($this->query, 'SELECT');
 
-      //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++;
         
         $queryResult = $this->queryRunner->setQuery($query)
-                                          ->setReturnType($returnAsList)
-                                          ->setReturnAsArray($returnAsArray)
-                                          ->execute();
+                                            ->setReturnType($returnAsList)
+                                            ->setReturnAsArray($returnAsArray)
+                                            ->execute();
 
         if (!is_object($queryResult)){
-          $this->result = false;
-          $this->numRows = 0;
-          return $this->result;
+            $this->result = false;
+            $this->numRows = 0;
+            return $this->result;
         }
         $this->result  = $queryResult->getResult();
         $this->numRows = $queryResult->getNumRows();
@@ -464,72 +464,72 @@ 
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
         }
-      } 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;
-    }
-
-   /**
-    * 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
-    * @param boolean $autoConnect whether to connect to database after set the configuration
-	  * @return object Database
-    */
+        } 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;
+    }
+
+    /**
+     * 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
+     * @param boolean $autoConnect whether to connect to database after set the configuration
+     * @return object Database
+     */
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
-      $db = array();
-      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';
-      }
+        $db = array();
+        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';
+        }
       
-      //merge with the parameter  
-      $db = array_merge($db, $overwriteConfig);
+        //merge with the parameter  
+        $db = array_merge($db, $overwriteConfig);
       
-      //get the default configuration
-      $config = $this->getDatabaseDefaultConfiguration();
+        //get the default configuration
+        $config = $this->getDatabaseDefaultConfiguration();
 		  
-    	$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']))
-												))
-							);
-  	  if($autoConnect){
-    		 //Now connect to the database
-    		 $this->connect();
-  		}
-		 return $this;
-    }
-
-    /**
-   * Return the database configuration
-   * @return array
-   */
+            $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']))
+                                                ))
+                            );
+        if($autoConnect){
+                //Now connect to the database
+                $this->connect();
+            }
+            return $this;
+    }
+
+    /**
+     * Return the database configuration
+     * @return array
+     */
     public  function getDatabaseConfiguration(){
-      return $this->config;
+        return $this->config;
     }
 
     /**
      * Close the connexion
      */
     public function close(){
-      $this->pdo = null;
+        $this->pdo = null;
     }
 
     /**
@@ -537,16 +537,16 @@ 
      * @return array
      */
     protected function getDatabaseDefaultConfiguration(){
-      return array(
-              'driver' => '',
-              'username' => '',
-              'password' => '',
-              'database' => '',
-              'hostname' => 'localhost',
-              'charset' => 'utf8',
-              'collation' => 'utf8_general_ci',
-              'prefix' => '',
-              'port' => ''
+        return array(
+                'driver' => '',
+                'username' => '',
+                'password' => '',
+                'database' => '',
+                'hostname' => 'localhost',
+                'charset' => 'utf8',
+                'collation' => 'utf8_general_ci',
+                'prefix' => '',
+                'port' => ''
             );
     }
 
@@ -555,18 +555,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'])
-                           ->setPrefix($this->config['prefix'])
-                           ->setPdo($this->pdo);
-     }
+                            ->setPrefix($this->config['prefix'])
+                            ->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'])
-                          ->setPdo($this->pdo);
-     }
+                            ->setPdo($this->pdo);
+        }
     }
 	
 
@@ -575,21 +575,21 @@ 
      * @return string|null the DSN string or null if can not find it
      */
     protected function getDsnValueFromConfig(){
-      $dsn = null;
-      $config = $this->getDatabaseConfiguration();
-      if (! empty($config)){
+        $dsn = null;
+        $config = $this->getDatabaseConfiguration();
+        if (! empty($config)){
         $driver = $config['driver'];
         $driverDsnMap = array(
-                              'mysql'  => $this->getDsnValueForDriver('mysql'),
-                              'pgsql'  => $this->getDsnValueForDriver('pgsql'),
-                              'sqlite' => $this->getDsnValueForDriver('sqlite'),
-                              'oracle' => $this->getDsnValueForDriver('oracle')
-                              );
+                                'mysql'  => $this->getDsnValueForDriver('mysql'),
+                                'pgsql'  => $this->getDsnValueForDriver('pgsql'),
+                                'sqlite' => $this->getDsnValueForDriver('sqlite'),
+                                'oracle' => $this->getDsnValueForDriver('oracle')
+                                );
         if (isset($driverDsnMap[$driver])){
-          $dsn = $driverDsnMap[$driver];
+            $dsn = $driverDsnMap[$driver];
         }
-      }    
-      return $dsn;
+        }    
+        return $dsn;
     }
 
     /**
@@ -598,32 +598,32 @@ 
      * @return string|null         the dsn name
      */
     protected function getDsnValueForDriver($driver){
-      $dsn = '';
-      $config = $this->getDatabaseConfiguration();
-      if (empty($config)){
+        $dsn = '';
+        $config = $this->getDatabaseConfiguration();
+        if (empty($config)){
         return null;
-      }
-      switch ($driver) {
+        }
+        switch ($driver) {
         case 'mysql':
         case 'pgsql':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = 'port=' . $config['port'] . ';';
-          }
-          $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
-          break;
+            }
+            $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
+            break;
         case 'sqlite':
           $dsn = 'sqlite:' . $config['database'];
-          break;
-          case 'oracle':
+            break;
+            case 'oracle':
           $port = '';
-          if (! empty($config['port'])) {
+            if (! empty($config['port'])) {
             $port = ':' . $config['port'];
-          }
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
-          break;
-      }
-      return $dsn;
+            }
+            $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
+            break;
+        }
+        return $dsn;
     }
 
     /**
@@ -635,11 +635,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);
     }
@@ -651,27 +651,27 @@ 
      * @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);
     }
 
 	
@@ -679,20 +679,20 @@ 
      * Reset the database class attributs to the initail values before each query.
      */
     private function reset(){
-	   //query builder reset
-      $this->queryBuilder->reset();
-      $this->numRows  = 0;
-      $this->insertId = null;
-      $this->query    = null;
-      $this->result   = array();
-      $this->data     = array();
+        //query builder reset
+        $this->queryBuilder->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;
     }
 
 }