tnhfw / tnh-fw

core/libraries/Html.php

Indentation +323 added lines, -323 removed lines

@@ -1,343 +1,343 @@
 <?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){
-			$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){
+            $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;
-			$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;
+            $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){
-			if($return){
-				return self::buildUlOl($data, $attributes, true, 'ul');
-			}
-			self::buildUlOl($data, $attributes, false, 'ul');
-		}
+        /**
+         * 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){
+            if($return){
+                return self::buildUlOl($data, $attributes, true, 'ul');
+            }
+            self::buildUlOl($data, $attributes, false, 'ul');
+        }
 
-		/**
-		 * 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){
-			if($return){
-				return self::buildUlOl($data, $attributes, true, 'ol');
-			}
-			self::buildUlOl($data, $attributes, false, 'ol');
-		}
+        /**
+         * 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){
+            if($return){
+                return self::buildUlOl($data, $attributes, true, 'ol');
+            }
+            self::buildUlOl($data, $attributes, false, 'ol');
+        }
 
 
-		/**
-		 * 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;
-			$tableAttributes = '';
-			if(! empty($attributes['table'])){
-				$tableAttributes = ' ' . attributes_to_string($attributes['table']);
-			}
-			$str .= '<table' . $tableAttributes . '>';
-			$str .= self::buildTableHeader($headers, $attributes);
-			$str .= self::buildTableBody($body, $attributes);
+        /**
+         * 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;
+            $tableAttributes = '';
+            if(! empty($attributes['table'])){
+                $tableAttributes = ' ' . attributes_to_string($attributes['table']);
+            }
+            $str .= '<table' . $tableAttributes . '>';
+            $str .= self::buildTableHeader($headers, $attributes);
+            $str .= self::buildTableBody($body, $attributes);
 
-			if($use_footer){
-				$str .= self::buildTableFooter($headers, $attributes);
-			}
-			$str .= '</table>';
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
+            if($use_footer){
+                $str .= self::buildTableFooter($headers, $attributes);
+            }
+            $str .= '</table>';
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
 
-		/**
-		 * This method is used to build the header of the html table
-		 * @see  Html::table 
-		 * @return string|null
-		 */
-		protected static function buildTableHeader(array $headers, $attributes = array()){
-			$str = null;
-			$theadAttributes = '';
-			if(! empty($attributes['thead'])){
-				$theadAttributes = ' ' . attributes_to_string($attributes['thead']);
-			}
-			$theadtrAttributes = '';
-			if(! empty($attributes['thead_tr'])){
-				$theadtrAttributes = ' ' . attributes_to_string($attributes['thead_tr']);
-			}
-			$thAttributes = '';
-			if(! empty($attributes['thead_th'])){
-				$thAttributes = ' ' . attributes_to_string($attributes['thead_th']);
-			}
-			$str .= '<thead' . $theadAttributes .'>';
-			$str .= '<tr' . $theadtrAttributes .'>';
-			foreach ($headers as $value) {
-				$str .= '<th' . $thAttributes .'>' .$value. '</th>';
-			}
-			$str .= '</tr>';
-			$str .= '</thead>';
-			return $str;
-		}
+        /**
+         * This method is used to build the header of the html table
+         * @see  Html::table 
+         * @return string|null
+         */
+        protected static function buildTableHeader(array $headers, $attributes = array()){
+            $str = null;
+            $theadAttributes = '';
+            if(! empty($attributes['thead'])){
+                $theadAttributes = ' ' . attributes_to_string($attributes['thead']);
+            }
+            $theadtrAttributes = '';
+            if(! empty($attributes['thead_tr'])){
+                $theadtrAttributes = ' ' . attributes_to_string($attributes['thead_tr']);
+            }
+            $thAttributes = '';
+            if(! empty($attributes['thead_th'])){
+                $thAttributes = ' ' . attributes_to_string($attributes['thead_th']);
+            }
+            $str .= '<thead' . $theadAttributes .'>';
+            $str .= '<tr' . $theadtrAttributes .'>';
+            foreach ($headers as $value) {
+                $str .= '<th' . $thAttributes .'>' .$value. '</th>';
+            }
+            $str .= '</tr>';
+            $str .= '</thead>';
+            return $str;
+        }
 
-		/**
-		 * This method is used to build the body of the html table
-		 * @see  Html::table 
-		 * @return string|null
-		 */
-		protected static function buildTableBody(array $body, $attributes = array()){
-			$str = null;
-			$tbodyAttributes = '';
-			if(! empty($attributes['tbody'])){
-				$tbodyAttributes = ' ' . attributes_to_string($attributes['tbody']);
-			}
-			$tbodytrAttributes = '';
-			if(! empty($attributes['tbody_tr'])){
-				$tbodytrAttributes = ' ' . attributes_to_string($attributes['tbody_tr']);
-			}
-			$tbodytdAttributes = '';
-			if(! empty($attributes['tbody_td'])){
-				$tbodytdAttributes = ' ' . attributes_to_string($attributes['tbody_td']);
-			}
-			$str .= '<tbody' . $tbodyAttributes .'>';
-			$str .= self::buildTableBodyContent($body, $tbodytrAttributes, $tbodytdAttributes);
-			$str .= '</tbody>';
-			return $str;
-		}
+        /**
+         * This method is used to build the body of the html table
+         * @see  Html::table 
+         * @return string|null
+         */
+        protected static function buildTableBody(array $body, $attributes = array()){
+            $str = null;
+            $tbodyAttributes = '';
+            if(! empty($attributes['tbody'])){
+                $tbodyAttributes = ' ' . attributes_to_string($attributes['tbody']);
+            }
+            $tbodytrAttributes = '';
+            if(! empty($attributes['tbody_tr'])){
+                $tbodytrAttributes = ' ' . attributes_to_string($attributes['tbody_tr']);
+            }
+            $tbodytdAttributes = '';
+            if(! empty($attributes['tbody_td'])){
+                $tbodytdAttributes = ' ' . attributes_to_string($attributes['tbody_td']);
+            }
+            $str .= '<tbody' . $tbodyAttributes .'>';
+            $str .= self::buildTableBodyContent($body, $tbodytrAttributes, $tbodytdAttributes);
+            $str .= '</tbody>';
+            return $str;
+        }
 
