tnhfw / tnh-fw

core/libraries/Html.php

Indentation +238 added lines, -238 removed lines

@@ -1,251 +1,251 @@
 <?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 Html{
+    class Html{
 
-		/**
-		 * Generate the html anchor link
-		 * @param  string $link       the href attribute value
-		 * @param  string $anchor     the displayed anchor
-		 * @param  array  $attributes the additional attributes to be added
-		 * @param boolean $return whether need return the generated html or just display it directly
-		 *
-		 * @return string|void             the anchor link generated html if $return is true or display it if not
-		 */
-		public static function a($link = '', $anchor = null, array $attributes = array(), $return = true){
-			if(! is_url($link)){
-				$link = Url::site_url($link);
-			}
-			if(! $anchor){
-				$anchor = $link;
-			}
-			$str = null;
-			$str .= '<a href = "'.$link.'"';
-			$str .= attributes_to_string($attributes);
-			$str .= '>';
-			$str .= $anchor;
-			$str .= '</a>';
+        /**
+         * Generate the html anchor link
+         * @param  string $link       the href attribute value
+         * @param  string $anchor     the displayed anchor
+         * @param  array  $attributes the additional attributes to be added
+         * @param boolean $return whether need return the generated html or just display it directly
+         *
+         * @return string|void             the anchor link generated html if $return is true or display it if not
+         */
+        public static function a($link = '', $anchor = null, array $attributes = array(), $return = true){
+            if(! is_url($link)){
+                $link = Url::site_url($link);
+            }
+            if(! $anchor){
+                $anchor = $link;
+            }
+            $str = null;
+            $str .= '<a href = "'.$link.'"';
+            $str .= attributes_to_string($attributes);
+            $str .= '>';
+            $str .= $anchor;
+            $str .= '</a>';
 
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 		
-		/**
-		 * Generate an mailto anchor link
-		 * @param  string $link       the email address 
-		 * @param  string $anchor     the displayed value of the link
-		 * @param  array  $attributes the additional attributes to be added
-		 * @param boolean $return whether need return the generated html or just display it directly
-		 *
-		 * @return string|void             the generated html for mailto link if $return is true or display it if not
-		 */
-		public static function mailto($link, $anchor = null, array $attributes = array(), $return = true){
-			if(! $anchor){
-				$anchor = $link;
-			}
-			$str = null;
-			$str .= '<a href = "mailto:'.$link.'"';
-			$str .= attributes_to_string($attributes);
-			$str .= '>';
-			$str .= $anchor;
-			$str .= '</a>';
+        /**
+         * Generate an mailto anchor link
+         * @param  string $link       the email address 
+         * @param  string $anchor     the displayed value of the link
+         * @param  array  $attributes the additional attributes to be added
+         * @param boolean $return whether need return the generated html or just display it directly
+         *
+         * @return string|void             the generated html for mailto link if $return is true or display it if not
+         */
+        public static function mailto($link, $anchor = null, array $attributes = array(), $return = true){
+            if(! $anchor){
+                $anchor = $link;
+            }
+            $str = null;
+            $str .= '<a href = "mailto:'.$link.'"';
+            $str .= attributes_to_string($attributes);
+            $str .= '>';
+            $str .= $anchor;
+            $str .= '</a>';
 
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html "br" tag  
-		 * @param  integer $nb the number of generated "<br />" tag
-		 * @param boolean $return whether need return the generated html or just display it directly
-		 *
-		 * @return string|void      the generated "br" html if $return is true or display it if not
-		 */
-		public static function br($nb = 1, $return = true){
-			$nb = (int) $nb;
-			$str = null;
-			for ($i = 1; $i <= $nb; $i++) {
-				$str .= '<br />';
-			}
+        /**
+         * Generate the html "br" tag  
+         * @param  integer $nb the number of generated "<br />" tag
+         * @param boolean $return whether need return the generated html or just display it directly
+         *
+         * @return string|void      the generated "br" html if $return is true or display it if not
+         */
+        public static function br($nb = 1, $return = true){
+            $nb = (int) $nb;
+            $str = null;
+            for ($i = 1; $i <= $nb; $i++) {
+                $str .= '<br />';
+            }
 
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html content for tag "hr"
-		 * @param integer $nb the number of generated "<hr />" tag
-		 * @param  array   $attributes the tag attributes
-		 * @param  boolean $return    whether need return the generated html or just display it directly
-		 *
-		 * @return string|void the generated "hr" html if $return is true or display it if not.
-		 */
-		public static function hr($nb = 1, array $attributes = array(), $return = true){
-			$nb = (int) $nb;
-			$str = null;
-			for ($i = 1; $i <= $nb; $i++) {
-				$str .= '<hr' .attributes_to_string($attributes). ' />';
-			}
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+        /**
+         * Generate the html content for tag "hr"
+         * @param integer $nb the number of generated "<hr />" tag
+         * @param  array   $attributes the tag attributes
+         * @param  boolean $return    whether need return the generated html or just display it directly
+         *
+         * @return string|void the generated "hr" html if $return is true or display it if not.
+         */
+        public static function hr($nb = 1, array $attributes = array(), $return = true){
+            $nb = (int) $nb;
+            $str = null;
+            for ($i = 1; $i <= $nb; $i++) {
+                $str .= '<hr' .attributes_to_string($attributes). ' />';
+            }
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html content for tag like h1, h2, h3, h4, h5 and h6
-		 * @param  integer $type       the tag type 1 mean h1, 2 h2, etc,
-		 * @param  string  $text       the display text
-		 * @param integer $nb the number of generated "<h{1,2,3,4,5,6}>"
-		 * @param  array   $attributes the tag attributes
-		 * @param  boolean $return    whether need return the generated html or just display it directly
-		 *
-		 * @return string|void the generated header html if $return is true or display it if not.
-		 */
-		public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true){
-			$nb = (int) $nb;
-			$type = (int) $type;
-			if($type <= 0 || $type > 6){
-				$type = 1;
-			}
-			$str = null;
-			for ($i = 1; $i <= $nb; $i++) {
-				$str .= '<h' . $type . attributes_to_string($attributes). '>' .$text. '</h' . $type . '>';
-			}
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+        /**
+         * Generate the html content for tag like h1, h2, h3, h4, h5 and h6
+         * @param  integer $type       the tag type 1 mean h1, 2 h2, etc,
+         * @param  string  $text       the display text
+         * @param integer $nb the number of generated "<h{1,2,3,4,5,6}>"
+         * @param  array   $attributes the tag attributes
+         * @param  boolean $return    whether need return the generated html or just display it directly
+         *
+         * @return string|void the generated header html if $return is true or display it if not.
+         */
+        public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true){
+            $nb = (int) $nb;
+            $type = (int) $type;
+            if($type <= 0 || $type > 6){
+                $type = 1;
+            }
+            $str = null;
+            for ($i = 1; $i <= $nb; $i++) {
+                $str .= '<h' . $type . attributes_to_string($attributes). '>' .$text. '</h' . $type . '>';
+            }
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html "ul" tag
-		 * @param  array   $data the data to use for each "li" tag
-		 * @param  array   $attributes   the "ul" properties attribute use the array index below for each tag:
-		 *  for ul "ul", for li "li".
-		 * @param  boolean $return whether need return the generated html or just display it directly
-		 *
-		 * @return string|void the generated "ul" html  if $return is true or display it if not.
-		 */
-		public static function ul($data = array(), $attributes = array(), $return = true){
-			$data = (array) $data;
-			$str = null;
-			$str .= '<ul' . (! empty($attributes['ul']) ? attributes_to_string($attributes['ul']):'') . '>';
-			foreach ($data as $row) {
-				$str .= '<li' . (! empty($attributes['li']) ? attributes_to_string($attributes['li']):'') .'>' .$row. '</li>';
-			}
-			$str .= '</ul>';
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+        /**
+         * Generate the html "ul" tag
+         * @param  array   $data the data to use for each "li" tag
+         * @param  array   $attributes   the "ul" properties attribute use the array index below for each tag:
+         *  for ul "ul", for li "li".
+         * @param  boolean $return whether need return the generated html or just display it directly
+         *
+         * @return string|void the generated "ul" html  if $return is true or display it if not.
+         */
+        public static function ul($data = array(), $attributes = array(), $return = true){
+            $data = (array) $data;
+            $str = null;
+            $str .= '<ul' . (! empty($attributes['ul']) ? attributes_to_string($attributes['ul']):'') . '>';
+            foreach ($data as $row) {
+                $str .= '<li' . (! empty($attributes['li']) ? attributes_to_string($attributes['li']):'') .'>' .$row. '</li>';
+            }
+            $str .= '</ul>';
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html "ol" tag
-		 * @param  array   $data the data to use for each "li" tag
-		 * @param  array   $attributes   the "ol" properties attribute use the array index below for each tag:
-		 *  for ol "ol", for li "li".
-		 * @param  boolean $return whether need return the generated html or just display it directly
-		 * @return string|void the generated "ol" html  if $return is true or display it if not.
-		 */
-		public static function ol($data = array(), $attributes = array(), $return = true){
-			$data = (array) $data;
-			$str = null;
-			$str .= '<ol' . (!empty($attributes['ol']) ? attributes_to_string($attributes['ol']):'') . '>';
-			foreach ($data as $row) {
-				$str .= '<li' . (!empty($attributes['li']) ? attributes_to_string($attributes['li']):'') .'>' .$row. '</li>';
-			}
-			$str .= '</ol>';
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+        /**
+         * Generate the html "ol" tag
+         * @param  array   $data the data to use for each "li" tag
+         * @param  array   $attributes   the "ol" properties attribute use the array index below for each tag:
+         *  for ol "ol", for li "li".
+         * @param  boolean $return whether need return the generated html or just display it directly
+         * @return string|void the generated "ol" html  if $return is true or display it if not.
+         */
+        public static function ol($data = array(), $attributes = array(), $return = true){
+            $data = (array) $data;
+            $str = null;
+            $str .= '<ol' . (!empty($attributes['ol']) ? attributes_to_string($attributes['ol']):'') . '>';
+            foreach ($data as $row) {
+                $str .= '<li' . (!empty($attributes['li']) ? attributes_to_string($attributes['li']):'') .'>' .$row. '</li>';
+            }
+            $str .= '</ol>';
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * Generate the html "table" tag
-		 * @param  array   $headers            the table headers to use between (<thead>)
-		 * @param  array   $body the table body values between (<tbody>)
-		 * @param  array   $attributes   the table properties attribute use the array index below for each tag:
-		 *  for table "table", for thead "thead", for thead tr "thead_tr",
-		 *  for thead th "thead_th", for tbody "tbody", for tbody tr "tbody_tr", for tbody td "tbody_td", for tfoot "tfoot",
-		 *  for tfoot tr "tfoot_tr", for tfoot th "tfoot_th".
-		 * @param boolean $use_footer whether need to generate table footer (<tfoot>) use the $headers values
-		 * @param  boolean $return whether need return the generated html or just display it directly
-		 * @return string|void the generated "table" html  if $return is true or display it if not.
-		 */
-		public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true){
-			$headers = (array) $headers;
-			$body = (array) $body;
-			$str = null;
-			$str .= '<table' . (! empty($attributes['table']) ? attributes_to_string($attributes['table']):'') . '>';
-			if(! empty($headers)){
-				$str .= '<thead' . (! empty($attributes['thead']) ? attributes_to_string($attributes['thead']):'') .'>';
-				$str .= '<tr' . (! empty($attributes['thead_tr']) ? attributes_to_string($attributes['thead_tr']):'') .'>';
-				foreach ($headers as $value) {
-					$str .= '<th' . (! empty($attributes['thead_th']) ? attributes_to_string($attributes['thead_th']):'') .'>' .$value. '</th>';
-				}
-				$str .= '</tr>';
-				$str .= '</thead>';
-			}
-			else{
-				//no need check for footer
-				$use_footer = false;
-			}
-			$str .= '<tbody' . (! empty($attributes['tbody']) ? attributes_to_string($attributes['tbody']):'') .'>';
-			foreach ($body as $row) {
-				if(is_array($row)){
-					$str .= '<tr' . (! empty($attributes['tbody_tr']) ? attributes_to_string($attributes['tbody_tr']):'') .'>';
-					foreach ($row as $value) {
-						$str .= '<td' . (! empty($attributes['tbody_td']) ? attributes_to_string($attributes['tbody_td']):'') .'>' .$value. '</td>';	
-					}
-					$str .= '</tr>';
-				}
-			}
-			$str .= '</tbody>';
-			if($use_footer){
-				$str .= '<tfoot' . (! empty($attributes['tfoot']) ? attributes_to_string($attributes['tfoot']):'') .'>';
-				$str .= '<tr' . (! empty($attributes['tfoot_tr']) ? attributes_to_string($attributes['tfoot_tr']):'') .'>';
-				foreach ($headers as $value) {
-					$str .= '<th' . (! empty($attributes['tfoot_th']) ? attributes_to_string($attributes['tfoot_th']):'') .'>' .$value. '</th>';
-				}
-				$str .= '</tr>';
-				$str .= '</tfoot>';
-			}
-			$str .= '</table>';
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
-	}
+        /**
+         * Generate the html "table" tag
+         * @param  array   $headers            the table headers to use between (<thead>)
+         * @param  array   $body the table body values between (<tbody>)
+         * @param  array   $attributes   the table properties attribute use the array index below for each tag:
+         *  for table "table", for thead "thead", for thead tr "thead_tr",
+         *  for thead th "thead_th", for tbody "tbody", for tbody tr "tbody_tr", for tbody td "tbody_td", for tfoot "tfoot",
+         *  for tfoot tr "tfoot_tr", for tfoot th "tfoot_th".
+         * @param boolean $use_footer whether need to generate table footer (<tfoot>) use the $headers values
+         * @param  boolean $return whether need return the generated html or just display it directly
+         * @return string|void the generated "table" html  if $return is true or display it if not.
+         */
+        public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true){
+            $headers = (array) $headers;
+            $body = (array) $body;
+            $str = null;
+            $str .= '<table' . (! empty($attributes['table']) ? attributes_to_string($attributes['table']):'') . '>';
+            if(! empty($headers)){
+                $str .= '<thead' . (! empty($attributes['thead']) ? attributes_to_string($attributes['thead']):'') .'>';
+                $str .= '<tr' . (! empty($attributes['thead_tr']) ? attributes_to_string($attributes['thead_tr']):'') .'>';
+                foreach ($headers as $value) {
+                    $str .= '<th' . (! empty($attributes['thead_th']) ? attributes_to_string($attributes['thead_th']):'') .'>' .$value. '</th>';
+                }
+                $str .= '</tr>';
+                $str .= '</thead>';
+            }
+            else{
+                //no need check for footer
+                $use_footer = false;
+            }
+            $str .= '<tbody' . (! empty($attributes['tbody']) ? attributes_to_string($attributes['tbody']):'') .'>';
+            foreach ($body as $row) {
+                if(is_array($row)){
+                    $str .= '<tr' . (! empty($attributes['tbody_tr']) ? attributes_to_string($attributes['tbody_tr']):'') .'>';
+                    foreach ($row as $value) {
+                        $str .= '<td' . (! empty($attributes['tbody_td']) ? attributes_to_string($attributes['tbody_td']):'') .'>' .$value. '</td>';	
+                    }
+                    $str .= '</tr>';
+                }
+            }
+            $str .= '</tbody>';
+            if($use_footer){
+                $str .= '<tfoot' . (! empty($attributes['tfoot']) ? attributes_to_string($attributes['tfoot']):'') .'>';
+                $str .= '<tr' . (! empty($attributes['tfoot_tr']) ? attributes_to_string($attributes['tfoot_tr']):'') .'>';
+                foreach ($headers as $value) {
+                    $str .= '<th' . (! empty($attributes['tfoot_th']) ? attributes_to_string($attributes['tfoot_th']):'') .'>' .$value. '</th>';
+                }
+                $str .= '</tr>';
+                $str .= '</tfoot>';
+            }
+            $str .= '</table>';
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
+    }

core/constants.php

Indentation +72 added lines, -72 removed lines

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

core/common.php

Indentation +536 added lines, -536 removed lines

@@ -1,585 +1,585 @@
 <?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 common.php
-	 *  
-	 *  Contains most of the commons functions used by the system
-	 *  
-	 *  @package	core
-	 *  @author	Tony NGUEREZA
-	 *  @copyright	Copyright (c) 2017
-	 *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
-	 *  @link	http://www.iacademy.cf
-	 *  @version 1.0.0
-	 *  @filesource
-	 */
+    /**
+     *  @file common.php
+     *  
+     *  Contains most of the commons functions used by the system
+     *  
+     *  @package	core
+     *  @author	Tony NGUEREZA
+     *  @copyright	Copyright (c) 2017
+     *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
+     *  @link	http://www.iacademy.cf
+     *  @version 1.0.0
+     *  @filesource
+     */
 	
 
-	/**
-	 * This function is the class loader helper is used if the library "Loader" not yet loaded
-	 * he load the class once
-	 * @param  string $class  the class name to be loaded
-	 * @param  string $dir    the directory where to find the class
-	 * @param  mixed $params the parameter to pass as argument to the constructor of the class
-	 * @codeCoverageIgnore
-	 * 
-	 * @return object         the instance of the loaded class
-	 */
-	function & class_loader($class, $dir = 'libraries', $params = null){
-		//put the first letter of class to upper case 
-		$class = ucfirst($class);
-		static $classes = array();
-		if (isset($classes[$class]) /*hack for duplicate log Logger name*/ && $class != 'Log'){
-			return $classes[$class];
-		}
-		$found = false;
-		foreach (array(ROOT_PATH, CORE_PATH) as $path) {
-			$file = $path . $dir . '/' . $class . '.php';
-			if (file_exists($file)){
-				if (class_exists($class, false) === false){
-					require_once $file;
-				}
-				//already found
-				$found = true;
-				break;
-			}
-		}
-		if (! $found){
-			//can't use show_error() at this time because some dependencies not yet loaded
-			set_http_status_header(503);
-			echo 'Cannot find the class [' . $class . ']';
-			die();
-		}
+    /**
+     * This function is the class loader helper is used if the library "Loader" not yet loaded
+     * he load the class once
+     * @param  string $class  the class name to be loaded
+     * @param  string $dir    the directory where to find the class
+     * @param  mixed $params the parameter to pass as argument to the constructor of the class
+     * @codeCoverageIgnore
+     * 
+     * @return object         the instance of the loaded class
+     */
+    function & class_loader($class, $dir = 'libraries', $params = null){
+        //put the first letter of class to upper case 
+        $class = ucfirst($class);
+        static $classes = array();
+        if (isset($classes[$class]) /*hack for duplicate log Logger name*/ && $class != 'Log'){
+            return $classes[$class];
+        }
+        $found = false;
+        foreach (array(ROOT_PATH, CORE_PATH) as $path) {
+            $file = $path . $dir . '/' . $class . '.php';
+            if (file_exists($file)){
+                if (class_exists($class, false) === false){
+                    require_once $file;
+                }
+                //already found
+                $found = true;
+                break;
+            }
+        }
+        if (! $found){
+            //can't use show_error() at this time because some dependencies not yet loaded
+            set_http_status_header(503);
+            echo 'Cannot find the class [' . $class . ']';
+            die();
+        }
 		
-		/*
+        /*
 		   TODO use the best method to get the Log instance
 		 */
-		if ($class == 'Log'){
-			//can't use the instruction like "return new Log()" 
-			//because we need return the reference instance of the loaded class.
-			$log = new Log();
-			return $log;
-		}
-		//track of loaded classes
-		class_loaded($class);
+        if ($class == 'Log'){
+            //can't use the instruction like "return new Log()" 
+            //because we need return the reference instance of the loaded class.
+            $log = new Log();
+            return $log;
+        }
+        //track of loaded classes
+        class_loaded($class);
 		
-		//record the class instance
-		$classes[$class] = isset($params) ? new $class($params) : new $class();
+        //record the class instance
+        $classes[$class] = isset($params) ? new $class($params) : new $class();
 		
-		return $classes[$class];
-	}
+        return $classes[$class];
+    }
 
-	/**
-	 * This function is the helper to record the loaded classes
-	 * @param  string $class the loaded class name
-	 * @codeCoverageIgnore
-	 * 
-	 * @return array        the list of the loaded classes
-	 */
-	function & class_loaded($class = null){
-		static $list = array();
-		if ($class !== null){
-			$list[strtolower($class)] = $class;
-		}
-		return $list;
-	}
+    /**
+     * This function is the helper to record the loaded classes
+     * @param  string $class the loaded class name
+     * @codeCoverageIgnore
+     * 
+     * @return array        the list of the loaded classes
+     */
+    function & class_loaded($class = null){
+        static $list = array();
+        if ($class !== null){
+            $list[strtolower($class)] = $class;
+        }
+        return $list;
+    }
 
-	/**
-	 * This function is used to load the configurations in the case the "Config" library not yet loaded
-	 * @param  array  $overwrite_values if need overwrite the existing configuration
-	 * @codeCoverageIgnore
-	 * 
-	 * @return array                   the configurations values
-	 */
-	function & load_configurations(array $overwrite_values = array()){
-		static $config;
-		if (empty($config)){
-			$file = CONFIG_PATH . 'config.php';
-			$found = false;
-			if (file_exists($file)){
-				require_once $file;
-				$found = true;
-			}
-			if (! $found){
-				set_http_status_header(503);
-				echo 'Unable to find the configuration file [' . $file . ']';
-				die();
-			}
-		}
-		foreach ($overwrite_values as $key => $value) {
-			$config[$key] = $value;
-		}
-		return $config;
-	}
+    /**
+     * This function is used to load the configurations in the case the "Config" library not yet loaded
+     * @param  array  $overwrite_values if need overwrite the existing configuration
+     * @codeCoverageIgnore
+     * 
+     * @return array                   the configurations values
+     */
+    function & load_configurations(array $overwrite_values = array()){
+        static $config;
+        if (empty($config)){
+            $file = CONFIG_PATH . 'config.php';
+            $found = false;
+            if (file_exists($file)){
+                require_once $file;
+                $found = true;
+            }
+            if (! $found){
+                set_http_status_header(503);
+                echo 'Unable to find the configuration file [' . $file . ']';
+                die();
+            }
+        }
+        foreach ($overwrite_values as $key => $value) {
+            $config[$key] = $value;
+        }
+        return $config;
+    }
 
-	/**
-	 * This function is the helper to get the config value in case the "Config" library not yet loaded
-	 * @param  string $key     the config item to get the vale
-	 * @param  mixed $default the default value to return if can't find the config item in the configuration
-	 * @test
-	 * 
-	 * @return mixed          the config value
-	 */
-	function get_config($key, $default = null){
-		static $cfg;
-		if (empty($cfg)){
-			$cfg[0] = & load_configurations();
-		}
-		return array_key_exists($key, $cfg[0]) ? $cfg[0][$key] : $default;
-	}
+    /**
+     * This function is the helper to get the config value in case the "Config" library not yet loaded
+     * @param  string $key     the config item to get the vale
+     * @param  mixed $default the default value to return if can't find the config item in the configuration
+     * @test
+     * 
+     * @return mixed          the config value
+     */
+    function get_config($key, $default = null){
+        static $cfg;
+        if (empty($cfg)){
+            $cfg[0] = & load_configurations();
+        }
+        return array_key_exists($key, $cfg[0]) ? $cfg[0][$key] : $default;
+    }
 
-	/**
-	 * This function is a helper to logging message
-	 * @param  string $level   the log level "ERROR", "DEBUG", "INFO", etc.
-	 * @param  string $message the log message to be saved
-	 * @param  string $logger  the logger to use if is set
-	 * 
-	 * @codeCoverageIgnore
-	 */
-	function save_to_log($level, $message, $logger = null){
-		$log =& class_loader('Log', 'classes');
-		if ($logger){
-			$log->setLogger($logger);
-		}
-		$log->writeLog($message, $level);
-	}
+    /**
+     * This function is a helper to logging message
+     * @param  string $level   the log level "ERROR", "DEBUG", "INFO", etc.
+     * @param  string $message the log message to be saved
+     * @param  string $logger  the logger to use if is set
+     * 
+     * @codeCoverageIgnore
+     */
+    function save_to_log($level, $message, $logger = null){
+        $log =& class_loader('Log', 'classes');
+        if ($logger){
+            $log->setLogger($logger);
+        }
+        $log->writeLog($message, $level);
+    }
 
-	/**
-	 * Set the HTTP status header
-	 * @param integer $code the HTTP status code
-	 * @param string  $text the HTTP status text
-	 * 
-	 * @codeCoverageIgnore
-	 */
-	function set_http_status_header($code = 200, $text = null){
-		if (empty($text)){
-			$http_status = array(
-								100 => 'Continue',
-								101 => 'Switching Protocols',
+    /**
+     * Set the HTTP status header
+     * @param integer $code the HTTP status code
+     * @param string  $text the HTTP status text
+     * 
+     * @codeCoverageIgnore
+     */
+    function set_http_status_header($code = 200, $text = null){
+        if (empty($text)){
+            $http_status = array(
+                                100 => 'Continue',
+                                101 => 'Switching Protocols',
 
-								200 => 'OK',
-								201 => 'Created',
-								202 => 'Accepted',
-								203 => 'Non-Authoritative Information',
-								204 => 'No Content',
-								205 => 'Reset Content',
-								206 => 'Partial Content',
+                                200 => 'OK',
+                                201 => 'Created',
+                                202 => 'Accepted',
+                                203 => 'Non-Authoritative Information',
+                                204 => 'No Content',
+                                205 => 'Reset Content',
+                                206 => 'Partial Content',
 
-								300 => 'Multiple Choices',
-								301 => 'Moved Permanently',
-								302 => 'Found',
-								303 => 'See Other',
-								304 => 'Not Modified',
-								305 => 'Use Proxy',
-								307 => 'Temporary Redirect',
+                                300 => 'Multiple Choices',
+                                301 => 'Moved Permanently',
+                                302 => 'Found',
+                                303 => 'See Other',
+                                304 => 'Not Modified',
+                                305 => 'Use Proxy',
+                                307 => 'Temporary Redirect',
 
-								400 => 'Bad Request',
-								401 => 'Unauthorized',
-								402 => 'Payment Required',
-								403 => 'Forbidden',
-								404 => 'Not Found',
-								405 => 'Method Not Allowed',
-								406 => 'Not Acceptable',
-								407 => 'Proxy Authentication Required',
-								408 => 'Request Timeout',
-								409 => 'Conflict',
-								410 => 'Gone',
-								411 => 'Length Required',
-								412 => 'Precondition Failed',
-								413 => 'Request Entity Too Large',
-								414 => 'Request-URI Too Long',
-								415 => 'Unsupported Media Type',
-								416 => 'Requested Range Not Satisfiable',
-								417 => 'Expectation Failed',
-								418 => 'I\'m a teapot',
+                                400 => 'Bad Request',
+                                401 => 'Unauthorized',
+                                402 => 'Payment Required',
+                                403 => 'Forbidden',
+                                404 => 'Not Found',
+                                405 => 'Method Not Allowed',
+                                406 => 'Not Acceptable',
+                                407 => 'Proxy Authentication Required',
+                                408 => 'Request Timeout',
+                                409 => 'Conflict',
+                                410 => 'Gone',
+                                411 => 'Length Required',
+                                412 => 'Precondition Failed',
+                                413 => 'Request Entity Too Large',
+                                414 => 'Request-URI Too Long',
+                                415 => 'Unsupported Media Type',
+                                416 => 'Requested Range Not Satisfiable',
+                                417 => 'Expectation Failed',
+                                418 => 'I\'m a teapot',
 
-								500 => 'Internal Server Error',
-								501 => 'Not Implemented',
-								502 => 'Bad Gateway',
-								503 => 'Service Unavailable',
-								504 => 'Gateway Timeout',
-								505 => 'HTTP Version Not Supported',
-							);
-			if (isset($http_status[$code])){
-				$text = $http_status[$code];
-			}
-			else{
-				show_error('No HTTP status text found for your code please check it.');
-			}
-		}
+                                500 => 'Internal Server Error',
+                                501 => 'Not Implemented',
+                                502 => 'Bad Gateway',
+                                503 => 'Service Unavailable',
+                                504 => 'Gateway Timeout',
+                                505 => 'HTTP Version Not Supported',
+                            );
+            if (isset($http_status[$code])){
+                $text = $http_status[$code];
+            }
+            else{
+                show_error('No HTTP status text found for your code please check it.');
+            }
+        }
 		
-		if (strpos(php_sapi_name(), 'cgi') === 0){
-			header('Status: ' . $code . ' ' . $text, TRUE);
-		}
-		else{
-			$proto = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
-			header($proto . ' ' . $code . ' ' . $text, TRUE, $code);
-		}
-	}
+        if (strpos(php_sapi_name(), 'cgi') === 0){
+            header('Status: ' . $code . ' ' . $text, TRUE);
+        }
+        else{
+            $proto = isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1';
+            header($proto . ' ' . $code . ' ' . $text, TRUE, $code);
+        }
+    }
 
-	/**
-	 *  This function displays an error message to the user and ends the execution of the script.
-	 *  
-	 *  @param string $msg the message to display
-	 *  @param string $title the message title: "error", "info", "warning", etc.
-	 *  @param boolean $logging either to save error in log
-	 *  
-	 *  @codeCoverageIgnore
-	 */
-	function show_error($msg, $title = 'error', $logging = true){
-		$title = strtoupper($title);
-		$data = array();
-		$data['error'] = $msg;
-		$data['title'] = $title;
-		if ($logging){
-			save_to_log('error', '['.$title.'] '.strip_tags($msg), 'GLOBAL::ERROR');
-		}
-		$response = & class_loader('Response', 'classes');
-		$response->sendError($data);
-		die();
-	}
+    /**
+     *  This function displays an error message to the user and ends the execution of the script.
+     *  
+     *  @param string $msg the message to display
+     *  @param string $title the message title: "error", "info", "warning", etc.
+     *  @param boolean $logging either to save error in log
+     *  
+     *  @codeCoverageIgnore
+     */
+    function show_error($msg, $title = 'error', $logging = true){
+        $title = strtoupper($title);
+        $data = array();
+        $data['error'] = $msg;
+        $data['title'] = $title;
+        if ($logging){
+            save_to_log('error', '['.$title.'] '.strip_tags($msg), 'GLOBAL::ERROR');
+        }
+        $response = & class_loader('Response', 'classes');
+        $response->sendError($data);
+        die();
+    }
 
-	/**
-	 *  Check whether the protocol used is "https" or not
-	 *  That is, the web server is configured to use a secure connection.
-	 *  @codeCoverageIgnore
-	 *  
-	 *  @return boolean true if the web server uses the https protocol, false if not.
-	 */
-	function is_https(){
-		/*
+    /**
+     *  Check whether the protocol used is "https" or not
+     *  That is, the web server is configured to use a secure connection.
+     *  @codeCoverageIgnore
+     *  
+     *  @return boolean true if the web server uses the https protocol, false if not.
+     */
+    function is_https(){
+        /*
 		* some servers pass the "HTTPS" parameter in the server variable,
 		* if is the case, check if the value is "on", "true", "1".
 		*/
-		if (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off'){
-			return true;
-		}
-		else if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https'){
-			return true;
-		}
-		else if (isset($_SERVER['HTTP_FRONT_END_HTTPS']) && strtolower($_SERVER['HTTP_FRONT_END_HTTPS']) !== 'off'){
-			return true;
-		}
-		return false;
-	}
+        if (isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off'){
+            return true;
+        }
+        else if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https'){
+            return true;
+        }
+        else if (isset($_SERVER['HTTP_FRONT_END_HTTPS']) && strtolower($_SERVER['HTTP_FRONT_END_HTTPS']) !== 'off'){
+            return true;
+        }
+        return false;
+    }
 	
-	/**
-	 *  This function is used to check the URL format of the given string argument. 
-	 *  The address is valid if the protocol is http, https, ftp, etc.
-	 *
-	 *  @param string $url the URL address to check
-	 *  @test
-	 *  
-	 *  @return boolean true if is a valid URL address or false.
-	 */
-	function is_url($url){
-		return preg_match('/^(http|https|ftp):\/\/(.*)/', $url) == 1;
-	}
+    /**
+     *  This function is used to check the URL format of the given string argument. 
+     *  The address is valid if the protocol is http, https, ftp, etc.
+     *
+     *  @param string $url the URL address to check
+     *  @test
+     *  
+     *  @return boolean true if is a valid URL address or false.
+     */
+    function is_url($url){
+        return preg_match('/^(http|https|ftp):\/\/(.*)/', $url) == 1;
+    }
 	
-	/**
-	 *  Function defined to load controller
-	 *  
-	 *  @param string $controllerClass the controller class name to be loaded
-	 *  @codeCoverageIgnore
-	 */
-	function autoload_controller($controllerClass){
-		if (file_exists($path = APPS_CONTROLLER_PATH . $controllerClass . '.php')){
-			require_once $path;
-		}
-	}
+    /**
+     *  Function defined to load controller
+     *  
+     *  @param string $controllerClass the controller class name to be loaded
+     *  @codeCoverageIgnore
+     */
+    function autoload_controller($controllerClass){
+        if (file_exists($path = APPS_CONTROLLER_PATH . $controllerClass . '.php')){
+            require_once $path;
+        }
+    }
 	
-	/**
-	 *  Function defined for handling PHP exception error message, 
-	 *  it displays an error message using the function "show_error"
-	 *  
-	 *  @param object $ex instance of the "Exception" class or a derived class
-	 *  @codeCoverageIgnore
-	 *  
-	 *  @return boolean
-	 */
-	function php_exception_handler($ex){
-		if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors'))){
-			show_error('An exception is occured in file '. $ex->getFile() .' at line ' . $ex->getLine() . ' raison : ' . $ex->getMessage(), 'PHP Exception #' . $ex->getCode());
-		}
-		else{
-			save_to_log('error', 'An exception is occured in file ' . $ex->getFile() . ' at line ' . $ex->getLine() . ' raison : ' . $ex->getMessage(), 'PHP Exception');
-		}
-		return true;
-	}
+    /**
+     *  Function defined for handling PHP exception error message, 
+     *  it displays an error message using the function "show_error"
+     *  
+     *  @param object $ex instance of the "Exception" class or a derived class
+     *  @codeCoverageIgnore
+     *  
+     *  @return boolean
+     */
+    function php_exception_handler($ex){
+        if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors'))){
+            show_error('An exception is occured in file '. $ex->getFile() .' at line ' . $ex->getLine() . ' raison : ' . $ex->getMessage(), 'PHP Exception #' . $ex->getCode());
+        }
+        else{
+            save_to_log('error', 'An exception is occured in file ' . $ex->getFile() . ' at line ' . $ex->getLine() . ' raison : ' . $ex->getMessage(), 'PHP Exception');
+        }
+        return true;
+    }
 	
-	/**
-	 *  Function defined for PHP error message handling
-	 *  			
-	 *  @param int $errno the type of error for example: E_USER_ERROR, E_USER_WARNING, etc.
-	 *  @param string $errstr the error message
-	 *  @param string $errfile the file where the error occurred
-	 *  @param int $errline the line number where the error occurred
-	 *  @codeCoverageIgnore
-	 *  
-	 *  @return boolean	
-	 */
-	function php_error_handler($errno , $errstr, $errfile , $errline){
-		$isError = (((E_ERROR | E_COMPILE_ERROR | E_CORE_ERROR | E_USER_ERROR) & $errno) === $errno);
-		if ($isError){
-			set_http_status_header(500);
-		}
-		if (! (error_reporting() & $errno)) {
-			save_to_log('error', 'An error is occurred in the file ' . $errfile . ' at line ' . $errline . ' raison : ' . $errstr, 'PHP ERROR');
-			return;
-		}
-		if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors'))){
-			$errorType = 'error';
-			switch ($errno) {
-				case E_USER_ERROR:
-					$errorType = 'error';
-					break;
-				case E_USER_WARNING:
-					$errorType = 'warning';
-					break;
-				case E_USER_NOTICE:
-					$errorType = 'notice';
-					break;
-				default:
-					$errorType = 'error';
-					break;
-			}
-			show_error('An error is occurred in the file <b>' . $errfile . '</b> at line <b>' . $errline .'</b> raison : ' . $errstr, 'PHP ' . $errorType);
-		}
-		if ($isError){
-			die();
-		}
-		return true;
-	}
+    /**
+     *  Function defined for PHP error message handling
+     *  			
+     *  @param int $errno the type of error for example: E_USER_ERROR, E_USER_WARNING, etc.
+     *  @param string $errstr the error message
+     *  @param string $errfile the file where the error occurred
+     *  @param int $errline the line number where the error occurred
+     *  @codeCoverageIgnore
+     *  
+     *  @return boolean	
+     */
+    function php_error_handler($errno , $errstr, $errfile , $errline){
+        $isError = (((E_ERROR | E_COMPILE_ERROR | E_CORE_ERROR | E_USER_ERROR) & $errno) === $errno);
+        if ($isError){
+            set_http_status_header(500);
+        }
+        if (! (error_reporting() & $errno)) {
+            save_to_log('error', 'An error is occurred in the file ' . $errfile . ' at line ' . $errline . ' raison : ' . $errstr, 'PHP ERROR');
+            return;
+        }
+        if (str_ireplace(array('off', 'none', 'no', 'false', 'null'), '', ini_get('display_errors'))){
+            $errorType = 'error';
+            switch ($errno) {
+                case E_USER_ERROR:
+                    $errorType = 'error';
+                    break;
+                case E_USER_WARNING:
+                    $errorType = 'warning';
+                    break;
+                case E_USER_NOTICE:
+                    $errorType = 'notice';
+                    break;
+                default:
+                    $errorType = 'error';
+                    break;
+            }
+            show_error('An error is occurred in the file <b>' . $errfile . '</b> at line <b>' . $errline .'</b> raison : ' . $errstr, 'PHP ' . $errorType);
+        }
+        if ($isError){
+            die();
+        }
+        return true;
+    }
 
-	/**
-	 * This function is used to run in shutdown situation of the script
-	 * @codeCoverageIgnore
-	 */
-	function php_shudown_handler(){
-		$lastError = error_get_last();
-		if (isset($lastError) &&
-			($lastError['type'] & (E_ERROR | E_PARSE | E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_COMPILE_WARNING))){
-			php_error_handler($lastError['type'], $lastError['message'], $lastError['file'], $lastError['line']);
-		}
-	}
+    /**
+     * This function is used to run in shutdown situation of the script
+     * @codeCoverageIgnore
+     */
+    function php_shudown_handler(){
+        $lastError = error_get_last();
+        if (isset($lastError) &&
+            ($lastError['type'] & (E_ERROR | E_PARSE | E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_COMPILE_WARNING))){
+            php_error_handler($lastError['type'], $lastError['message'], $lastError['file'], $lastError['line']);
+        }
+    }
 
 
-	/**
-	 *  Convert array attributes to string
-	 *
-	 *  This function converts an associative array into HTML attributes.
-	 *  For example :
-	 *  $a = array('name' => 'Foo', 'type' => 'text'); => produces the following string:
-	 *  name = "Foo" type = "text"
-	 *
-	 *  @param array $attributes associative array to convert to a string attribute.
-	 *   
-	 *  @return string string of the HTML attribute.
-	 */
-	function attributes_to_string(array $attributes){
-		$str = ' ';
-		//we check that the array passed as an argument is not empty.
-		if (! empty($attributes)){
-			foreach($attributes as $key => $value){
-				$key = trim(htmlspecialchars($key));
-				$value = trim(htmlspecialchars($value));
-				/*
+    /**
+     *  Convert array attributes to string
+     *
+     *  This function converts an associative array into HTML attributes.
+     *  For example :
+     *  $a = array('name' => 'Foo', 'type' => 'text'); => produces the following string:
+     *  name = "Foo" type = "text"
+     *
+     *  @param array $attributes associative array to convert to a string attribute.
+     *   
+     *  @return string string of the HTML attribute.
+     */
+    function attributes_to_string(array $attributes){
+        $str = ' ';
+        //we check that the array passed as an argument is not empty.
+        if (! empty($attributes)){
+            foreach($attributes as $key => $value){
+                $key = trim(htmlspecialchars($key));
+                $value = trim(htmlspecialchars($value));
+                /*
 				* To predict the case where the string to convert contains the character "
 				* we check if this is the case we add a slash to solve this problem.
 				* For example:
 				* 	$attr = array('placeholder' => 'I am a "puple"')
 				* 	$str = attributes_to_string($attr); => placeholder = "I am a \"puple\""
 				 */
-				if ($value && strpos('"', $value) !== false){
-					$value = addslashes($value);
-				}
-				$str .= $key.' = "'.$value.'" ';
-			}
-		}
-		//remove the space after using rtrim()
-		return rtrim($str);
-	}
+                if ($value && strpos('"', $value) !== false){
+                    $value = addslashes($value);
+                }
+                $str .= $key.' = "'.$value.'" ';
+            }
+        }
+        //remove the space after using rtrim()
+        return rtrim($str);
+    }
 
 
-	/**
-	* Function to stringfy PHP variable, useful in debug situation
-	*
-	* @param mixed $var the variable to stringfy
-	* @codeCoverageIgnore
-	*
-	* @return string the stringfy value
-	*/
-	function stringfy_vars($var){
-		return print_r($var, true);
-	}
+    /**
+     * Function to stringfy PHP variable, useful in debug situation
+     *
+     * @param mixed $var the variable to stringfy
+     * @codeCoverageIgnore
+     *
+     * @return string the stringfy value
+     */
+    function stringfy_vars($var){
+        return print_r($var, true);
+    }
 
-	/**
-	 * Clean the user input
-	 * @param  mixed $str the value to clean
-	 * @test
-	 * 
-	 * @return mixed   the sanitize value
-	 */
-	function clean_input($str){
-		if (is_array($str)){
-			$str = array_map('clean_input', $str);
-		}
-		else if (is_object($str)){
-			$obj = $str;
-			foreach ($str as $var => $value) {
-				$obj->$var = clean_input($value);
-			}
-			$str = $obj;
-		}
-		else{
-			$str = htmlspecialchars(strip_tags($str), ENT_QUOTES, 'UTF-8');
-		}
-		return $str;
-	}
+    /**
+     * Clean the user input
+     * @param  mixed $str the value to clean
+     * @test
+     * 
+     * @return mixed   the sanitize value
+     */
+    function clean_input($str){
+        if (is_array($str)){
+            $str = array_map('clean_input', $str);
+        }
+        else if (is_object($str)){
+            $obj = $str;
+            foreach ($str as $var => $value) {
+                $obj->$var = clean_input($value);
+            }
+            $str = $obj;
+        }
+        else{
+            $str = htmlspecialchars(strip_tags($str), ENT_QUOTES, 'UTF-8');
+        }
+        return $str;
+    }
 	
-	/**
-	 * This function is used to hidden some part of the given string. Helpful if you need hide some confidential 
-	 * Information like credit card number, password, etc.
-	 *
-	 * @param  string $str the string you want to hide some part
-	 * @param  int $startCount the length of non hidden for the beginning char
-	 * @param  int $endCount the length of non hidden for the ending char
-	 * @param  string $hiddenChar the char used to hide the given string
-	 * @test
-	 * 
-	 * @return string the string with the hidden part.
-	 */
-	function string_hidden($str, $startCount = 0, $endCount = 0, $hiddenChar = '*'){
-		//get the string length
-		$len = strlen($str);
-		//if str is empty
-		if ($len <= 0){
-			return str_repeat($hiddenChar, 6);
-		}
-		//if the length is less than startCount and endCount
-		//or the startCount and endCount length is 0
-		//or startCount is negative or endCount is negative
-		//return the full string hidden
+    /**
+     * This function is used to hidden some part of the given string. Helpful if you need hide some confidential 
+     * Information like credit card number, password, etc.
+     *
+     * @param  string $str the string you want to hide some part
+     * @param  int $startCount the length of non hidden for the beginning char
+     * @param  int $endCount the length of non hidden for the ending char
+     * @param  string $hiddenChar the char used to hide the given string
+     * @test
+     * 
+     * @return string the string with the hidden part.
+     */
+    function string_hidden($str, $startCount = 0, $endCount = 0, $hiddenChar = '*'){
+        //get the string length
+        $len = strlen($str);
+        //if str is empty
+        if ($len <= 0){
+            return str_repeat($hiddenChar, 6);
+        }
+        //if the length is less than startCount and endCount
+        //or the startCount and endCount length is 0
+        //or startCount is negative or endCount is negative
+        //return the full string hidden
 		
-		if ((($startCount + $endCount) > $len) || ($startCount == 0 && $endCount == 0) || ($startCount < 0 || $endCount < 0)){
-			return str_repeat($hiddenChar, $len);
-		}
-		//the start non hidden string
-		$startNonHiddenStr = substr($str, 0, $startCount);
-		//the end non hidden string
-		$endNonHiddenStr = null;
-		if ($endCount > 0){
-			$endNonHiddenStr = substr($str, - $endCount);
-		}
-		//the hidden string
-		$hiddenStr = str_repeat($hiddenChar, $len - ($startCount + $endCount));
+        if ((($startCount + $endCount) > $len) || ($startCount == 0 && $endCount == 0) || ($startCount < 0 || $endCount < 0)){
+            return str_repeat($hiddenChar, $len);
+        }
+        //the start non hidden string
+        $startNonHiddenStr = substr($str, 0, $startCount);
+        //the end non hidden string
+        $endNonHiddenStr = null;
+        if ($endCount > 0){
+            $endNonHiddenStr = substr($str, - $endCount);
+        }
+        //the hidden string
+        $hiddenStr = str_repeat($hiddenChar, $len - ($startCount + $endCount));
 		
-		return $startNonHiddenStr . $hiddenStr . $endNonHiddenStr;
-	}
+        return $startNonHiddenStr . $hiddenStr . $endNonHiddenStr;
+    }
 	
-	/**
-	 * This function is used to set the initial session config regarding the configuration
-	 * @codeCoverageIgnore
-	 */
-	function set_session_config(){
-		//$_SESSION is not available on cli mode 
-		if (! IS_CLI){
-			$logger =& class_loader('Log', 'classes');
-			$logger->setLogger('PHPSession');
-			//set session params
-			$sessionHandler = get_config('session_handler', 'files'); //the default is to store in the files
-			$sessionName = get_config('session_name');
-			if ($sessionName){
-				session_name($sessionName);
-			}
-			$logger->info('Session handler: ' . $sessionHandler);
-			$logger->info('Session name: ' . $sessionName);
+    /**
+     * This function is used to set the initial session config regarding the configuration
+     * @codeCoverageIgnore
+     */
+    function set_session_config(){
+        //$_SESSION is not available on cli mode 
+        if (! IS_CLI){
+            $logger =& class_loader('Log', 'classes');
+            $logger->setLogger('PHPSession');
+            //set session params
+            $sessionHandler = get_config('session_handler', 'files'); //the default is to store in the files
+            $sessionName = get_config('session_name');
+            if ($sessionName){
+                session_name($sessionName);
+            }
+            $logger->info('Session handler: ' . $sessionHandler);
+            $logger->info('Session name: ' . $sessionName);
 
-			if ($sessionHandler == 'files'){
-				$sessionSavePath = get_config('session_save_path');
-				if ($sessionSavePath){
-					if (! is_dir($sessionSavePath)){
-						mkdir($sessionSavePath, 1773);
-					}
-					session_save_path($sessionSavePath);
-					$logger->info('Session save path: ' . $sessionSavePath);
-				}
-			}
-			else if ($sessionHandler == 'database'){
-				//load database session handle library
-				//Database Session handler Model
-				require_once CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php';
+            if ($sessionHandler == 'files'){
+                $sessionSavePath = get_config('session_save_path');
+                if ($sessionSavePath){
+                    if (! is_dir($sessionSavePath)){
+                        mkdir($sessionSavePath, 1773);
+                    }
+                    session_save_path($sessionSavePath);
+                    $logger->info('Session save path: ' . $sessionSavePath);
+                }
+            }
+            else if ($sessionHandler == 'database'){
+                //load database session handle library
+                //Database Session handler Model
+                require_once CORE_CLASSES_MODEL_PATH . 'DBSessionHandlerModel.php';
 
-				$DBS =& class_loader('DBSessionHandler', 'classes');
-				session_set_save_handler($DBS, true);
-				$logger->info('session save path: ' . get_config('session_save_path'));
-			}
-			else{
-				show_error('Invalid session handler configuration');
-			}
-			$lifetime = get_config('session_cookie_lifetime', 0);
-			$path = get_config('session_cookie_path', '/');
-			$domain = get_config('session_cookie_domain', '');
-			$secure = get_config('session_cookie_secure', false);
-			session_set_cookie_params(
-				$lifetime,
-				$path,
-				$domain,
-				$secure,
-				$httponly = true /*for security for access to cookie via javascript or XSS attack*/
-			);
-			//to prevent attack of Session Fixation 
-			//thank to https://www.phparch.com/2018/01/php-sessions-in-depth/
-			ini_set('session.use_strict_mode ', 1);
-			ini_set('session.use_only_cookies', 1);
-			ini_set('session.use_trans_sid ', 0);
+                $DBS =& class_loader('DBSessionHandler', 'classes');
+                session_set_save_handler($DBS, true);
+                $logger->info('session save path: ' . get_config('session_save_path'));
+            }
+            else{
+                show_error('Invalid session handler configuration');
+            }
+            $lifetime = get_config('session_cookie_lifetime', 0);
+            $path = get_config('session_cookie_path', '/');
+            $domain = get_config('session_cookie_domain', '');
+            $secure = get_config('session_cookie_secure', false);
+            session_set_cookie_params(
+                $lifetime,
+                $path,
+                $domain,
+                $secure,
+                $httponly = true /*for security for access to cookie via javascript or XSS attack*/
+            );
+            //to prevent attack of Session Fixation 
+            //thank to https://www.phparch.com/2018/01/php-sessions-in-depth/
+            ini_set('session.use_strict_mode ', 1);
+            ini_set('session.use_only_cookies', 1);
+            ini_set('session.use_trans_sid ', 0);
 			
-			$logger->info('Session lifetime: ' . $lifetime);
-			$logger->info('Session cookie path: ' . $path);
-			$logger->info('Session domain: ' . $domain);
-			$logger->info('Session is secure: ' . ($secure ? 'TRUE':'FALSE'));
+            $logger->info('Session lifetime: ' . $lifetime);
+            $logger->info('Session cookie path: ' . $path);
+            $logger->info('Session domain: ' . $domain);
+            $logger->info('Session is secure: ' . ($secure ? 'TRUE':'FALSE'));
 			
-			if ((function_exists('session_status') && session_status() !== PHP_SESSION_ACTIVE) || !session_id()){
-				$logger->info('Session not yet start, start it now');
-				session_start();
-			}
-		}
-	}
+            if ((function_exists('session_status') && session_status() !== PHP_SESSION_ACTIVE) || !session_id()){
+                $logger->info('Session not yet start, start it now');
+                session_start();
+            }
+        }
+    }
 	
-	/**
-	* This function is very useful, it allows to recover the instance of the global controller.
-	* Note this function always returns the address of the super instance.
-	* For example :
-	* $obj = & get_instance();
-	* 
-	* @codeCoverageIgnore
-	*  
-	* @return object the instance of the "Controller" class
-	*/
-	function & get_instance(){
-		return Controller::get_instance();
-	}
+    /**
+     * This function is very useful, it allows to recover the instance of the global controller.
+     * Note this function always returns the address of the super instance.
+     * For example :
+     * $obj = & get_instance();
+     * 
+     * @codeCoverageIgnore
+     *  
+     * @return object the instance of the "Controller" class
+     */
+    function & get_instance(){
+        return Controller::get_instance();
+    }

core/lang/en/lang_form_validation.php

Indentation +6 added lines, -6 removed lines

@@ -1,9 +1,9 @@ 
 <?php 
     defined('ROOT_PATH') || exit('Access denied');
- 	/**
- 	 * Form validation language message (English) 
- 	 */
- 	$lang['fv_required']     		= 'Field %1 is required.';
+        /**
+         * Form validation language message (English) 
+         */
+        $lang['fv_required']     		= 'Field %1 is required.';
     $lang['fv_min_length']   		= 'Field %1 must contain at least %2 characters.';
     $lang['fv_max_length']   		= 'Field %1 must contain at most %2 characters.';
     $lang['fv_exact_length'] 		= 'Field %1 must contain exactly %2 characters.';
@@ -14,8 +14,8 @@ 
     $lang['fv_not_equal_post_key']  = 'Field %1 must not be the same as field %2.';
     $lang['fv_not_equal_string']    = 'Field %1 must not contain the value %2.';
     $lang['fv_depends']      		= 'Field %1 depends on field %2 which is not valid.';
-	$lang['fv_is_unique']	   		= 'The value of field %1 already exists.';
-	$lang['fv_is_unique_update']	= 'The value of field %1 already exists for another record.';
+    $lang['fv_is_unique']	   		= 'The value of field %1 already exists.';
+    $lang['fv_is_unique_update']	= 'The value of field %1 already exists for another record.';
     $lang['fv_exists']	   			= 'The value of the field %1 does not exist.';
     $lang['fv_regex']	   			= 'The value of the field %1 does not use the correct format.';
     $lang['fv_in_list']	   			= 'The value of field %1 must be one of the list (%2).';

core/lang/en/lang_file_upload.php

Indentation +4 added lines, -4 removed lines

@@ -1,9 +1,9 @@
 <?php 
     defined('ROOT_PATH') || exit('Access denied');
- 	/**
- 	 * File upload language messages (English) 
- 	 */
- 	$lang['fu_upload_err_ini_size']     = 'The uploaded file exceeds the upload_max_filesize directive in php.ini.';
+        /**
+         * File upload language messages (English) 
+         */
+        $lang['fu_upload_err_ini_size']     = 'The uploaded file exceeds the upload_max_filesize directive in php.ini.';
     $lang['fu_upload_err_form_size']   	= 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.';
     $lang['fu_upload_err_partial']   	= 'The uploaded file was only partially uploaded.';
     $lang['fu_upload_err_no_file'] 		= 'No file was choosed. Please select one.';

core/classes/database/DatabaseQueryRunner.php

Indentation +163 added lines, -163 removed lines

@@ -1,90 +1,90 @@ 
 <?php
     defined('ROOT_PATH') || exit('Access denied');
-  /**
-   * TNH Framework
-   *
-   * A simple PHP framework using HMVC architecture
-   *
-   * This content is released under the GNU GPL License (GPL)
-   *
-   * Copyright (C) 2017 Tony NGUEREZA
-   *
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; either version 3
-   * of the License, or (at your option) any later version.
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-  */
-  class DatabaseQueryRunner{
+    /**
+     * TNH Framework
+     *
+     * A simple PHP framework using HMVC architecture
+     *
+     * This content is released under the GNU GPL License (GPL)
+     *
+     * Copyright (C) 2017 Tony NGUEREZA
+     *
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; either version 3
+     * of the License, or (at your option) any later version.
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+     */
+    class DatabaseQueryRunner{
       
     /**
-	* The logger instance
-	* @var object
-	*/
+     * The logger instance
+     * @var object
+     */
     private $logger            = null;
     
-  	/**
-  	 * The last query result
-  	 * @var object
-  	*/
-  	private $queryResult       = null;
+        /**
+         * The last query result
+         * @var object
+         */
+        private $queryResult       = null;
   	
-  	/**
-    * The benchmark instance
-    * @var object
-    */
+        /**
+         * The benchmark instance
+         * @var object
+         */
     private $benchmarkInstance = null;
     
     /**
-	 * The SQL query statment to execute
-	 * @var string
-	*/
+     * The SQL query statment to execute
+     * @var string
+     */
     private $query             = null;
     
     /**
-	 * Indicate if we need return result as list (boolean) 
+     * Indicate if we need return result as list (boolean) 
      * or the data used to replace the placeholder (array)
-	 * @var array|boolean
-	 */
-     private $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;
 
 
@@ -98,7 +98,7 @@ 
      */
     public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){
         if (is_object($pdo)){
-          $this->pdo = $pdo;
+            $this->pdo = $pdo;
         }
         $this->query         = $query;
         $this->returnAsList  = $returnAsList;
@@ -116,10 +116,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 . ']');
@@ -132,101 +132,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;
     }
     
     /**
@@ -235,18 +235,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;
     }
     
     /**
@@ -254,17 +254,17 @@ 
      * @return Log
      */
     public function getLogger(){
-      return $this->logger;
+        return $this->logger;
     }
 
     /**
      * Set the log instance
      * @param Log $logger the log object
-	 * @return object DatabaseQueryRunner
+     * @return object DatabaseQueryRunner
      */
     public function setLogger($logger){
-      $this->logger = $logger;
-      return $this;
+        $this->logger = $logger;
+        return $this;
     }
     
     /**
@@ -272,7 +272,7 @@ 
      * @return string
      */
     public function getQuery(){
-      return $this->query;
+        return $this->query;
     }
     
     /**
@@ -281,8 +281,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setQuery($query){
-       $this->query = $query;
-       return $this;
+        $this->query = $query;
+        return $this;
     }
     
     /**
@@ -291,8 +291,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnType($returnType){
-       $this->returnAsList = $returnType;
-       return $this;
+        $this->returnAsList = $returnType;
+        return $this;
     }
     
     /**
@@ -301,8 +301,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setReturnAsArray($status = true){
-       $this->returnAsArray = $status;
-       return $this;
+        $this->returnAsArray = $status;
+        return $this;
     }
     
     /**
@@ -310,7 +310,7 @@ 
      * @return string
      */
     public function getQueryError(){
-      return $this->error;
+        return $this->error;
     }
 
     /**
@@ -318,7 +318,7 @@ 
      * @return object
      */
     public function getPdo(){
-      return $this->pdo;
+        return $this->pdo;
     }
 
     /**
@@ -327,16 +327,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;
     }
 
     /**
@@ -345,8 +345,8 @@ 
      * @return object DatabaseQueryRunner
      */
     public function setDriver($driver){
-      $this->driver = $driver;
-      return $this;
+        $this->driver = $driver;
+        return $this;
     }
     
     /**
@@ -355,18 +355,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');
     }
     
     /**
@@ -374,19 +374,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/functions/function_user_agent.php

Indentation +70 added lines, -70 removed lines

@@ -1,75 +1,75 @@
 <?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 function_user_agent.php
-	 *    
-	 *  Contains most of the utility functions for agent, platform, mobile, browser, and other management.
-	 *  
-	 *  @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
-	 */
+    /**
+     *  @file function_user_agent.php
+     *    
+     *  Contains most of the utility functions for agent, platform, mobile, browser, and other management.
+     *  
+     *  @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
+     */
 	
 	 
-	if(! function_exists('get_ip')){
-		/**
-		 *  Retrieves the user's IP address
-		 *  
-		 *  This function allows to retrieve the IP address of the client
-		 *  even if it uses a proxy, the actual IP address is retrieved.
-		 *  
-		 *  @return string the IP address.
-		 */
-		function get_ip(){
-			$ip = '127.0.0.1';
-			$ipServerVars = array(
-								'REMOTE_ADDR',
-								'HTTP_CLIENT_IP',
-								'HTTP_X_FORWARDED_FOR',
-								'HTTP_X_FORWARDED',
-								'HTTP_FORWARDED_FOR',
-								'HTTP_FORWARDED'
-							);
-			foreach ($ipServerVars as $var) {
-				if(isset($_SERVER[$var])){
-					$ip = $_SERVER[$var];
-					break;
-				}
-			}
-			// Strip any secondary IP etc from the IP address
-			if (strpos($ip, ',') > 0) {
-				$ip = substr($ip, 0, strpos($ip, ','));
-			}
-			return $ip;
-		}
-	}
+    if(! function_exists('get_ip')){
+        /**
+         *  Retrieves the user's IP address
+         *  
+         *  This function allows to retrieve the IP address of the client
+         *  even if it uses a proxy, the actual IP address is retrieved.
+         *  
+         *  @return string the IP address.
+         */
+        function get_ip(){
+            $ip = '127.0.0.1';
+            $ipServerVars = array(
+                                'REMOTE_ADDR',
+                                'HTTP_CLIENT_IP',
+                                'HTTP_X_FORWARDED_FOR',
+                                'HTTP_X_FORWARDED',
+                                'HTTP_FORWARDED_FOR',
+                                'HTTP_FORWARDED'
+                            );
+            foreach ($ipServerVars as $var) {
+                if(isset($_SERVER[$var])){
+                    $ip = $_SERVER[$var];
+                    break;
+                }
+            }
+            // Strip any secondary IP etc from the IP address
+            if (strpos($ip, ',') > 0) {
+                $ip = substr($ip, 0, strpos($ip, ','));
+            }
+            return $ip;
+        }
+    }

core/libraries/Assets.php

Indentation +154 added lines, -154 removed lines

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

Indentation +165 added lines, -165 removed lines

@@ -1,195 +1,195 @@
 <?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 bootstrap.php
-	 *  
-	 *  Contains the loading process: loading of constants, common functions, libraries 
-	 *  configurations, etc
-	 *  verification of the environment and the routing of the request.
-	 *  
-	 *  @package	core	
-	 *  @author	Tony NGUEREZA
-	 *  @copyright	Copyright (c) 2017
-	 *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
-	 *  @link	http://www.iacademy.cf
-	 *  @version 1.0.0
-	 *  @filesource
-	 */
+    /**
+     *  @file bootstrap.php
+     *  
+     *  Contains the loading process: loading of constants, common functions, libraries 
+     *  configurations, etc
+     *  verification of the environment and the routing of the request.
+     *  
+     *  @package	core	
+     *  @author	Tony NGUEREZA
+     *  @copyright	Copyright (c) 2017
+     *  @license	https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL)
+     *  @link	http://www.iacademy.cf
+     *  @version 1.0.0
+     *  @filesource
+     */
 	
-	//if the application is running in CLI mode $_SESSION global variable is not available
-	if(IS_CLI){
-		$_SESSION = array();
-	}
+    //if the application is running in CLI mode $_SESSION global variable is not available
+    if(IS_CLI){
+        $_SESSION = array();
+    }
 		
-	/**
-	*  inclusion of global constants of the environment that contain : name of the framework,
-	*  version, release date, version of PHP required, etc.
-	*/
-	require_once CORE_PATH . 'constants.php';	
+    /**
+     *  inclusion of global constants of the environment that contain : name of the framework,
+     *  version, release date, version of PHP required, etc.
+     */
+    require_once CORE_PATH . 'constants.php';	
 	
-	/**
-	 *  include file containing commons functions used in the framework such: show_error, 
-	 *  php_exception_handler, php_error_handler, get_instance, etc.
-	 */
-	require_once CORE_PATH . 'common.php';
+    /**
+     *  include file containing commons functions used in the framework such: show_error, 
+     *  php_exception_handler, php_error_handler, get_instance, etc.
+     */
+    require_once CORE_PATH . 'common.php';
 
-	/**
-	 * The Benchmark class
-	 */
-	$BENCHMARK =& class_loader('Benchmark');
+    /**
+     * The Benchmark class
+     */
+    $BENCHMARK =& class_loader('Benchmark');
 	
-	$BENCHMARK->mark('APP_EXECUTION_START');
+    $BENCHMARK->mark('APP_EXECUTION_START');
 	
-	/**
-    * instance of the Log class
-    */
+    /**
+     * instance of the Log class
+     */
     $LOGGER =& class_loader('Log', 'classes');
 
     $LOGGER->setLogger('ApplicationBootstrap');
 
     $LOGGER->debug('Checking PHP version ...');	
 	
-	/**
-	* Verification of the PHP environment: minimum and maximum version
-	*/
-	if (version_compare(phpversion(), TNH_REQUIRED_PHP_MIN_VERSION, '<')){
-		show_error('Your PHP Version [' . phpversion() . '] is less than [' . TNH_REQUIRED_PHP_MIN_VERSION . '], please install a new version or update your PHP to the latest.', 'PHP Error environment');	
-	}
-	else if(version_compare(phpversion(), TNH_REQUIRED_PHP_MAX_VERSION, '>')){
-		show_error('Your PHP Version [' . phpversion() . '] is greather than [' . TNH_REQUIRED_PHP_MAX_VERSION . '] please install a PHP version that is compatible.', 'PHP Error environment');	
-	}
-	$LOGGER->info('PHP version [' . phpversion() . '] is OK [REQUIRED MINIMUM: ' . TNH_REQUIRED_PHP_MIN_VERSION . ', REQUIRED MAXIMUM: ' . TNH_REQUIRED_PHP_MAX_VERSION . '], application can work without any issue');
+    /**
+     * Verification of the PHP environment: minimum and maximum version
+     */
+    if (version_compare(phpversion(), TNH_REQUIRED_PHP_MIN_VERSION, '<')){
+        show_error('Your PHP Version [' . phpversion() . '] is less than [' . TNH_REQUIRED_PHP_MIN_VERSION . '], please install a new version or update your PHP to the latest.', 'PHP Error environment');	
+    }
+    else if(version_compare(phpversion(), TNH_REQUIRED_PHP_MAX_VERSION, '>')){
+        show_error('Your PHP Version [' . phpversion() . '] is greather than [' . TNH_REQUIRED_PHP_MAX_VERSION . '] please install a PHP version that is compatible.', 'PHP Error environment');	
+    }
+    $LOGGER->info('PHP version [' . phpversion() . '] is OK [REQUIRED MINIMUM: ' . TNH_REQUIRED_PHP_MIN_VERSION . ', REQUIRED MAXIMUM: ' . TNH_REQUIRED_PHP_MAX_VERSION . '], application can work without any issue');
 
-	/**
-	* Setting of the PHP error message handling function
-	*/
-	set_error_handler('php_error_handler');
+    /**
+     * Setting of the PHP error message handling function
+     */
+    set_error_handler('php_error_handler');
 
-	/**
-	* Setting of the PHP error exception handling function
-	*/
-	set_exception_handler('php_exception_handler');
+    /**
+     * Setting of the PHP error exception handling function
+     */
+    set_exception_handler('php_exception_handler');
 
-	/**
-	 * Setting of the PHP shutdown handling function
-	 */
-	register_shutdown_function('php_shudown_handler');
+    /**
+     * Setting of the PHP shutdown handling function
+     */
+    register_shutdown_function('php_shudown_handler');
 	
-	//if user have some composer packages
-	$LOGGER->debug('Check for composer autoload');
-	if(file_exists(VENDOR_PATH . 'autoload.php')){
-		$LOGGER->info('The composer autoload file exists include it');
-		require_once VENDOR_PATH . 'autoload.php';
-	}
-	else{
-		$LOGGER->info('The composer autoload file does not exist skipping');
-	}
+    //if user have some composer packages
+    $LOGGER->debug('Check for composer autoload');
+    if(file_exists(VENDOR_PATH . 'autoload.php')){
+        $LOGGER->info('The composer autoload file exists include it');
+        require_once VENDOR_PATH . 'autoload.php';
+    }
+    else{
+        $LOGGER->info('The composer autoload file does not exist skipping');
+    }
 	
-	$LOGGER->debug('Begin to load the required resources');
+    $LOGGER->debug('Begin to load the required resources');
 
-	/**
-	 * Load the EventInfo class file
-	 */
-	require_once CORE_CLASSES_PATH . 'EventInfo.php';
+    /**
+     * Load the EventInfo class file
+     */
+    require_once CORE_CLASSES_PATH . 'EventInfo.php';
 
 
-	$BENCHMARK->mark('CONFIG_INIT_START');
-	/**
-	* Load configurations and using the 
-	* static method "init()" to initialize the Config class .
-	*/
-	$CONFIG =& class_loader('Config', 'classes');	
-	$CONFIG->init();
-	$BENCHMARK->mark('CONFIG_INIT_END');
+    $BENCHMARK->mark('CONFIG_INIT_START');
+    /**
+     * Load configurations and using the 
+     * static method "init()" to initialize the Config class .
+     */
+    $CONFIG =& class_loader('Config', 'classes');	
+    $CONFIG->init();
+    $BENCHMARK->mark('CONFIG_INIT_END');
 
-	$BENCHMARK->mark('MODULE_INIT_START');
-	/**
-	* Load modules and using the 
-	* static method "init()" to initialize the Module class.
-	*/
-	$MODULE =& class_loader('Module', 'classes');
-	$MODULE->init();
-	$BENCHMARK->mark('MODULE_INIT_END');
+    $BENCHMARK->mark('MODULE_INIT_START');
+    /**
+     * Load modules and using the 
+     * static method "init()" to initialize the Module class.
+     */
+    $MODULE =& class_loader('Module', 'classes');
+    $MODULE->init();
+    $BENCHMARK->mark('MODULE_INIT_END');
 
-	$LOGGER->debug('Loading Base Controller ...');
-	/**
-	 * Include of the file containing the Base Controller class 
-	 */
-	require_once CORE_CLASSES_PATH . 'Controller.php';
-	$LOGGER->info('Base Controller loaded successfully');
+    $LOGGER->debug('Loading Base Controller ...');
+    /**
+     * Include of the file containing the Base Controller class 
+     */
+    require_once CORE_CLASSES_PATH . 'Controller.php';
+    $LOGGER->info('Base Controller loaded successfully');
 
-	/**
-	* Register controllers autoload function
-	*/
-	 spl_autoload_register('autoload_controller');
+    /**
+     * Register controllers autoload function
+     */
+        spl_autoload_register('autoload_controller');
 
-	/**
-	* Loading Security class
-	*/
-	$SECURITY =& class_loader('Security', 'classes');
-	$SECURITY->checkWhiteListIpAccess();
+    /**
+     * Loading Security class
+     */
+    $SECURITY =& class_loader('Security', 'classes');
+    $SECURITY->checkWhiteListIpAccess();
 	
-	/**
-	* Loading Url class
-	*/
-	$URL =& class_loader('Url', 'classes');
+    /**
+     * Loading Url class
+     */
+    $URL =& class_loader('Url', 'classes');
 	
-	if(get_config('cache_enable', false)){
-		/**
-		 * Load Cache interface file
-		 */
-		require_once CORE_CLASSES_CACHE_PATH . 'CacheInterface.php';
-		$cacheHandler = get_config('cache_handler');
-		if(! $cacheHandler){
-			show_error('The cache feature is enabled in the configuration but the cache handler class is not set.');
-		}
-		$CACHE = null;
-		//first check if the cache handler is the system driver
-		if(file_exists(CORE_CLASSES_CACHE_PATH . $cacheHandler . '.php')){
-			$CACHE =& class_loader($cacheHandler, 'classes/cache');
-		}
-		else{
-			//it's not a system driver use user library
-			$CACHE =& class_loader($cacheHandler);
-		}
-		//check if the page already cached
-		if(! empty($_SERVER['REQUEST_METHOD']) && strtolower($_SERVER['REQUEST_METHOD']) == 'get'){
-			$RESPONSE = & class_loader('Response', 'classes');
-			$RESPONSE->renderFinalPageFromCache($CACHE);
-		}
-	}
+    if(get_config('cache_enable', false)){
+        /**
+         * Load Cache interface file
+         */
+        require_once CORE_CLASSES_CACHE_PATH . 'CacheInterface.php';
+        $cacheHandler = get_config('cache_handler');
+        if(! $cacheHandler){
+            show_error('The cache feature is enabled in the configuration but the cache handler class is not set.');
+        }
+        $CACHE = null;
+        //first check if the cache handler is the system driver
+        if(file_exists(CORE_CLASSES_CACHE_PATH . $cacheHandler . '.php')){
+            $CACHE =& class_loader($cacheHandler, 'classes/cache');
+        }
+        else{
+            //it's not a system driver use user library
+            $CACHE =& class_loader($cacheHandler);
+        }
+        //check if the page already cached
+        if(! empty($_SERVER['REQUEST_METHOD']) && strtolower($_SERVER['REQUEST_METHOD']) == 'get'){
+            $RESPONSE = & class_loader('Response', 'classes');
+            $RESPONSE->renderFinalPageFromCache($CACHE);
+        }
+    }
 	
-	//load model class
-	require_once CORE_CLASSES_MODEL_PATH . 'Model.php';
+    //load model class
+    require_once CORE_CLASSES_MODEL_PATH . 'Model.php';
 	
-	$LOGGER->info('Everything is OK load Router library and dispatch the request to the corresponding controller');
-	/**
-	* Routing
-	* instantiation of the "Router" class and request processing.
-	*/
-	$ROUTER = & class_loader('Router', 'classes');
-	$ROUTER->processRequest();
+    $LOGGER->info('Everything is OK load Router library and dispatch the request to the corresponding controller');
+    /**
+     * Routing
+     * instantiation of the "Router" class and request processing.
+     */
+    $ROUTER = & class_loader('Router', 'classes');
+    $ROUTER->processRequest();