-		/**
-		 * This method is used to build the body content of the html table
-		 * @param  array  $body              the table body data
-		 * @param  string $tbodytrAttributes the html attributes for each tr in tbody
-		 * @param  string $tbodytdAttributes the html attributes for each td in tbody
-		 * @return string                    
-		 */
-		protected static function buildTableBodyContent(array $body, $tbodytrAttributes, $tbodytdAttributes){
-			$str = null;
-			foreach ($body as $row) {
-				if(is_array($row)){
-					$str .= '<tr' . $tbodytrAttributes .'>';
-					foreach ($row as $value) {
-						$str .= '<td' . $tbodytdAttributes .'>' .$value. '</td>';	
-					}
-					$str .= '</tr>';
-				}
-			}
-			return $str;
-		}
+        /**
+         * This method is used to build the body content of the html table
+         * @param  array  $body              the table body data
+         * @param  string $tbodytrAttributes the html attributes for each tr in tbody
+         * @param  string $tbodytdAttributes the html attributes for each td in tbody
+         * @return string                    
+         */
+        protected static function buildTableBodyContent(array $body, $tbodytrAttributes, $tbodytdAttributes){
+            $str = null;
+            foreach ($body as $row) {
+                if(is_array($row)){
+                    $str .= '<tr' . $tbodytrAttributes .'>';
+                    foreach ($row as $value) {
+                        $str .= '<td' . $tbodytdAttributes .'>' .$value. '</td>';	
+                    }
+                    $str .= '</tr>';
+                }
+            }
+            return $str;
+        }
 
-		/**
-		 * This method is used to build the footer of the html table
-		 * @see  Html::table 
-		 * @return string|null
-		 */
-		protected static function buildTableFooter(array $footers, $attributes = array()){
-			$str = null;
-			$tfootAttributes = '';
-			if(! empty($attributes['tfoot'])){
-				$tfootAttributes = ' ' . attributes_to_string($attributes['tfoot']);
-			}
-			$tfoottrAttributes = '';
-			if(! empty($attributes['tfoot_tr'])){
-				$tfoottrAttributes = ' ' . attributes_to_string($attributes['tfoot_tr']);
-			}
-			$thAttributes = '';
-			if(! empty($attributes['tfoot_th'])){
-				$thAttributes = ' ' . attributes_to_string($attributes['tfoot_th']);
-			}
-			$str .= '<tfoot' . $tfootAttributes .'>';
-				$str .= '<tr' . $tfoottrAttributes .'>';
-				foreach ($footers as $value) {
-					$str .= '<th' . $thAttributes .'>' .$value. '</th>';
-				}
-				$str .= '</tr>';
-				$str .= '</tfoot>';
-			return $str;
-		}
+        /**
+         * This method is used to build the footer of the html table
+         * @see  Html::table 
+         * @return string|null
+         */
+        protected static function buildTableFooter(array $footers, $attributes = array()){
+            $str = null;
+            $tfootAttributes = '';
+            if(! empty($attributes['tfoot'])){
+                $tfootAttributes = ' ' . attributes_to_string($attributes['tfoot']);
+            }
+            $tfoottrAttributes = '';
+            if(! empty($attributes['tfoot_tr'])){
+                $tfoottrAttributes = ' ' . attributes_to_string($attributes['tfoot_tr']);
+            }
+            $thAttributes = '';
+            if(! empty($attributes['tfoot_th'])){
+                $thAttributes = ' ' . attributes_to_string($attributes['tfoot_th']);
+            }
+            $str .= '<tfoot' . $tfootAttributes .'>';
+                $str .= '<tr' . $tfoottrAttributes .'>';
+                foreach ($footers as $value) {
+                    $str .= '<th' . $thAttributes .'>' .$value. '</th>';
+                }
+                $str .= '</tr>';
+                $str .= '</tfoot>';
+            return $str;
+        }
 
-		/**
-		 * Return the HTML content for ol or ul tags
-		 * @see  Html::ol
-		 * @see  Html::ul
-		 * @param  string  $olul   the type 'ol' or 'ul'
-		 * @return void|string
-		 */
-		protected static function buildUlOl($data = array(), $attributes = array(), $return = true, $olul = 'ul'){
-			$data = (array) $data;
-			$str = null;
-			$olulAttributes = '';
-			if(! empty($attributes[$olul])){
-				$olulAttributes = ' ' . attributes_to_string($attributes[$olul]);
-			}
-			$liAttributes = '';
-			if(! empty($attributes['li'])){
-				$liAttributes = ' ' . attributes_to_string($attributes['li']);
-			}
-			$str .= '<' . $olul . $olulAttributes . '>';
-			foreach ($data as $row) {
-				$str .= '<li' . $liAttributes .'>' .$row. '</li>';
-			}
-			$str .= '</' . $olul . '>';
-			if($return){
-				return $str;
-			}
-			echo $str;
-		}
-	}
+        /**
+         * Return the HTML content for ol or ul tags
+         * @see  Html::ol
+         * @see  Html::ul
+         * @param  string  $olul   the type 'ol' or 'ul'
+         * @return void|string
+         */
+        protected static function buildUlOl($data = array(), $attributes = array(), $return = true, $olul = 'ul'){
+            $data = (array) $data;
+            $str = null;
+            $olulAttributes = '';
+            if(! empty($attributes[$olul])){
+                $olulAttributes = ' ' . attributes_to_string($attributes[$olul]);
+            }
+            $liAttributes = '';
+            if(! empty($attributes['li'])){
+                $liAttributes = ' ' . attributes_to_string($attributes['li']);
+            }
+            $str .= '<' . $olul . $olulAttributes . '>';
+            foreach ($data as $row) {
+                $str .= '<li' . $liAttributes .'>' .$row. '</li>';
+            }
+            $str .= '</' . $olul . '>';
+            if($return){
+                return $str;
+            }
+            echo $str;
+        }
+    }

core/classes/model/Model.php

Indentation +126 added lines, -126 removed lines

@@ -22,7 +22,7 @@ 
      * 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.
-    */
+     */
 
 
     /**
@@ -120,10 +120,10 @@ 
         protected $_temporary_return_type = NULL;
     	
     	
-    	/**
+        /**
     		The database cache time 
-    	*/
-    	protected $dbCacheTime = 0;
+         */
+        protected $dbCacheTime = 0;
 
         /**
          * Instance of the Loader class
@@ -151,12 +151,12 @@ 
             }
             else{
                 $obj = & get_instance();
-        		if (isset($obj->database) && is_object($obj->database)){
+                if (isset($obj->database) && is_object($obj->database)){
                     /**
-                    * NOTE: Need use "clone" because some Model need have the personal instance of the database library
-                    * to prevent duplication
-                    */
-        			$this->setDatabaseInstance(clone $obj->database);
+                     * NOTE: Need use "clone" because some Model need have the personal instance of the database library
+                     * to prevent duplication
+                     */
+                    $this->setDatabaseInstance(clone $obj->database);
                 }
             }
 
@@ -174,7 +174,7 @@ 
          */
         public function get($primary_value)
         {
-    		return $this->get_by($this->primary_key, $primary_value);
+            return $this->get_by($this->primary_key, $primary_value);
         }
 
         /**
@@ -189,12 +189,12 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-    		$this->_set_where($where);
+            $this->_set_where($where);
 
             $this->trigger('before_get');
-			$type = $this->_temporary_return_type == 'array' ? 'array' : false;
+            $type = $this->_temporary_return_type == 'array' ? 'array' : false;
             $this->getQueryBuilder()->from($this->_table);
-			$row = $this->_database->get($type);
+            $row = $this->_database->get($type);
             $this->_temporary_return_type = $this->return_type;
             $row = $this->trigger('after_get', $row);
             $this->_with = array();
@@ -231,9 +231,9 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-			$type = $this->_temporary_return_type == 'array' ? 'array':false;
+            $type = $this->_temporary_return_type == 'array' ? 'array':false;
             $this->getQueryBuilder()->from($this->_table);
-			$result = $this->_database->getAll($type);
+            $result = $this->_database->getAll($type);
             $this->_temporary_return_type = $this->return_type;
 
             foreach ($result as $key => &$row)
@@ -247,7 +247,7 @@ 
         /**
          * Insert a new row into the table. $data should be an associative array
          * of data to be inserted. Returns newly created ID.
-		 * @see Database::insert
+         * @see Database::insert
          */
         public function insert($data = array(), $skip_validation = FALSE, $escape = true)
         {
@@ -260,11 +260,11 @@ 
             {
                 $data = $this->trigger('before_create', $data);
                 $this->getQueryBuilder()->from($this->_table);
-				$this->_database->insert($data, $escape);
+                $this->_database->insert($data, $escape);
                 $insert_id = $this->_database->insertId();
                 $this->trigger('after_create', $insert_id);
-				//if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
-				return ! $insert_id ? true : $insert_id;
+                //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
+                return ! $insert_id ? true : $insert_id;
             }
             else
             {
@@ -324,7 +324,7 @@ 
             {
                 $this->getQueryBuilder()->in($this->primary_key, $primary_values)
                                         ->from($this->_table);
-				$result = $this->_database->update($data, $escape);
+                $result = $this->_database->update($data, $escape);
                 $this->trigger('after_update', array($data, $result));
                 return $result;
             }
@@ -356,7 +356,7 @@ 
             {
                 $this->_set_where($args);
                 $this->getQueryBuilder()->from($this->_table);
-				$result = $this->_database->update($data);
+                $result = $this->_database->update($data);
                 $this->trigger('after_update', array($data, $result));
                 return $result;
             }
@@ -370,7 +370,7 @@ 
         {
             $data = $this->trigger('before_update', $data);
             $this->getQueryBuilder()->from($this->_table);
-			$result = $this->_database->update($data, $escape);
+            $result = $this->_database->update($data, $escape);
             $this->trigger('after_update', array($data, $result));
             return $result;
         }
@@ -382,16 +382,16 @@ 
         {
             $this->trigger('before_delete', $id);
             $this->getQueryBuilder()->where($this->primary_key, $id);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
 
             $this->trigger('after_delete', $result);
@@ -404,18 +404,18 @@ 
         public function delete_by()
         {
             $where = func_get_args();
-    	    $where = $this->trigger('before_delete', $where);
+            $where = $this->trigger('before_delete', $where);
             $this->_set_where($where);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
             $this->trigger('after_delete', $result);
             return $result;
@@ -428,16 +428,16 @@ 
         {
             $primary_values = $this->trigger('before_delete', $primary_values);
             $this->getQueryBuilder()->in($this->primary_key, $primary_values);
-			$result = false;
+            $result = false;
             if ($this->soft_delete)
             {
                 $this->getQueryBuilder()->from($this->_table);	
-				$result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
+                $result = $this->_database->update(array( $this->soft_delete_key => TRUE ));
             }
             else
             {
                 $this->getQueryBuilder()->from($this->_table); 
-				$result = $this->_database->delete();
+                $result = $this->_database->delete();
             }
             $this->trigger('after_delete', $result);
             return $result;
@@ -449,8 +449,8 @@ 
          */
         public function truncate()
         {
-			$this->getQueryBuilder()->from($this->_table); 
-			$result = $this->_database->delete();
+            $this->getQueryBuilder()->from($this->_table); 
+            $result = $this->_database->delete();
             return $result;
         }
 
@@ -468,14 +468,14 @@ 
             return $this;
         }
 		
-		/**
-		* Relationship
-		*/
+        /**
+         * Relationship
+         */
         public function relate($row)
         {
-    		if (empty($row))
+            if (empty($row))
             {
-    		    return $row;
+                return $row;
             }
 
             $row = $this->relateBelongsTo($row);
@@ -508,9 +508,9 @@ 
                 $this->getQueryBuilder()->where($this->soft_delete_key, FALSE);
             }
             $this->getQueryBuilder()
-									 ->select(array($key, $value))
-									 ->from($this->_table);
-			$result = $this->_database->getAll();
+                                        ->select(array($key, $value))
+                                        ->from($this->_table);
+            $result = $this->_database->getAll();
             $options = array();
             foreach ($result as $row)
             {
@@ -532,7 +532,7 @@ 
             $where = func_get_args();
             $this->_set_where($where);
             $this->getQueryBuilder()->from($this->_table);
-			$this->_database->getAll();
+            $this->_database->getAll();
             return $this->_database->numRows();
         }
 
@@ -545,20 +545,20 @@ 
             {
                 $this->getQueryBuilder()->where($this->soft_delete_key, (bool)$this->_temporary_only_deleted);
             }
-			$this->getQueryBuilder()->from($this->_table);
-			$this->_database->getAll();
+            $this->getQueryBuilder()->from($this->_table);
+            $this->_database->getAll();
             return $this->_database->numRows();
         }
 		
-		/**
-		* Enabled cache temporary
-		*/
-		public function cached($ttl = 0){
-		  if ($ttl > 0){
-			$this->_database = $this->_database->cached($ttl);
-		  }
-		  return $this;
-		}
+        /**
+         * Enabled cache temporary
+         */
+        public function cached($ttl = 0){
+            if ($ttl > 0){
+            $this->_database = $this->_database->cached($ttl);
+            }
+            return $this;
+        }
 
         /**
          * Tell the class to skip the insert validation
@@ -582,10 +582,10 @@ 
          */
         public function get_next_id()
         {
-			$this->getQueryBuilder()->select('AUTO_INCREMENT')
-									->from('information_schema.TABLES')
-									->where('TABLE_NAME', $this->_table)
-									->where('TABLE_SCHEMA', $this->_database->getDatabaseName());
+            $this->getQueryBuilder()->select('AUTO_INCREMENT')
+                                    ->from('information_schema.TABLES')
+                                    ->where('TABLE_NAME', $this->_table)
+                                    ->where('TABLE_SCHEMA', $this->_database->getDatabaseName());
             return (int) $this->_database->get()->AUTO_INCREMENT;
         }
 
@@ -708,24 +708,24 @@ 
             {
                 if (is_object($row))
                 {
-					if (isset($row->$attr)){
-						unset($row->$attr);
-					}
+                    if (isset($row->$attr)){
+                        unset($row->$attr);
+                    }
                 }
                 else
                 {
-					if (isset($row[$attr])){
-						unset($row[$attr]);
-					}
+                    if (isset($row[$attr])){
+                        unset($row[$attr]);
+                    }
                 }
             }
             return $row;
         }
 		
-		 /**
-         * Return the database instance
-         * @return Database the database instance
-         */
+            /**
+             * Return the database instance
+             * @return Database the database instance
+             */
         public function getDatabaseInstance(){
             return $this->_database;
         }
@@ -734,7 +734,7 @@ 
          * set the Database instance for future use
          * @param Database $db the database object
          */
-         public function setDatabaseInstance($db){
+            public function setDatabaseInstance($db){
             $this->_database = $db;
             if ($this->dbCacheTime > 0){
                 $this->_database->setCache($this->dbCacheTime);
@@ -753,14 +753,14 @@ 
         /**
          * Set the loader instance for future use
          * @param Loader $loader the loader object
-		 * @return object
+         * @return object
          */
-         public function setLoader($loader){
+            public function setLoader($loader){
             $this->loaderInstance = $loader;
             return $this;
         }
 
-		/**
+        /**
          * Return the queryBuilder instance this is the shortcut to database queryBuilder
          * @return object the DatabaseQueryBuilder instance
          */
@@ -771,9 +771,9 @@ 
         /**
          * Set the DatabaseQueryBuilder instance for future use
          * @param object $queryBuilder the DatabaseQueryBuilder object
-		 * @return object
+         * @return object
          */
-         public function setQueryBuilder($queryBuilder){
+            public function setQueryBuilder($queryBuilder){
             $this->_database->setQueryBuilder($queryBuilder);
             return $this;
         }
@@ -790,9 +790,9 @@ 
         /**
          * Set the form validation instance for future use
          * @param FormValidation $fv the form validation object
-		 * @return object
+         * @return object
          */
-         public function setFormValidation($fv){
+            public function setFormValidation($fv){
             $this->formValidationInstance = $fv;
             return $this;
         }
@@ -833,12 +833,12 @@ 
          * INTERNAL METHODS
          * ------------------------------------------------------------ */
 
-		/**
-		* relate for the relation "belongs_to"
-		* @return mixed
-		*/
-		protected function relateBelongsTo($row){
-			foreach ($this->belongs_to as $key => $value)
+        /**
+         * relate for the relation "belongs_to"
+         * @return mixed
+         */
+        protected function relateBelongsTo($row){
+            foreach ($this->belongs_to as $key => $value)
             {
                 if (is_string($value))
                 {
@@ -869,15 +869,15 @@ 
                     }
                 }
             }
-			return $row;
-		}
-
-		/**
-		* relate for the relation "has_many"
-		* @return mixed
-		*/
-		protected function relateHasMany($row){
-			foreach ($this->has_many as $key => $value)
+            return $row;
+        }
+
+        /**
+         * relate for the relation "has_many"
+         * @return mixed
+         */
+        protected function relateHasMany($row){
+            foreach ($this->has_many as $key => $value)
             {
                 if (is_string($value))
                 {
@@ -908,8 +908,8 @@ 
                     }
                 }
             }
-			return $row;
-		}
+            return $row;
+        }
 		
         /**
          * Trigger an event and call its observers. Pass through the event name
@@ -945,7 +945,7 @@ 
             }
             $fv = $this->formValidationInstance;
             if (! is_object($fv)){
-                 Loader::library('FormValidation');
+                    Loader::library('FormValidation');
                 $fv = $this->formvalidation;
                 $this->setFormValidation($fv);  
             }
@@ -960,30 +960,30 @@ 
         }
 		
 		
-		/**
-		* Set WHERE parameters, when is array
-		* @param array $params
-		*/
-		protected function _set_where_array(array $params){
-			foreach ($params as $field => $filter)
-			{
-				if (is_array($filter))
-				{
-					$this->getQueryBuilder()->in($field, $filter);
-				}
-				else
-				{
-					if (is_int($field))
-					{
-						$this->getQueryBuilder()->where($filter);
-					}
-					else
-					{
-						$this->getQueryBuilder()->where($field, $filter);
-					}
-				}
-			}
-		}
+        /**
+         * Set WHERE parameters, when is array
+         * @param array $params
+         */
+        protected function _set_where_array(array $params){
+            foreach ($params as $field => $filter)
+            {
+                if (is_array($filter))
+                {
+                    $this->getQueryBuilder()->in($field, $filter);
+                }
+                else
+                {
+                    if (is_int($field))
+                    {
+                        $this->getQueryBuilder()->where($filter);
+                    }
+                    else
+                    {
+                        $this->getQueryBuilder()->where($field, $filter);
+                    }
+                }
+            }
+        }
 
 
         /**
@@ -999,8 +999,8 @@ 
             {
                 $this->getQueryBuilder()->where($params[0]);
             }
-        	else if (count($params) == 2)
-    		{
+            else if (count($params) == 2)
+            {
                 if (is_array($params[1]))
                 {
                     $this->getQueryBuilder()->in($params[0], $params[1]);
@@ -1009,11 +1009,11 @@ 
                 {
                     $this->getQueryBuilder()->where($params[0], $params[1]);
                 }
-    		}
-    		else if (count($params) == 3)
-    		{
-    			$this->getQueryBuilder()->where($params[0], $params[1], $params[2]);
-    		}
+            }
+            else if (count($params) == 3)
+            {
+                $this->getQueryBuilder()->where($params[0], $params[1], $params[2]);
+            }
             else
             {
                 if (is_array($params[1]))
@@ -1029,7 +1029,7 @@ 
 
         /**
             Shortcut to controller
-        */
+         */
         public function __get($key){
             return get_instance()->{$key};
         }

core/classes/Log.php

Indentation +262 added lines, -262 removed lines

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

core/bootstrap.php

Indentation +167 added lines, -167 removed lines

@@ -1,197 +1,197 @@
 <?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');
-			if ($RESPONSE->renderFinalPageFromCache($CACHE)){
-				return;
-			}
-		}
-	}
+    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');
+            if ($RESPONSE->renderFinalPageFromCache($CACHE)){
+                return;
+            }
+        }
+    }
 	
-	//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();

core/common.php

Indentation +533 added lines, -533 removed lines

@@ -1,578 +1,578 @@
 <?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',
-								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',
-								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.');
-			}
-		}
+    /**
+     * 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',
+                                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',
+                                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 = 'HTTP/1.1';
-			if(isset($_SERVER['SERVER_PROTOCOL'])){
-				$proto = $_SERVER['SERVER_PROTOCOL'];
-			}
-			header($proto . ' ' . $code . ' ' . $text, TRUE, $code);
-		}
-	}
+        if (strpos(php_sapi_name(), 'cgi') === 0){
+            header('Status: ' . $code . ' ' . $text, TRUE);
+        }
+        else{
+            $proto = 'HTTP/1.1';
+            if(isset($_SERVER['SERVER_PROTOCOL'])){
+                $proto = $_SERVER['SERVER_PROTOCOL'];
+            }
+            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;
-		}
-		if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https'){
-			return true;
-		}
-		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;
+        }
+        if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https'){
+            return true;
+        }
+        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_WARNING:
-					$errorType = 'warning';
-					break;
-				case E_USER_NOTICE:
-					$errorType = 'notice';
-					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_WARNING:
+                    $errorType = 'warning';
+                    break;
+                case E_USER_NOTICE:
+                    $errorType = 'notice';
+                    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/classes/Module.php

Indentation +255 added lines, -255 removed lines

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

core/classes/Response.php

Indentation +490 added lines, -490 removed lines

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

core/classes/Router.php

Indentation +610 added lines, -610 removed lines

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

core/classes/DBSessionHandler.php

Indentation +352 added lines, -352 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.
+     */
 	
-	/**
-	 * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
-	 */
-	if ( !interface_exists('SessionHandlerInterface')){
-		show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
-	}
-
-	class DBSessionHandler implements SessionHandlerInterface{
+    /**
+     * check if the interface "SessionHandlerInterface" exists (normally in PHP 5.4 this already exists)
+     */
+    if ( !interface_exists('SessionHandlerInterface')){
+        show_error('"SessionHandlerInterface" interface does not exists or is disabled can not use it to handler database session.');
+    }
+
+    class DBSessionHandler implements SessionHandlerInterface{
 		
-		/**
-		 * The encryption method to use to encrypt session data in database
-		 * @const string
-		 */
-		const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
+        /**
+         * The encryption method to use to encrypt session data in database
+         * @const string
+         */
+        const DB_SESSION_HASH_METHOD = 'AES-256-CBC';
 		
-		/**
-		 * Super global instance
-		 * @var object
-		 */
-		protected $OBJ = null;
-
-		/**
-		 * Session secret to use 
-		 * @var string
-		 */
-		private $sessionSecret = null;
-
-		/**
-		 * The initialisation vector to use for openssl
-		 * @var string
-		 */
-		private $iv = null;
-
-		/**
-		 * The model instance to use
-		 * @var object
-		 */
-		private $modelInstance = null;
-
-		/**
-		 * The columns of the table to use to store session data
-		 * @var array
-		 */
-		private $sessionTableColumns = array();
-
-		/**
-		 * The instance of the Log 
-		 * @var Log
-		 */
-		private $logger;
-
-		/**
+        /**
+         * Super global instance
+         * @var object
+         */
+        protected $OBJ = null;
+
+        /**
+         * Session secret to use 
+         * @var string
+         */
+        private $sessionSecret = null;
+
+        /**
+         * The initialisation vector to use for openssl
+         * @var string
+         */
+        private $iv = null;
+
+        /**
+         * The model instance to use
+         * @var object
+         */
+        private $modelInstance = null;
+
+        /**
+         * The columns of the table to use to store session data
+         * @var array
+         */
+        private $sessionTableColumns = array();
+
+        /**
+         * The instance of the Log 
+         * @var Log
+         */
+        private $logger;
+
+        /**
          * Instance of the Loader class
          * @var Loader
          */
@@ -85,227 +85,227 @@ 
          * Create new instance of Database session handler
          * @param object $modelInstance the model instance
          */
-		public function __construct(DBSessionHandlerModel $modelInstance = null){
-			//Set Log instance to use
-	        $this->setLoggerFromParamOrCreate(null);
+        public function __construct(DBSessionHandlerModel $modelInstance = null){
+            //Set Log instance to use
+            $this->setLoggerFromParamOrCreate(null);
 			
-	    	//Set Loader instance to use
-	        $this->setDependencyInstanceFromParamOrCreate('loader', null, 'Loader', 'classes');
+            //Set Loader instance to use
+            $this->setDependencyInstanceFromParamOrCreate('loader', null, 'Loader', 'classes');
 	       
-		    $this->OBJ = & get_instance();
+            $this->OBJ = & get_instance();
 		    
-			if (is_object($modelInstance)){
-				$this->setModelInstance($modelInstance);
-			}
-		}
-
-		/**
-		 * Set the session secret used to encrypt the data in database 
-		 * @param string $secret the base64 string secret
-		 */
-		public function setSessionSecret($secret){
-			$this->sessionSecret = $secret;
-			return $this;
-		}
-
-		/**
-		 * Return the session secret
-		 * @return string 
-		 */
-		public function getSessionSecret(){
-			return $this->sessionSecret;
-		}
-
-
-		/**
-		 * Set the initializer vector for openssl 
-		 * @param string $key the session secret used in base64 format
-		 */
-		public function setInitializerVector($key){
-			$ivLength = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
-			$key = base64_decode($key);
-			$this->iv = substr(hash('sha256', $key), 0, $ivLength);
-			return $this;
-		}
-
-		/**
-		 * Return the initializer vector
-		 * @return string 
-		 */
-		public function getInitializerVector(){
-			return $this->iv;
-		}
-
-		/**
-		 * Open the database session handler, here nothing to do just return true
-		 * @param  string $savePath    the session save path
-		 * @param  string $sessionName the session name
-		 * @return boolean 
-		 */
-		public function open($savePath, $sessionName){
-			$this->logger->debug('Opening database session handler for [' . $sessionName . ']');
-			//try to check if session secret is set before
-			$secret = $this->getSessionSecret();
-			if (empty($secret)){
-				$secret = get_config('session_secret', null);
-				$this->setSessionSecret($secret);
-			}
-			$this->logger->info('Session secret: ' . $secret);
-
-			if (! is_object($this->modelInstance)){
-				$this->setModelInstanceFromConfig();
-			}
-			$this->setInitializerVector($secret);
-
-			//set session tables columns
-			$this->sessionTableColumns = $this->modelInstance->getSessionTableColumns();
-
-			if (empty($this->sessionTableColumns)){
-				show_error('The session handler is "database" but the table columns not set');
-			}
-			$this->logger->info('Database session, the model columns are listed below: ' . stringfy_vars($this->sessionTableColumns));
+            if (is_object($modelInstance)){
+                $this->setModelInstance($modelInstance);
+            }
+        }
+
+        /**
+         * Set the session secret used to encrypt the data in database 
+         * @param string $secret the base64 string secret
+         */
+        public function setSessionSecret($secret){
+            $this->sessionSecret = $secret;
+            return $this;
+        }
+
+        /**
+         * Return the session secret
+         * @return string 
+         */
+        public function getSessionSecret(){
+            return $this->sessionSecret;
+        }
+
+
+        /**
+         * Set the initializer vector for openssl 
+         * @param string $key the session secret used in base64 format
+         */
+        public function setInitializerVector($key){
+            $ivLength = openssl_cipher_iv_length(self::DB_SESSION_HASH_METHOD);
+            $key = base64_decode($key);
+            $this->iv = substr(hash('sha256', $key), 0, $ivLength);
+            return $this;
+        }
+
+        /**
+         * Return the initializer vector
+         * @return string 
+         */
+        public function getInitializerVector(){
+            return $this->iv;
+        }
+
+        /**
+         * Open the database session handler, here nothing to do just return true
+         * @param  string $savePath    the session save path
+         * @param  string $sessionName the session name
+         * @return boolean 
+         */
+        public function open($savePath, $sessionName){
+            $this->logger->debug('Opening database session handler for [' . $sessionName . ']');
+            //try to check if session secret is set before
+            $secret = $this->getSessionSecret();
+            if (empty($secret)){
+                $secret = get_config('session_secret', null);
+                $this->setSessionSecret($secret);
+            }
+            $this->logger->info('Session secret: ' . $secret);
+
+            if (! is_object($this->modelInstance)){
+                $this->setModelInstanceFromConfig();
+            }
+            $this->setInitializerVector($secret);
+
+            //set session tables columns
+            $this->sessionTableColumns = $this->modelInstance->getSessionTableColumns();
+
+            if (empty($this->sessionTableColumns)){
+                show_error('The session handler is "database" but the table columns not set');
+            }
+            $this->logger->info('Database session, the model columns are listed below: ' . stringfy_vars($this->sessionTableColumns));
 			
-			//delete the expired session
-			$timeActivity = get_config('session_inactivity_time', 100);
-			$this->gc($timeActivity);
+            //delete the expired session
+            $timeActivity = get_config('session_inactivity_time', 100);
+            $this->gc($timeActivity);
 			
-			return true;
-		}
-
-		/**
-		 * Close the session
-		 * @return boolean
-		 */
-		public function close(){
-			$this->logger->debug('Closing database session handler');
-			return true;
-		}
-
-		/**
-		 * Get the session value for the given session id
-		 * @param  string $sid the session id to use
-		 * @return string      the session data in serialiaze format
-		 */
-		public function read($sid){
-			$this->logger->debug('Reading database session data for SID: ' . $sid);
-			$instance = $this->getModelInstance();
-			$columns = $this->sessionTableColumns;
-			$this->loader->functions('user_agent'); 
-			$this->loader->library('Browser'); 
+            return true;
+        }
+
+        /**
+         * Close the session
+         * @return boolean
+         */
+        public function close(){
+            $this->logger->debug('Closing database session handler');
+            return true;
+        }
+
+        /**
+         * Get the session value for the given session id
+         * @param  string $sid the session id to use
+         * @return string      the session data in serialiaze format
+         */
+        public function read($sid){
+            $this->logger->debug('Reading database session data for SID: ' . $sid);
+            $instance = $this->getModelInstance();
+            $columns = $this->sessionTableColumns;
+            $this->loader->functions('user_agent'); 
+            $this->loader->library('Browser'); 
 			
-			$ip = get_ip();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $ip = get_ip();
+            $host = @gethostbyaddr($ip) or null;
+            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
 			
-			$data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
-			if ($data && isset($data->{$columns['sdata']})){
-				//checking inactivity 
-				$timeInactivity = time() - get_config('session_inactivity_time', 100);
-				if ($data->{$columns['stime']} < $timeInactivity){
-					$this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
-					$this->destroy($sid);
-					return null;
-				}
-				return $this->decode($data->{$columns['sdata']});
-			}
-			$this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
-			return null;
-		}
-
-		/**
-		 * Save the session data
-		 * @param  string $sid  the session ID
-		 * @param  mixed $data the session data to save in serialize format
-		 * @return boolean 
-		 */
-		public function write($sid, $data){
-			$this->logger->debug('Saving database session data for SID: ' . $sid . ', data: ' . stringfy_vars($data));
-			$instance = $this->getModelInstance();
-			$columns = $this->sessionTableColumns;
-
-			$this->loader->functions('user_agent'); 
-			$this->loader->library('Browser'); 
-
-			$ip = get_ip();
-			$keyValue = $instance->getKeyValue();
-			$host = @gethostbyaddr($ip) or null;
-			$browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
-			$data = $this->encode($data);
-			$params = array(
-							$columns['sid'] => $sid,
-							$columns['sdata'] => $data,
-							$columns['stime'] => time(),
-							$columns['shost'] => $host,
-							$columns['sbrowser'] => $browser,
-							$columns['sip'] => $ip,
-							$columns['skey'] => $keyValue
-						);
-			$this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
-			$exists = $instance->get($sid);
-			if ($exists){
-				$this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
-				//update
-				unset($params[$columns['sid']]);
-				return $instance->update($sid, $params);
-			}
-			$this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
-			return $instance->insert($params);
-			return true;
-		}
-
-
-		/**
-		 * Destroy the session data for the given session id
-		 * @param  string $sid the session id value
-		 * @return boolean
-		 */
-		public function destroy($sid){
-			$this->logger->debug('Destroy of session data for SID: ' . $sid);
-			$instance = $this->modelInstance;
-			$instance->delete($sid);
-			return true;
-		}
-
-		/**
-		 * Clean the expire session data to save espace
-		 * @param  integer $maxLifetime the max lifetime
-		 * @return boolean
-		 */
-		public function gc($maxLifetime){
-			$instance = $this->modelInstance;
-			$time = time() - $maxLifetime;
-			$this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
-			$instance->deleteByTime($time);
-			return true;
-		}
-
-		/**
-		 * Encode the session data using the openssl
-		 * @param  mixed $data the session data to encode
-		 * @return mixed the encoded session data
-		 */
-		public function encode($data){
-			$key = base64_decode($this->sessionSecret);
-			$dataEncrypted = openssl_encrypt($data , self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
-			$output = base64_encode($dataEncrypted);
-			return $output;
-		}
-
-
-		/**
-		 * Decode the session data using the openssl
-		 * @param  mixed $data the data to decode
-		 * @return mixed       the decoded data
-		 */
-		public function decode($data){
-			$key = base64_decode($this->sessionSecret);
-			$data = base64_decode($data);
-			$data = openssl_decrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
-			return $data;
-		}
+            $data = $instance->get_by(array($columns['sid'] => $sid, $columns['shost'] => $host, $columns['sbrowser'] => $browser));
+            if ($data && isset($data->{$columns['sdata']})){
+                //checking inactivity 
+                $timeInactivity = time() - get_config('session_inactivity_time', 100);
+                if ($data->{$columns['stime']} < $timeInactivity){
+                    $this->logger->info('Database session data for SID: ' . $sid . ' already expired, destroy it');
+                    $this->destroy($sid);
+                    return null;
+                }
+                return $this->decode($data->{$columns['sdata']});
+            }
+            $this->logger->info('Database session data for SID: ' . $sid . ' is not valid return false, may be the session ID is wrong');
+            return null;
+        }
+
+        /**
+         * Save the session data
+         * @param  string $sid  the session ID
+         * @param  mixed $data the session data to save in serialize format
+         * @return boolean 
+         */
+        public function write($sid, $data){
+            $this->logger->debug('Saving database session data for SID: ' . $sid . ', data: ' . stringfy_vars($data));
+            $instance = $this->getModelInstance();
+            $columns = $this->sessionTableColumns;
+
+            $this->loader->functions('user_agent'); 
+            $this->loader->library('Browser'); 
+
+            $ip = get_ip();
+            $keyValue = $instance->getKeyValue();
+            $host = @gethostbyaddr($ip) or null;
+            $browser = $this->OBJ->browser->getPlatform().', '.$this->OBJ->browser->getBrowser().' '.$this->OBJ->browser->getVersion();
+            $data = $this->encode($data);
+            $params = array(
+                            $columns['sid'] => $sid,
+                            $columns['sdata'] => $data,
+                            $columns['stime'] => time(),
+                            $columns['shost'] => $host,
+                            $columns['sbrowser'] => $browser,
+                            $columns['sip'] => $ip,
+                            $columns['skey'] => $keyValue
+                        );
+            $this->logger->info('Database session data to save are listed below :' . stringfy_vars($params));
+            $exists = $instance->get($sid);
+            if ($exists){
+                $this->logger->info('Session data for SID: ' . $sid . ' already exists, just update it');
+                //update
+                unset($params[$columns['sid']]);
+                return $instance->update($sid, $params);
+            }
+            $this->logger->info('Session data for SID: ' . $sid . ' not yet exists, insert it now');
+            return $instance->insert($params);
+            return true;
+        }
+
+
+        /**
+         * Destroy the session data for the given session id
+         * @param  string $sid the session id value
+         * @return boolean
+         */
+        public function destroy($sid){
+            $this->logger->debug('Destroy of session data for SID: ' . $sid);
+            $instance = $this->modelInstance;
+            $instance->delete($sid);
+            return true;
+        }
+
+        /**
+         * Clean the expire session data to save espace
+         * @param  integer $maxLifetime the max lifetime
+         * @return boolean
+         */
+        public function gc($maxLifetime){
+            $instance = $this->modelInstance;
+            $time = time() - $maxLifetime;
+            $this->logger->debug('Garbage collector of expired session. maxLifetime [' . $maxLifetime . '] sec, expired time [' . $time . ']');
+            $instance->deleteByTime($time);
+            return true;
+        }
+
+        /**
+         * Encode the session data using the openssl
+         * @param  mixed $data the session data to encode
+         * @return mixed the encoded session data
+         */
+        public function encode($data){
+            $key = base64_decode($this->sessionSecret);
+            $dataEncrypted = openssl_encrypt($data , self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
+            $output = base64_encode($dataEncrypted);
+            return $output;
+        }
+
+
+        /**
+         * Decode the session data using the openssl
+         * @param  mixed $data the data to decode
+         * @return mixed       the decoded data
+         */
+        public function decode($data){
+            $key = base64_decode($this->sessionSecret);
+            $data = base64_decode($data);
+            $data = openssl_decrypt($data, self::DB_SESSION_HASH_METHOD, $key, OPENSSL_RAW_DATA, $this->getInitializerVector());
+            return $data;
+        }
 
 		
-		/**
+        /**
          * Return the loader instance
          * @return object Loader the loader instance
          */
@@ -317,7 +317,7 @@ 
          * set the loader instance for future use
          * @param object Loader $loader the loader object
          */
-         public function setLoader($loader){
+            public function setLoader($loader){
             $this->loader = $loader;
             return $this;
         }
@@ -334,77 +334,77 @@ 
          * set the model instance for future use
          * @param DBSessionHandlerModel $modelInstance the model object
          */
-         public function setModelInstance(DBSessionHandlerModel $modelInstance){
+            public function setModelInstance(DBSessionHandlerModel $modelInstance){
             $this->modelInstance = $modelInstance;
             return $this;
         }
 
         /**
-	     * Return the Log instance
-	     * @return Log
-	     */
-	    public function getLogger(){
-	      return $this->logger;
-	    }
-
-	    /**
-	     * Set the log instance
-	     * @param Log $logger the log object
-	     */
-	    public function setLogger(Log $logger){
-	      $this->logger = $logger;
-	      return $this;
-	    }
-
-	    /**
-	     * Set the dependencies instance using argument or create new instance if is null
-	     * @param string $name this class property name.
-	     * @param object $instance the instance. If is not null will use it
-	     * otherwise will create new instance.
-	     * @param string $loadClassName the name of class to load using class_loader function.
-	     * @param string $loadClassPath the path of class to load using class_loader function.
-	     *
-	     * @return object this current instance
-	     */
-	    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
-	      if ($instance !== null){
-	        $this->{$name} = $instance;
-	        return $this;
-	      }
-	      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
-	      return $this;
-	    }
+         * Return the Log instance
+         * @return Log
+         */
+        public function getLogger(){
+            return $this->logger;
+        }
+
+        /**
+         * Set the log instance
+         * @param Log $logger the log object
+         */
+        public function setLogger(Log $logger){
+            $this->logger = $logger;
+            return $this;
+        }
+
+        /**
+         * Set the dependencies instance using argument or create new instance if is null
+         * @param string $name this class property name.
+         * @param object $instance the instance. If is not null will use it
+         * otherwise will create new instance.
+         * @param string $loadClassName the name of class to load using class_loader function.
+         * @param string $loadClassPath the path of class to load using class_loader function.
+         *
+         * @return object this current instance
+         */
+        protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
+            if ($instance !== null){
+            $this->{$name} = $instance;
+            return $this;
+            }
+            $this->{$name} =& class_loader($loadClassName, $loadClassePath);
+            return $this;
+        }
 	    
-		   /**
-	     * Set the Log instance using argument or create new instance
-	     * @param object $logger the Log instance if not null
-	     *
-	     * @return object this current instance
-	     */
-	    protected function setLoggerFromParamOrCreate(Log $logger = null){
-	      $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
-	      if ($logger === null){
-	        $this->logger->setLogger('Library::DBSessionHandler');
-	      }
-	      return $this;
-	    }
-
-	    /**
-	     * Set the model instance using the configuration for session
-	     */
-	    protected function setModelInstanceFromConfig(){
-	    	$modelName = get_config('session_save_path');
-			$this->logger->info('The database session model: ' . $modelName);
-			$this->loader->model($modelName, 'dbsessionhandlerinstance'); 
-			//@codeCoverageIgnoreStart
+            /**
+             * Set the Log instance using argument or create new instance
+             * @param object $logger the Log instance if not null
+             *
+             * @return object this current instance
+             */
+        protected function setLoggerFromParamOrCreate(Log $logger = null){
+            $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
+            if ($logger === null){
+            $this->logger->setLogger('Library::DBSessionHandler');
+            }
+            return $this;
+        }
+
+        /**
+         * Set the model instance using the configuration for session
+         */
+        protected function setModelInstanceFromConfig(){
+            $modelName = get_config('session_save_path');
+            $this->logger->info('The database session model: ' . $modelName);
+            $this->loader->model($modelName, 'dbsessionhandlerinstance'); 
+            //@codeCoverageIgnoreStart
             if (isset($this->OBJ->dbsessionhandlerinstance) 
-            	&& ! ($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
+                && ! ($this->OBJ->dbsessionhandlerinstance instanceof DBSessionHandlerModel)
             ) {
-				show_error('To use database session handler, your class model "' . get_class($this->OBJ->dbsessionhandlerinstance) . '" need extends "DBSessionHandlerModel"');
-			}  
-			//@codeCoverageIgnoreEnd
+                show_error('To use database session handler, your class model "' . get_class($this->OBJ->dbsessionhandlerinstance) . '" need extends "DBSessionHandlerModel"');
+            }  
+            //@codeCoverageIgnoreEnd
 			
-			//set model instance
-			$this->modelInstance = $this->OBJ->dbsessionhandlerinstance;
-	    }
-	}
+            //set model instance
+            $this->modelInstance = $this->OBJ->dbsessionhandlerinstance;
+        }
+    }