Passed
Push — 1.0.0-dev ( 8edc19...2b6704 )
by nguereza
03:32
created
config/config.php 1 patch
Indentation   +273 added lines, -273 removed lines patch added patch discarded remove patch
@@ -1,337 +1,337 @@
 block discarded – undo
1 1
 <?php
2
-	defined('ROOT_PATH') || exit('Access denied');
3
-	/**
4
-	 * TNH Framework
5
-	 *
6
-	 * A simple PHP framework created using the concept of codeigniter with bootstrap twitter
7
-	 *
8
-	 * This content is released under the GNU GPL License (GPL)
9
-	 *
10
-	 * Copyright (C) 2017 Tony NGUEREZA
11
-	 *
12
-	 * This program is free software; you can redistribute it and/or
13
-	 * modify it under the terms of the GNU General Public License
14
-	 * as published by the Free Software Foundation; either version 3
15
-	 * of the License, or (at your option) any later version.
16
-	 *
17
-	 * This program is distributed in the hope that it will be useful,
18
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
-	 * GNU General Public License for more details.
21
-	 *
22
-	 * You should have received a copy of the GNU General Public License
23
-	 * along with this program; if not, write to the Free Software
24
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-	*/
2
+    defined('ROOT_PATH') || exit('Access denied');
3
+    /**
4
+     * TNH Framework
5
+     *
6
+     * A simple PHP framework created using the concept of codeigniter with bootstrap twitter
7
+     *
8
+     * This content is released under the GNU GPL License (GPL)
9
+     *
10
+     * Copyright (C) 2017 Tony NGUEREZA
11
+     *
12
+     * This program is free software; you can redistribute it and/or
13
+     * modify it under the terms of the GNU General Public License
14
+     * as published by the Free Software Foundation; either version 3
15
+     * of the License, or (at your option) any later version.
16
+     *
17
+     * This program is distributed in the hope that it will be useful,
18
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
+     * GNU General Public License for more details.
21
+     *
22
+     * You should have received a copy of the GNU General Public License
23
+     * along with this program; if not, write to the Free Software
24
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
+     */
26 26
 	
27
-	/**
28
-	* This file contains the main configuration of your application
29
-	* web address, front controller, error logging, session parameters, CSRF, Cache, 
30
-	* Whitelist IP access, etc.
31
-	*/
27
+    /**
28
+     * This file contains the main configuration of your application
29
+     * web address, front controller, error logging, session parameters, CSRF, Cache, 
30
+     * Whitelist IP access, etc.
31
+     */
32 32
 	
33
-	/*+---------------------------------------------------------------+
33
+    /*+---------------------------------------------------------------+
34 34
 	* Basic configuration section
35 35
 	+------------------------------------------------------------------+
36 36
 	*/
37 37
 	
38
-	/**
39
-	* The web address of your application.
40
-	*
41
-	* The address of your application or website terminated by a slash.
42
-	* You can use a domain name or IP address, for example:
43
-	*
44
-	* $config['base_url'] = 'http://www.mysite.com';
45
-	* or
46
-	* $config['base_url'] = 'http://198.15.25.12';
47
-	*
48
-	* If this value is empty, we try to determine it automatically by using 
49
-	* the server variables "SERVER_ADDR" or "SCRIPT_NAME",
50
-	* we recommend that you specify this value for a server in production this may reduce the performance of your application.
51
-	*/
52
-	$config['base_url'] = '';
38
+    /**
39
+     * The web address of your application.
40
+     *
41
+     * The address of your application or website terminated by a slash.
42
+     * You can use a domain name or IP address, for example:
43
+     *
44
+     * $config['base_url'] = 'http://www.mysite.com';
45
+     * or
46
+     * $config['base_url'] = 'http://198.15.25.12';
47
+     *
48
+     * If this value is empty, we try to determine it automatically by using 
49
+     * the server variables "SERVER_ADDR" or "SCRIPT_NAME",
50
+     * we recommend that you specify this value for a server in production this may reduce the performance of your application.
51
+     */
52
+    $config['base_url'] = '';
53 53
 	
54
-	/**
55
-	* The front controller
56
-	*
57
-	* This represents the name of the file called by the application during the loading 
58
-	* process generally the file "index.php". 
59
-	* If your webserver supports the url rewrite module, then you can leave this value empty. 
60
-	* You will find a sample file to hide this file in the url inside the root folder of your 
61
-	* application "htaccess.txt" for the apache web server just rename it to ".htaccess"
62
-	* 
63
-	* Without the rewrite module url enabled, leave this value to "index.php", in this case your urls look like:
64
-	*
65
-	* http://www.yoursite.com/index.php/controller/method
66
-	* 
67
-	* otherwise if the module is available and activated you can put this value empty and your urls look like:
68
-	*
69
-	* http://www.yoursite.com/controller/method
70
-	*
71
-	*/
72
-	$config['front_controller'] = 'index.php';
54
+    /**
55
+     * The front controller
56
+     *
57
+     * This represents the name of the file called by the application during the loading 
58
+     * process generally the file "index.php". 
59
+     * If your webserver supports the url rewrite module, then you can leave this value empty. 
60
+     * You will find a sample file to hide this file in the url inside the root folder of your 
61
+     * application "htaccess.txt" for the apache web server just rename it to ".htaccess"
62
+     * 
63
+     * Without the rewrite module url enabled, leave this value to "index.php", in this case your urls look like:
64
+     *
65
+     * http://www.yoursite.com/index.php/controller/method
66
+     * 
67
+     * otherwise if the module is available and activated you can put this value empty and your urls look like:
68
+     *
69
+     * http://www.yoursite.com/controller/method
70
+     *
71
+     */
72
+    $config['front_controller'] = 'index.php';
73 73
 	
74
-	/**
75
-	 *  Url suffix
76
-	 */
77
-	$config['url_suffix'] = '';
74
+    /**
75
+     *  Url suffix
76
+     */
77
+    $config['url_suffix'] = '';
78 78
 	
79
-	/**
80
-	 *  site charset
81
-	 */
82
-	$config['charset'] = 'UTF-8';
79
+    /**
80
+     *  site charset
81
+     */
82
+    $config['charset'] = 'UTF-8';
83 83
 	
84
-	/**
85
-	* Compress the output before send to browser
86
-	*
87
-	* Enables Gzip output compression for faster page loads.  When enabled,
88
-	* the Response class will test whether your server supports Gzip.
89
-	* Even if it does, however, not all browsers support compression
90
-	* so enable only if you are reasonably sure your visitors can handle it.
91
-	*
92
-	* This is only used if "zlib.output_compression" is turned off in your php configuration.
93
-	* Please do not use it together with httpd-level output compression.
94
-	*
95
-	* IMPORTANT NOTE:  If you are getting a blank page when compression is enabled it
96
-	* means you are prematurely outputting something to your browser. It could
97
-	* even be a line of whitespace at the end of one of your scripts. For
98
-	* compression to work, nothing can be sent before the output buffer is called
99
-	* by the Response class.  Do not 'echo' any values with compression enabled.
100
-	*/
101
-	$config['compress_output'] = false;
84
+    /**
85
+     * Compress the output before send to browser
86
+     *
87
+     * Enables Gzip output compression for faster page loads.  When enabled,
88
+     * the Response class will test whether your server supports Gzip.
89
+     * Even if it does, however, not all browsers support compression
90
+     * so enable only if you are reasonably sure your visitors can handle it.
91
+     *
92
+     * This is only used if "zlib.output_compression" is turned off in your php configuration.
93
+     * Please do not use it together with httpd-level output compression.
94
+     *
95
+     * IMPORTANT NOTE:  If you are getting a blank page when compression is enabled it
96
+     * means you are prematurely outputting something to your browser. It could
97
+     * even be a line of whitespace at the end of one of your scripts. For
98
+     * compression to work, nothing can be sent before the output buffer is called
99
+     * by the Response class.  Do not 'echo' any values with compression enabled.
100
+     */
101
+    $config['compress_output'] = false;
102 102
 
103
-	/*+---------------------------------------------------------------+
103
+    /*+---------------------------------------------------------------+
104 104
 	* Language configuration section
105 105
 	+------------------------------------------------------------------+
106 106
 	*/
107
-	/**
108
-	 * list of available supported language
109
-	 * array(
110
-	 * 		'lang_key' => 'human readable'
111
-	 * )
112
-	 */
113
-	$config['languages'] = array('en' => 'english');
107
+    /**
108
+     * list of available supported language
109
+     * array(
110
+     * 		'lang_key' => 'human readable'
111
+     * )
112
+     */
113
+    $config['languages'] = array('en' => 'english');
114 114
 
115
-	/**
116
-	 * the default language to use if can not find the client language
117
-	 * need match with the array key of the supported languages
118
-	 */
119
-	$config['default_language'] = 'en'; //en = english, fr = french
115
+    /**
116
+     * the default language to use if can not find the client language
117
+     * need match with the array key of the supported languages
118
+     */
119
+    $config['default_language'] = 'en'; //en = english, fr = french
120 120
 
121
-	/**
122
-	 * the name of cookie used to store the client language
123
-	 */
124
-	$config['language_cookie_name'] = 'cookie_lang';
121
+    /**
122
+     * the name of cookie used to store the client language
123
+     */
124
+    $config['language_cookie_name'] = 'cookie_lang';
125 125
 
126 126
 
127
-	/*+---------------------------------------------------------------+
127
+    /*+---------------------------------------------------------------+
128 128
 	* Logs configuration section
129 129
 	+------------------------------------------------------------------+
130 130
 	*/
131 131
 	
132
-	/** 
133
-	* The log level
134
-	*
135
-	* The valid level are: OFF, NONE, FATAL, ERROR, WARNING, WARN, INFO, DEBUG, ALL
136
-	*
137
-	* 'OFF' or 'NONE' = do not save log
138
-	* 'FATAL' = enable log for fatal level and above (FATAL)
139
-	* 'ERROR' = enable log for error level and above (ERROR, FATAL)
140
-	* 'WARNING' or WARN = enable log for warning level and above (WARNING, ERROR, FATAL)
141
-	* 'INFO' = enable log for info level and above (INFO, WARNING, ERROR, FATAL)
142
-	* 'DEBUG' = enable log for debug level and above (DEBUG, INFO, WARNING, ERROR, FATAL)
143
-	* 'ALL' = enable log for all level
144
-	*
145
-	* The default value is NONE if the config value is: null, '', 0, false
146
-	* 
147
-	* Note: in production environment it's recommand to set the log level to 'WARNING' if not in small
148
-	* of time the log file size will increase very fast and will cost the application performance
149
-	* and also the filesystem usage of your server.
150
-	*/
151
-	$config['log_level'] = 'NONE';
132
+    /** 
133
+     * The log level
134
+     *
135
+     * The valid level are: OFF, NONE, FATAL, ERROR, WARNING, WARN, INFO, DEBUG, ALL
136
+     *
137
+     * 'OFF' or 'NONE' = do not save log
138
+     * 'FATAL' = enable log for fatal level and above (FATAL)
139
+     * 'ERROR' = enable log for error level and above (ERROR, FATAL)
140
+     * 'WARNING' or WARN = enable log for warning level and above (WARNING, ERROR, FATAL)
141
+     * 'INFO' = enable log for info level and above (INFO, WARNING, ERROR, FATAL)
142
+     * 'DEBUG' = enable log for debug level and above (DEBUG, INFO, WARNING, ERROR, FATAL)
143
+     * 'ALL' = enable log for all level
144
+     *
145
+     * The default value is NONE if the config value is: null, '', 0, false
146
+     * 
147
+     * Note: in production environment it's recommand to set the log level to 'WARNING' if not in small
148
+     * of time the log file size will increase very fast and will cost the application performance
149
+     * and also the filesystem usage of your server.
150
+     */
151
+    $config['log_level'] = 'NONE';
152 152
 
153 153
 
154
-	/**
155
-	* The path to log directory
156
-	* 
157
-	* The path that the log data will be saved ending with de "/" or "\", leave empty if you
158
-	* want use the default configuration
159
-	* warning : if set, this directory must exist and will be writable and owned by the web server
160
-	* else the default value will be used i.e the constant LOG_PATH
161
-	* for security raison this directory must be outside of the document root of your
162
-	* website.
163
-	*/	
164
-	$config['log_save_path'] = '';
154
+    /**
155
+     * The path to log directory
156
+     * 
157
+     * The path that the log data will be saved ending with de "/" or "\", leave empty if you
158
+     * want use the default configuration
159
+     * warning : if set, this directory must exist and will be writable and owned by the web server
160
+     * else the default value will be used i.e the constant LOG_PATH
161
+     * for security raison this directory must be outside of the document root of your
162
+     * website.
163
+     */	
164
+    $config['log_save_path'] = '';
165 165
 	
166
-	/**
167
-	* The logger name to use for the log
168
-	* 
169
-	* If this config is set so means only log message with this or these logger(s) will be saved
170
-	*
171
-	* Example:
172
-	* $config['log_logger_name'] = array('MY_LOGGER1', 'MY_LOGGER2'); //only log message with MY_LOGGER1 or MY_LOGGER2 will be saved in file.
173
-	*/	
174
-	$config['log_logger_name'] = array();
166
+    /**
167
+     * The logger name to use for the log
168
+     * 
169
+     * If this config is set so means only log message with this or these logger(s) will be saved
170
+     *
171
+     * Example:
172
+     * $config['log_logger_name'] = array('MY_LOGGER1', 'MY_LOGGER2'); //only log message with MY_LOGGER1 or MY_LOGGER2 will be saved in file.
173
+     */	
174
+    $config['log_logger_name'] = array();
175 175
 	
176 176
 	
177
-	/*+---------------------------------------------------------------+
177
+    /*+---------------------------------------------------------------+
178 178
 	* Session configuration section
179 179
 	+------------------------------------------------------------------+
180 180
 	*/
181 181
 	
182
-	/**
183
-	* The session name 
184
-	*
185
-	* By default is PHPSESSID. this must be alpha-numerical characters
186
-	*/
187
-	$config['session_name'] = 'PHPSESSID';
182
+    /**
183
+     * The session name 
184
+     *
185
+     * By default is PHPSESSID. this must be alpha-numerical characters
186
+     */
187
+    $config['session_name'] = 'PHPSESSID';
188 188
 	
189
-	/**
190
-	* Session save path
191
-	*
192
-	* The path that the session data will be saved, leave empty if you
193
-	* want use the default configuration in the php.ini
194
-	* warning : if set, this directory must exist and will be writable and owned by the web server
195
-	* for security raison this directory must be outside of the document root of your
196
-	* website.
197
-	* Note: if the session handler is "database" the session_save_path is the model name to use
198
-	*/
199
-	$config['session_save_path'] = '';
189
+    /**
190
+     * Session save path
191
+     *
192
+     * The path that the session data will be saved, leave empty if you
193
+     * want use the default configuration in the php.ini
194
+     * warning : if set, this directory must exist and will be writable and owned by the web server
195
+     * for security raison this directory must be outside of the document root of your
196
+     * website.
197
+     * Note: if the session handler is "database" the session_save_path is the model name to use
198
+     */
199
+    $config['session_save_path'] = '';
200 200
 
201
-	/**
202
-	* Session handler
203
-	*
204
-	* The session handler that we will use to manage the session.
205
-	* currently the possible values are "files", "database".
206
-	*/
207
-	$config['session_handler'] = 'files';
201
+    /**
202
+     * Session handler
203
+     *
204
+     * The session handler that we will use to manage the session.
205
+     * currently the possible values are "files", "database".
206
+     */
207
+    $config['session_handler'] = 'files';
208 208
 	
209
-	/**
210
-	* Session secret
211
-	*
212
-	* This is used to hash the session data if the config "session_handler" is set to "database"
213
-	* warning : do not change this value until you already set
214
-	* for security raison use the very complicated value include $%)@^&^\''\'\'
215
-	* NOTE: this value is an base64 so you need use the tool that generate it, like
216
-	*  PHP function base64_encode()
217
-	*/
218
-	$config['session_secret'] = '';
209
+    /**
210
+     * Session secret
211
+     *
212
+     * This is used to hash the session data if the config "session_handler" is set to "database"
213
+     * warning : do not change this value until you already set
214
+     * for security raison use the very complicated value include $%)@^&^\''\'\'
215
+     * NOTE: this value is an base64 so you need use the tool that generate it, like
216
+     *  PHP function base64_encode()
217
+     */
218
+    $config['session_secret'] = '';
219 219
 
220
-	/**
221
-	 * number of second that consider the session already expire
222
-	 */
223
-	$config['session_inactivity_time'] = 600; //in second
220
+    /**
221
+     * number of second that consider the session already expire
222
+     */
223
+    $config['session_inactivity_time'] = 600; //in second
224 224
 
225
-	/**
226
-	* Session cookie lifetime
227
-	*
228
-	* The cookie lifetime that the session will be dropped in seconds, leave 0 if you want
229
-	* the cookie expire after the browser is closed
230
-	*/
231
-	$config['session_cookie_lifetime'] = 0;
225
+    /**
226
+     * Session cookie lifetime
227
+     *
228
+     * The cookie lifetime that the session will be dropped in seconds, leave 0 if you want
229
+     * the cookie expire after the browser is closed
230
+     */
231
+    $config['session_cookie_lifetime'] = 0;
232 232
 	
233
-	/**
234
-	* Session cookie path
235
-	*
236
-	* The path to your website that the cookie is available "/" means all path is available
237
-	* example : /mysubdirectory => available in http://www.mysite.com/mysubdirectory
238
-	*/
239
-	$config['session_cookie_path'] = '/';
233
+    /**
234
+     * Session cookie path
235
+     *
236
+     * The path to your website that the cookie is available "/" means all path is available
237
+     * example : /mysubdirectory => available in http://www.mysite.com/mysubdirectory
238
+     */
239
+    $config['session_cookie_path'] = '/';
240 240
 	
241
-	/** 
242
-	* Session cookie domain
243
-	*
244
-	* The domain of your website that the cookie is available if you want the cookie is available
245
-	* in all your subdomain use this dot before the domain name for example ".mysite.com".
246
-	* leave empty if you want use the default configuration
247
-	*/
248
-	$config['session_cookie_domain'] = '';
241
+    /** 
242
+     * Session cookie domain
243
+     *
244
+     * The domain of your website that the cookie is available if you want the cookie is available
245
+     * in all your subdomain use this dot before the domain name for example ".mysite.com".
246
+     * leave empty if you want use the default configuration
247
+     */
248
+    $config['session_cookie_domain'] = '';
249 249
 	
250
-	/**
251
-	* Session cookie secure
252
-	* 
253
-	* If your website use SSL i.e https, you set "true" for this configuration, so the cookie
254
-	* is available only if the website use the secure connection else set this value to "false"
255
-	*/
256
-	$config['session_cookie_secure'] = false;
250
+    /**
251
+     * Session cookie secure
252
+     * 
253
+     * If your website use SSL i.e https, you set "true" for this configuration, so the cookie
254
+     * is available only if the website use the secure connection else set this value to "false"
255
+     */
256
+    $config['session_cookie_secure'] = false;
257 257
 	
258 258
 
259
-	/*+---------------------------------------------------------------+
259
+    /*+---------------------------------------------------------------+
260 260
 	* CSRF configuration section
261 261
 	+------------------------------------------------------------------+
262 262
 	*/
263 263
 	
264
-	/**
265
-	 * CSRF status
266
-	 *
267
-	 * if you would to use the CSRF (that we recommand you), set this key to true
268
-	 */
269
-	$config['csrf_enable'] = false;
264
+    /**
265
+     * CSRF status
266
+     *
267
+     * if you would to use the CSRF (that we recommand you), set this key to true
268
+     */
269
+    $config['csrf_enable'] = false;
270 270
 
271
-	/**
272
-	 * CSRF key
273
-	 *
274
-	 * the key used to store the csrf data
275
-	 */
276
-	$config['csrf_key'] = 'csrf_key';
271
+    /**
272
+     * CSRF key
273
+     *
274
+     * the key used to store the csrf data
275
+     */
276
+    $config['csrf_key'] = 'csrf_key';
277 277
 
278
-	/**
279
-	 * CSRF expire
280
-	 *
281
-	 * expire time in seconds of the CSRF data
282
-	 */
283
-	$config['csrf_expire'] = 120;
278
+    /**
279
+     * CSRF expire
280
+     *
281
+     * expire time in seconds of the CSRF data
282
+     */
283
+    $config['csrf_expire'] = 120;
284 284
 	
285 285
 	
286
-	/*+---------------------------------------------------------------+
286
+    /*+---------------------------------------------------------------+
287 287
 	* Cache configuration section
288 288
 	+------------------------------------------------------------------+
289 289
 	*/
290 290
 	
291
-	/**
292
-	 * Cache status
293
-	 *
294
-	 * If you would to use the cache functionnality set this value to true
295
-	 */
296
-	$config['cache_enable'] = false;
291
+    /**
292
+     * Cache status
293
+     *
294
+     * If you would to use the cache functionnality set this value to true
295
+     */
296
+    $config['cache_enable'] = false;
297 297
 	
298
-	/**
299
-	 * Cache Time To Live
300
-	 *
301
-	 * expire time in seconds of the cache data
302
-	 */
303
-	$config['cache_ttl'] = 120; //in second
298
+    /**
299
+     * Cache Time To Live
300
+     *
301
+     * expire time in seconds of the cache data
302
+     */
303
+    $config['cache_ttl'] = 120; //in second
304 304
 
305
-	/**
306
-	* Cache handler class
307
-	*
308
-	* The cache handler class inside (CORE_CLASSES_CACHE_PATH, LIBRARY_PATH) directories that implements 
309
-	* the interface "CacheInterface" that we will use to manage the cache.
310
-	* currently the possible values are "FileCache", "ApcCache".
311
-	*/
312
-	$config['cache_handler'] = 'FileCache';
305
+    /**
306
+     * Cache handler class
307
+     *
308
+     * The cache handler class inside (CORE_CLASSES_CACHE_PATH, LIBRARY_PATH) directories that implements 
309
+     * the interface "CacheInterface" that we will use to manage the cache.
310
+     * currently the possible values are "FileCache", "ApcCache".
311
+     */
312
+    $config['cache_handler'] = 'FileCache';
313 313
 	
314 314
 	
315
-	/*+---------------------------------------------------------------+
315
+    /*+---------------------------------------------------------------+
316 316
 	* White list IP access configuration section
317 317
 	+------------------------------------------------------------------+
318 318
 	*/
319 319
 	
320
-	/**
321
-	 * White list ip status
322
-	 *
323
-	 * if you would to use the white list ip access, set this key to true
324
-	 */
325
-	$config['white_list_ip_enable'] = false;
320
+    /**
321
+     * White list ip status
322
+     *
323
+     * if you would to use the white list ip access, set this key to true
324
+     */
325
+    $config['white_list_ip_enable'] = false;
326 326
 	
327
-	/**
328
-	 * White listed ip addresses
329
-	 *
330
-	 * add the allowed ip address list to access this application.
331
-	 * You can use the wildcard address
332
-	 * @example: '18.90.09.*', '10.*.*.*', '*'
333
-	 * 
334
-	 */
335
-	$config['white_list_ip_addresses'] = array('127.0.0.1', '::1');
327
+    /**
328
+     * White listed ip addresses
329
+     *
330
+     * add the allowed ip address list to access this application.
331
+     * You can use the wildcard address
332
+     * @example: '18.90.09.*', '10.*.*.*', '*'
333
+     * 
334
+     */
335
+    $config['white_list_ip_addresses'] = array('127.0.0.1', '::1');
336 336
 
337
-	
338 337
\ No newline at end of file
338
+    
339 339
\ No newline at end of file
Please login to merge, or discard this patch.
tests/tnhfw/classes/database/DatabaseTest.php 1 patch
Indentation   +33 added lines, -33 removed lines patch added patch discarded remove patch
@@ -1,52 +1,52 @@
 block discarded – undo
1 1
 <?php 
2 2
 
3
-	use PHPUnit\Framework\TestCase;
3
+    use PHPUnit\Framework\TestCase;
4 4
 
5
-	class DatabaseTest extends TestCase
6
-	{	
5
+    class DatabaseTest extends TestCase
6
+    {	
7 7
 	
8
-		public static function setUpBeforeClass()
9
-		{
8
+        public static function setUpBeforeClass()
9
+        {
10 10
 		
11
-		}
11
+        }
12 12
 		
13
-		public static function tearDownAfterClass()
14
-		{
13
+        public static function tearDownAfterClass()
14
+        {
15 15
 			
16
-		}
16
+        }
17 17
 		
18
-		protected function setUp()
19
-		{
20
-		}
18
+        protected function setUp()
19
+        {
20
+        }
21 21
 
22
-		protected function tearDown()
23
-		{
24
-		}
22
+        protected function tearDown()
23
+        {
24
+        }
25 25
 		
26
-		public function testConnectToDatabaseSuccessfully()
27
-		{
26
+        public function testConnectToDatabaseSuccessfully()
27
+        {
28 28
             $cfg = get_db_config();
29 29
             $db = new Database($cfg, false);
30 30
             $isConnected = $db->connect();
31 31
             $this->assertTrue($isConnected);
32
-		}
32
+        }
33 33
         
34 34
         public function testCannotConnectToDatabase()
35
-		{
36
-             $db = new Database(array(
37
-                                  'driver' => '',
38
-                                  'username' => '',
39
-                                  'password' => '',
40
-                                  'database' => '',
41
-                                  'hostname' => '',
42
-                                  'charset' => '',
43
-                                  'collation' => '',
44
-                                  'prefix' => '',
45
-                                  'port' => ''
35
+        {
36
+                $db = new Database(array(
37
+                                    'driver' => '',
38
+                                    'username' => '',
39
+                                    'password' => '',
40
+                                    'database' => '',
41
+                                    'hostname' => '',
42
+                                    'charset' => '',
43
+                                    'collation' => '',
44
+                                    'prefix' => '',
45
+                                    'port' => ''
46 46
                                 ), 
47 47
                                 false);
48
-             $isConnected = $db->connect();
49
-			$this->assertFalse($isConnected);
50
-		}
48
+                $isConnected = $db->connect();
49
+            $this->assertFalse($isConnected);
50
+        }
51 51
 
52
-	}
53 52
\ No newline at end of file
53
+    }
54 54
\ No newline at end of file
Please login to merge, or discard this patch.
core/classes/database/Database.php 3 patches
Indentation   +356 added lines, -356 removed lines patch added patch discarded remove patch
@@ -1,119 +1,119 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
     defined('ROOT_PATH') || exit('Access denied');
3
-  /**
4
-   * TNH Framework
5
-   *
6
-   * A simple PHP framework using HMVC architecture
7
-   *
8
-   * This content is released under the GNU GPL License (GPL)
9
-   *
10
-   * Copyright (C) 2017 Tony NGUEREZA
11
-   *
12
-   * This program is free software; you can redistribute it and/or
13
-   * modify it under the terms of the GNU General Public License
14
-   * as published by the Free Software Foundation; either version 3
15
-   * of the License, or (at your option) any later version.
16
-   *
17
-   * This program is distributed in the hope that it will be useful,
18
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
-   * GNU General Public License for more details.
21
-   *
22
-   * You should have received a copy of the GNU General Public License
23
-   * along with this program; if not, write to the Free Software
24
-   * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-  */
26
-  class Database{
3
+    /**
4
+     * TNH Framework
5
+     *
6
+     * A simple PHP framework using HMVC architecture
7
+     *
8
+     * This content is released under the GNU GPL License (GPL)
9
+     *
10
+     * Copyright (C) 2017 Tony NGUEREZA
11
+     *
12
+     * This program is free software; you can redistribute it and/or
13
+     * modify it under the terms of the GNU General Public License
14
+     * as published by the Free Software Foundation; either version 3
15
+     * of the License, or (at your option) any later version.
16
+     *
17
+     * This program is distributed in the hope that it will be useful,
18
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
+     * GNU General Public License for more details.
21
+     *
22
+     * You should have received a copy of the GNU General Public License
23
+     * along with this program; if not, write to the Free Software
24
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
+     */
26
+    class Database{
27 27
 	
28
-  	/**
29
-  	 * The PDO instance
30
-  	 * @var object
31
-  	*/
28
+        /**
29
+         * The PDO instance
30
+         * @var object
31
+         */
32 32
     private $pdo                 = null;
33 33
     
34
-  	/**
35
-  	 * The database name used for the application
36
-  	 * @var string
37
-  	*/
38
-	  private $databaseName        = null;
34
+        /**
35
+         * The database name used for the application
36
+         * @var string
37
+         */
38
+        private $databaseName        = null;
39 39
 	
40
-  	/**
41
-  	 * The number of rows returned by the last query
42
-  	 * @var int
43
-  	*/
40
+        /**
41
+         * The number of rows returned by the last query
42
+         * @var int
43
+         */
44 44
     private $numRows             = 0;
45 45
 	
46
-  	/**
47
-  	 * The last insert id for the primary key column that have auto increment or sequence
48
-  	 * @var mixed
49
-  	*/
46
+        /**
47
+         * The last insert id for the primary key column that have auto increment or sequence
48
+         * @var mixed
49
+         */
50 50
     private $insertId            = null;
51 51
 	
52
-  	/**
53
-  	 * The full SQL query statment after build for each command
54
-  	 * @var string
55
-  	*/
52
+        /**
53
+         * The full SQL query statment after build for each command
54
+         * @var string
55
+         */
56 56
     private $query               = null;
57 57
 	
58
-  	/**
59
-  	 * The result returned for the last query
60
-  	 * @var mixed
61
-  	*/
58
+        /**
59
+         * The result returned for the last query
60
+         * @var mixed
61
+         */
62 62
     private $result              = array();
63 63
 	
64
-  	/**
65
-  	 * The cache default time to live in second. 0 means no need to use the cache feature
66
-  	 * @var int
67
-  	*/
68
-  	private $cacheTtl             = 0;
64
+        /**
65
+         * The cache default time to live in second. 0 means no need to use the cache feature
66
+         * @var int
67
+         */
68
+        private $cacheTtl             = 0;
69 69
 	
70
-  	/**
71
-  	 * The cache current time to live. 0 means no need to use the cache feature
72
-  	 * @var int
73
-  	*/
70
+        /**
71
+         * The cache current time to live. 0 means no need to use the cache feature
72
+         * @var int
73
+         */
74 74
     private $temporaryCacheTtl   = 0;
75 75
 	
76
-  	/**
77
-  	 * The number of executed query for the current request
78
-  	 * @var int
79
-  	*/
76
+        /**
77
+         * The number of executed query for the current request
78
+         * @var int
79
+         */
80 80
     private $queryCount          = 0;
81 81
 	
82
-  	/**
83
-  	 * The default data to be used in the statments query INSERT, UPDATE
84
-  	 * @var array
85
-  	*/
82
+        /**
83
+         * The default data to be used in the statments query INSERT, UPDATE
84
+         * @var array
85
+         */
86 86
     private $data                = array();
87 87
 	
88
-  	/**
89
-  	 * The database configuration
90
-  	 * @var array
91
-  	*/
88
+        /**
89
+         * The database configuration
90
+         * @var array
91
+         */
92 92
     private $config              = array();
93 93
 	
94
-  	/**
95
-  	 * The logger instance
96
-  	 * @var object
97
-  	 */
94
+        /**
95
+         * The logger instance
96
+         * @var object
97
+         */
98 98
     private $logger              = null;
99 99
 
100 100
     /**
101
-    * The cache instance
102
-    * @var object
103
-    */
101
+     * The cache instance
102
+     * @var object
103
+     */
104 104
     private $cacheInstance       = null;
105 105
 
106 106
     
107
-  	/**
108
-    * The DatabaseQueryBuilder instance
109
-    * @var object
110
-    */
107
+        /**
108
+         * The DatabaseQueryBuilder instance
109
+         * @var object
110
+         */
111 111
     private $queryBuilder        = null;
112 112
     
113 113
     /**
114
-    * The DatabaseQueryRunner instance
115
-    * @var object
116
-    */
114
+     * The DatabaseQueryRunner instance
115
+     * @var object
116
+     */
117 117
     private $queryRunner         = null;
118 118
 
119 119
 
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
         //Set Log instance to use
127 127
         $this->setLoggerFromParamOrCreate(null);
128 128
 		
129
-    		//Set DatabaseQueryBuilder instance to use
129
+            //Set DatabaseQueryBuilder instance to use
130 130
         $this->setDependencyInstanceFromParamOrCreate('queryBuilder', null, 'DatabaseQueryBuilder', 'classes/database');
131 131
        
132 132
         //Set DatabaseQueryRunner instance to use
@@ -144,8 +144,8 @@  discard block
 block discarded – undo
144 144
      * @return bool 
145 145
      */
146 146
     public function connect(){
147
-      $config = $this->getDatabaseConfiguration();
148
-      if (! empty($config)){
147
+        $config = $this->getDatabaseConfiguration();
148
+        if (! empty($config)){
149 149
         try{
150 150
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
151 151
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
@@ -156,14 +156,14 @@  discard block
 block discarded – undo
156 156
             $this->updateQueryBuilderAndRunnerProperties();
157 157
 
158 158
             return is_object($this->pdo);
159
-          }
160
-          catch (PDOException $e){
159
+            }
160
+            catch (PDOException $e){
161 161
             $this->logger->fatal($e->getMessage());
162 162
             show_error('Cannot connect to Database.');
163 163
             return false;
164
-          }
165
-      }
166
-      return false;
164
+            }
165
+        }
166
+        return false;
167 167
     }
168 168
 
169 169
 
@@ -172,7 +172,7 @@  discard block
 block discarded – undo
172 172
      * @return int
173 173
      */
174 174
     public function numRows(){
175
-      return $this->numRows;
175
+        return $this->numRows;
176 176
     }
177 177
 
178 178
     /**
@@ -180,7 +180,7 @@  discard block
 block discarded – undo
180 180
      * @return mixed
181 181
      */
182 182
     public function insertId(){
183
-      return $this->insertId;
183
+        return $this->insertId;
184 184
     }
185 185
 
186 186
 
@@ -191,13 +191,13 @@  discard block
 block discarded – undo
191 191
      * @return mixed       the query SQL string or the record result
192 192
      */
193 193
     public function get($returnSQLQueryOrResultType = false){
194
-      $this->queryBuilder->limit(1);
195
-      $query = $this->getAll(true);
196
-      if ($returnSQLQueryOrResultType === true){
194
+        $this->queryBuilder->limit(1);
195
+        $query = $this->getAll(true);
196
+        if ($returnSQLQueryOrResultType === true){
197 197
         return $query;
198
-      } else {
198
+        } else {
199 199
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
200
-      }
200
+        }
201 201
     }
202 202
 
203 203
     /**
@@ -207,11 +207,11 @@  discard block
 block discarded – undo
207 207
      * @return mixed       the query SQL string or the record result
208 208
      */
209 209
     public function getAll($returnSQLQueryOrResultType = false){
210
-	   $query = $this->queryBuilder->getQuery();
211
-	   if ($returnSQLQueryOrResultType === true){
212
-      	return $query;
213
-      }
214
-      return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
210
+        $query = $this->queryBuilder->getQuery();
211
+        if ($returnSQLQueryOrResultType === true){
212
+            return $query;
213
+        }
214
+        return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
215 215
     }
216 216
 
217 217
     /**
@@ -221,19 +221,19 @@  discard block
 block discarded – undo
221 221
      * @return mixed          the insert id of the new record or null
222 222
      */
223 223
     public function insert($data = array(), $escape = true){
224
-      if (empty($data) && ! empty($this->data)){
224
+        if (empty($data) && ! empty($this->data)){
225 225
         //as when using $this->setData() may be the data already escaped
226 226
         $escape = false;
227 227
         $data = $this->data;
228
-      }
229
-      $query = $this->queryBuilder->insert($data, $escape)->getQuery();
230
-      $result = $this->query($query);
231
-      if ($result){
228
+        }
229
+        $query = $this->queryBuilder->insert($data, $escape)->getQuery();
230
+        $result = $this->query($query);
231
+        if ($result){
232 232
         $this->insertId = $this->pdo->lastInsertId();
233
-		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
233
+            //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
234 234
         return ! ($this->insertId) ? true : $this->insertId;
235
-      }
236
-      return false;
235
+        }
236
+        return false;
237 237
     }
238 238
 
239 239
     /**
@@ -243,13 +243,13 @@  discard block
 block discarded – undo
243 243
      * @return mixed          the update status
244 244
      */
245 245
     public function update($data = array(), $escape = true){
246
-      if (empty($data) && ! empty($this->data)){
246
+        if (empty($data) && ! empty($this->data)){
247 247
         //as when using $this->setData() may be the data already escaped
248 248
         $escape = false;
249 249
         $data = $this->data;
250
-      }
251
-      $query = $this->queryBuilder->update($data, $escape)->getQuery();
252
-      return $this->query($query);
250
+        }
251
+        $query = $this->queryBuilder->update($data, $escape)->getQuery();
252
+        return $this->query($query);
253 253
     }
254 254
 
255 255
     /**
@@ -257,8 +257,8 @@  discard block
 block discarded – undo
257 257
      * @return mixed the delete status
258 258
      */
259 259
     public function delete(){
260
-		  $query = $this->queryBuilder->delete()->getQuery();
261
-    	return $this->query($query);
260
+            $query = $this->queryBuilder->delete()->getQuery();
261
+        return $this->query($query);
262 262
     }
263 263
 
264 264
     /**
@@ -267,17 +267,17 @@  discard block
 block discarded – undo
267 267
      * @return object        the current Database instance
268 268
      */
269 269
     public function setCache($ttl = 0){
270
-      $this->cacheTtl = $ttl;
271
-      $this->temporaryCacheTtl = $ttl;
272
-      return $this;
270
+        $this->cacheTtl = $ttl;
271
+        $this->temporaryCacheTtl = $ttl;
272
+        return $this;
273 273
     }
274 274
 	
275
-	/**
276
-	 * Enabled cache temporary for the current query not globally	
277
-	 * @param  integer $ttl the cache time to live in second
278
-	 * @return object        the current Database instance
279
-	 */
280
-  	public function cached($ttl = 0){
275
+    /**
276
+     * Enabled cache temporary for the current query not globally	
277
+     * @param  integer $ttl the cache time to live in second
278
+     * @return object        the current Database instance
279
+     */
280
+        public function cached($ttl = 0){
281 281
         $this->temporaryCacheTtl = $ttl;
282 282
         return $this;
283 283
     }
@@ -290,11 +290,11 @@  discard block
 block discarded – undo
290 290
      * need escaped
291 291
      */
292 292
     public function escape($data, $escaped = true){
293
-      $data = trim($data);
294
-      if($escaped){
293
+        $data = trim($data);
294
+        if($escaped){
295 295
         return $this->pdo->quote($data);
296
-      }
297
-      return $data; 
296
+        }
297
+        return $data; 
298 298
     }
299 299
 
300 300
     /**
@@ -302,7 +302,7 @@  discard block
 block discarded – undo
302 302
      * @return int
303 303
      */
304 304
     public function queryCount(){
305
-      return $this->queryCount;
305
+        return $this->queryCount;
306 306
     }
307 307
 
308 308
     /**
@@ -310,7 +310,7 @@  discard block
 block discarded – undo
310 310
      * @return string
311 311
      */
312 312
     public function getQuery(){
313
-      return $this->query;
313
+        return $this->query;
314 314
     }
315 315
 
316 316
     /**
@@ -318,7 +318,7 @@  discard block
 block discarded – undo
318 318
      * @return string
319 319
      */
320 320
     public function getDatabaseName(){
321
-      return $this->databaseName;
321
+        return $this->databaseName;
322 322
     }
323 323
 
324 324
     /**
@@ -326,17 +326,17 @@  discard block
 block discarded – undo
326 326
      * @return object
327 327
      */
328 328
     public function getPdo(){
329
-      return $this->pdo;
329
+        return $this->pdo;
330 330
     }
331 331
 
332 332
     /**
333 333
      * Set the PDO instance
334 334
      * @param object $pdo the pdo object
335
-	 * @return object Database
335
+     * @return object Database
336 336
      */
337 337
     public function setPdo(PDO $pdo){
338
-      $this->pdo = $pdo;
339
-      return $this;
338
+        $this->pdo = $pdo;
339
+        return $this;
340 340
     }
341 341
 
342 342
 
@@ -345,44 +345,44 @@  discard block
 block discarded – undo
345 345
      * @return Log
346 346
      */
347 347
     public function getLogger(){
348
-      return $this->logger;
348
+        return $this->logger;
349 349
     }
350 350
 
351 351
     /**
352 352
      * Set the log instance
353 353
      * @param Log $logger the log object
354
-	 * @return object Database
354
+     * @return object Database
355 355
      */
356 356
     public function setLogger($logger){
357
-      $this->logger = $logger;
358
-      return $this;
357
+        $this->logger = $logger;
358
+        return $this;
359 359
     }
360 360
 
361
-     /**
362
-     * Return the cache instance
363
-     * @return CacheInterface
364
-     */
361
+        /**
362
+         * Return the cache instance
363
+         * @return CacheInterface
364
+         */
365 365
     public function getCacheInstance(){
366
-      return $this->cacheInstance;
366
+        return $this->cacheInstance;
367 367
     }
368 368
 
369 369
     /**
370 370
      * Set the cache instance
371 371
      * @param CacheInterface $cache the cache object
372
-	 * @return object Database
372
+     * @return object Database
373 373
      */
374 374
     public function setCacheInstance($cache){
375
-      $this->cacheInstance = $cache;
376
-      return $this;
375
+        $this->cacheInstance = $cache;
376
+        return $this;
377 377
     }
378 378
 	
379 379
 	
380
-	   /**
381
-     * Return the DatabaseQueryBuilder instance
382
-     * @return object DatabaseQueryBuilder
383
-     */
380
+        /**
381
+         * Return the DatabaseQueryBuilder instance
382
+         * @return object DatabaseQueryBuilder
383
+         */
384 384
     public function getQueryBuilder(){
385
-      return $this->queryBuilder;
385
+        return $this->queryBuilder;
386 386
     }
387 387
 
388 388
     /**
@@ -390,8 +390,8 @@  discard block
 block discarded – undo
390 390
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
391 391
      */
392 392
     public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
393
-      $this->queryBuilder = $queryBuilder;
394
-      return $this;
393
+        $this->queryBuilder = $queryBuilder;
394
+        return $this;
395 395
     }
396 396
     
397 397
     /**
@@ -399,7 +399,7 @@  discard block
 block discarded – undo
399 399
      * @return object DatabaseQueryRunner
400 400
      */
401 401
     public function getQueryRunner(){
402
-      return $this->queryRunner;
402
+        return $this->queryRunner;
403 403
     }
404 404
 
405 405
     /**
@@ -407,8 +407,8 @@  discard block
 block discarded – undo
407 407
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
408 408
      */
409 409
     public function setQueryRunner(DatabaseQueryRunner $queryRunner){
410
-      $this->queryRunner = $queryRunner;
411
-      return $this;
410
+        $this->queryRunner = $queryRunner;
411
+        return $this;
412 412
     }
413 413
 
414 414
     /**
@@ -416,7 +416,7 @@  discard block
 block discarded – undo
416 416
      * @return array
417 417
      */
418 418
     public function getData(){
419
-      return $this->data;
419
+        return $this->data;
420 420
     }
421 421
 
422 422
     /**
@@ -427,62 +427,62 @@  discard block
 block discarded – undo
427 427
      * @return object        the current Database instance
428 428
      */
429 429
     public function setData($key, $value = null, $escape = true){
430
-  	  if (is_array($key)){
431
-    		foreach($key as $k => $v){
432
-    			$this->setData($k, $v, $escape);
433
-    		}	
434
-  	  } else {
430
+        if (is_array($key)){
431
+            foreach($key as $k => $v){
432
+                $this->setData($k, $v, $escape);
433
+            }	
434
+        } else {
435 435
         $this->data[$key] = $this->escape($value, $escape);
436
-  	  }
437
-      return $this;
436
+        }
437
+        return $this;
438 438
     }
439 439
 
440
-     /**
441
-     * Execute an SQL query
442
-     * @param  string  $query the query SQL string
443
-     * @param  boolean $returnAsList  indicate whether to return all record or just one row 
444
-     * @param  boolean $returnAsArray return the result as array or not
445
-     * @return mixed         the query result
446
-     */
440
+        /**
441
+         * Execute an SQL query
442
+         * @param  string  $query the query SQL string
443
+         * @param  boolean $returnAsList  indicate whether to return all record or just one row 
444
+         * @param  boolean $returnAsArray return the result as array or not
445
+         * @return mixed         the query result
446
+         */
447 447
     public function query($query, $returnAsList = true, $returnAsArray = false){
448
-      $this->reset();
449
-      $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
450
-      //If is the SELECT query
451
-      $isSqlSELECTQuery = stristr($this->query, 'SELECT');
448
+        $this->reset();
449
+        $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
450
+        //If is the SELECT query
451
+        $isSqlSELECTQuery = stristr($this->query, 'SELECT');
452 452
 
453
-      //cache expire time
454
-      $cacheExpire = $this->temporaryCacheTtl;
453
+        //cache expire time
454
+        $cacheExpire = $this->temporaryCacheTtl;
455 455
       
456
-      //return to the initial cache time
457
-      $this->temporaryCacheTtl = $this->cacheTtl;
456
+        //return to the initial cache time
457
+        $this->temporaryCacheTtl = $this->cacheTtl;
458 458
       
459
-      //config for cache
460
-      $cacheEnable = get_config('cache_enable');
459
+        //config for cache
460
+        $cacheEnable = get_config('cache_enable');
461 461
       
462
-      //the database cache content
463
-      $cacheContent = null;
462
+        //the database cache content
463
+        $cacheContent = null;
464 464
 
465
-      //if can use cache feature for this query
466
-      $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
465
+        //if can use cache feature for this query
466
+        $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
467 467
     
468
-      if ($dbCacheStatus && $isSqlSELECTQuery){
469
-          $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
470
-          $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
471
-      }
468
+        if ($dbCacheStatus && $isSqlSELECTQuery){
469
+            $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
470
+            $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
471
+        }
472 472
       
473
-      if (!$cacheContent){
474
-  	   	//count the number of query execution to server
473
+        if (!$cacheContent){
474
+                //count the number of query execution to server
475 475
         $this->queryCount++;
476 476
         
477 477
         $queryResult = $this->queryRunner->setQuery($query)
478
-                                          ->setReturnType($returnAsList)
479
-                                          ->setReturnAsArray($returnAsArray)
480
-                                          ->execute();
478
+                                            ->setReturnType($returnAsList)
479
+                                            ->setReturnAsArray($returnAsArray)
480
+                                            ->execute();
481 481
 
482 482
         if (!is_object($queryResult)){
483
-          $this->result = false;
484
-          $this->numRows = 0;
485
-          return $this->result;
483
+            $this->result = false;
484
+            $this->numRows = 0;
485
+            return $this->result;
486 486
         }
487 487
         $this->result  = $queryResult->getResult();
488 488
         $this->numRows = $queryResult->getNumRows();
@@ -490,72 +490,72 @@  discard block
 block discarded – undo
490 490
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
491 491
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
492 492
         }
493
-      } else if ($isSqlSELECTQuery){
494
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
495
-          $this->result = $cacheContent;
496
-          $this->numRows = count($this->result);
497
-      }
498
-      return $this->result;
499
-    }
500
-
501
-   /**
502
-    * Setting the database configuration using the configuration file and additional configuration from param
503
-    * @param array $overwriteConfig the additional configuration to overwrite with the existing one
504
-    * @param boolean $useConfigFile whether to use database configuration file
505
-    * @param boolean $autoConnect whether to connect to database after set the configuration
506
-	  * @return object Database
507
-    */
493
+        } else if ($isSqlSELECTQuery){
494
+            $this->logger->info('The result for query [' .$this->query. '] already cached use it');
495
+            $this->result = $cacheContent;
496
+            $this->numRows = count($this->result);
497
+        }
498
+        return $this->result;
499
+    }
500
+
501
+    /**
502
+     * Setting the database configuration using the configuration file and additional configuration from param
503
+     * @param array $overwriteConfig the additional configuration to overwrite with the existing one
504
+     * @param boolean $useConfigFile whether to use database configuration file
505
+     * @param boolean $autoConnect whether to connect to database after set the configuration
506
+     * @return object Database
507
+     */
508 508
     public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
509
-      $db = array();
510
-      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
511
-          //here don't use require_once because somewhere user can create database instance directly
512
-          require CONFIG_PATH . 'database.php';
513
-      }
509
+        $db = array();
510
+        if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
511
+            //here don't use require_once because somewhere user can create database instance directly
512
+            require CONFIG_PATH . 'database.php';
513
+        }
514 514
       
515
-      //merge with the parameter  
516
-      $db = array_merge($db, $overwriteConfig);
515
+        //merge with the parameter  
516
+        $db = array_merge($db, $overwriteConfig);
517 517
       
518
-      //get the default configuration
519
-      $config = $this->getDatabaseDefaultConfiguration();
518
+        //get the default configuration
519
+        $config = $this->getDatabaseDefaultConfiguration();
520 520
 		  
521
-    	$config = array_merge($config, $db);
522
-    	//determine the port using the hostname like localhost:3307
523
-      //hostname will be "localhost", and port "3307"
524
-      $p = explode(':', $config['hostname']);
525
-  	  if (count($p) >= 2){
526
-  		  $config['hostname'] = $p[0];
527
-  		  $config['port'] = $p[1];
528
-  		}
521
+        $config = array_merge($config, $db);
522
+        //determine the port using the hostname like localhost:3307
523
+        //hostname will be "localhost", and port "3307"
524
+        $p = explode(':', $config['hostname']);
525
+        if (count($p) >= 2){
526
+            $config['hostname'] = $p[0];
527
+            $config['port'] = $p[1];
528
+            }
529 529
 		
530
-		 $this->databaseName = $config['database'];
531
-		 $this->config = $config;
532
-		 $this->logger->info(
533
-								'The database configuration are listed below: ' 
534
-								. stringfy_vars(array_merge(
535
-															$this->config, 
536
-															array('password' => string_hidden($this->config['password']))
537
-												))
538
-							);
539
-  	  if($autoConnect){
540
-    		 //Now connect to the database
541
-    		 $this->connect();
542
-  		}
543
-		 return $this;
544
-    }
545
-
546
-    /**
547
-   * Return the database configuration
548
-   * @return array
549
-   */
530
+            $this->databaseName = $config['database'];
531
+            $this->config = $config;
532
+            $this->logger->info(
533
+                                'The database configuration are listed below: ' 
534
+                                . stringfy_vars(array_merge(
535
+                                                            $this->config, 
536
+                                                            array('password' => string_hidden($this->config['password']))
537
+                                                ))
538
+                            );
539
+        if($autoConnect){
540
+                //Now connect to the database
541
+                $this->connect();
542
+            }
543
+            return $this;
544
+    }
545
+
546
+    /**
547
+     * Return the database configuration
548
+     * @return array
549
+     */
550 550
     public  function getDatabaseConfiguration(){
551
-      return $this->config;
551
+        return $this->config;
552 552
     }
553 553
 
554 554
     /**
555 555
      * Close the connexion
556 556
      */
557 557
     public function close(){
558
-      $this->pdo = null;
558
+        $this->pdo = null;
559 559
     }
560 560
 
561 561
     /**
@@ -563,16 +563,16 @@  discard block
 block discarded – undo
563 563
      * @return array
564 564
      */
565 565
     protected function getDatabaseDefaultConfiguration(){
566
-      return array(
567
-              'driver' => '',
568
-              'username' => '',
569
-              'password' => '',
570
-              'database' => '',
571
-              'hostname' => 'localhost',
572
-              'charset' => 'utf8',
573
-              'collation' => 'utf8_general_ci',
574
-              'prefix' => '',
575
-              'port' => ''
566
+        return array(
567
+                'driver' => '',
568
+                'username' => '',
569
+                'password' => '',
570
+                'database' => '',
571
+                'hostname' => 'localhost',
572
+                'charset' => 'utf8',
573
+                'collation' => 'utf8_general_ci',
574
+                'prefix' => '',
575
+                'port' => ''
576 576
             );
577 577
     }
578 578
 
@@ -581,18 +581,18 @@  discard block
 block discarded – undo
581 581
      * @return void
582 582
      */
583 583
     protected function updateQueryBuilderAndRunnerProperties(){
584
-       //update queryBuilder with some properties needed
585
-     if (is_object($this->queryBuilder)){
584
+        //update queryBuilder with some properties needed
585
+        if (is_object($this->queryBuilder)){
586 586
         $this->queryBuilder->setDriver($this->config['driver'])
587
-                           ->setPrefix($this->config['prefix'])
588
-                           ->setPdo($this->pdo);
589
-     }
587
+                            ->setPrefix($this->config['prefix'])
588
+                            ->setPdo($this->pdo);
589
+        }
590 590
 
591
-      //update queryRunner with some properties needed
592
-     if (is_object($this->queryRunner)){
591
+        //update queryRunner with some properties needed
592
+        if (is_object($this->queryRunner)){
593 593
         $this->queryRunner->setDriver($this->config['driver'])
594
-                          ->setPdo($this->pdo);
595
-     }
594
+                            ->setPdo($this->pdo);
595
+        }
596 596
     }
597 597
 	
598 598
 
@@ -601,21 +601,21 @@  discard block
 block discarded – undo
601 601
      * @return string|null the DSN string or null if can not find it
602 602
      */
603 603
     protected function getDsnValueFromConfig(){
604
-      $dsn = null;
605
-      $config = $this->getDatabaseConfiguration();
606
-      if (! empty($config)){
604
+        $dsn = null;
605
+        $config = $this->getDatabaseConfiguration();
606
+        if (! empty($config)){
607 607
         $driver = $config['driver'];
608 608
         $driverDsnMap = array(
609
-                              'mysql'  => $this->getDsnValueForDriver('mysql'),
610
-                              'pgsql'  => $this->getDsnValueForDriver('pgsql'),
611
-                              'sqlite' => $this->getDsnValueForDriver('sqlite'),
612
-                              'oracle' => $this->getDsnValueForDriver('oracle')
613
-                              );
609
+                                'mysql'  => $this->getDsnValueForDriver('mysql'),
610
+                                'pgsql'  => $this->getDsnValueForDriver('pgsql'),
611
+                                'sqlite' => $this->getDsnValueForDriver('sqlite'),
612
+                                'oracle' => $this->getDsnValueForDriver('oracle')
613
+                                );
614 614
         if (isset($driverDsnMap[$driver])){
615
-          $dsn = $driverDsnMap[$driver];
615
+            $dsn = $driverDsnMap[$driver];
616 616
         }
617
-      }    
618
-      return $dsn;
617
+        }    
618
+        return $dsn;
619 619
     }
620 620
 
621 621
     /**
@@ -624,32 +624,32 @@  discard block
 block discarded – undo
624 624
      * @return string|null         the dsn name
625 625
      */
626 626
     protected function getDsnValueForDriver($driver){
627
-      $dsn = '';
628
-      $config = $this->getDatabaseConfiguration();
629
-      if (empty($config)){
627
+        $dsn = '';
628
+        $config = $this->getDatabaseConfiguration();
629
+        if (empty($config)){
630 630
         return null;
631
-      }
632
-      switch ($driver) {
631
+        }
632
+        switch ($driver) {
633 633
         case 'mysql':
634 634
         case 'pgsql':
635 635
           $port = '';
636
-          if (! empty($config['port'])) {
636
+            if (! empty($config['port'])) {
637 637
             $port = 'port=' . $config['port'] . ';';
638
-          }
639
-          $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
640
-          break;
638
+            }
639
+            $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
640
+            break;
641 641
         case 'sqlite':
642 642
           $dsn = 'sqlite:' . $config['database'];
643
-          break;
644
-          case 'oracle':
643
+            break;
644
+            case 'oracle':
645 645
           $port = '';
646
-          if (! empty($config['port'])) {
646
+            if (! empty($config['port'])) {
647 647
             $port = ':' . $config['port'];
648
-          }
649
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
650
-          break;
651
-      }
652
-      return $dsn;
648
+            }
649
+            $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
650
+            break;
651
+        }
652
+        return $dsn;
653 653
     }
654 654
 
655 655
     /**
@@ -661,11 +661,11 @@  discard block
 block discarded – undo
661 661
     protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
662 662
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
663 663
         if (! is_object($this->cacheInstance)){
664
-    			//can not call method with reference in argument
665
-    			//like $this->setCacheInstance(& get_instance()->cache);
666
-    			//use temporary variable
667
-    			$instance = & get_instance()->cache;
668
-    			$this->cacheInstance = $instance;
664
+                //can not call method with reference in argument
665
+                //like $this->setCacheInstance(& get_instance()->cache);
666
+                //use temporary variable
667
+                $instance = & get_instance()->cache;
668
+                $this->cacheInstance = $instance;
669 669
         }
670 670
         return $this->cacheInstance->get($cacheKey);
671 671
     }
@@ -677,80 +677,80 @@  discard block
 block discarded – undo
677 677
      * @param mixed $result the query result to save
678 678
      * @param int $expire the cache TTL
679 679
      */
680
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
680
+        protected function setCacheContentForQuery($query, $key, $result, $expire){
681 681
         $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
682 682
         if (! is_object($this->cacheInstance)){
683
-  				//can not call method with reference in argument
684
-  				//like $this->setCacheInstance(& get_instance()->cache);
685
-  				//use temporary variable
686
-  				$instance = & get_instance()->cache;
687
-  				$this->cacheInstance = $instance;
688
-  			}
683
+                    //can not call method with reference in argument
684
+                    //like $this->setCacheInstance(& get_instance()->cache);
685
+                    //use temporary variable
686
+                    $instance = & get_instance()->cache;
687
+                    $this->cacheInstance = $instance;
688
+                }
689 689
         $this->cacheInstance->set($key, $result, $expire);
690
-     }
690
+        }
691 691
 
692 692
     
693
-	 /**
694
-     * Return the cache key for the given query
695
-     * @see Database::query
696
-     * 
697
-     *  @return string
698
-     */
693
+        /**
694
+         * Return the cache key for the given query
695
+         * @see Database::query
696
+         * 
697
+         *  @return string
698
+         */
699 699
     protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
700
-      return md5($query . $returnAsList . $returnAsArray);
701
-    }
702
-
703
-     /**
704
-     * Set the dependencies instance using argument or create new instance if is null
705
-     * @param string $name this class property name.
706
-     * @param object $instance the instance. If is not null will use it
707
-     * otherwise will create new instance.
708
-     * @param string $loadClassName the name of class to load using class_loader function.
709
-     * @param string $loadClassPath the path of class to load using class_loader function.
710
-     *
711
-     * @return object this current instance
712
-     */
700
+        return md5($query . $returnAsList . $returnAsArray);
701
+    }
702
+
703
+        /**
704
+         * Set the dependencies instance using argument or create new instance if is null
705
+         * @param string $name this class property name.
706
+         * @param object $instance the instance. If is not null will use it
707
+         * otherwise will create new instance.
708
+         * @param string $loadClassName the name of class to load using class_loader function.
709
+         * @param string $loadClassPath the path of class to load using class_loader function.
710
+         *
711
+         * @return object this current instance
712
+         */
713 713
     protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
714
-      if ($instance !== null){
714
+        if ($instance !== null){
715 715
         $this->{$name} = $instance;
716 716
         return $this;
717
-      }
718
-      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
719
-      return $this;
717
+        }
718
+        $this->{$name} =& class_loader($loadClassName, $loadClassePath);
719
+        return $this;
720 720
     }
721 721
     
722
-	   /**
723
-     * Set the Log instance using argument or create new instance
724
-     * @param object $logger the Log instance if not null
725
-     *
726
-     * @return object this current instance
727
-     */
722
+        /**
723
+         * Set the Log instance using argument or create new instance
724
+         * @param object $logger the Log instance if not null
725
+         *
726
+         * @return object this current instance
727
+         */
728 728
     protected function setLoggerFromParamOrCreate(Log $logger = null){
729
-      $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
730
-      if ($logger === null){
729
+        $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
730
+        if ($logger === null){
731 731
         $this->logger->setLogger('Library::Database');
732
-      }
733
-      return $this;
732
+        }
733
+        return $this;
734 734
     }
735 735
 	
736 736
     /**
737 737
      * Reset the database class attributs to the initail values before each query.
738 738
      */
739 739
     private function reset(){
740
-	   //query builder reset
741
-      $this->queryBuilder->reset();
742
-      $this->numRows  = 0;
743
-      $this->insertId = null;
744
-      $this->query    = null;
745
-      $this->result   = array();
746
-      $this->data     = array();
740
+        //query builder reset
741
+        $this->queryBuilder->reset();
742
+        $this->numRows  = 0;
743
+        $this->insertId = null;
744
+        $this->query    = null;
745
+        $this->result   = array();
746
+        $this->data     = array();
747 747
     }
748 748
 
749 749
     /**
750 750
      * The class destructor
751 751
      */
752 752
     public function __destruct(){
753
-      $this->pdo = null;
753
+        $this->pdo = null;
754 754
     }
755 755
 
756 756
 }
Please login to merge, or discard this patch.
Spacing   +93 added lines, -93 removed lines patch added patch discarded remove patch
@@ -23,98 +23,98 @@  discard block
 block discarded – undo
23 23
    * along with this program; if not, write to the Free Software
24 24
    * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25 25
   */
26
-  class Database{
26
+  class Database {
27 27
 	
28 28
   	/**
29 29
   	 * The PDO instance
30 30
   	 * @var object
31 31
   	*/
32
-    private $pdo                 = null;
32
+    private $pdo = null;
33 33
     
34 34
   	/**
35 35
   	 * The database name used for the application
36 36
   	 * @var string
37 37
   	*/
38
-	  private $databaseName        = null;
38
+	  private $databaseName = null;
39 39
 	
40 40
   	/**
41 41
   	 * The number of rows returned by the last query
42 42
   	 * @var int
43 43
   	*/
44
-    private $numRows             = 0;
44
+    private $numRows = 0;
45 45
 	
46 46
   	/**
47 47
   	 * The last insert id for the primary key column that have auto increment or sequence
48 48
   	 * @var mixed
49 49
   	*/
50
-    private $insertId            = null;
50
+    private $insertId = null;
51 51
 	
52 52
   	/**
53 53
   	 * The full SQL query statment after build for each command
54 54
   	 * @var string
55 55
   	*/
56
-    private $query               = null;
56
+    private $query = null;
57 57
 	
58 58
   	/**
59 59
   	 * The result returned for the last query
60 60
   	 * @var mixed
61 61
   	*/
62
-    private $result              = array();
62
+    private $result = array();
63 63
 	
64 64
   	/**
65 65
   	 * The cache default time to live in second. 0 means no need to use the cache feature
66 66
   	 * @var int
67 67
   	*/
68
-  	private $cacheTtl             = 0;
68
+  	private $cacheTtl = 0;
69 69
 	
70 70
   	/**
71 71
   	 * The cache current time to live. 0 means no need to use the cache feature
72 72
   	 * @var int
73 73
   	*/
74
-    private $temporaryCacheTtl   = 0;
74
+    private $temporaryCacheTtl = 0;
75 75
 	
76 76
   	/**
77 77
   	 * The number of executed query for the current request
78 78
   	 * @var int
79 79
   	*/
80
-    private $queryCount          = 0;
80
+    private $queryCount = 0;
81 81
 	
82 82
   	/**
83 83
   	 * The default data to be used in the statments query INSERT, UPDATE
84 84
   	 * @var array
85 85
   	*/
86
-    private $data                = array();
86
+    private $data = array();
87 87
 	
88 88
   	/**
89 89
   	 * The database configuration
90 90
   	 * @var array
91 91
   	*/
92
-    private $config              = array();
92
+    private $config = array();
93 93
 	
94 94
   	/**
95 95
   	 * The logger instance
96 96
   	 * @var object
97 97
   	 */
98
-    private $logger              = null;
98
+    private $logger = null;
99 99
 
100 100
     /**
101 101
     * The cache instance
102 102
     * @var object
103 103
     */
104
-    private $cacheInstance       = null;
104
+    private $cacheInstance = null;
105 105
 
106 106
     
107 107
   	/**
108 108
     * The DatabaseQueryBuilder instance
109 109
     * @var object
110 110
     */
111
-    private $queryBuilder        = null;
111
+    private $queryBuilder = null;
112 112
     
113 113
     /**
114 114
     * The DatabaseQueryRunner instance
115 115
     * @var object
116 116
     */
117
-    private $queryRunner         = null;
117
+    private $queryRunner = null;
118 118
 
119 119
 
120 120
     /**
@@ -122,7 +122,7 @@  discard block
 block discarded – undo
122 122
      * @param array $overwriteConfig the config to overwrite with the config set in database.php
123 123
      * @param boolean $autoConnect whether to connect to database automatically
124 124
      */
125
-    public function __construct($overwriteConfig = array(), $autoConnect = true){
125
+    public function __construct($overwriteConfig = array(), $autoConnect = true) {
126 126
         //Set Log instance to use
127 127
         $this->setLoggerFromParamOrCreate(null);
128 128
 		
@@ -143,10 +143,10 @@  discard block
 block discarded – undo
143 143
      * This is used to connect to database
144 144
      * @return bool 
145 145
      */
146
-    public function connect(){
146
+    public function connect() {
147 147
       $config = $this->getDatabaseConfiguration();
148
-      if (! empty($config)){
149
-        try{
148
+      if (!empty($config)) {
149
+        try {
150 150
             $this->pdo = new PDO($this->getDsnValueFromConfig(), $config['username'], $config['password']);
151 151
             $this->pdo->exec("SET NAMES '" . $config['charset'] . "' COLLATE '" . $config['collation'] . "'");
152 152
             $this->pdo->exec("SET CHARACTER SET '" . $config['charset'] . "'");
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 
158 158
             return is_object($this->pdo);
159 159
           }
160
-          catch (PDOException $e){
160
+          catch (PDOException $e) {
161 161
             $this->logger->fatal($e->getMessage());
162 162
             show_error('Cannot connect to Database.');
163 163
             return false;
@@ -171,7 +171,7 @@  discard block
 block discarded – undo
171 171
      * Return the number of rows returned by the current query
172 172
      * @return int
173 173
      */
174
-    public function numRows(){
174
+    public function numRows() {
175 175
       return $this->numRows;
176 176
     }
177 177
 
@@ -179,7 +179,7 @@  discard block
 block discarded – undo
179 179
      * Return the last insert id value
180 180
      * @return mixed
181 181
      */
182
-    public function insertId(){
182
+    public function insertId() {
183 183
       return $this->insertId;
184 184
     }
185 185
 
@@ -190,10 +190,10 @@  discard block
 block discarded – undo
190 190
      * If is string will determine the result type "array" or "object"
191 191
      * @return mixed       the query SQL string or the record result
192 192
      */
193
-    public function get($returnSQLQueryOrResultType = false){
193
+    public function get($returnSQLQueryOrResultType = false) {
194 194
       $this->queryBuilder->limit(1);
195 195
       $query = $this->getAll(true);
196
-      if ($returnSQLQueryOrResultType === true){
196
+      if ($returnSQLQueryOrResultType === true) {
197 197
         return $query;
198 198
       } else {
199 199
         return $this->query($query, false, $returnSQLQueryOrResultType == 'array');
@@ -206,9 +206,9 @@  discard block
 block discarded – undo
206 206
      * If is string will determine the result type "array" or "object"
207 207
      * @return mixed       the query SQL string or the record result
208 208
      */
209
-    public function getAll($returnSQLQueryOrResultType = false){
209
+    public function getAll($returnSQLQueryOrResultType = false) {
210 210
 	   $query = $this->queryBuilder->getQuery();
211
-	   if ($returnSQLQueryOrResultType === true){
211
+	   if ($returnSQLQueryOrResultType === true) {
212 212
       	return $query;
213 213
       }
214 214
       return $this->query($query, true, $returnSQLQueryOrResultType == 'array');
@@ -220,18 +220,18 @@  discard block
 block discarded – undo
220 220
      * @param  boolean $escape  whether to escape or not the values
221 221
      * @return mixed          the insert id of the new record or null
222 222
      */
223
-    public function insert($data = array(), $escape = true){
224
-      if (empty($data) && ! empty($this->data)){
223
+    public function insert($data = array(), $escape = true) {
224
+      if (empty($data) && !empty($this->data)) {
225 225
         //as when using $this->setData() may be the data already escaped
226 226
         $escape = false;
227 227
         $data = $this->data;
228 228
       }
229 229
       $query = $this->queryBuilder->insert($data, $escape)->getQuery();
230 230
       $result = $this->query($query);
231
-      if ($result){
231
+      if ($result) {
232 232
         $this->insertId = $this->pdo->lastInsertId();
233 233
 		    //if the table doesn't have the auto increment field or sequence, the value of 0 will be returned 
234
-        return ! ($this->insertId) ? true : $this->insertId;
234
+        return !($this->insertId) ? true : $this->insertId;
235 235
       }
236 236
       return false;
237 237
     }
@@ -242,8 +242,8 @@  discard block
 block discarded – undo
242 242
      * @param  boolean $escape  whether to escape or not the values
243 243
      * @return mixed          the update status
244 244
      */
245
-    public function update($data = array(), $escape = true){
246
-      if (empty($data) && ! empty($this->data)){
245
+    public function update($data = array(), $escape = true) {
246
+      if (empty($data) && !empty($this->data)) {
247 247
         //as when using $this->setData() may be the data already escaped
248 248
         $escape = false;
249 249
         $data = $this->data;
@@ -256,7 +256,7 @@  discard block
 block discarded – undo
256 256
      * Delete the record in database
257 257
      * @return mixed the delete status
258 258
      */
259
-    public function delete(){
259
+    public function delete() {
260 260
 		  $query = $this->queryBuilder->delete()->getQuery();
261 261
     	return $this->query($query);
262 262
     }
@@ -266,7 +266,7 @@  discard block
 block discarded – undo
266 266
      * @param integer $ttl the cache time to live in second
267 267
      * @return object        the current Database instance
268 268
      */
269
-    public function setCache($ttl = 0){
269
+    public function setCache($ttl = 0) {
270 270
       $this->cacheTtl = $ttl;
271 271
       $this->temporaryCacheTtl = $ttl;
272 272
       return $this;
@@ -277,7 +277,7 @@  discard block
 block discarded – undo
277 277
 	 * @param  integer $ttl the cache time to live in second
278 278
 	 * @return object        the current Database instance
279 279
 	 */
280
-  	public function cached($ttl = 0){
280
+  	public function cached($ttl = 0) {
281 281
         $this->temporaryCacheTtl = $ttl;
282 282
         return $this;
283 283
     }
@@ -289,9 +289,9 @@  discard block
 block discarded – undo
289 289
      * @return mixed       the data after escaped or the same data if no
290 290
      * need escaped
291 291
      */
292
-    public function escape($data, $escaped = true){
292
+    public function escape($data, $escaped = true) {
293 293
       $data = trim($data);
294
-      if($escaped){
294
+      if ($escaped) {
295 295
         return $this->pdo->quote($data);
296 296
       }
297 297
       return $data; 
@@ -301,7 +301,7 @@  discard block
 block discarded – undo
301 301
      * Return the number query executed count for the current request
302 302
      * @return int
303 303
      */
304
-    public function queryCount(){
304
+    public function queryCount() {
305 305
       return $this->queryCount;
306 306
     }
307 307
 
@@ -309,7 +309,7 @@  discard block
 block discarded – undo
309 309
      * Return the current query SQL string
310 310
      * @return string
311 311
      */
312
-    public function getQuery(){
312
+    public function getQuery() {
313 313
       return $this->query;
314 314
     }
315 315
 
@@ -317,7 +317,7 @@  discard block
 block discarded – undo
317 317
      * Return the application database name
318 318
      * @return string
319 319
      */
320
-    public function getDatabaseName(){
320
+    public function getDatabaseName() {
321 321
       return $this->databaseName;
322 322
     }
323 323
 
@@ -325,7 +325,7 @@  discard block
 block discarded – undo
325 325
      * Return the PDO instance
326 326
      * @return object
327 327
      */
328
-    public function getPdo(){
328
+    public function getPdo() {
329 329
       return $this->pdo;
330 330
     }
331 331
 
@@ -334,7 +334,7 @@  discard block
 block discarded – undo
334 334
      * @param object $pdo the pdo object
335 335
 	 * @return object Database
336 336
      */
337
-    public function setPdo(PDO $pdo){
337
+    public function setPdo(PDO $pdo) {
338 338
       $this->pdo = $pdo;
339 339
       return $this;
340 340
     }
@@ -344,7 +344,7 @@  discard block
 block discarded – undo
344 344
      * Return the Log instance
345 345
      * @return Log
346 346
      */
347
-    public function getLogger(){
347
+    public function getLogger() {
348 348
       return $this->logger;
349 349
     }
350 350
 
@@ -353,7 +353,7 @@  discard block
 block discarded – undo
353 353
      * @param Log $logger the log object
354 354
 	 * @return object Database
355 355
      */
356
-    public function setLogger($logger){
356
+    public function setLogger($logger) {
357 357
       $this->logger = $logger;
358 358
       return $this;
359 359
     }
@@ -362,7 +362,7 @@  discard block
 block discarded – undo
362 362
      * Return the cache instance
363 363
      * @return CacheInterface
364 364
      */
365
-    public function getCacheInstance(){
365
+    public function getCacheInstance() {
366 366
       return $this->cacheInstance;
367 367
     }
368 368
 
@@ -371,7 +371,7 @@  discard block
 block discarded – undo
371 371
      * @param CacheInterface $cache the cache object
372 372
 	 * @return object Database
373 373
      */
374
-    public function setCacheInstance($cache){
374
+    public function setCacheInstance($cache) {
375 375
       $this->cacheInstance = $cache;
376 376
       return $this;
377 377
     }
@@ -381,7 +381,7 @@  discard block
 block discarded – undo
381 381
      * Return the DatabaseQueryBuilder instance
382 382
      * @return object DatabaseQueryBuilder
383 383
      */
384
-    public function getQueryBuilder(){
384
+    public function getQueryBuilder() {
385 385
       return $this->queryBuilder;
386 386
     }
387 387
 
@@ -389,7 +389,7 @@  discard block
 block discarded – undo
389 389
      * Set the DatabaseQueryBuilder instance
390 390
      * @param object DatabaseQueryBuilder $queryBuilder the DatabaseQueryBuilder object
391 391
      */
392
-    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder){
392
+    public function setQueryBuilder(DatabaseQueryBuilder $queryBuilder) {
393 393
       $this->queryBuilder = $queryBuilder;
394 394
       return $this;
395 395
     }
@@ -398,7 +398,7 @@  discard block
 block discarded – undo
398 398
      * Return the DatabaseQueryRunner instance
399 399
      * @return object DatabaseQueryRunner
400 400
      */
401
-    public function getQueryRunner(){
401
+    public function getQueryRunner() {
402 402
       return $this->queryRunner;
403 403
     }
404 404
 
@@ -406,7 +406,7 @@  discard block
 block discarded – undo
406 406
      * Set the DatabaseQueryRunner instance
407 407
      * @param object DatabaseQueryRunner $queryRunner the DatabaseQueryRunner object
408 408
      */
409
-    public function setQueryRunner(DatabaseQueryRunner $queryRunner){
409
+    public function setQueryRunner(DatabaseQueryRunner $queryRunner) {
410 410
       $this->queryRunner = $queryRunner;
411 411
       return $this;
412 412
     }
@@ -415,7 +415,7 @@  discard block
 block discarded – undo
415 415
      * Return the data to be used for insert, update, etc.
416 416
      * @return array
417 417
      */
418
-    public function getData(){
418
+    public function getData() {
419 419
       return $this->data;
420 420
     }
421 421
 
@@ -426,9 +426,9 @@  discard block
 block discarded – undo
426 426
      * @param boolean $escape whether to escape or not the $value
427 427
      * @return object        the current Database instance
428 428
      */
429
-    public function setData($key, $value = null, $escape = true){
430
-  	  if (is_array($key)){
431
-    		foreach($key as $k => $v){
429
+    public function setData($key, $value = null, $escape = true) {
430
+  	  if (is_array($key)) {
431
+    		foreach ($key as $k => $v) {
432 432
     			$this->setData($k, $v, $escape);
433 433
     		}	
434 434
   	  } else {
@@ -444,7 +444,7 @@  discard block
 block discarded – undo
444 444
      * @param  boolean $returnAsArray return the result as array or not
445 445
      * @return mixed         the query result
446 446
      */
447
-    public function query($query, $returnAsList = true, $returnAsArray = false){
447
+    public function query($query, $returnAsList = true, $returnAsArray = false) {
448 448
       $this->reset();
449 449
       $this->query = preg_replace('/\s\s+|\t\t+/', ' ', trim($query));
450 450
       //If is the SELECT query
@@ -465,12 +465,12 @@  discard block
 block discarded – undo
465 465
       //if can use cache feature for this query
466 466
       $dbCacheStatus = $cacheEnable && $cacheExpire > 0;
467 467
     
468
-      if ($dbCacheStatus && $isSqlSELECTQuery){
468
+      if ($dbCacheStatus && $isSqlSELECTQuery) {
469 469
           $this->logger->info('The cache is enabled for this query, try to get result from cache'); 
470 470
           $cacheContent = $this->getCacheContentForQuery($query, $returnAsList, $returnAsArray);  
471 471
       }
472 472
       
473
-      if (!$cacheContent){
473
+      if (!$cacheContent) {
474 474
   	   	//count the number of query execution to server
475 475
         $this->queryCount++;
476 476
         
@@ -479,19 +479,19 @@  discard block
 block discarded – undo
479 479
                                           ->setReturnAsArray($returnAsArray)
480 480
                                           ->execute();
481 481
 
482
-        if (!is_object($queryResult)){
482
+        if (!is_object($queryResult)) {
483 483
           $this->result = false;
484 484
           $this->numRows = 0;
485 485
           return $this->result;
486 486
         }
487 487
         $this->result  = $queryResult->getResult();
488 488
         $this->numRows = $queryResult->getNumRows();
489
-        if ($isSqlSELECTQuery && $dbCacheStatus){
489
+        if ($isSqlSELECTQuery && $dbCacheStatus) {
490 490
             $key = $this->getCacheKeyForQuery($this->query, $returnAsList, $returnAsArray);
491 491
             $this->setCacheContentForQuery($this->query, $key, $this->result, $cacheExpire);
492 492
         }
493
-      } else if ($isSqlSELECTQuery){
494
-          $this->logger->info('The result for query [' .$this->query. '] already cached use it');
493
+      } else if ($isSqlSELECTQuery) {
494
+          $this->logger->info('The result for query [' . $this->query . '] already cached use it');
495 495
           $this->result = $cacheContent;
496 496
           $this->numRows = count($this->result);
497 497
       }
@@ -505,9 +505,9 @@  discard block
 block discarded – undo
505 505
     * @param boolean $autoConnect whether to connect to database after set the configuration
506 506
 	  * @return object Database
507 507
     */
508
-    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false){
508
+    public function setDatabaseConfiguration(array $overwriteConfig = array(), $useConfigFile = true, $autoConnect = false) {
509 509
       $db = array();
510
-      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')){
510
+      if ($useConfigFile && file_exists(CONFIG_PATH . 'database.php')) {
511 511
           //here don't use require_once because somewhere user can create database instance directly
512 512
           require CONFIG_PATH . 'database.php';
513 513
       }
@@ -522,7 +522,7 @@  discard block
 block discarded – undo
522 522
     	//determine the port using the hostname like localhost:3307
523 523
       //hostname will be "localhost", and port "3307"
524 524
       $p = explode(':', $config['hostname']);
525
-  	  if (count($p) >= 2){
525
+  	  if (count($p) >= 2) {
526 526
   		  $config['hostname'] = $p[0];
527 527
   		  $config['port'] = $p[1];
528 528
   		}
@@ -536,7 +536,7 @@  discard block
 block discarded – undo
536 536
 															array('password' => string_hidden($this->config['password']))
537 537
 												))
538 538
 							);
539
-  	  if($autoConnect){
539
+  	  if ($autoConnect) {
540 540
     		 //Now connect to the database
541 541
     		 $this->connect();
542 542
   		}
@@ -547,14 +547,14 @@  discard block
 block discarded – undo
547 547
    * Return the database configuration
548 548
    * @return array
549 549
    */
550
-    public  function getDatabaseConfiguration(){
550
+    public  function getDatabaseConfiguration() {
551 551
       return $this->config;
552 552
     }
553 553
 
554 554
     /**
555 555
      * Close the connexion
556 556
      */
557
-    public function close(){
557
+    public function close() {
558 558
       $this->pdo = null;
559 559
     }
560 560
 
@@ -562,7 +562,7 @@  discard block
 block discarded – undo
562 562
      * Return the database default configuration
563 563
      * @return array
564 564
      */
565
-    protected function getDatabaseDefaultConfiguration(){
565
+    protected function getDatabaseDefaultConfiguration() {
566 566
       return array(
567 567
               'driver' => '',
568 568
               'username' => '',
@@ -580,16 +580,16 @@  discard block
 block discarded – undo
580 580
      * Update the DatabaseQueryBuilder and DatabaseQueryRunner properties
581 581
      * @return void
582 582
      */
583
-    protected function updateQueryBuilderAndRunnerProperties(){
583
+    protected function updateQueryBuilderAndRunnerProperties() {
584 584
        //update queryBuilder with some properties needed
585
-     if (is_object($this->queryBuilder)){
585
+     if (is_object($this->queryBuilder)) {
586 586
         $this->queryBuilder->setDriver($this->config['driver'])
587 587
                            ->setPrefix($this->config['prefix'])
588 588
                            ->setPdo($this->pdo);
589 589
      }
590 590
 
591 591
       //update queryRunner with some properties needed
592
-     if (is_object($this->queryRunner)){
592
+     if (is_object($this->queryRunner)) {
593 593
         $this->queryRunner->setDriver($this->config['driver'])
594 594
                           ->setPdo($this->pdo);
595 595
      }
@@ -600,10 +600,10 @@  discard block
 block discarded – undo
600 600
      * This method is used to get the PDO DSN string using the configured driver
601 601
      * @return string|null the DSN string or null if can not find it
602 602
      */
603
-    protected function getDsnValueFromConfig(){
603
+    protected function getDsnValueFromConfig() {
604 604
       $dsn = null;
605 605
       $config = $this->getDatabaseConfiguration();
606
-      if (! empty($config)){
606
+      if (!empty($config)) {
607 607
         $driver = $config['driver'];
608 608
         $driverDsnMap = array(
609 609
                               'mysql'  => $this->getDsnValueForDriver('mysql'),
@@ -611,7 +611,7 @@  discard block
 block discarded – undo
611 611
                               'sqlite' => $this->getDsnValueForDriver('sqlite'),
612 612
                               'oracle' => $this->getDsnValueForDriver('oracle')
613 613
                               );
614
-        if (isset($driverDsnMap[$driver])){
614
+        if (isset($driverDsnMap[$driver])) {
615 615
           $dsn = $driverDsnMap[$driver];
616 616
         }
617 617
       }    
@@ -623,17 +623,17 @@  discard block
 block discarded – undo
623 623
      * @param  string $driver the driver name
624 624
      * @return string|null         the dsn name
625 625
      */
626
-    protected function getDsnValueForDriver($driver){
626
+    protected function getDsnValueForDriver($driver) {
627 627
       $dsn = '';
628 628
       $config = $this->getDatabaseConfiguration();
629
-      if (empty($config)){
629
+      if (empty($config)) {
630 630
         return null;
631 631
       }
632 632
       switch ($driver) {
633 633
         case 'mysql':
634 634
         case 'pgsql':
635 635
           $port = '';
636
-          if (! empty($config['port'])) {
636
+          if (!empty($config['port'])) {
637 637
             $port = 'port=' . $config['port'] . ';';
638 638
           }
639 639
           $dsn = $driver . ':host=' . $config['hostname'] . ';' . $port . 'dbname=' . $config['database'];
@@ -643,10 +643,10 @@  discard block
 block discarded – undo
643 643
           break;
644 644
           case 'oracle':
645 645
           $port = '';
646
-          if (! empty($config['port'])) {
646
+          if (!empty($config['port'])) {
647 647
             $port = ':' . $config['port'];
648 648
           }
649
-          $dsn =  'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
649
+          $dsn = 'oci:dbname=' . $config['hostname'] . $port . '/' . $config['database'];
650 650
           break;
651 651
       }
652 652
       return $dsn;
@@ -658,9 +658,9 @@  discard block
 block discarded – undo
658 658
      *      
659 659
      * @return mixed
660 660
      */
661
-    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray){
661
+    protected function getCacheContentForQuery($query, $returnAsList, $returnAsArray) {
662 662
         $cacheKey = $this->getCacheKeyForQuery($query, $returnAsList, $returnAsArray);
663
-        if (! is_object($this->cacheInstance)){
663
+        if (!is_object($this->cacheInstance)) {
664 664
     			//can not call method with reference in argument
665 665
     			//like $this->setCacheInstance(& get_instance()->cache);
666 666
     			//use temporary variable
@@ -677,9 +677,9 @@  discard block
 block discarded – undo
677 677
      * @param mixed $result the query result to save
678 678
      * @param int $expire the cache TTL
679 679
      */
680
-     protected function setCacheContentForQuery($query, $key, $result, $expire){
681
-        $this->logger->info('Save the result for query [' .$query. '] into cache for future use');
682
-        if (! is_object($this->cacheInstance)){
680
+     protected function setCacheContentForQuery($query, $key, $result, $expire) {
681
+        $this->logger->info('Save the result for query [' . $query . '] into cache for future use');
682
+        if (!is_object($this->cacheInstance)) {
683 683
   				//can not call method with reference in argument
684 684
   				//like $this->setCacheInstance(& get_instance()->cache);
685 685
   				//use temporary variable
@@ -696,7 +696,7 @@  discard block
 block discarded – undo
696 696
      * 
697 697
      *  @return string
698 698
      */
699
-    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray){
699
+    protected function getCacheKeyForQuery($query, $returnAsList, $returnAsArray) {
700 700
       return md5($query . $returnAsList . $returnAsArray);
701 701
     }
702 702
 
@@ -710,12 +710,12 @@  discard block
 block discarded – undo
710 710
      *
711 711
      * @return object this current instance
712 712
      */
713
-    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes'){
714
-      if ($instance !== null){
713
+    protected function setDependencyInstanceFromParamOrCreate($name, $instance = null, $loadClassName = null, $loadClassePath = 'classes') {
714
+      if ($instance !== null) {
715 715
         $this->{$name} = $instance;
716 716
         return $this;
717 717
       }
718
-      $this->{$name} =& class_loader($loadClassName, $loadClassePath);
718
+      $this->{$name} = & class_loader($loadClassName, $loadClassePath);
719 719
       return $this;
720 720
     }
721 721
     
@@ -725,9 +725,9 @@  discard block
 block discarded – undo
725 725
      *
726 726
      * @return object this current instance
727 727
      */
728
-    protected function setLoggerFromParamOrCreate(Log $logger = null){
728
+    protected function setLoggerFromParamOrCreate(Log $logger = null) {
729 729
       $this->setDependencyInstanceFromParamOrCreate('logger', $logger, 'Log', 'classes');
730
-      if ($logger === null){
730
+      if ($logger === null) {
731 731
         $this->logger->setLogger('Library::Database');
732 732
       }
733 733
       return $this;
@@ -736,7 +736,7 @@  discard block
 block discarded – undo
736 736
     /**
737 737
      * Reset the database class attributs to the initail values before each query.
738 738
      */
739
-    private function reset(){
739
+    private function reset() {
740 740
 	   //query builder reset
741 741
       $this->queryBuilder->reset();
742 742
       $this->numRows  = 0;
@@ -749,7 +749,7 @@  discard block
 block discarded – undo
749 749
     /**
750 750
      * The class destructor
751 751
      */
752
-    public function __destruct(){
752
+    public function __destruct() {
753 753
       $this->pdo = null;
754 754
     }
755 755
 
Please login to merge, or discard this patch.
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -156,8 +156,7 @@
 block discarded – undo
156 156
             $this->updateQueryBuilderAndRunnerProperties();
157 157
 
158 158
             return is_object($this->pdo);
159
-          }
160
-          catch (PDOException $e){
159
+          } catch (PDOException $e){
161 160
             $this->logger->fatal($e->getMessage());
162 161
             show_error('Cannot connect to Database.');
163 162
             return false;
Please login to merge, or discard this patch.
core/libraries/Pagination.php 3 patches
Indentation   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -1,32 +1,32 @@  discard block
 block discarded – undo
1 1
 <?php
2 2
     defined('ROOT_PATH') || exit('Access denied');
3
-	/**
4
-	 * TNH Framework
5
-	 *
6
-	 * A simple PHP framework using HMVC architecture
7
-	 *
8
-	 * This content is released under the GNU GPL License (GPL)
9
-	 *
10
-	 * Copyright (C) 2017 Tony NGUEREZA
11
-	 *
12
-	 * This program is free software; you can redistribute it and/or
13
-	 * modify it under the terms of the GNU General Public License
14
-	 * as published by the Free Software Foundation; either version 3
15
-	 * of the License, or (at your option) any later version.
16
-	 *
17
-	 * This program is distributed in the hope that it will be useful,
18
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
-	 * GNU General Public License for more details.
21
-	 *
22
-	 * You should have received a copy of the GNU General Public License
23
-	 * along with this program; if not, write to the Free Software
24
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-	*/
3
+    /**
4
+     * TNH Framework
5
+     *
6
+     * A simple PHP framework using HMVC architecture
7
+     *
8
+     * This content is released under the GNU GPL License (GPL)
9
+     *
10
+     * Copyright (C) 2017 Tony NGUEREZA
11
+     *
12
+     * This program is free software; you can redistribute it and/or
13
+     * modify it under the terms of the GNU General Public License
14
+     * as published by the Free Software Foundation; either version 3
15
+     * of the License, or (at your option) any later version.
16
+     *
17
+     * This program is distributed in the hope that it will be useful,
18
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
+     * GNU General Public License for more details.
21
+     *
22
+     * You should have received a copy of the GNU General Public License
23
+     * along with this program; if not, write to the Free Software
24
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
+     */
26 26
 
27 27
     class Pagination{
28 28
         
29
-		/**
29
+        /**
30 30
          * The list of loaded config
31 31
          * @var array
32 32
          */
@@ -49,13 +49,13 @@  discard block
 block discarded – undo
49 49
                 if (empty($config) || ! is_array($config)){
50 50
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
51 51
                 }
52
-				else{
53
-					$config = array_merge($config, $overwriteConfig);
54
-					$this->config = $config;
52
+                else{
53
+                    $config = array_merge($config, $overwriteConfig);
54
+                    $this->config = $config;
55 55
                     //put it gobally
56
-					Config::setAll($config);
57
-					unset($config);
58
-				}
56
+                    Config::setAll($config);
57
+                    unset($config);
58
+                }
59 59
             }
60 60
             else{
61 61
                 show_error('Unable to find the pagination configuration file');
@@ -92,11 +92,11 @@  discard block
 block discarded – undo
92 92
             return $this->paginationQueryString;
93 93
         }
94 94
 
95
-         /**
96
-         * Set the value of the pagination query string
97
-         * @param string $paginationQueryString the new value
98
-         * @return object
99
-         */
95
+            /**
96
+             * Set the value of the pagination query string
97
+             * @param string $paginationQueryString the new value
98
+             * @return object
99
+             */
100 100
         public function setPaginationQueryString($paginationQueryString){
101 101
             $this->paginationQueryString = $paginationQueryString;
102 102
             return $this;
@@ -113,7 +113,7 @@  discard block
 block discarded – undo
113 113
             $queryString = Url::queryString();
114 114
             $currentUrl = Url::current();
115 115
             $query = '';
116
-             if ($queryString == ''){
116
+                if ($queryString == ''){
117 117
                 $query = '?' . $pageQueryName . '=';
118 118
             }
119 119
             else{
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
          */
147 147
         public function getLink($totalRows, $currentPageNumber){
148 148
             $numberOfLink = $this->config['nb_link'];
149
-			$numberOfRowPerPage = $this->config['pagination_per_page'];
149
+            $numberOfRowPerPage = $this->config['pagination_per_page'];
150 150
             if (empty($this->paginationQueryString)){
151 151
                 //determine the pagination query string value
152 152
                 $this->determinePaginationQueryStringValue();
@@ -159,8 +159,8 @@  discard block
 block discarded – undo
159 159
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
160 160
 			
161 161
             if ($currentPageNumber <= 0){
162
-				$currentPageNumber = 1;
163
-			}
162
+                $currentPageNumber = 1;
163
+            }
164 164
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
165 165
                 return $navbar;
166 166
             }
@@ -185,7 +185,7 @@  discard block
 block discarded – undo
185 185
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
186 186
             }
187 187
             else if ($currentPageNumber == $numberOfPage){
188
-               $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
188
+                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
189 189
             }
190 190
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
191 191
             return $navbar;
@@ -253,8 +253,8 @@  discard block
 block discarded – undo
253 253
                 }
254 254
             }
255 255
             $navbar .= $this->config['next_open']
256
-                         . '<a href="' . $query . ($currentPageNumber + 1) . '">' 
257
-                         . $this->config['next_text'] . '</a>' . $this->config['next_close'];
256
+                            . '<a href="' . $query . ($currentPageNumber + 1) . '">' 
257
+                            . $this->config['next_text'] . '</a>' . $this->config['next_close'];
258 258
             return $navbar;
259 259
         }
260 260
 
Please login to merge, or discard this patch.
Spacing   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
24 24
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25 25
 	*/
26 26
 
27
-    class Pagination{
27
+    class Pagination {
28 28
         
29 29
 		/**
30 30
          * The list of loaded config
@@ -42,14 +42,14 @@  discard block
 block discarded – undo
42 42
          * Create an instance of pagination
43 43
          * @param array $overwriteConfig the list of configuration to overwrite the defined configuration in config_pagination.php
44 44
          */
45
-        public function __construct(array $overwriteConfig = array()){
46
-            if (file_exists(CONFIG_PATH . 'config_pagination.php')){
45
+        public function __construct(array $overwriteConfig = array()) {
46
+            if (file_exists(CONFIG_PATH . 'config_pagination.php')) {
47 47
                 $config = array();
48 48
                 require_once CONFIG_PATH . 'config_pagination.php';
49
-                if (empty($config) || ! is_array($config)){
49
+                if (empty($config) || !is_array($config)) {
50 50
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
51 51
                 }
52
-				else{
52
+				else {
53 53
 					$config = array_merge($config, $overwriteConfig);
54 54
 					$this->config = $config;
55 55
                     //put it gobally
@@ -57,7 +57,7 @@  discard block
 block discarded – undo
57 57
 					unset($config);
58 58
 				}
59 59
             }
60
-            else{
60
+            else {
61 61
                 show_error('Unable to find the pagination configuration file');
62 62
             }
63 63
         }
@@ -68,8 +68,8 @@  discard block
 block discarded – undo
68 68
          * config_pagination.php
69 69
          * @param array $config the configuration to overwrite
70 70
          */
71
-        public function setConfig(array $config = array()){
72
-            if (! empty($config)){
71
+        public function setConfig(array $config = array()) {
72
+            if (!empty($config)) {
73 73
                 $this->config = array_merge($this->config, $config);
74 74
                 Config::setAll($config);
75 75
             }
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
          * 
81 81
          * @return array
82 82
          */
83
-        public function getConfig(){
83
+        public function getConfig() {
84 84
             return $this->config;
85 85
         }
86 86
 
@@ -88,7 +88,7 @@  discard block
 block discarded – undo
88 88
          * Return the value of the pagination query string
89 89
          * @return string
90 90
          */
91
-        public function getPaginationQueryString(){
91
+        public function getPaginationQueryString() {
92 92
             return $this->paginationQueryString;
93 93
         }
94 94
 
@@ -97,7 +97,7 @@  discard block
 block discarded – undo
97 97
          * @param string $paginationQueryString the new value
98 98
          * @return object
99 99
          */
100
-        public function setPaginationQueryString($paginationQueryString){
100
+        public function setPaginationQueryString($paginationQueryString) {
101 101
             $this->paginationQueryString = $paginationQueryString;
102 102
             return $this;
103 103
         }
@@ -108,25 +108,25 @@  discard block
 block discarded – undo
108 108
          * 
109 109
          * @return object
110 110
          */
111
-        public function determinePaginationQueryStringValue(){
111
+        public function determinePaginationQueryStringValue() {
112 112
             $pageQueryName = $this->config['page_query_string_name'];
113 113
             $queryString = Url::queryString();
114 114
             $currentUrl = Url::current();
115 115
             $query = '';
116
-             if ($queryString == ''){
116
+             if ($queryString == '') {
117 117
                 $query = '?' . $pageQueryName . '=';
118 118
             }
119
-            else{
119
+            else {
120 120
                 $tab = explode($pageQueryName . '=', $queryString);
121 121
                 $nb = count($tab);
122
-                if ($nb == 1){
122
+                if ($nb == 1) {
123 123
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
124 124
                 }
125
-                else{
126
-                    if ($tab[0] == ''){
125
+                else {
126
+                    if ($tab[0] == '') {
127 127
                         $query = '?' . $pageQueryName . '=';
128 128
                     }
129
-                    else{
129
+                    else {
130 130
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
131 131
                     }
132 132
                 }
@@ -144,10 +144,10 @@  discard block
 block discarded – undo
144 144
          * 
145 145
          * @return string the pagination link
146 146
          */
147
-        public function getLink($totalRows, $currentPageNumber){
147
+        public function getLink($totalRows, $currentPageNumber) {
148 148
             $numberOfLink = $this->config['nb_link'];
149 149
 			$numberOfRowPerPage = $this->config['pagination_per_page'];
150
-            if (empty($this->paginationQueryString)){
150
+            if (empty($this->paginationQueryString)) {
151 151
                 //determine the pagination query string value
152 152
                 $this->determinePaginationQueryStringValue();
153 153
             }
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
158 158
             $numberOfLink = (int) $numberOfLink;
159 159
             $numberOfRowPerPage = (int) $numberOfRowPerPage;
160 160
 			
161
-            if ($currentPageNumber <= 0){
161
+            if ($currentPageNumber <= 0) {
162 162
 				$currentPageNumber = 1;
163 163
 			}
164 164
             if ($numberOfPage <= 1 || $numberOfLink <= 0 || $numberOfRowPerPage <= 0) {
@@ -173,18 +173,18 @@  discard block
 block discarded – undo
173 173
          * @param  int $numberOfPage      the total number of page
174 174
          * @return string
175 175
          */
176
-        protected function buildPaginationNavbar($currentPageNumber, $numberOfPage){
176
+        protected function buildPaginationNavbar($currentPageNumber, $numberOfPage) {
177 177
             $values = $this->getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage);
178 178
             $begin = $values['begin'];
179 179
             $end   = $values['end'];
180 180
             $navbar = null;
181
-            if ($currentPageNumber == 1){
181
+            if ($currentPageNumber == 1) {
182 182
                 $navbar .= $this->buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber);
183 183
             }
184
-            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
184
+            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage) {
185 185
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
186 186
             }
187
-            else if ($currentPageNumber == $numberOfPage){
187
+            else if ($currentPageNumber == $numberOfPage) {
188 188
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
189 189
             }
190 190
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -197,32 +197,32 @@  discard block
 block discarded – undo
197 197
          * @param  int $numberOfPage      the total number of page
198 198
          * @return array                    the begin and end number
199 199
          */
200
-        protected function getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage){
200
+        protected function getPaginationBeginAndEndNumber($currentPageNumber, $numberOfPage) {
201 201
             $start = null;
202 202
             $begin = null;
203 203
             $end   = null;
204 204
             $numberOfLink = $this->config['nb_link'];
205
-            if ($numberOfLink % 2 == 0){
205
+            if ($numberOfLink % 2 == 0) {
206 206
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
207 207
                 $end   = $currentPageNumber + ($numberOfLink / 2);
208 208
             }
209
-            else{
209
+            else {
210 210
                 $start = $currentPageNumber - floor($numberOfLink / 2);
211 211
                 $end   = $currentPageNumber + floor($numberOfLink / 2);
212 212
             }
213
-            if ($start <= 1){
213
+            if ($start <= 1) {
214 214
                 $begin = 1;
215 215
                 $end   = $numberOfLink;
216 216
             }
217
-            else if ($start > 1 && $end < $numberOfPage){
217
+            else if ($start > 1 && $end < $numberOfPage) {
218 218
                 $begin = $start;
219 219
                 $end = $end;
220 220
             }
221
-            else{
221
+            else {
222 222
                 $begin = ($numberOfPage - $numberOfLink) + 1;
223 223
                 $end   = $numberOfPage;
224 224
             }
225
-            if ($numberOfPage <= $numberOfLink){
225
+            if ($numberOfPage <= $numberOfLink) {
226 226
                 $begin = 1;
227 227
                 $end = $numberOfPage;
228 228
             }
@@ -239,14 +239,14 @@  discard block
 block discarded – undo
239 239
          * @param  int $currentPageNumber the pagination current page number
240 240
          * @return string                    
241 241
          */
242
-        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber){
242
+        protected function buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber) {
243 243
             $navbar = null;
244 244
             $query = $this->paginationQueryString;
245
-            for($i = $begin; $i <= $end; $i++){
246
-                if ($i == $currentPageNumber){
245
+            for ($i = $begin; $i <= $end; $i++) {
246
+                if ($i == $currentPageNumber) {
247 247
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
248 248
                 }
249
-                else{
249
+                else {
250 250
                     $navbar .= $this->config['digit_open'] 
251 251
                             . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
252 252
                             . $this->config['digit_close'];
@@ -265,23 +265,23 @@  discard block
 block discarded – undo
265 265
          * @param  int $currentPageNumber the pagination current page number
266 266
          * @return string                    
267 267
          */
268
-        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber){
268
+        protected function buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber) {
269 269
             $navbar = null;
270 270
             $query = $this->paginationQueryString;
271 271
             $navbar .= $this->config['previous_open'] 
272 272
                             . '<a href="' . $query . ($currentPageNumber - 1) . '">' 
273 273
                             . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
274
-            for($i = $begin; $i <= $end; $i++){
275
-                if ($i == $currentPageNumber){
274
+            for ($i = $begin; $i <= $end; $i++) {
275
+                if ($i == $currentPageNumber) {
276 276
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
277 277
                 }
278
-                else{
278
+                else {
279 279
                     $navbar .= $this->config['digit_open'] 
280
-                                    . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' 
280
+                                    . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
281 281
                                     . $this->config['digit_close'];
282 282
                 }
283 283
             }
284
-            $navbar .= $this->config['next_open']."<a href='$query".($currentPageNumber + 1)."'>".$this->config['next_text']."</a>".$this->config['next_close'];
284
+            $navbar .= $this->config['next_open'] . "<a href='$query" . ($currentPageNumber + 1) . "'>" . $this->config['next_text'] . "</a>" . $this->config['next_close'];
285 285
             return $navbar;
286 286
         }
287 287
 
@@ -292,19 +292,19 @@  discard block
 block discarded – undo
292 292
          * @param  int $currentPageNumber the pagination current page number
293 293
          * @return string                    
294 294
          */
295
-        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber){
295
+        protected function buildPaginationLinkForLastPage($begin, $end, $currentPageNumber) {
296 296
             $navbar = null;
297 297
             $query = $this->paginationQueryString;
298 298
             $navbar .= $this->config['previous_open'] 
299 299
                         . '<a href="' . $query . ($currentPageNumber - 1) . '">' 
300 300
                         . $this->config['previous_text'] . '</a>' . $this->config['previous_close'];
301
-            for($i = $begin; $i <= $end; $i++){
302
-                if ($i == $currentPageNumber){
301
+            for ($i = $begin; $i <= $end; $i++) {
302
+                if ($i == $currentPageNumber) {
303 303
                     $navbar .= $this->config['active_link_open'] 
304 304
                                 . $currentPageNumber 
305 305
                                 . $this->config['active_link_close'];
306 306
                 }
307
-                else{
307
+                else {
308 308
                     $navbar .= $this->config['digit_open'] 
309 309
                                 . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
310 310
                                 . $this->config['digit_close'];
Please login to merge, or discard this patch.
Braces   +13 added lines, -26 removed lines patch added patch discarded remove patch
@@ -48,16 +48,14 @@  discard block
 block discarded – undo
48 48
                 require_once CONFIG_PATH . 'config_pagination.php';
49 49
                 if (empty($config) || ! is_array($config)){
50 50
                     show_error('No configuration found in ' . CONFIG_PATH . 'config_pagination.php');
51
-                }
52
-				else{
51
+                } else{
53 52
 					$config = array_merge($config, $overwriteConfig);
54 53
 					$this->config = $config;
55 54
                     //put it gobally
56 55
 					Config::setAll($config);
57 56
 					unset($config);
58 57
 				}
59
-            }
60
-            else{
58
+            } else{
61 59
                 show_error('Unable to find the pagination configuration file');
62 60
             }
63 61
         }
@@ -115,18 +113,15 @@  discard block
 block discarded – undo
115 113
             $query = '';
116 114
              if ($queryString == ''){
117 115
                 $query = '?' . $pageQueryName . '=';
118
-            }
119
-            else{
116
+            } else{
120 117
                 $tab = explode($pageQueryName . '=', $queryString);
121 118
                 $nb = count($tab);
122 119
                 if ($nb == 1){
123 120
                     $query = '?' . $queryString . '&' . $pageQueryName . '=';
124
-                }
125
-                else{
121
+                } else{
126 122
                     if ($tab[0] == ''){
127 123
                         $query = '?' . $pageQueryName . '=';
128
-                    }
129
-                    else{
124
+                    } else{
130 125
                         $query = '?' . $tab[0] . '' . $pageQueryName . '=';
131 126
                     }
132 127
                 }
@@ -180,11 +175,9 @@  discard block
 block discarded – undo
180 175
             $navbar = null;
181 176
             if ($currentPageNumber == 1){
182 177
                 $navbar .= $this->buildPaginationLinkForFirstPage($begin, $end, $currentPageNumber);
183
-            }
184
-            else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
178
+            } else if ($currentPageNumber > 1 && $currentPageNumber < $numberOfPage){
185 179
                 $navbar .= $this->buildPaginationLinkForMiddlePage($begin, $end, $currentPageNumber);
186
-            }
187
-            else if ($currentPageNumber == $numberOfPage){
180
+            } else if ($currentPageNumber == $numberOfPage){
188 181
                $navbar .= $this->buildPaginationLinkForLastPage($begin, $end, $currentPageNumber);
189 182
             }
190 183
             $navbar = $this->config['pagination_open'] . $navbar . $this->config['pagination_close'];
@@ -205,20 +198,17 @@  discard block
 block discarded – undo
205 198
             if ($numberOfLink % 2 == 0){
206 199
                 $start = $currentPageNumber - ($numberOfLink / 2) + 1;
207 200
                 $end   = $currentPageNumber + ($numberOfLink / 2);
208
-            }
209
-            else{
201
+            } else{
210 202
                 $start = $currentPageNumber - floor($numberOfLink / 2);
211 203
                 $end   = $currentPageNumber + floor($numberOfLink / 2);
212 204
             }
213 205
             if ($start <= 1){
214 206
                 $begin = 1;
215 207
                 $end   = $numberOfLink;
216
-            }
217
-            else if ($start > 1 && $end < $numberOfPage){
208
+            } else if ($start > 1 && $end < $numberOfPage){
218 209
                 $begin = $start;
219 210
                 $end = $end;
220
-            }
221
-            else{
211
+            } else{
222 212
                 $begin = ($numberOfPage - $numberOfLink) + 1;
223 213
                 $end   = $numberOfPage;
224 214
             }
@@ -245,8 +235,7 @@  discard block
 block discarded – undo
245 235
             for($i = $begin; $i <= $end; $i++){
246 236
                 if ($i == $currentPageNumber){
247 237
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
248
-                }
249
-                else{
238
+                } else{
250 239
                     $navbar .= $this->config['digit_open'] 
251 240
                             . '<a href="' . $query . $i . '" ' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
252 241
                             . $this->config['digit_close'];
@@ -274,8 +263,7 @@  discard block
 block discarded – undo
274 263
             for($i = $begin; $i <= $end; $i++){
275 264
                 if ($i == $currentPageNumber){
276 265
                     $navbar .= $this->config['active_link_open'] . $currentPageNumber . $this->config['active_link_close'];
277
-                }
278
-                else{
266
+                } else{
279 267
                     $navbar .= $this->config['digit_open'] 
280 268
                                     . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i .'</a>' 
281 269
                                     . $this->config['digit_close'];
@@ -303,8 +291,7 @@  discard block
 block discarded – undo
303 291
                     $navbar .= $this->config['active_link_open'] 
304 292
                                 . $currentPageNumber 
305 293
                                 . $this->config['active_link_close'];
306
-                }
307
-                else{
294
+                } else{
308 295
                     $navbar .= $this->config['digit_open'] 
309 296
                                 . '<a href="' . $query . $i . '"' . attributes_to_string($this->config['attributes']) . '>' . $i . '</a>' 
310 297
                                 . $this->config['digit_close'];
Please login to merge, or discard this patch.
core/libraries/Html.php 2 patches
Indentation   +318 added lines, -318 removed lines patch added patch discarded remove patch
@@ -1,335 +1,335 @@
 block discarded – undo
1 1
 <?php
2
-	defined('ROOT_PATH') || exit('Access denied');
3
-	/**
4
-	 * TNH Framework
5
-	 *
6
-	 * A simple PHP framework using HMVC architecture
7
-	 *
8
-	 * This content is released under the GNU GPL License (GPL)
9
-	 *
10
-	 * Copyright (C) 2017 Tony NGUEREZA
11
-	 *
12
-	 * This program is free software; you can redistribute it and/or
13
-	 * modify it under the terms of the GNU General Public License
14
-	 * as published by the Free Software Foundation; either version 3
15
-	 * of the License, or (at your option) any later version.
16
-	 *
17
-	 * This program is distributed in the hope that it will be useful,
18
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
-	 * GNU General Public License for more details.
21
-	 *
22
-	 * You should have received a copy of the GNU General Public License
23
-	 * along with this program; if not, write to the Free Software
24
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-	*/
2
+    defined('ROOT_PATH') || exit('Access denied');
3
+    /**
4
+     * TNH Framework
5
+     *
6
+     * A simple PHP framework using HMVC architecture
7
+     *
8
+     * This content is released under the GNU GPL License (GPL)
9
+     *
10
+     * Copyright (C) 2017 Tony NGUEREZA
11
+     *
12
+     * This program is free software; you can redistribute it and/or
13
+     * modify it under the terms of the GNU General Public License
14
+     * as published by the Free Software Foundation; either version 3
15
+     * of the License, or (at your option) any later version.
16
+     *
17
+     * This program is distributed in the hope that it will be useful,
18
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
+     * GNU General Public License for more details.
21
+     *
22
+     * You should have received a copy of the GNU General Public License
23
+     * along with this program; if not, write to the Free Software
24
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
+     */
26 26
 
27
-	class Html{
27
+    class Html{
28 28
 
29
-		/**
30
-		 * Generate the html anchor link
31
-		 * @param  string $link       the href attribute value
32
-		 * @param  string $anchor     the displayed anchor
33
-		 * @param  array  $attributes the additional attributes to be added
34
-		 * @param boolean $return whether need return the generated html or just display it directly
35
-		 *
36
-		 * @return string|void             the anchor link generated html if $return is true or display it if not
37
-		 */
38
-		public static function a($link = '', $anchor = null, array $attributes = array(), $return = true){
39
-			$link = Url::site_url($link);
40
-			if(! $anchor){
41
-				$anchor = $link;
42
-			}
43
-			$str = null;
44
-			$str .= '<a href = "'.$link.'"';
45
-			$str .= attributes_to_string($attributes);
46
-			$str .= '>';
47
-			$str .= $anchor;
48
-			$str .= '</a>';
29
+        /**
30
+         * Generate the html anchor link
31
+         * @param  string $link       the href attribute value
32
+         * @param  string $anchor     the displayed anchor
33
+         * @param  array  $attributes the additional attributes to be added
34
+         * @param boolean $return whether need return the generated html or just display it directly
35
+         *
36
+         * @return string|void             the anchor link generated html if $return is true or display it if not
37
+         */
38
+        public static function a($link = '', $anchor = null, array $attributes = array(), $return = true){
39
+            $link = Url::site_url($link);
40
+            if(! $anchor){
41
+                $anchor = $link;
42
+            }
43
+            $str = null;
44
+            $str .= '<a href = "'.$link.'"';
45
+            $str .= attributes_to_string($attributes);
46
+            $str .= '>';
47
+            $str .= $anchor;
48
+            $str .= '</a>';
49 49
 
50
-			if($return){
51
-				return $str;
52
-			}
53
-			echo $str;
54
-		}
50
+            if($return){
51
+                return $str;
52
+            }
53
+            echo $str;
54
+        }
55 55
 		
56
-		/**
57
-		 * Generate an mailto anchor link
58
-		 * @param  string $link       the email address 
59
-		 * @param  string $anchor     the displayed value of the link
60
-		 * @param  array  $attributes the additional attributes to be added
61
-		 * @param boolean $return whether need return the generated html or just display it directly
62
-		 *
63
-		 * @return string|void             the generated html for mailto link if $return is true or display it if not
64
-		 */
65
-		public static function mailto($link, $anchor = null, array $attributes = array(), $return = true){
66
-			if(! $anchor){
67
-				$anchor = $link;
68
-			}
69
-			$str = null;
70
-			$str .= '<a href = "mailto:'.$link.'"';
71
-			$str .= attributes_to_string($attributes);
72
-			$str .= '>';
73
-			$str .= $anchor;
74
-			$str .= '</a>';
56
+        /**
57
+         * Generate an mailto anchor link
58
+         * @param  string $link       the email address 
59
+         * @param  string $anchor     the displayed value of the link
60
+         * @param  array  $attributes the additional attributes to be added
61
+         * @param boolean $return whether need return the generated html or just display it directly
62
+         *
63
+         * @return string|void             the generated html for mailto link if $return is true or display it if not
64
+         */
65
+        public static function mailto($link, $anchor = null, array $attributes = array(), $return = true){
66
+            if(! $anchor){
67
+                $anchor = $link;
68
+            }
69
+            $str = null;
70
+            $str .= '<a href = "mailto:'.$link.'"';
71
+            $str .= attributes_to_string($attributes);
72
+            $str .= '>';
73
+            $str .= $anchor;
74
+            $str .= '</a>';
75 75
 
76
-			if($return){
77
-				return $str;
78
-			}
79
-			echo $str;
80
-		}
76
+            if($return){
77
+                return $str;
78
+            }
79
+            echo $str;
80
+        }
81 81
 
82
-		/**
83
-		 * Generate the html "br" tag  
84
-		 * @param  integer $nb the number of generated "<br />" tag
85
-		 * @param boolean $return whether need return the generated html or just display it directly
86
-		 *
87
-		 * @return string|void      the generated "br" html if $return is true or display it if not
88
-		 */
89
-		public static function br($nb = 1, $return = true){
90
-			$nb = (int) $nb;
91
-			$str = null;
92
-			for ($i = 1; $i <= $nb; $i++) {
93
-				$str .= '<br />';
94
-			}
82
+        /**
83
+         * Generate the html "br" tag  
84
+         * @param  integer $nb the number of generated "<br />" tag
85
+         * @param boolean $return whether need return the generated html or just display it directly
86
+         *
87
+         * @return string|void      the generated "br" html if $return is true or display it if not
88
+         */
89
+        public static function br($nb = 1, $return = true){
90
+            $nb = (int) $nb;
91
+            $str = null;
92
+            for ($i = 1; $i <= $nb; $i++) {
93
+                $str .= '<br />';
94
+            }
95 95
 
96
-			if($return){
97
-				return $str;
98
-			}
99
-			echo $str;
100
-		}
96
+            if($return){
97
+                return $str;
98
+            }
99
+            echo $str;
100
+        }
101 101
 
102
-		/**
103
-		 * Generate the html content for tag "hr"
104
-		 * @param integer $nb the number of generated "<hr />" tag
105
-		 * @param  array   $attributes the tag attributes
106
-		 * @param  boolean $return    whether need return the generated html or just display it directly
107
-		 *
108
-		 * @return string|void the generated "hr" html if $return is true or display it if not.
109
-		 */
110
-		public static function hr($nb = 1, array $attributes = array(), $return = true){
111
-			$nb = (int) $nb;
112
-			$str = null;
113
-			for ($i = 1; $i <= $nb; $i++) {
114
-				$str .= '<hr' .attributes_to_string($attributes). ' />';
115
-			}
116
-			if($return){
117
-				return $str;
118
-			}
119
-			echo $str;
120
-		}
102
+        /**
103
+         * Generate the html content for tag "hr"
104
+         * @param integer $nb the number of generated "<hr />" tag
105
+         * @param  array   $attributes the tag attributes
106
+         * @param  boolean $return    whether need return the generated html or just display it directly
107
+         *
108
+         * @return string|void the generated "hr" html if $return is true or display it if not.
109
+         */
110
+        public static function hr($nb = 1, array $attributes = array(), $return = true){
111
+            $nb = (int) $nb;
112
+            $str = null;
113
+            for ($i = 1; $i <= $nb; $i++) {
114
+                $str .= '<hr' .attributes_to_string($attributes). ' />';
115
+            }
116
+            if($return){
117
+                return $str;
118
+            }
119
+            echo $str;
120
+        }
121 121
 
122
-		/**
123
-		 * Generate the html content for tag like h1, h2, h3, h4, h5 and h6
124
-		 * @param  integer $type       the tag type 1 mean h1, 2 h2, etc,
125
-		 * @param  string  $text       the display text
126
-		 * @param integer $nb the number of generated "<h{1,2,3,4,5,6}>"
127
-		 * @param  array   $attributes the tag attributes
128
-		 * @param  boolean $return    whether need return the generated html or just display it directly
129
-		 *
130
-		 * @return string|void the generated header html if $return is true or display it if not.
131
-		 */
132
-		public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true){
133
-			$nb = (int) $nb;
134
-			$type = (int) $type;
135
-			if($type <= 0 || $type > 6){
136
-				$type = 1;
137
-			}
138
-			$str = null;
139
-			for ($i = 1; $i <= $nb; $i++) {
140
-				$str .= '<h' . $type . attributes_to_string($attributes). '>' .$text. '</h' . $type . '>';
141
-			}
142
-			if($return){
143
-				return $str;
144
-			}
145
-			echo $str;
146
-		}
122
+        /**
123
+         * Generate the html content for tag like h1, h2, h3, h4, h5 and h6
124
+         * @param  integer $type       the tag type 1 mean h1, 2 h2, etc,
125
+         * @param  string  $text       the display text
126
+         * @param integer $nb the number of generated "<h{1,2,3,4,5,6}>"
127
+         * @param  array   $attributes the tag attributes
128
+         * @param  boolean $return    whether need return the generated html or just display it directly
129
+         *
130
+         * @return string|void the generated header html if $return is true or display it if not.
131
+         */
132
+        public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true){
133
+            $nb = (int) $nb;
134
+            $type = (int) $type;
135
+            if($type <= 0 || $type > 6){
136
+                $type = 1;
137
+            }
138
+            $str = null;
139
+            for ($i = 1; $i <= $nb; $i++) {
140
+                $str .= '<h' . $type . attributes_to_string($attributes). '>' .$text. '</h' . $type . '>';
141
+            }
142
+            if($return){
143
+                return $str;
144
+            }
145
+            echo $str;
146
+        }
147 147
 
148
-		/**
149
-		 * Generate the html "ul" tag
150
-		 * @param  array   $data the data to use for each "li" tag
151
-		 * @param  array   $attributes   the "ul" properties attribute use the array index below for each tag:
152
-		 *  for ul "ul", for li "li".
153
-		 * @param  boolean $return whether need return the generated html or just display it directly
154
-		 *
155
-		 * @return string|void the generated "ul" html  if $return is true or display it if not.
156
-		 */
157
-		public static function ul($data = array(), $attributes = array(), $return = true){
158
-			$data = (array) $data;
159
-			$str = null;
160
-			$ulAttributes = '';
161
-			if(! empty($attributes['ul'])){
162
-				$ulAttributes = ' ' . attributes_to_string($attributes['ul']);
163
-			}
164
-			$liAttributes = '';
165
-			if(! empty($attributes['li'])){
166
-				$liAttributes = ' ' . attributes_to_string($attributes['li']);
167
-			}
168
-			$str .= '<ul' . $ulAttributes . '>';
169
-			foreach ($data as $row) {
170
-				$str .= '<li' . $liAttributes .'>' .$row. '</li>';
171
-			}
172
-			$str .= '</ul>';
173
-			if($return){
174
-				return $str;
175
-			}
176
-			echo $str;
177
-		}
148
+        /**
149
+         * Generate the html "ul" tag
150
+         * @param  array   $data the data to use for each "li" tag
151
+         * @param  array   $attributes   the "ul" properties attribute use the array index below for each tag:
152
+         *  for ul "ul", for li "li".
153
+         * @param  boolean $return whether need return the generated html or just display it directly
154
+         *
155
+         * @return string|void the generated "ul" html  if $return is true or display it if not.
156
+         */
157
+        public static function ul($data = array(), $attributes = array(), $return = true){
158
+            $data = (array) $data;
159
+            $str = null;
160
+            $ulAttributes = '';
161
+            if(! empty($attributes['ul'])){
162
+                $ulAttributes = ' ' . attributes_to_string($attributes['ul']);
163
+            }
164
+            $liAttributes = '';
165
+            if(! empty($attributes['li'])){
166
+                $liAttributes = ' ' . attributes_to_string($attributes['li']);
167
+            }
168
+            $str .= '<ul' . $ulAttributes . '>';
169
+            foreach ($data as $row) {
170
+                $str .= '<li' . $liAttributes .'>' .$row. '</li>';
171
+            }
172
+            $str .= '</ul>';
173
+            if($return){
174
+                return $str;
175
+            }
176
+            echo $str;
177
+        }
178 178
 
179
-		/**
180
-		 * Generate the html "ol" tag
181
-		 * @param  array   $data the data to use for each "li" tag
182
-		 * @param  array   $attributes   the "ol" properties attribute use the array index below for each tag:
183
-		 *  for ol "ol", for li "li".
184
-		 * @param  boolean $return whether need return the generated html or just display it directly
185
-		 * @return string|void the generated "ol" html  if $return is true or display it if not.
186
-		 */
187
-		public static function ol($data = array(), $attributes = array(), $return = true){
188
-			$data = (array) $data;
189
-			$str = null;
190
-			$olAttributes = '';
191
-			if(! empty($attributes['ol'])){
192
-				$olAttributes = ' ' . attributes_to_string($attributes['ol']);
193
-			}
194
-			$liAttributes = '';
195
-			if(! empty($attributes['li'])){
196
-				$liAttributes = ' ' . attributes_to_string($attributes['li']);
197
-			}
198
-			$str .= '<ol' . $olAttributes . '>';
199
-			foreach ($data as $row) {
200
-				$str .= '<li' . $liAttributes .'>' .$row. '</li>';
201
-			}
202
-			$str .= '</ol>';
203
-			if($return){
204
-				return $str;
205
-			}
206
-			echo $str;
207
-		}
179
+        /**
180
+         * Generate the html "ol" tag
181
+         * @param  array   $data the data to use for each "li" tag
182
+         * @param  array   $attributes   the "ol" properties attribute use the array index below for each tag:
183
+         *  for ol "ol", for li "li".
184
+         * @param  boolean $return whether need return the generated html or just display it directly
185
+         * @return string|void the generated "ol" html  if $return is true or display it if not.
186
+         */
187
+        public static function ol($data = array(), $attributes = array(), $return = true){
188
+            $data = (array) $data;
189
+            $str = null;
190
+            $olAttributes = '';
191
+            if(! empty($attributes['ol'])){
192
+                $olAttributes = ' ' . attributes_to_string($attributes['ol']);
193
+            }
194
+            $liAttributes = '';
195
+            if(! empty($attributes['li'])){
196
+                $liAttributes = ' ' . attributes_to_string($attributes['li']);
197
+            }
198
+            $str .= '<ol' . $olAttributes . '>';
199
+            foreach ($data as $row) {
200
+                $str .= '<li' . $liAttributes .'>' .$row. '</li>';
201
+            }
202
+            $str .= '</ol>';
203
+            if($return){
204
+                return $str;
205
+            }
206
+            echo $str;
207
+        }
208 208
 
209
-		/**
210
-		 * Generate the html "table" tag
211
-		 * @param  array   $headers            the table headers to use between (<thead>)
212
-		 * @param  array   $body the table body values between (<tbody>)
213
-		 * @param  array   $attributes   the table properties attribute use the array index below for each tag:
214
-		 *  for table "table", for thead "thead", for thead tr "thead_tr",
215
-		 *  for thead th "thead_th", for tbody "tbody", for tbody tr "tbody_tr", for tbody td "tbody_td", for tfoot "tfoot",
216
-		 *  for tfoot tr "tfoot_tr", for tfoot th "tfoot_th".
217
-		 * @param boolean $use_footer whether need to generate table footer (<tfoot>) use the $headers values
218
-		 * @param  boolean $return whether need return the generated html or just display it directly
219
-		 * @return string|void the generated "table" html  if $return is true or display it if not.
220
-		 */
221
-		public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true){
222
-			$headers = (array) $headers;
223
-			$body = (array) $body;
224
-			$str = null;
225
-			$tableAttributes = '';
226
-			if(! empty($attributes['table'])){
227
-				$tableAttributes = ' ' . attributes_to_string($attributes['table']);
228
-			}
229
-			$str .= '<table' . $tableAttributes . '>';
230
-			$str .= self::buildTableHeader($headers, $attributes);
231
-			$str .= self::buildTableBody($body, $attributes);
209
+        /**
210
+         * Generate the html "table" tag
211
+         * @param  array   $headers            the table headers to use between (<thead>)
212
+         * @param  array   $body the table body values between (<tbody>)
213
+         * @param  array   $attributes   the table properties attribute use the array index below for each tag:
214
+         *  for table "table", for thead "thead", for thead tr "thead_tr",
215
+         *  for thead th "thead_th", for tbody "tbody", for tbody tr "tbody_tr", for tbody td "tbody_td", for tfoot "tfoot",
216
+         *  for tfoot tr "tfoot_tr", for tfoot th "tfoot_th".
217
+         * @param boolean $use_footer whether need to generate table footer (<tfoot>) use the $headers values
218
+         * @param  boolean $return whether need return the generated html or just display it directly
219
+         * @return string|void the generated "table" html  if $return is true or display it if not.
220
+         */
221
+        public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true){
222
+            $headers = (array) $headers;
223
+            $body = (array) $body;
224
+            $str = null;
225
+            $tableAttributes = '';
226
+            if(! empty($attributes['table'])){
227
+                $tableAttributes = ' ' . attributes_to_string($attributes['table']);
228
+            }
229
+            $str .= '<table' . $tableAttributes . '>';
230
+            $str .= self::buildTableHeader($headers, $attributes);
231
+            $str .= self::buildTableBody($body, $attributes);
232 232
 
233
-			if($use_footer){
234
-				$str .= self::buildTableFooter($headers, $attributes);
235
-			}
236
-			$str .= '</table>';
237
-			if($return){
238
-				return $str;
239
-			}
240
-			echo $str;
241
-		}
233
+            if($use_footer){
234
+                $str .= self::buildTableFooter($headers, $attributes);
235
+            }
236
+            $str .= '</table>';
237
+            if($return){
238
+                return $str;
239
+            }
240
+            echo $str;
241
+        }
242 242
 
243
-		/**
244
-		 * This method is used to build the header of the html table
245
-		 * @see  Html::table 
246
-		 * @return string|null
247
-		 */
248
-		protected static function buildTableHeader(array $headers, $attributes = array()){
249
-			$str = null;
250
-			if(! empty($headers)){
251
-				$theadAttributes = '';
252
-				if(! empty($attributes['thead'])){
253
-					$theadAttributes = ' ' . attributes_to_string($attributes['thead']);
254
-				}
255
-				$theadtrAttributes = '';
256
-				if(! empty($attributes['thead_tr'])){
257
-					$theadtrAttributes = ' ' . attributes_to_string($attributes['thead_tr']);
258
-				}
259
-				$thAttributes = '';
260
-				if(! empty($attributes['thead_th'])){
261
-					$thAttributes = ' ' . attributes_to_string($attributes['thead_th']);
262
-				}
263
-				$str .= '<thead' . $theadAttributes .'>';
264
-				$str .= '<tr' . $theadtrAttributes .'>';
265
-				foreach ($headers as $value) {
266
-					$str .= '<th' . $thAttributes .'>' .$value. '</th>';
267
-				}
268
-				$str .= '</tr>';
269
-				$str .= '</thead>';
270
-			}
271
-			return $str;
272
-		}
243
+        /**
244
+         * This method is used to build the header of the html table
245
+         * @see  Html::table 
246
+         * @return string|null
247
+         */
248
+        protected static function buildTableHeader(array $headers, $attributes = array()){
249
+            $str = null;
250
+            if(! empty($headers)){
251
+                $theadAttributes = '';
252
+                if(! empty($attributes['thead'])){
253
+                    $theadAttributes = ' ' . attributes_to_string($attributes['thead']);
254
+                }
255
+                $theadtrAttributes = '';
256
+                if(! empty($attributes['thead_tr'])){
257
+                    $theadtrAttributes = ' ' . attributes_to_string($attributes['thead_tr']);
258
+                }
259
+                $thAttributes = '';
260
+                if(! empty($attributes['thead_th'])){
261
+                    $thAttributes = ' ' . attributes_to_string($attributes['thead_th']);
262
+                }
263
+                $str .= '<thead' . $theadAttributes .'>';
264
+                $str .= '<tr' . $theadtrAttributes .'>';
265
+                foreach ($headers as $value) {
266
+                    $str .= '<th' . $thAttributes .'>' .$value. '</th>';
267
+                }
268
+                $str .= '</tr>';
269
+                $str .= '</thead>';
270
+            }
271
+            return $str;
272
+        }
273 273
 
274
-		/**
275
-		 * This method is used to build the body of the html table
276
-		 * @see  Html::table 
277
-		 * @return string|null
278
-		 */
279
-		protected static function buildTableBody(array $body, $attributes = array()){
280
-			$str = null;
281
-			$tbodyAttributes = '';
282
-			if(! empty($attributes['tbody'])){
283
-				$tbodyAttributes = ' ' . attributes_to_string($attributes['tbody']);
284
-			}
285
-			$tbodytrAttributes = '';
286
-			if(! empty($attributes['tbody_tr'])){
287
-				$tbodytrAttributes = ' ' . attributes_to_string($attributes['tbody_tr']);
288
-			}
289
-			$tbodytdAttributes = '';
290
-			if(! empty($attributes['tbody_td'])){
291
-				$tbodytdAttributes = ' ' . attributes_to_string($attributes['tbody_td']);
292
-			}
293
-			$str .= '<tbody' . $tbodyAttributes .'>';
294
-			foreach ($body as $row) {
295
-				if(is_array($row)){
296
-					$str .= '<tr' . $tbodytrAttributes .'>';
297
-					foreach ($row as $value) {
298
-						$str .= '<td' . $tbodytdAttributes .'>' .$value. '</td>';	
299
-					}
300
-					$str .= '</tr>';
301
-				}
302
-			}
303
-			$str .= '</tbody>';
304
-			return $str;
305
-		}
274
+        /**
275
+         * This method is used to build the body of the html table
276
+         * @see  Html::table 
277
+         * @return string|null
278
+         */
279
+        protected static function buildTableBody(array $body, $attributes = array()){
280
+            $str = null;
281
+            $tbodyAttributes = '';
282
+            if(! empty($attributes['tbody'])){
283
+                $tbodyAttributes = ' ' . attributes_to_string($attributes['tbody']);
284
+            }
285
+            $tbodytrAttributes = '';
286
+            if(! empty($attributes['tbody_tr'])){
287
+                $tbodytrAttributes = ' ' . attributes_to_string($attributes['tbody_tr']);
288
+            }
289
+            $tbodytdAttributes = '';
290
+            if(! empty($attributes['tbody_td'])){
291
+                $tbodytdAttributes = ' ' . attributes_to_string($attributes['tbody_td']);
292
+            }
293
+            $str .= '<tbody' . $tbodyAttributes .'>';
294
+            foreach ($body as $row) {
295
+                if(is_array($row)){
296
+                    $str .= '<tr' . $tbodytrAttributes .'>';
297
+                    foreach ($row as $value) {
298
+                        $str .= '<td' . $tbodytdAttributes .'>' .$value. '</td>';	
299
+                    }
300
+                    $str .= '</tr>';
301
+                }
302
+            }
303
+            $str .= '</tbody>';
304
+            return $str;
305
+        }
306 306
 
307
-		/**
308
-		 * This method is used to build the footer of the html table
309
-		 * @see  Html::table 
310
-		 * @return string|null
311
-		 */
312
-		protected static function buildTableFooter(array $footers, $attributes = array()){
313
-			$str = null;
314
-			$tfootAttributes = '';
315
-			if(! empty($attributes['tfoot'])){
316
-				$tfootAttributes = ' ' . attributes_to_string($attributes['tfoot']);
317
-			}
318
-			$tfoottrAttributes = '';
319
-			if(! empty($attributes['tfoot_tr'])){
320
-				$tfoottrAttributes = ' ' . attributes_to_string($attributes['tfoot_tr']);
321
-			}
322
-			$thAttributes = '';
323
-			if(! empty($attributes['tfoot_th'])){
324
-				$thAttributes = ' ' . attributes_to_string($attributes['tfoot_th']);
325
-			}
326
-			$str .= '<tfoot' . $tfootAttributes .'>';
327
-				$str .= '<tr' . $tfoottrAttributes .'>';
328
-				foreach ($footers as $value) {
329
-					$str .= '<th' . $thAttributes .'>' .$value. '</th>';
330
-				}
331
-				$str .= '</tr>';
332
-				$str .= '</tfoot>';
333
-			return $str;
334
-		}
335
-	}
307
+        /**
308
+         * This method is used to build the footer of the html table
309
+         * @see  Html::table 
310
+         * @return string|null
311
+         */
312
+        protected static function buildTableFooter(array $footers, $attributes = array()){
313
+            $str = null;
314
+            $tfootAttributes = '';
315
+            if(! empty($attributes['tfoot'])){
316
+                $tfootAttributes = ' ' . attributes_to_string($attributes['tfoot']);
317
+            }
318
+            $tfoottrAttributes = '';
319
+            if(! empty($attributes['tfoot_tr'])){
320
+                $tfoottrAttributes = ' ' . attributes_to_string($attributes['tfoot_tr']);
321
+            }
322
+            $thAttributes = '';
323
+            if(! empty($attributes['tfoot_th'])){
324
+                $thAttributes = ' ' . attributes_to_string($attributes['tfoot_th']);
325
+            }
326
+            $str .= '<tfoot' . $tfootAttributes .'>';
327
+                $str .= '<tr' . $tfoottrAttributes .'>';
328
+                foreach ($footers as $value) {
329
+                    $str .= '<th' . $thAttributes .'>' .$value. '</th>';
330
+                }
331
+                $str .= '</tr>';
332
+                $str .= '</tfoot>';
333
+            return $str;
334
+        }
335
+    }
Please login to merge, or discard this patch.
Spacing   +55 added lines, -55 removed lines patch added patch discarded remove patch
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
24 24
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25 25
 	*/
26 26
 
27
-	class Html{
27
+	class Html {
28 28
 
29 29
 		/**
30 30
 		 * Generate the html anchor link
@@ -35,19 +35,19 @@  discard block
 block discarded – undo
35 35
 		 *
36 36
 		 * @return string|void             the anchor link generated html if $return is true or display it if not
37 37
 		 */
38
-		public static function a($link = '', $anchor = null, array $attributes = array(), $return = true){
38
+		public static function a($link = '', $anchor = null, array $attributes = array(), $return = true) {
39 39
 			$link = Url::site_url($link);
40
-			if(! $anchor){
40
+			if (!$anchor) {
41 41
 				$anchor = $link;
42 42
 			}
43 43
 			$str = null;
44
-			$str .= '<a href = "'.$link.'"';
44
+			$str .= '<a href = "' . $link . '"';
45 45
 			$str .= attributes_to_string($attributes);
46 46
 			$str .= '>';
47 47
 			$str .= $anchor;
48 48
 			$str .= '</a>';
49 49
 
50
-			if($return){
50
+			if ($return) {
51 51
 				return $str;
52 52
 			}
53 53
 			echo $str;
@@ -62,18 +62,18 @@  discard block
 block discarded – undo
62 62
 		 *
63 63
 		 * @return string|void             the generated html for mailto link if $return is true or display it if not
64 64
 		 */
65
-		public static function mailto($link, $anchor = null, array $attributes = array(), $return = true){
66
-			if(! $anchor){
65
+		public static function mailto($link, $anchor = null, array $attributes = array(), $return = true) {
66
+			if (!$anchor) {
67 67
 				$anchor = $link;
68 68
 			}
69 69
 			$str = null;
70
-			$str .= '<a href = "mailto:'.$link.'"';
70
+			$str .= '<a href = "mailto:' . $link . '"';
71 71
 			$str .= attributes_to_string($attributes);
72 72
 			$str .= '>';
73 73
 			$str .= $anchor;
74 74
 			$str .= '</a>';
75 75
 
76
-			if($return){
76
+			if ($return) {
77 77
 				return $str;
78 78
 			}
79 79
 			echo $str;
@@ -86,14 +86,14 @@  discard block
 block discarded – undo
86 86
 		 *
87 87
 		 * @return string|void      the generated "br" html if $return is true or display it if not
88 88
 		 */
89
-		public static function br($nb = 1, $return = true){
89
+		public static function br($nb = 1, $return = true) {
90 90
 			$nb = (int) $nb;
91 91
 			$str = null;
92 92
 			for ($i = 1; $i <= $nb; $i++) {
93 93
 				$str .= '<br />';
94 94
 			}
95 95
 
96
-			if($return){
96
+			if ($return) {
97 97
 				return $str;
98 98
 			}
99 99
 			echo $str;
@@ -107,13 +107,13 @@  discard block
 block discarded – undo
107 107
 		 *
108 108
 		 * @return string|void the generated "hr" html if $return is true or display it if not.
109 109
 		 */
110
-		public static function hr($nb = 1, array $attributes = array(), $return = true){
110
+		public static function hr($nb = 1, array $attributes = array(), $return = true) {
111 111
 			$nb = (int) $nb;
112 112
 			$str = null;
113 113
 			for ($i = 1; $i <= $nb; $i++) {
114
-				$str .= '<hr' .attributes_to_string($attributes). ' />';
114
+				$str .= '<hr' . attributes_to_string($attributes) . ' />';
115 115
 			}
116
-			if($return){
116
+			if ($return) {
117 117
 				return $str;
118 118
 			}
119 119
 			echo $str;
@@ -129,17 +129,17 @@  discard block
 block discarded – undo
129 129
 		 *
130 130
 		 * @return string|void the generated header html if $return is true or display it if not.
131 131
 		 */
132
-		public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true){
132
+		public static function head($type = 1, $text = null, $nb = 1, array $attributes = array(), $return = true) {
133 133
 			$nb = (int) $nb;
134 134
 			$type = (int) $type;
135
-			if($type <= 0 || $type > 6){
135
+			if ($type <= 0 || $type > 6) {
136 136
 				$type = 1;
137 137
 			}
138 138
 			$str = null;
139 139
 			for ($i = 1; $i <= $nb; $i++) {
140
-				$str .= '<h' . $type . attributes_to_string($attributes). '>' .$text. '</h' . $type . '>';
140
+				$str .= '<h' . $type . attributes_to_string($attributes) . '>' . $text . '</h' . $type . '>';
141 141
 			}
142
-			if($return){
142
+			if ($return) {
143 143
 				return $str;
144 144
 			}
145 145
 			echo $str;
@@ -154,23 +154,23 @@  discard block
 block discarded – undo
154 154
 		 *
155 155
 		 * @return string|void the generated "ul" html  if $return is true or display it if not.
156 156
 		 */
157
-		public static function ul($data = array(), $attributes = array(), $return = true){
157
+		public static function ul($data = array(), $attributes = array(), $return = true) {
158 158
 			$data = (array) $data;
159 159
 			$str = null;
160 160
 			$ulAttributes = '';
161
-			if(! empty($attributes['ul'])){
161
+			if (!empty($attributes['ul'])) {
162 162
 				$ulAttributes = ' ' . attributes_to_string($attributes['ul']);
163 163
 			}
164 164
 			$liAttributes = '';
165
-			if(! empty($attributes['li'])){
165
+			if (!empty($attributes['li'])) {
166 166
 				$liAttributes = ' ' . attributes_to_string($attributes['li']);
167 167
 			}
168 168
 			$str .= '<ul' . $ulAttributes . '>';
169 169
 			foreach ($data as $row) {
170
-				$str .= '<li' . $liAttributes .'>' .$row. '</li>';
170
+				$str .= '<li' . $liAttributes . '>' . $row . '</li>';
171 171
 			}
172 172
 			$str .= '</ul>';
173
-			if($return){
173
+			if ($return) {
174 174
 				return $str;
175 175
 			}
176 176
 			echo $str;
@@ -184,23 +184,23 @@  discard block
 block discarded – undo
184 184
 		 * @param  boolean $return whether need return the generated html or just display it directly
185 185
 		 * @return string|void the generated "ol" html  if $return is true or display it if not.
186 186
 		 */
187
-		public static function ol($data = array(), $attributes = array(), $return = true){
187
+		public static function ol($data = array(), $attributes = array(), $return = true) {
188 188
 			$data = (array) $data;
189 189
 			$str = null;
190 190
 			$olAttributes = '';
191
-			if(! empty($attributes['ol'])){
191
+			if (!empty($attributes['ol'])) {
192 192
 				$olAttributes = ' ' . attributes_to_string($attributes['ol']);
193 193
 			}
194 194
 			$liAttributes = '';
195
-			if(! empty($attributes['li'])){
195
+			if (!empty($attributes['li'])) {
196 196
 				$liAttributes = ' ' . attributes_to_string($attributes['li']);
197 197
 			}
198 198
 			$str .= '<ol' . $olAttributes . '>';
199 199
 			foreach ($data as $row) {
200
-				$str .= '<li' . $liAttributes .'>' .$row. '</li>';
200
+				$str .= '<li' . $liAttributes . '>' . $row . '</li>';
201 201
 			}
202 202
 			$str .= '</ol>';
203
-			if($return){
203
+			if ($return) {
204 204
 				return $str;
205 205
 			}
206 206
 			echo $str;
@@ -218,23 +218,23 @@  discard block
 block discarded – undo
218 218
 		 * @param  boolean $return whether need return the generated html or just display it directly
219 219
 		 * @return string|void the generated "table" html  if $return is true or display it if not.
220 220
 		 */
221
-		public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true){
221
+		public static function table($headers = array(), $body = array(), $attributes = array(), $use_footer = false, $return = true) {
222 222
 			$headers = (array) $headers;
223 223
 			$body = (array) $body;
224 224
 			$str = null;
225 225
 			$tableAttributes = '';
226
-			if(! empty($attributes['table'])){
226
+			if (!empty($attributes['table'])) {
227 227
 				$tableAttributes = ' ' . attributes_to_string($attributes['table']);
228 228
 			}
229 229
 			$str .= '<table' . $tableAttributes . '>';
230 230
 			$str .= self::buildTableHeader($headers, $attributes);
231 231
 			$str .= self::buildTableBody($body, $attributes);
232 232
 
233
-			if($use_footer){
233
+			if ($use_footer) {
234 234
 				$str .= self::buildTableFooter($headers, $attributes);
235 235
 			}
236 236
 			$str .= '</table>';
237
-			if($return){
237
+			if ($return) {
238 238
 				return $str;
239 239
 			}
240 240
 			echo $str;
@@ -245,25 +245,25 @@  discard block
 block discarded – undo
245 245
 		 * @see  Html::table 
246 246
 		 * @return string|null
247 247
 		 */
248
-		protected static function buildTableHeader(array $headers, $attributes = array()){
248
+		protected static function buildTableHeader(array $headers, $attributes = array()) {
249 249
 			$str = null;
250
-			if(! empty($headers)){
250
+			if (!empty($headers)) {
251 251
 				$theadAttributes = '';
252
-				if(! empty($attributes['thead'])){
252
+				if (!empty($attributes['thead'])) {
253 253
 					$theadAttributes = ' ' . attributes_to_string($attributes['thead']);
254 254
 				}
255 255
 				$theadtrAttributes = '';
256
-				if(! empty($attributes['thead_tr'])){
256
+				if (!empty($attributes['thead_tr'])) {
257 257
 					$theadtrAttributes = ' ' . attributes_to_string($attributes['thead_tr']);
258 258
 				}
259 259
 				$thAttributes = '';
260
-				if(! empty($attributes['thead_th'])){
260
+				if (!empty($attributes['thead_th'])) {
261 261
 					$thAttributes = ' ' . attributes_to_string($attributes['thead_th']);
262 262
 				}
263
-				$str .= '<thead' . $theadAttributes .'>';
264
-				$str .= '<tr' . $theadtrAttributes .'>';
263
+				$str .= '<thead' . $theadAttributes . '>';
264
+				$str .= '<tr' . $theadtrAttributes . '>';
265 265
 				foreach ($headers as $value) {
266
-					$str .= '<th' . $thAttributes .'>' .$value. '</th>';
266
+					$str .= '<th' . $thAttributes . '>' . $value . '</th>';
267 267
 				}
268 268
 				$str .= '</tr>';
269 269
 				$str .= '</thead>';
@@ -276,26 +276,26 @@  discard block
 block discarded – undo
276 276
 		 * @see  Html::table 
277 277
 		 * @return string|null
278 278
 		 */
279
-		protected static function buildTableBody(array $body, $attributes = array()){
279
+		protected static function buildTableBody(array $body, $attributes = array()) {
280 280
 			$str = null;
281 281
 			$tbodyAttributes = '';
282
-			if(! empty($attributes['tbody'])){
282
+			if (!empty($attributes['tbody'])) {
283 283
 				$tbodyAttributes = ' ' . attributes_to_string($attributes['tbody']);
284 284
 			}
285 285
 			$tbodytrAttributes = '';
286
-			if(! empty($attributes['tbody_tr'])){
286
+			if (!empty($attributes['tbody_tr'])) {
287 287
 				$tbodytrAttributes = ' ' . attributes_to_string($attributes['tbody_tr']);
288 288
 			}
289 289
 			$tbodytdAttributes = '';
290
-			if(! empty($attributes['tbody_td'])){
290
+			if (!empty($attributes['tbody_td'])) {
291 291
 				$tbodytdAttributes = ' ' . attributes_to_string($attributes['tbody_td']);
292 292
 			}
293
-			$str .= '<tbody' . $tbodyAttributes .'>';
293
+			$str .= '<tbody' . $tbodyAttributes . '>';
294 294
 			foreach ($body as $row) {
295
-				if(is_array($row)){
296
-					$str .= '<tr' . $tbodytrAttributes .'>';
295
+				if (is_array($row)) {
296
+					$str .= '<tr' . $tbodytrAttributes . '>';
297 297
 					foreach ($row as $value) {
298
-						$str .= '<td' . $tbodytdAttributes .'>' .$value. '</td>';	
298
+						$str .= '<td' . $tbodytdAttributes . '>' . $value . '</td>';	
299 299
 					}
300 300
 					$str .= '</tr>';
301 301
 				}
@@ -309,24 +309,24 @@  discard block
 block discarded – undo
309 309
 		 * @see  Html::table 
310 310
 		 * @return string|null
311 311
 		 */
312
-		protected static function buildTableFooter(array $footers, $attributes = array()){
312
+		protected static function buildTableFooter(array $footers, $attributes = array()) {
313 313
 			$str = null;
314 314
 			$tfootAttributes = '';
315
-			if(! empty($attributes['tfoot'])){
315
+			if (!empty($attributes['tfoot'])) {
316 316
 				$tfootAttributes = ' ' . attributes_to_string($attributes['tfoot']);
317 317
 			}
318 318
 			$tfoottrAttributes = '';
319
-			if(! empty($attributes['tfoot_tr'])){
319
+			if (!empty($attributes['tfoot_tr'])) {
320 320
 				$tfoottrAttributes = ' ' . attributes_to_string($attributes['tfoot_tr']);
321 321
 			}
322 322
 			$thAttributes = '';
323
-			if(! empty($attributes['tfoot_th'])){
323
+			if (!empty($attributes['tfoot_th'])) {
324 324
 				$thAttributes = ' ' . attributes_to_string($attributes['tfoot_th']);
325 325
 			}
326
-			$str .= '<tfoot' . $tfootAttributes .'>';
327
-				$str .= '<tr' . $tfoottrAttributes .'>';
326
+			$str .= '<tfoot' . $tfootAttributes . '>';
327
+				$str .= '<tr' . $tfoottrAttributes . '>';
328 328
 				foreach ($footers as $value) {
329
-					$str .= '<th' . $thAttributes .'>' .$value. '</th>';
329
+					$str .= '<th' . $thAttributes . '>' . $value . '</th>';
330 330
 				}
331 331
 				$str .= '</tr>';
332 332
 				$str .= '</tfoot>';
Please login to merge, or discard this patch.
core/classes/Module.php 3 patches
Indentation   +284 added lines, -284 removed lines patch added patch discarded remove patch
@@ -1,6 +1,6 @@  discard block
 block discarded – undo
1 1
 <?php
2
-	defined('ROOT_PATH') || exit('Access denied');
3
-	/**
2
+    defined('ROOT_PATH') || exit('Access denied');
3
+    /**
4 4
      * TNH Framework
5 5
      *
6 6
      * A simple PHP framework using HMVC architecture
@@ -22,308 +22,308 @@  discard block
 block discarded – undo
22 22
      * You should have received a copy of the GNU General Public License
23 23
      * along with this program; if not, write to the Free Software
24 24
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-    */
25
+     */
26 26
    
27
-	class Module{
27
+    class Module{
28 28
 		
29
-		/**
30
-		 * list of loaded module
31
-		 * @var array
32
-		 */
33
-		private static $list = array();
29
+        /**
30
+         * list of loaded module
31
+         * @var array
32
+         */
33
+        private static $list = array();
34 34
 
35
-		/**
36
-		 * logger instance
37
-		 * @var Log
38
-		 */
39
-		private static $logger;
35
+        /**
36
+         * logger instance
37
+         * @var Log
38
+         */
39
+        private static $logger;
40 40
 
41
-		/**
42
-		 * The signleton of the logger
43
-		 * @return Object the Log instance
44
-		 */
45
-		private static function getLogger(){
46
-			if(self::$logger == null){
47
-				self::$logger[0] =& class_loader('Log', 'classes');
48
-				self::$logger[0]->setLogger('Library::Module');
49
-			}
50
-			return self::$logger[0];
51
-		}
41
+        /**
42
+         * The signleton of the logger
43
+         * @return Object the Log instance
44
+         */
45
+        private static function getLogger(){
46
+            if(self::$logger == null){
47
+                self::$logger[0] =& class_loader('Log', 'classes');
48
+                self::$logger[0]->setLogger('Library::Module');
49
+            }
50
+            return self::$logger[0];
51
+        }
52 52
 
53
-		/**
54
-		 * Initialise the module list by scanning the directory MODULE_PATH
55
-		 */
56
-		public function init(){
57
-			$logger = self::getLogger();
58
-			$logger->debug('Check if the application contains the modules ...');
59
-			$moduleDir = opendir(MODULE_PATH);
60
-			if(is_resource($moduleDir)){
61
-				while(($module = readdir($moduleDir)) !== false){
62
-					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
63
-						self::$list[] = $module;
64
-					}
65
-					else{
66
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
67
-					}
68
-				}
69
-				closedir($moduleDir);
70
-			}
71
-			ksort(self::$list);
53
+        /**
54
+         * Initialise the module list by scanning the directory MODULE_PATH
55
+         */
56
+        public function init(){
57
+            $logger = self::getLogger();
58
+            $logger->debug('Check if the application contains the modules ...');
59
+            $moduleDir = opendir(MODULE_PATH);
60
+            if(is_resource($moduleDir)){
61
+                while(($module = readdir($moduleDir)) !== false){
62
+                    if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
63
+                        self::$list[] = $module;
64
+                    }
65
+                    else{
66
+                        $logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
67
+                    }
68
+                }
69
+                closedir($moduleDir);
70
+            }
71
+            ksort(self::$list);
72 72
 			
73
-			if(self::hasModule()){
74
-				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
75
-			}
76
-		}
73
+            if(self::hasModule()){
74
+                $logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
75
+            }
76
+        }
77 77
 		
78
-		/**
79
-		 * Get the list of the custom autoload configuration from module if exists
80
-		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
81
-		 */
82
-		public static function getModulesAutoloadConfig(){
83
-			$logger = self::getLogger();
84
-			if(! self::hasModule()){
85
-				$logger->info('No module was loaded skipping.');
86
-				return false;
87
-			}
88
-			$autoloads = array();
89
-			$autoloads['libraries'] = array();
90
-			$autoloads['config']    = array();
91
-			$autoloads['models']    = array();
92
-			$autoloads['functions'] = array();
93
-			$autoloads['languages'] = array();
78
+        /**
79
+         * Get the list of the custom autoload configuration from module if exists
80
+         * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
81
+         */
82
+        public static function getModulesAutoloadConfig(){
83
+            $logger = self::getLogger();
84
+            if(! self::hasModule()){
85
+                $logger->info('No module was loaded skipping.');
86
+                return false;
87
+            }
88
+            $autoloads = array();
89
+            $autoloads['libraries'] = array();
90
+            $autoloads['config']    = array();
91
+            $autoloads['models']    = array();
92
+            $autoloads['functions'] = array();
93
+            $autoloads['languages'] = array();
94 94
 			
95
-			foreach (self::$list as $module) {
96
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
97
-				if(file_exists($file)){
98
-					$autoload = array();
99
-					require_once $file;
100
-					if(! empty($autoload) && is_array($autoload)){
101
-						$autoloads = array_merge_recursive($autoloads, $autoload);
102
-						unset($autoload);
103
-					}
104
-				}
105
-			}
106
-			return $autoloads;
107
-		}
95
+            foreach (self::$list as $module) {
96
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
97
+                if(file_exists($file)){
98
+                    $autoload = array();
99
+                    require_once $file;
100
+                    if(! empty($autoload) && is_array($autoload)){
101
+                        $autoloads = array_merge_recursive($autoloads, $autoload);
102
+                        unset($autoload);
103
+                    }
104
+                }
105
+            }
106
+            return $autoloads;
107
+        }
108 108
 
109
-		/**
110
-		 * Get the list of the custom routes configuration from module if exists
111
-		 * @return array|boolean the routes list or false if no module contains the routes configuration
112
-		 */
113
-		public static function getModulesRoutes(){
114
-			$logger = self::getLogger();
115
-			if(! self::hasModule()){
116
-				$logger->info('No module was loaded skipping.');
117
-				return false;
118
-			}
119
-			$routes = array();
120
-			foreach (self::$list as $module) {
121
-				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
122
-				if(file_exists($file)){
123
-					$route = array();
124
-					require_once $file;
125
-					if(! empty($route) && is_array($route)){
126
-						$routes = array_merge($routes, $route);
127
-						unset($route);
128
-					}
129
-				}
130
-			}
131
-			return $routes;
132
-		}
109
+        /**
110
+         * Get the list of the custom routes configuration from module if exists
111
+         * @return array|boolean the routes list or false if no module contains the routes configuration
112
+         */
113
+        public static function getModulesRoutes(){
114
+            $logger = self::getLogger();
115
+            if(! self::hasModule()){
116
+                $logger->info('No module was loaded skipping.');
117
+                return false;
118
+            }
119
+            $routes = array();
120
+            foreach (self::$list as $module) {
121
+                $file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
122
+                if(file_exists($file)){
123
+                    $route = array();
124
+                    require_once $file;
125
+                    if(! empty($route) && is_array($route)){
126
+                        $routes = array_merge($routes, $route);
127
+                        unset($route);
128
+                    }
129
+                }
130
+            }
131
+            return $routes;
132
+        }
133 133
 
134 134
 
135
-		/**
136
-		 * Check if in module list can have this controller
137
-		 * @param  string $class the controller class
138
-		 * @param  string $module  the module name
139
-		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
140
-		 */
141
-		public static function findControllerFullPath($class, $module = null){
142
-			$logger = self::getLogger();
143
-			if(! self::hasModule()){
144
-				$logger->info('No module was loaded skiping.');
145
-				return false;
146
-			}
147
-			$class = str_ireplace('.php', '', $class);
148
-			$class = ucfirst($class);
149
-			$classFile = $class.'.php';
150
-			$logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
151
-			$filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
152
-			if(file_exists($filePath)){
153
-				$logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
154
-				return $filePath;
155
-			}
156
-			$logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
157
-			return false;
158
-		}
135
+        /**
136
+         * Check if in module list can have this controller
137
+         * @param  string $class the controller class
138
+         * @param  string $module  the module name
139
+         * @return boolean|string  false or null if no module have this controller, path the full path of the controller
140
+         */
141
+        public static function findControllerFullPath($class, $module = null){
142
+            $logger = self::getLogger();
143
+            if(! self::hasModule()){
144
+                $logger->info('No module was loaded skiping.');
145
+                return false;
146
+            }
147
+            $class = str_ireplace('.php', '', $class);
148
+            $class = ucfirst($class);
149
+            $classFile = $class.'.php';
150
+            $logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
151
+            $filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
152
+            if(file_exists($filePath)){
153
+                $logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
154
+                return $filePath;
155
+            }
156
+            $logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
157
+            return false;
158
+        }
159 159
 
160
-		/**
161
-		 * Check if in module list can have this model
162
-		 * @param  string $class the model class
163
-		 * @param string $module the module name
164
-		 * @return boolean|string  false or null if no module have this model, return the full path of this model
165
-		 */
166
-		public static function findModelFullPath($class, $module = null){
167
-			$logger = self::getLogger();
168
-			if(! self::hasModule()){
169
-				$logger->info('No module was loaded skiping.');
170
-				return false;
171
-			}
172
-			$class = str_ireplace('.php', '', $class);
173
-			$class = ucfirst($class);
174
-			$classFile = $class.'.php';
175
-			$logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
176
-			$filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
177
-			if(file_exists($filePath)){
178
-				$logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
179
-				return $filePath;
180
-			}
181
-			$logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
182
-			return false;
183
-		}
160
+        /**
161
+         * Check if in module list can have this model
162
+         * @param  string $class the model class
163
+         * @param string $module the module name
164
+         * @return boolean|string  false or null if no module have this model, return the full path of this model
165
+         */
166
+        public static function findModelFullPath($class, $module = null){
167
+            $logger = self::getLogger();
168
+            if(! self::hasModule()){
169
+                $logger->info('No module was loaded skiping.');
170
+                return false;
171
+            }
172
+            $class = str_ireplace('.php', '', $class);
173
+            $class = ucfirst($class);
174
+            $classFile = $class.'.php';
175
+            $logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
176
+            $filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
177
+            if(file_exists($filePath)){
178
+                $logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
179
+                return $filePath;
180
+            }
181
+            $logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
182
+            return false;
183
+        }
184 184
 		
185
-		/**
186
-		 * Check if in module list can have this config
187
-		 * @param  string $configuration the config name
188
-		 * @param string $module the module name
189
-		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
190
-		 */
191
-		public static function findConfigFullPath($configuration, $module = null){
192
-			$logger = self::getLogger();
193
-			if(! self::hasModule()){
194
-				$logger->info('No module was loaded skiping.');
195
-				return false;
196
-			}
197
-			$configuration = str_ireplace('.php', '', $configuration);
198
-			$file = $configuration.'.php';
199
-			$logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
200
-			$filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
201
-			if(file_exists($filePath)){
202
-				$logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
203
-				return $filePath;
204
-			}
205
-			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
206
-			return false;
207
-		}
185
+        /**
186
+         * Check if in module list can have this config
187
+         * @param  string $configuration the config name
188
+         * @param string $module the module name
189
+         * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
190
+         */
191
+        public static function findConfigFullPath($configuration, $module = null){
192
+            $logger = self::getLogger();
193
+            if(! self::hasModule()){
194
+                $logger->info('No module was loaded skiping.');
195
+                return false;
196
+            }
197
+            $configuration = str_ireplace('.php', '', $configuration);
198
+            $file = $configuration.'.php';
199
+            $logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
200
+            $filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
201
+            if(file_exists($filePath)){
202
+                $logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
203
+                return $filePath;
204
+            }
205
+            $logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
206
+            return false;
207
+        }
208 208
 
209
-		/**
210
-		 * Check if in module list can have this helper
211
-		 * @param  string $helper the helper name
212
-		 * @param string $module the module name
213
-		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
214
-		 */
215
-		public static function findFunctionFullPath($helper, $module = null){
216
-			$logger = self::getLogger();
217
-			if(! self::hasModule()){
218
-				$logger->info('No module was loaded skiping.');
219
-				return false;
220
-			}
221
-			$helper = str_ireplace('.php', '', $helper);
222
-			$helper = str_ireplace('function_', '', $helper);
223
-			$file = 'function_'.$helper.'.php';
224
-			$logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
225
-			$filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
226
-			if(file_exists($filePath)){
227
-				$logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
228
-				return $filePath;
229
-			}
230
-			$logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
231
-			return false;
209
+        /**
210
+         * Check if in module list can have this helper
211
+         * @param  string $helper the helper name
212
+         * @param string $module the module name
213
+         * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
214
+         */
215
+        public static function findFunctionFullPath($helper, $module = null){
216
+            $logger = self::getLogger();
217
+            if(! self::hasModule()){
218
+                $logger->info('No module was loaded skiping.');
219
+                return false;
220
+            }
221
+            $helper = str_ireplace('.php', '', $helper);
222
+            $helper = str_ireplace('function_', '', $helper);
223
+            $file = 'function_'.$helper.'.php';
224
+            $logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
225
+            $filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
226
+            if(file_exists($filePath)){
227
+                $logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
228
+                return $filePath;
229
+            }
230
+            $logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
231
+            return false;
232 232
 			
233
-		}
233
+        }
234 234
 
235 235
 
236
-		/**
237
-		 * Check if in module list can have this library
238
-		 * @param  string $class the library name
239
-		 * @param string $module the module name
240
-		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
241
-		 */
242
-		public static function findLibraryFullPath($class, $module = null){
243
-			$logger = self::getLogger();
244
-			if(! self::hasModule()){
245
-				$logger->info('No module was loaded skiping.');
246
-				return false;
247
-			}
248
-			$class = str_ireplace('.php', '', $class);
249
-			$file = $class.'.php';
250
-			$logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
251
-			$filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
252
-			if(file_exists($filePath)){
253
-				$logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
254
-				return $filePath;
255
-			}
256
-			$logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
257
-			return false;
258
-		}
236
+        /**
237
+         * Check if in module list can have this library
238
+         * @param  string $class the library name
239
+         * @param string $module the module name
240
+         * @return boolean|string  false or null if no module have this library,  return the full path of this library
241
+         */
242
+        public static function findLibraryFullPath($class, $module = null){
243
+            $logger = self::getLogger();
244
+            if(! self::hasModule()){
245
+                $logger->info('No module was loaded skiping.');
246
+                return false;
247
+            }
248
+            $class = str_ireplace('.php', '', $class);
249
+            $file = $class.'.php';
250
+            $logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
251
+            $filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
252
+            if(file_exists($filePath)){
253
+                $logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
254
+                return $filePath;
255
+            }
256
+            $logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
257
+            return false;
258
+        }
259 259
 
260 260
 
261
-		/**
262
-		 * Check if in module list can have this view
263
-		 * @param  string $view the view path
264
-		 * @param string $module the module name to check
265
-		 * @return boolean|string  false or null if no module have this view, path the full path of the view
266
-		 */
267
-		public static function findViewFullPath($view, $module = null){
268
-			$logger = self::getLogger();
269
-			if(! self::hasModule()){
270
-				$logger->info('No module was loaded skiping.');
271
-				return false;
272
-			}
273
-			$view = str_ireplace('.php', '', $view);
274
-			$view = trim($view, '/\\');
275
-			$view = str_ireplace('/', DS, $view);
276
-			$viewFile = $view . '.php';
277
-			$logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
278
-			$filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
279
-			if(file_exists($filePath)){
280
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
281
-				return $filePath;
282
-			}
283
-			$logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
284
-			return false;
285
-		}
261
+        /**
262
+         * Check if in module list can have this view
263
+         * @param  string $view the view path
264
+         * @param string $module the module name to check
265
+         * @return boolean|string  false or null if no module have this view, path the full path of the view
266
+         */
267
+        public static function findViewFullPath($view, $module = null){
268
+            $logger = self::getLogger();
269
+            if(! self::hasModule()){
270
+                $logger->info('No module was loaded skiping.');
271
+                return false;
272
+            }
273
+            $view = str_ireplace('.php', '', $view);
274
+            $view = trim($view, '/\\');
275
+            $view = str_ireplace('/', DS, $view);
276
+            $viewFile = $view . '.php';
277
+            $logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
278
+            $filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
279
+            if(file_exists($filePath)){
280
+                $logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
281
+                return $filePath;
282
+            }
283
+            $logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
284
+            return false;
285
+        }
286 286
 
287
-		/**
288
-		 * Check if in module list can have this language
289
-		 * @param  string $language the language name
290
-		 * @param string $module the module name
291
-		 * @param string $appLang the application language like 'en', 'fr'
292
-		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
293
-		 */
294
-		public static function findLanguageFullPath($language, $module = null, $appLang){
295
-			$logger = self::getLogger();
296
-			if(! self::hasModule()){
297
-				$logger->info('No module was loaded skiping.');
298
-				return false;
299
-			}
300
-			$language = str_ireplace('.php', '', $language);
301
-			$language = str_ireplace('lang_', '', $language);
302
-			$file = 'lang_'.$language.'.php';
303
-			$logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
304
-			$filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
305
-			if(file_exists($filePath)){
306
-				$logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
307
-				return $filePath;
308
-			}
309
-			$logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
310
-			return false;
311
-		}
287
+        /**
288
+         * Check if in module list can have this language
289
+         * @param  string $language the language name
290
+         * @param string $module the module name
291
+         * @param string $appLang the application language like 'en', 'fr'
292
+         * @return boolean|string  false or null if no module have this language,  return the full path of this language
293
+         */
294
+        public static function findLanguageFullPath($language, $module = null, $appLang){
295
+            $logger = self::getLogger();
296
+            if(! self::hasModule()){
297
+                $logger->info('No module was loaded skiping.');
298
+                return false;
299
+            }
300
+            $language = str_ireplace('.php', '', $language);
301
+            $language = str_ireplace('lang_', '', $language);
302
+            $file = 'lang_'.$language.'.php';
303
+            $logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
304
+            $filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
305
+            if(file_exists($filePath)){
306
+                $logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
307
+                return $filePath;
308
+            }
309
+            $logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
310
+            return false;
311
+        }
312 312
 
313
-		/**
314
-		 * Get the list of module loaded
315
-		 * @return array the module list
316
-		 */
317
-		public static function getModuleList(){
318
-			return self::$list;
319
-		}
313
+        /**
314
+         * Get the list of module loaded
315
+         * @return array the module list
316
+         */
317
+        public static function getModuleList(){
318
+            return self::$list;
319
+        }
320 320
 
321
-		/**
322
-		 * Check if the application has an module
323
-		 * @return boolean
324
-		 */
325
-		public static function hasModule(){
326
-			return !empty(self::$list);
327
-		}
321
+        /**
322
+         * Check if the application has an module
323
+         * @return boolean
324
+         */
325
+        public static function hasModule(){
326
+            return !empty(self::$list);
327
+        }
328 328
 
329
-	}
329
+    }
Please login to merge, or discard this patch.
Spacing   +69 added lines, -69 removed lines patch added patch discarded remove patch
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
24 24
      * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25 25
     */
26 26
    
27
-	class Module{
27
+	class Module {
28 28
 		
29 29
 		/**
30 30
 		 * list of loaded module
@@ -42,9 +42,9 @@  discard block
 block discarded – undo
42 42
 		 * The signleton of the logger
43 43
 		 * @return Object the Log instance
44 44
 		 */
45
-		private static function getLogger(){
46
-			if(self::$logger == null){
47
-				self::$logger[0] =& class_loader('Log', 'classes');
45
+		private static function getLogger() {
46
+			if (self::$logger == null) {
47
+				self::$logger[0] = & class_loader('Log', 'classes');
48 48
 				self::$logger[0]->setLogger('Library::Module');
49 49
 			}
50 50
 			return self::$logger[0];
@@ -53,24 +53,24 @@  discard block
 block discarded – undo
53 53
 		/**
54 54
 		 * Initialise the module list by scanning the directory MODULE_PATH
55 55
 		 */
56
-		public function init(){
56
+		public function init() {
57 57
 			$logger = self::getLogger();
58 58
 			$logger->debug('Check if the application contains the modules ...');
59 59
 			$moduleDir = opendir(MODULE_PATH);
60
-			if(is_resource($moduleDir)){
61
-				while(($module = readdir($moduleDir)) !== false){
62
-					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
60
+			if (is_resource($moduleDir)) {
61
+				while (($module = readdir($moduleDir)) !== false) {
62
+					if (preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)) {
63 63
 						self::$list[] = $module;
64 64
 					}
65
-					else{
66
-						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
65
+					else {
66
+						$logger->info('Skipping [' . $module . '], may be this is not a directory or does not exists or is invalid name');
67 67
 					}
68 68
 				}
69 69
 				closedir($moduleDir);
70 70
 			}
71 71
 			ksort(self::$list);
72 72
 			
73
-			if(self::hasModule()){
73
+			if (self::hasModule()) {
74 74
 				$logger->info('The application contains the module below [' . implode(', ', self::getModuleList()) . ']');
75 75
 			}
76 76
 		}
@@ -79,9 +79,9 @@  discard block
 block discarded – undo
79 79
 		 * Get the list of the custom autoload configuration from module if exists
80 80
 		 * @return array|boolean the autoload configurations list or false if no module contains the autoload configuration values
81 81
 		 */
82
-		public static function getModulesAutoloadConfig(){
82
+		public static function getModulesAutoloadConfig() {
83 83
 			$logger = self::getLogger();
84
-			if(! self::hasModule()){
84
+			if (!self::hasModule()) {
85 85
 				$logger->info('No module was loaded skipping.');
86 86
 				return false;
87 87
 			}
@@ -94,10 +94,10 @@  discard block
 block discarded – undo
94 94
 			
95 95
 			foreach (self::$list as $module) {
96 96
 				$file = MODULE_PATH . $module . DS . 'config' . DS . 'autoload.php';
97
-				if(file_exists($file)){
97
+				if (file_exists($file)) {
98 98
 					$autoload = array();
99 99
 					require_once $file;
100
-					if(! empty($autoload) && is_array($autoload)){
100
+					if (!empty($autoload) && is_array($autoload)) {
101 101
 						$autoloads = array_merge_recursive($autoloads, $autoload);
102 102
 						unset($autoload);
103 103
 					}
@@ -110,19 +110,19 @@  discard block
 block discarded – undo
110 110
 		 * Get the list of the custom routes configuration from module if exists
111 111
 		 * @return array|boolean the routes list or false if no module contains the routes configuration
112 112
 		 */
113
-		public static function getModulesRoutes(){
113
+		public static function getModulesRoutes() {
114 114
 			$logger = self::getLogger();
115
-			if(! self::hasModule()){
115
+			if (!self::hasModule()) {
116 116
 				$logger->info('No module was loaded skipping.');
117 117
 				return false;
118 118
 			}
119 119
 			$routes = array();
120 120
 			foreach (self::$list as $module) {
121 121
 				$file = MODULE_PATH . $module . DS . 'config' . DS . 'routes.php';
122
-				if(file_exists($file)){
122
+				if (file_exists($file)) {
123 123
 					$route = array();
124 124
 					require_once $file;
125
-					if(! empty($route) && is_array($route)){
125
+					if (!empty($route) && is_array($route)) {
126 126
 						$routes = array_merge($routes, $route);
127 127
 						unset($route);
128 128
 					}
@@ -138,22 +138,22 @@  discard block
 block discarded – undo
138 138
 		 * @param  string $module  the module name
139 139
 		 * @return boolean|string  false or null if no module have this controller, path the full path of the controller
140 140
 		 */
141
-		public static function findControllerFullPath($class, $module = null){
141
+		public static function findControllerFullPath($class, $module = null) {
142 142
 			$logger = self::getLogger();
143
-			if(! self::hasModule()){
143
+			if (!self::hasModule()) {
144 144
 				$logger->info('No module was loaded skiping.');
145 145
 				return false;
146 146
 			}
147 147
 			$class = str_ireplace('.php', '', $class);
148 148
 			$class = ucfirst($class);
149
-			$classFile = $class.'.php';
150
-			$logger->debug('Checking the controller [' . $class . '] in module [' .$module. '] ...');
149
+			$classFile = $class . '.php';
150
+			$logger->debug('Checking the controller [' . $class . '] in module [' . $module . '] ...');
151 151
 			$filePath = MODULE_PATH . $module . DS . 'controllers' . DS . $classFile;
152
-			if(file_exists($filePath)){
153
-				$logger->info('Found controller [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
152
+			if (file_exists($filePath)) {
153
+				$logger->info('Found controller [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
154 154
 				return $filePath;
155 155
 			}
156
-			$logger->info('Controller [' . $class . '] does not exist in the module [' .$module. ']');
156
+			$logger->info('Controller [' . $class . '] does not exist in the module [' . $module . ']');
157 157
 			return false;
158 158
 		}
159 159
 
@@ -163,22 +163,22 @@  discard block
 block discarded – undo
163 163
 		 * @param string $module the module name
164 164
 		 * @return boolean|string  false or null if no module have this model, return the full path of this model
165 165
 		 */
166
-		public static function findModelFullPath($class, $module = null){
166
+		public static function findModelFullPath($class, $module = null) {
167 167
 			$logger = self::getLogger();
168
-			if(! self::hasModule()){
168
+			if (!self::hasModule()) {
169 169
 				$logger->info('No module was loaded skiping.');
170 170
 				return false;
171 171
 			}
172 172
 			$class = str_ireplace('.php', '', $class);
173 173
 			$class = ucfirst($class);
174
-			$classFile = $class.'.php';
175
-			$logger->debug('Checking model [' . $class . '] in module [' .$module. '] ...');
174
+			$classFile = $class . '.php';
175
+			$logger->debug('Checking model [' . $class . '] in module [' . $module . '] ...');
176 176
 			$filePath = MODULE_PATH . $module . DS . 'models' . DS . $classFile;
177
-			if(file_exists($filePath)){
178
-				$logger->info('Found model [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
177
+			if (file_exists($filePath)) {
178
+				$logger->info('Found model [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
179 179
 				return $filePath;
180 180
 			}
181
-			$logger->info('Model [' . $class . '] does not exist in the module [' .$module. ']');
181
+			$logger->info('Model [' . $class . '] does not exist in the module [' . $module . ']');
182 182
 			return false;
183 183
 		}
184 184
 		
@@ -188,21 +188,21 @@  discard block
 block discarded – undo
188 188
 		 * @param string $module the module name
189 189
 		 * @return boolean|string  false or null if no module have this configuration,  return the full path of this configuration
190 190
 		 */
191
-		public static function findConfigFullPath($configuration, $module = null){
191
+		public static function findConfigFullPath($configuration, $module = null) {
192 192
 			$logger = self::getLogger();
193
-			if(! self::hasModule()){
193
+			if (!self::hasModule()) {
194 194
 				$logger->info('No module was loaded skiping.');
195 195
 				return false;
196 196
 			}
197 197
 			$configuration = str_ireplace('.php', '', $configuration);
198
-			$file = $configuration.'.php';
199
-			$logger->debug('Checking configuration [' . $configuration . '] in module [' .$module. '] ...');
198
+			$file = $configuration . '.php';
199
+			$logger->debug('Checking configuration [' . $configuration . '] in module [' . $module . '] ...');
200 200
 			$filePath = MODULE_PATH . $module . DS . 'config' . DS . $file;
201
-			if(file_exists($filePath)){
202
-				$logger->info('Found configuration [' . $configuration . '] in module [' .$module. '], the file path is [' .$filePath. ']');
201
+			if (file_exists($filePath)) {
202
+				$logger->info('Found configuration [' . $configuration . '] in module [' . $module . '], the file path is [' . $filePath . ']');
203 203
 				return $filePath;
204 204
 			}
205
-			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' .$module. ']');
205
+			$logger->info('Configuration [' . $configuration . '] does not exist in the module [' . $module . ']');
206 206
 			return false;
207 207
 		}
208 208
 
@@ -212,22 +212,22 @@  discard block
 block discarded – undo
212 212
 		 * @param string $module the module name
213 213
 		 * @return boolean|string  false or null if no module have this helper,  return the full path of this helper
214 214
 		 */
215
-		public static function findFunctionFullPath($helper, $module = null){
215
+		public static function findFunctionFullPath($helper, $module = null) {
216 216
 			$logger = self::getLogger();
217
-			if(! self::hasModule()){
217
+			if (!self::hasModule()) {
218 218
 				$logger->info('No module was loaded skiping.');
219 219
 				return false;
220 220
 			}
221 221
 			$helper = str_ireplace('.php', '', $helper);
222 222
 			$helper = str_ireplace('function_', '', $helper);
223
-			$file = 'function_'.$helper.'.php';
224
-			$logger->debug('Checking helper [' . $helper . '] in module [' .$module. '] ...');
223
+			$file = 'function_' . $helper . '.php';
224
+			$logger->debug('Checking helper [' . $helper . '] in module [' . $module . '] ...');
225 225
 			$filePath = MODULE_PATH . $module . DS . 'functions' . DS . $file;
226
-			if(file_exists($filePath)){
227
-				$logger->info('Found helper [' . $helper . '] in module [' .$module. '], the file path is [' .$filePath. ']');
226
+			if (file_exists($filePath)) {
227
+				$logger->info('Found helper [' . $helper . '] in module [' . $module . '], the file path is [' . $filePath . ']');
228 228
 				return $filePath;
229 229
 			}
230
-			$logger->info('Helper [' . $helper . '] does not exist in the module [' .$module. ']');
230
+			$logger->info('Helper [' . $helper . '] does not exist in the module [' . $module . ']');
231 231
 			return false;
232 232
 			
233 233
 		}
@@ -239,21 +239,21 @@  discard block
 block discarded – undo
239 239
 		 * @param string $module the module name
240 240
 		 * @return boolean|string  false or null if no module have this library,  return the full path of this library
241 241
 		 */
242
-		public static function findLibraryFullPath($class, $module = null){
242
+		public static function findLibraryFullPath($class, $module = null) {
243 243
 			$logger = self::getLogger();
244
-			if(! self::hasModule()){
244
+			if (!self::hasModule()) {
245 245
 				$logger->info('No module was loaded skiping.');
246 246
 				return false;
247 247
 			}
248 248
 			$class = str_ireplace('.php', '', $class);
249
-			$file = $class.'.php';
250
-			$logger->debug('Checking library [' . $class . '] in module [' .$module. '] ...');
249
+			$file = $class . '.php';
250
+			$logger->debug('Checking library [' . $class . '] in module [' . $module . '] ...');
251 251
 			$filePath = MODULE_PATH . $module . DS . 'libraries' . DS . $file;
252
-			if(file_exists($filePath)){
253
-				$logger->info('Found library [' . $class . '] in module [' .$module. '], the file path is [' .$filePath. ']');
252
+			if (file_exists($filePath)) {
253
+				$logger->info('Found library [' . $class . '] in module [' . $module . '], the file path is [' . $filePath . ']');
254 254
 				return $filePath;
255 255
 			}
256
-			$logger->info('Library [' . $class . '] does not exist in the module [' .$module. ']');
256
+			$logger->info('Library [' . $class . '] does not exist in the module [' . $module . ']');
257 257
 			return false;
258 258
 		}
259 259
 
@@ -264,9 +264,9 @@  discard block
 block discarded – undo
264 264
 		 * @param string $module the module name to check
265 265
 		 * @return boolean|string  false or null if no module have this view, path the full path of the view
266 266
 		 */
267
-		public static function findViewFullPath($view, $module = null){
267
+		public static function findViewFullPath($view, $module = null) {
268 268
 			$logger = self::getLogger();
269
-			if(! self::hasModule()){
269
+			if (!self::hasModule()) {
270 270
 				$logger->info('No module was loaded skiping.');
271 271
 				return false;
272 272
 			}
@@ -274,13 +274,13 @@  discard block
 block discarded – undo
274 274
 			$view = trim($view, '/\\');
275 275
 			$view = str_ireplace('/', DS, $view);
276 276
 			$viewFile = $view . '.php';
277
-			$logger->debug('Checking view [' . $view . '] in module [' .$module. '] ...');
277
+			$logger->debug('Checking view [' . $view . '] in module [' . $module . '] ...');
278 278
 			$filePath = MODULE_PATH . $module . DS . 'views' . DS . $viewFile;
279
-			if(file_exists($filePath)){
280
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$filePath. ']');
279
+			if (file_exists($filePath)) {
280
+				$logger->info('Found view [' . $view . '] in module [' . $module . '], the file path is [' . $filePath . ']');
281 281
 				return $filePath;
282 282
 			}
283
-			$logger->info('View [' . $view . '] does not exist in the module [' .$module. ']');
283
+			$logger->info('View [' . $view . '] does not exist in the module [' . $module . ']');
284 284
 			return false;
285 285
 		}
286 286
 
@@ -291,22 +291,22 @@  discard block
 block discarded – undo
291 291
 		 * @param string $appLang the application language like 'en', 'fr'
292 292
 		 * @return boolean|string  false or null if no module have this language,  return the full path of this language
293 293
 		 */
294
-		public static function findLanguageFullPath($language, $module = null, $appLang){
294
+		public static function findLanguageFullPath($language, $module = null, $appLang) {
295 295
 			$logger = self::getLogger();
296
-			if(! self::hasModule()){
296
+			if (!self::hasModule()) {
297 297
 				$logger->info('No module was loaded skiping.');
298 298
 				return false;
299 299
 			}
300 300
 			$language = str_ireplace('.php', '', $language);
301 301
 			$language = str_ireplace('lang_', '', $language);
302
-			$file = 'lang_'.$language.'.php';
303
-			$logger->debug('Checking language [' . $language . '] in module [' .$module. '] ...');
302
+			$file = 'lang_' . $language . '.php';
303
+			$logger->debug('Checking language [' . $language . '] in module [' . $module . '] ...');
304 304
 			$filePath = MODULE_PATH . $module . DS . 'lang' . DS . $appLang . DS . $file;
305
-			if(file_exists($filePath)){
306
-				$logger->info('Found language [' . $language . '] in module [' .$module. '], the file path is [' .$filePath. ']');
305
+			if (file_exists($filePath)) {
306
+				$logger->info('Found language [' . $language . '] in module [' . $module . '], the file path is [' . $filePath . ']');
307 307
 				return $filePath;
308 308
 			}
309
-			$logger->info('Language [' . $language . '] does not exist in the module [' .$module. ']');
309
+			$logger->info('Language [' . $language . '] does not exist in the module [' . $module . ']');
310 310
 			return false;
311 311
 		}
312 312
 
@@ -314,7 +314,7 @@  discard block
 block discarded – undo
314 314
 		 * Get the list of module loaded
315 315
 		 * @return array the module list
316 316
 		 */
317
-		public static function getModuleList(){
317
+		public static function getModuleList() {
318 318
 			return self::$list;
319 319
 		}
320 320
 
@@ -322,7 +322,7 @@  discard block
 block discarded – undo
322 322
 		 * Check if the application has an module
323 323
 		 * @return boolean
324 324
 		 */
325
-		public static function hasModule(){
325
+		public static function hasModule() {
326 326
 			return !empty(self::$list);
327 327
 		}
328 328
 
Please login to merge, or discard this patch.
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -61,8 +61,7 @@
 block discarded – undo
61 61
 				while(($module = readdir($moduleDir)) !== false){
62 62
 					if(preg_match('/^([a-z0-9-_]+)$/i', $module) && is_dir(MODULE_PATH . $module)){
63 63
 						self::$list[] = $module;
64
-					}
65
-					else{
64
+					} else{
66 65
 						$logger->info('Skipping [' .$module. '], may be this is not a directory or does not exists or is invalid name');
67 66
 					}
68 67
 				}
Please login to merge, or discard this patch.
core/classes/Response.php 3 patches
Indentation   +484 added lines, -484 removed lines patch added patch discarded remove patch
@@ -1,538 +1,538 @@
 block discarded – undo
1 1
 <?php
2
-	defined('ROOT_PATH') or exit('Access denied');
3
-	/**
4
-	 * TNH Framework
5
-	 *
6
-	 * A simple PHP framework using HMVC architecture
7
-	 *
8
-	 * This content is released under the GNU GPL License (GPL)
9
-	 *
10
-	 * Copyright (C) 2017 Tony NGUEREZA
11
-	 *
12
-	 * This program is free software; you can redistribute it and/or
13
-	 * modify it under the terms of the GNU General Public License
14
-	 * as published by the Free Software Foundation; either version 3
15
-	 * of the License, or (at your option) any later version.
16
-	 *
17
-	 * This program is distributed in the hope that it will be useful,
18
-	 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
-	 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
-	 * GNU General Public License for more details.
21
-	 *
22
-	 * You should have received a copy of the GNU General Public License
23
-	 * along with this program; if not, write to the Free Software
24
-	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
-	*/
2
+    defined('ROOT_PATH') or exit('Access denied');
3
+    /**
4
+     * TNH Framework
5
+     *
6
+     * A simple PHP framework using HMVC architecture
7
+     *
8
+     * This content is released under the GNU GPL License (GPL)
9
+     *
10
+     * Copyright (C) 2017 Tony NGUEREZA
11
+     *
12
+     * This program is free software; you can redistribute it and/or
13
+     * modify it under the terms of the GNU General Public License
14
+     * as published by the Free Software Foundation; either version 3
15
+     * of the License, or (at your option) any later version.
16
+     *
17
+     * This program is distributed in the hope that it will be useful,
18
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
+     * GNU General Public License for more details.
21
+     *
22
+     * You should have received a copy of the GNU General Public License
23
+     * along with this program; if not, write to the Free Software
24
+     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25
+     */
26 26
 
27
-	class Response{
27
+    class Response{
28 28
 
29
-		/**
30
-		 * The list of request header to send with response
31
-		 * @var array
32
-		 */
33
-		private static $headers = array();
29
+        /**
30
+         * The list of request header to send with response
31
+         * @var array
32
+         */
33
+        private static $headers = array();
34 34
 
35
-		/**
36
-		 * The logger instance
37
-		 * @var object
38
-		 */
39
-		private static $logger;
35
+        /**
36
+         * The logger instance
37
+         * @var object
38
+         */
39
+        private static $logger;
40 40
 		
41
-		/**
42
-		 * The final page content to display to user
43
-		 * @var string
44
-		 */
45
-		private $_pageRender = null;
41
+        /**
42
+         * The final page content to display to user
43
+         * @var string
44
+         */
45
+        private $_pageRender = null;
46 46
 		
47
-		/**
48
-		 * The current request URL
49
-		 * @var string
50
-		 */
51
-		private $_currentUrl = null;
47
+        /**
48
+         * The current request URL
49
+         * @var string
50
+         */
51
+        private $_currentUrl = null;
52 52
 		
53
-		/**
54
-		 * The current request URL cache key
55
-		 * @var string
56
-		 */
57
-		private $_currentUrlCacheKey = null;
53
+        /**
54
+         * The current request URL cache key
55
+         * @var string
56
+         */
57
+        private $_currentUrlCacheKey = null;
58 58
 		
59
-		/**
60
-		* Whether we can compress the output using Gzip
61
-		* @var boolean
62
-		*/
63
-		private static $_canCompressOutput = false;
59
+        /**
60
+         * Whether we can compress the output using Gzip
61
+         * @var boolean
62
+         */
63
+        private static $_canCompressOutput = false;
64 64
 		
65
-		/**
66
-		 * Construct new response instance
67
-		 */
68
-		public function __construct(){
69
-			$currentUrl = '';
70
-			if (! empty($_SERVER['REQUEST_URI'])){
71
-				$currentUrl = $_SERVER['REQUEST_URI'];
72
-			}
73
-			if (! empty($_SERVER['QUERY_STRING'])){
74
-				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
75
-			}
76
-			$this->_currentUrl =  $currentUrl;
65
+        /**
66
+         * Construct new response instance
67
+         */
68
+        public function __construct(){
69
+            $currentUrl = '';
70
+            if (! empty($_SERVER['REQUEST_URI'])){
71
+                $currentUrl = $_SERVER['REQUEST_URI'];
72
+            }
73
+            if (! empty($_SERVER['QUERY_STRING'])){
74
+                $currentUrl .= '?' . $_SERVER['QUERY_STRING'];
75
+            }
76
+            $this->_currentUrl =  $currentUrl;
77 77
 					
78
-			$this->_currentUrlCacheKey = md5($this->_currentUrl);
78
+            $this->_currentUrlCacheKey = md5($this->_currentUrl);
79 79
 			
80
-			self::$_canCompressOutput = get_config('compress_output')
81
-										  && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
82
-										  && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
83
-										  && extension_loaded('zlib')
84
-										  && (bool) ini_get('zlib.output_compression') === false;
85
-		}
80
+            self::$_canCompressOutput = get_config('compress_output')
81
+                                          && isset($_SERVER['HTTP_ACCEPT_ENCODING']) 
82
+                                          && stripos($_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip') !== false 
83
+                                          && extension_loaded('zlib')
84
+                                          && (bool) ini_get('zlib.output_compression') === false;
85
+        }
86 86
 
87 87
 		
88
-		/**
89
-		 * The signleton of the logger
90
-		 * @return Object the Log instance
91
-		 */
92
-		public static function getLogger(){
93
-			if(self::$logger == null){
94
-				$logger = array();
95
-				$logger[0] =& class_loader('Log', 'classes');
96
-				$logger[0]->setLogger('Library::Response');
97
-				self::$logger = $logger[0];
98
-			}
99
-			return self::$logger;			
100
-		}
88
+        /**
89
+         * The signleton of the logger
90
+         * @return Object the Log instance
91
+         */
92
+        public static function getLogger(){
93
+            if(self::$logger == null){
94
+                $logger = array();
95
+                $logger[0] =& class_loader('Log', 'classes');
96
+                $logger[0]->setLogger('Library::Response');
97
+                self::$logger = $logger[0];
98
+            }
99
+            return self::$logger;			
100
+        }
101 101
 
102
-		/**
103
-		 * Set the log instance for future use
104
-		 * @param object $logger the log object
105
-		 * @return object the log instance
106
-		 */
107
-		public static function setLogger($logger){
108
-			self::$logger = $logger;
109
-			return self::$logger;
110
-		}
102
+        /**
103
+         * Set the log instance for future use
104
+         * @param object $logger the log object
105
+         * @return object the log instance
106
+         */
107
+        public static function setLogger($logger){
108
+            self::$logger = $logger;
109
+            return self::$logger;
110
+        }
111 111
 
112 112
 
113
-		/**
114
-		 * Send the HTTP Response headers
115
-		 * @param  integer $httpCode the HTTP status code
116
-		 * @param  array   $headers   the additional headers to add to the existing headers list
117
-		 */
118
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
119
-			set_http_status_header($httpCode);
120
-			self::setHeaders($headers);
121
-			if(! headers_sent()){
122
-				foreach(self::getHeaders() as $key => $value){
123
-					header($key .': '.$value);
124
-				}
125
-			}
126
-		}
113
+        /**
114
+         * Send the HTTP Response headers
115
+         * @param  integer $httpCode the HTTP status code
116
+         * @param  array   $headers   the additional headers to add to the existing headers list
117
+         */
118
+        public static function sendHeaders($httpCode = 200, array $headers = array()){
119
+            set_http_status_header($httpCode);
120
+            self::setHeaders($headers);
121
+            if(! headers_sent()){
122
+                foreach(self::getHeaders() as $key => $value){
123
+                    header($key .': '.$value);
124
+                }
125
+            }
126
+        }
127 127
 
128
-		/**
129
-		 * Get the list of the headers
130
-		 * @return array the headers list
131
-		 */
132
-		public static function getHeaders(){
133
-			return self::$headers;
134
-		}
128
+        /**
129
+         * Get the list of the headers
130
+         * @return array the headers list
131
+         */
132
+        public static function getHeaders(){
133
+            return self::$headers;
134
+        }
135 135
 
136
-		/**
137
-		 * Get the header value for the given name
138
-		 * @param  string $name the header name
139
-		 * @return string|null       the header value
140
-		 */
141
-		public static function getHeader($name){
142
-			if(array_key_exists($name, self::$headers)){
143
-				return self::$headers[$name];
144
-			}
145
-			return null;
146
-		}
136
+        /**
137
+         * Get the header value for the given name
138
+         * @param  string $name the header name
139
+         * @return string|null       the header value
140
+         */
141
+        public static function getHeader($name){
142
+            if(array_key_exists($name, self::$headers)){
143
+                return self::$headers[$name];
144
+            }
145
+            return null;
146
+        }
147 147
 
148 148
 
149
-		/**
150
-		 * Set the header value for the specified name
151
-		 * @param string $name  the header name
152
-		 * @param string $value the header value to be set
153
-		 */
154
-		public static function setHeader($name, $value){
155
-			self::$headers[$name] = $value;
156
-		}
149
+        /**
150
+         * Set the header value for the specified name
151
+         * @param string $name  the header name
152
+         * @param string $value the header value to be set
153
+         */
154
+        public static function setHeader($name, $value){
155
+            self::$headers[$name] = $value;
156
+        }
157 157
 
158
-		/**
159
-		 * Set the headers using array
160
-		 * @param array $headers the list of the headers to set. 
161
-		 * Note: this will merge with the existing headers
162
-		 */
163
-		public static function setHeaders(array $headers){
164
-			self::$headers = array_merge(self::getHeaders(), $headers);
165
-		}
158
+        /**
159
+         * Set the headers using array
160
+         * @param array $headers the list of the headers to set. 
161
+         * Note: this will merge with the existing headers
162
+         */
163
+        public static function setHeaders(array $headers){
164
+            self::$headers = array_merge(self::getHeaders(), $headers);
165
+        }
166 166
 		
167
-		/**
168
-		 * Redirect user to the specified page
169
-		 * @param  string $path the URL or URI to be redirect to
170
-		 */
171
-		public static function redirect($path = ''){
172
-			$logger = self::getLogger();
173
-			$url = Url::site_url($path);
174
-			$logger->info('Redirect to URL [' .$url. ']');
175
-			if(! headers_sent()){
176
-				header('Location: '.$url);
177
-				exit;
178
-			}
179
-			echo '<script>
167
+        /**
168
+         * Redirect user to the specified page
169
+         * @param  string $path the URL or URI to be redirect to
170
+         */
171
+        public static function redirect($path = ''){
172
+            $logger = self::getLogger();
173
+            $url = Url::site_url($path);
174
+            $logger->info('Redirect to URL [' .$url. ']');
175
+            if(! headers_sent()){
176
+                header('Location: '.$url);
177
+                exit;
178
+            }
179
+            echo '<script>
180 180
 					location.href = "'.$url.'";
181 181
 				</script>';
182
-		}
182
+        }
183 183
 
184
-		/**
185
-		 * Render the view to display later or return the content
186
-		 * @param  string  $view   the view name or path
187
-		 * @param  array|object   $data   the variable data to use in the view
188
-		 * @param  boolean $return whether to return the view generated content or display it directly
189
-		 * @return void|string          if $return is true will return the view content otherwise
190
-		 * will display the view content.
191
-		 */
192
-		public function render($view, $data = null, $return = false){
193
-			$logger = self::getLogger();
194
-			//convert data to an array
195
-			$data = (array) $data;
196
-			$view = str_ireplace('.php', '', $view);
197
-			$view = trim($view, '/\\');
198
-			$viewFile = $view . '.php';
199
-			$path = APPS_VIEWS_PATH . $viewFile;
184
+        /**
185
+         * Render the view to display later or return the content
186
+         * @param  string  $view   the view name or path
187
+         * @param  array|object   $data   the variable data to use in the view
188
+         * @param  boolean $return whether to return the view generated content or display it directly
189
+         * @return void|string          if $return is true will return the view content otherwise
190
+         * will display the view content.
191
+         */
192
+        public function render($view, $data = null, $return = false){
193
+            $logger = self::getLogger();
194
+            //convert data to an array
195
+            $data = (array) $data;
196
+            $view = str_ireplace('.php', '', $view);
197
+            $view = trim($view, '/\\');
198
+            $viewFile = $view . '.php';
199
+            $path = APPS_VIEWS_PATH . $viewFile;
200 200
 			
201
-			//check in module first
202
-			$logger->debug('Checking the view [' . $view . '] from module list ...');
203
-			$moduleInfo = self::getModuleInfoForView($view);
204
-			$module    = $moduleInfo['module'];
205
-			$view  = $moduleInfo['view'];
206
-			if(! empty($moduleInfo['viewFile'])){
207
-				$viewFile = $moduleInfo['viewFile'];
208
-			}
209
-			$moduleViewPath = Module::findViewFullPath($view, $module);
210
-			if($moduleViewPath){
211
-				$path = $moduleViewPath;
212
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
213
-			}
214
-			else{
215
-				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
216
-			}
201
+            //check in module first
202
+            $logger->debug('Checking the view [' . $view . '] from module list ...');
203
+            $moduleInfo = self::getModuleInfoForView($view);
204
+            $module    = $moduleInfo['module'];
205
+            $view  = $moduleInfo['view'];
206
+            if(! empty($moduleInfo['viewFile'])){
207
+                $viewFile = $moduleInfo['viewFile'];
208
+            }
209
+            $moduleViewPath = Module::findViewFullPath($view, $module);
210
+            if($moduleViewPath){
211
+                $path = $moduleViewPath;
212
+                $logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
213
+            }
214
+            else{
215
+                $logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
216
+            }
217 217
 			
218
-			$logger->info('The view file path to be loaded is [' . $path . ']');
218
+            $logger->info('The view file path to be loaded is [' . $path . ']');
219 219
 			
220
-			/////////
221
-			if($return){
222
-				return $this->loadView($path, $data, true);
223
-			}
224
-			$this->loadView($path, $data, false);
225
-		}
220
+            /////////
221
+            if($return){
222
+                return $this->loadView($path, $data, true);
223
+            }
224
+            $this->loadView($path, $data, false);
225
+        }
226 226
 
227 227
 		
228
-		/**
229
-		* Send the final page output to user
230
-		*/
231
-		public function renderFinalPage(){
232
-			$logger = self::getLogger();
233
-			$obj = & get_instance();
234
-			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
235
-			$dispatcher = $obj->eventdispatcher;
236
-			$content = $this->_pageRender;
237
-			if(! $content){
238
-				$logger->warning('The final view content is empty.');
239
-				return;
240
-			}
241
-			//dispatch
242
-			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
243
-			$content = null;
244
-			if(! empty($event->payload)){
245
-				$content = $event->payload;
246
-			}
247
-			if(empty($content)){
248
-				$logger->warning('The view content is empty after dispatch to event listeners.');
249
-			}
228
+        /**
229
+         * Send the final page output to user
230
+         */
231
+        public function renderFinalPage(){
232
+            $logger = self::getLogger();
233
+            $obj = & get_instance();
234
+            $cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
235
+            $dispatcher = $obj->eventdispatcher;
236
+            $content = $this->_pageRender;
237
+            if(! $content){
238
+                $logger->warning('The final view content is empty.');
239
+                return;
240
+            }
241
+            //dispatch
242
+            $event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
243
+            $content = null;
244
+            if(! empty($event->payload)){
245
+                $content = $event->payload;
246
+            }
247
+            if(empty($content)){
248
+                $logger->warning('The view content is empty after dispatch to event listeners.');
249
+            }
250 250
 			
251
-			//check whether need save the page into cache.
252
-			if($cachePageStatus){
253
-				$this->savePageContentIntoCache($content);
254
-			}
251
+            //check whether need save the page into cache.
252
+            if($cachePageStatus){
253
+                $this->savePageContentIntoCache($content);
254
+            }
255 255
 			
256
-			// Parse out the elapsed time and memory usage,
257
-			// then swap the pseudo-variables with the data
258
-			$elapsedTime = $obj->benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
259
-			$memoryUsage	= round($obj->benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
260
-			$content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
256
+            // Parse out the elapsed time and memory usage,
257
+            // then swap the pseudo-variables with the data
258
+            $elapsedTime = $obj->benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
259
+            $memoryUsage	= round($obj->benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
260
+            $content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
261 261
 			
262
-			//compress the output if is available
263
-			$type = null;
264
-			if (self::$_canCompressOutput){
265
-				$type = 'ob_gzhandler';
266
-			}
267
-			ob_start($type);
268
-			self::sendHeaders(200);
269
-			echo $content;
270
-			ob_end_flush();
271
-		}
262
+            //compress the output if is available
263
+            $type = null;
264
+            if (self::$_canCompressOutput){
265
+                $type = 'ob_gzhandler';
266
+            }
267
+            ob_start($type);
268
+            self::sendHeaders(200);
269
+            echo $content;
270
+            ob_end_flush();
271
+        }
272 272
 
273 273
 		
274
-		/**
275
-		* Send the final page output to user if is cached
276
-		* @param object $cache the cache instance
277
-		*
278
-		* @return boolean whether the page content if available or not
279
-		*/
280
-		public function renderFinalPageFromCache(&$cache){
281
-			$logger = self::getLogger();
282
-			//the current page cache key for identification
283
-			$pageCacheKey = $this->_currentUrlCacheKey;
274
+        /**
275
+         * Send the final page output to user if is cached
276
+         * @param object $cache the cache instance
277
+         *
278
+         * @return boolean whether the page content if available or not
279
+         */
280
+        public function renderFinalPageFromCache(&$cache){
281
+            $logger = self::getLogger();
282
+            //the current page cache key for identification
283
+            $pageCacheKey = $this->_currentUrlCacheKey;
284 284
 			
285
-			$logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
286
-			//get the cache information to prepare header to send to browser
287
-			$cacheInfo = $cache->getInfo($pageCacheKey);
288
-			if($cacheInfo){
289
-				$status = $this->sendCacheNotYetExpireInfo($cacheInfo);
290
-				if($status === false){
291
-					return $this->sendPageContentToBrowser($cache);
292
-				}
293
-			}
294
-			return false;
295
-		}
285
+            $logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
286
+            //get the cache information to prepare header to send to browser
287
+            $cacheInfo = $cache->getInfo($pageCacheKey);
288
+            if($cacheInfo){
289
+                $status = $this->sendCacheNotYetExpireInfo($cacheInfo);
290
+                if($status === false){
291
+                    return $this->sendPageContentToBrowser($cache);
292
+                }
293
+            }
294
+            return false;
295
+        }
296 296
 	
297 297
 		
298
-		/**
299
-		* Get the final page to be rendered
300
-		* @return string
301
-		*/
302
-		public function getFinalPageRendered(){
303
-			return $this->_pageRender;
304
-		}
298
+        /**
299
+         * Get the final page to be rendered
300
+         * @return string
301
+         */
302
+        public function getFinalPageRendered(){
303
+            return $this->_pageRender;
304
+        }
305 305
 
306
-		/**
307
-		 * Send the HTTP 404 error if can not found the 
308
-		 * routing information for the current request
309
-		 */
310
-		public static function send404(){
311
-			/********* for logs **************/
312
-			//can't use $obj = & get_instance()  here because the global super object will be available until
313
-			//the main controller is loaded even for Loader::library('xxxx');
314
-			$logger = self::getLogger();
315
-			$request =& class_loader('Request', 'classes');
316
-			$userAgent =& class_loader('Browser');
317
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
306
+        /**
307
+         * Send the HTTP 404 error if can not found the 
308
+         * routing information for the current request
309
+         */
310
+        public static function send404(){
311
+            /********* for logs **************/
312
+            //can't use $obj = & get_instance()  here because the global super object will be available until
313
+            //the main controller is loaded even for Loader::library('xxxx');
314
+            $logger = self::getLogger();
315
+            $request =& class_loader('Request', 'classes');
316
+            $userAgent =& class_loader('Browser');
317
+            $browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
318 318
 			
319
-			//here can't use Loader::functions just include the helper manually
320
-			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
319
+            //here can't use Loader::functions just include the helper manually
320
+            require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
321 321
 
322
-			$str = '[404 page not found] : ';
323
-			$str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
324
-			$logger->error($str);
325
-			/***********************************/
326
-			$path = CORE_VIEWS_PATH . '404.php';
327
-			if(file_exists($path)){
328
-				//compress the output if is available
329
-				$type = null;
330
-				if (self::$_canCompressOutput){
331
-					$type = 'ob_gzhandler';
332
-				}
333
-				ob_start($type);
334
-				require_once $path;
335
-				$output = ob_get_clean();
336
-				self::sendHeaders(404);
337
-				echo $output;
338
-			}
339
-			else{
340
-				show_error('The 404 view [' .$path. '] does not exist');
341
-			}
342
-		}
322
+            $str = '[404 page not found] : ';
323
+            $str .= ' Unable to find the request page [' . $request->requestUri() . ']. The visitor IP address [' . get_ip() . '], browser [' . $browser . ']';
324
+            $logger->error($str);
325
+            /***********************************/
326
+            $path = CORE_VIEWS_PATH . '404.php';
327
+            if(file_exists($path)){
328
+                //compress the output if is available
329
+                $type = null;
330
+                if (self::$_canCompressOutput){
331
+                    $type = 'ob_gzhandler';
332
+                }
333
+                ob_start($type);
334
+                require_once $path;
335
+                $output = ob_get_clean();
336
+                self::sendHeaders(404);
337
+                echo $output;
338
+            }
339
+            else{
340
+                show_error('The 404 view [' .$path. '] does not exist');
341
+            }
342
+        }
343 343
 
344
-		/**
345
-		 * Display the error to user
346
-		 * @param  array  $data the error information
347
-		 */
348
-		public static function sendError(array $data = array()){
349
-			$path = CORE_VIEWS_PATH . 'errors.php';
350
-			if(file_exists($path)){
351
-				//compress the output if is available
352
-				$type = null;
353
-				if (self::$_canCompressOutput){
354
-					$type = 'ob_gzhandler';
355
-				}
356
-				ob_start($type);
357
-				extract($data);
358
-				require_once $path;
359
-				$output = ob_get_clean();
360
-				self::sendHeaders(503);
361
-				echo $output;
362
-			}
363
-			else{
364
-				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
365
-				set_http_status_header(503);
366
-				echo 'The error view [' . $path . '] does not exist';
367
-			}
368
-		}
344
+        /**
345
+         * Display the error to user
346
+         * @param  array  $data the error information
347
+         */
348
+        public static function sendError(array $data = array()){
349
+            $path = CORE_VIEWS_PATH . 'errors.php';
350
+            if(file_exists($path)){
351
+                //compress the output if is available
352
+                $type = null;
353
+                if (self::$_canCompressOutput){
354
+                    $type = 'ob_gzhandler';
355
+                }
356
+                ob_start($type);
357
+                extract($data);
358
+                require_once $path;
359
+                $output = ob_get_clean();
360
+                self::sendHeaders(503);
361
+                echo $output;
362
+            }
363
+            else{
364
+                //can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
365
+                set_http_status_header(503);
366
+                echo 'The error view [' . $path . '] does not exist';
367
+            }
368
+        }
369 369
 
370
-		/**
371
-		 * Send the cache not yet expire to browser
372
-		 * @param  array $cacheInfo the cache information
373
-		 * @return boolean            true if the information is sent otherwise false
374
-		 */
375
-		protected function sendCacheNotYetExpireInfo($cacheInfo){
376
-			if(! empty($cacheInfo)){
377
-				$logger = self::getLogger();
378
-				$lastModified = $cacheInfo['mtime'];
379
-				$expire = $cacheInfo['expire'];
380
-				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
381
-				self::setHeader('Pragma', 'public');
382
-				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
383
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
384
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
385
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
386
-					$logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
387
-					self::sendHeaders(304);
388
-					return true;
389
-				}
390
-			}
391
-			return false;
392
-		}
370
+        /**
371
+         * Send the cache not yet expire to browser
372
+         * @param  array $cacheInfo the cache information
373
+         * @return boolean            true if the information is sent otherwise false
374
+         */
375
+        protected function sendCacheNotYetExpireInfo($cacheInfo){
376
+            if(! empty($cacheInfo)){
377
+                $logger = self::getLogger();
378
+                $lastModified = $cacheInfo['mtime'];
379
+                $expire = $cacheInfo['expire'];
380
+                $maxAge = $expire - $_SERVER['REQUEST_TIME'];
381
+                self::setHeader('Pragma', 'public');
382
+                self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
383
+                self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
384
+                self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
385
+                if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
386
+                    $logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
387
+                    self::sendHeaders(304);
388
+                    return true;
389
+                }
390
+            }
391
+            return false;
392
+        }
393 393
 
394
-		/**
395
-		 * Send the page content from cache to browser
396
-		 * @param object $cache the cache instance
397
-		 * @return boolean     the status of the operation
398
-		 */
399
-		protected function sendPageContentToBrowser(&$cache){
400
-			$logger = self::getLogger();
401
-			$logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
402
-			self::sendHeaders(200);
403
-			//current page cache key
404
-			$pageCacheKey = $this->_currentUrlCacheKey;
405
-			//get the cache content
406
-			$content = $cache->get($pageCacheKey);
407
-			if($content){
408
-				$logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
409
-				//load benchmark class
410
-				$benchmark = & class_loader('Benchmark');
394
+        /**
395
+         * Send the page content from cache to browser
396
+         * @param object $cache the cache instance
397
+         * @return boolean     the status of the operation
398
+         */
399
+        protected function sendPageContentToBrowser(&$cache){
400
+            $logger = self::getLogger();
401
+            $logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
402
+            self::sendHeaders(200);
403
+            //current page cache key
404
+            $pageCacheKey = $this->_currentUrlCacheKey;
405
+            //get the cache content
406
+            $content = $cache->get($pageCacheKey);
407
+            if($content){
408
+                $logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
409
+                //load benchmark class
410
+                $benchmark = & class_loader('Benchmark');
411 411
 				
412
-				// Parse out the elapsed time and memory usage,
413
-				// then swap the pseudo-variables with the data
414
-				$elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
415
-				$memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
416
-				$content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
412
+                // Parse out the elapsed time and memory usage,
413
+                // then swap the pseudo-variables with the data
414
+                $elapsedTime = $benchmark->elapsedTime('APP_EXECUTION_START', 'APP_EXECUTION_END');
415
+                $memoryUsage	= round($benchmark->memoryUsage('APP_EXECUTION_START', 'APP_EXECUTION_END') / 1024 / 1024, 6) . 'MB';
416
+                $content = str_replace(array('{elapsed_time}', '{memory_usage}'), array($elapsedTime, $memoryUsage), $content);
417 417
 				
418
-				///display the final output
419
-				//compress the output if is available
420
-				$type = null;
421
-				if (self::$_canCompressOutput){
422
-					$type = 'ob_gzhandler';
423
-				}
424
-				ob_start($type);
425
-				echo $content;
426
-				ob_end_flush();
427
-				return true;
428
-			}
429
-			$logger->info('The page cache content for the URL [' . $this->_currentUrl . '] is not valid may be already expired');
430
-			$cache->delete($pageCacheKey);
431
-			return false;
432
-		}
418
+                ///display the final output
419
+                //compress the output if is available
420
+                $type = null;
421
+                if (self::$_canCompressOutput){
422
+                    $type = 'ob_gzhandler';
423
+                }
424
+                ob_start($type);
425
+                echo $content;
426
+                ob_end_flush();
427
+                return true;
428
+            }
429
+            $logger->info('The page cache content for the URL [' . $this->_currentUrl . '] is not valid may be already expired');
430
+            $cache->delete($pageCacheKey);
431
+            return false;
432
+        }
433 433
 
434
-		/**
435
-		 * Save the content of page into cache
436
-		 * @param  string $content the page content to be saved
437
-		 * @return void
438
-		 */
439
-		protected function savePageContentIntoCache($content){
440
-			$obj = & get_instance();
441
-			$logger = self::getLogger();
434
+        /**
435
+         * Save the content of page into cache
436
+         * @param  string $content the page content to be saved
437
+         * @return void
438
+         */
439
+        protected function savePageContentIntoCache($content){
440
+            $obj = & get_instance();
441
+            $logger = self::getLogger();
442 442
 
443
-			//current page URL
444
-			$url = $this->_currentUrl;
445
-			//Cache view Time to live in second
446
-			$viewCacheTtl = get_config('cache_ttl');
447
-			if (!empty($obj->view_cache_ttl)){
448
-				$viewCacheTtl = $obj->view_cache_ttl;
449
-			}
450
-			//the cache handler instance
451
-			$cacheInstance = $obj->cache;
452
-			//the current page cache key for identification
453
-			$cacheKey = $this->_currentUrlCacheKey;
443
+            //current page URL
444
+            $url = $this->_currentUrl;
445
+            //Cache view Time to live in second
446
+            $viewCacheTtl = get_config('cache_ttl');
447
+            if (!empty($obj->view_cache_ttl)){
448
+                $viewCacheTtl = $obj->view_cache_ttl;
449
+            }
450
+            //the cache handler instance
451
+            $cacheInstance = $obj->cache;
452
+            //the current page cache key for identification
453
+            $cacheKey = $this->_currentUrlCacheKey;
454 454
 			
455
-			$logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
456
-			$cacheInstance->set($cacheKey, $content, $viewCacheTtl);
455
+            $logger->debug('Save the page content for URL [' . $url . '] into the cache ...');
456
+            $cacheInstance->set($cacheKey, $content, $viewCacheTtl);
457 457
 			
458
-			//get the cache information to prepare header to send to browser
459
-			$cacheInfo = $cacheInstance->getInfo($cacheKey);
460
-			if($cacheInfo){
461
-				$lastModified = $cacheInfo['mtime'];
462
-				$expire = $cacheInfo['expire'];
463
-				$maxAge = $expire - time();
464
-				self::setHeader('Pragma', 'public');
465
-				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
466
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
467
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
468
-			}
469
-		}
458
+            //get the cache information to prepare header to send to browser
459
+            $cacheInfo = $cacheInstance->getInfo($cacheKey);
460
+            if($cacheInfo){
461
+                $lastModified = $cacheInfo['mtime'];
462
+                $expire = $cacheInfo['expire'];
463
+                $maxAge = $expire - time();
464
+                self::setHeader('Pragma', 'public');
465
+                self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
466
+                self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
467
+                self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
468
+            }
469
+        }
470 470
 		
471 471
 
472
-		/**
473
-		 * Get the module information for the view to load
474
-		 * @param  string $view the view name like moduleName/viewName, viewName
475
-		 * 
476
-		 * @return array        the module information
477
-		 * array(
478
-		 * 	'module'=> 'module_name'
479
-		 * 	'view' => 'view_name'
480
-		 * 	'viewFile' => 'view_file'
481
-		 * )
482
-		 */
483
-		protected  function getModuleInfoForView($view){
484
-			$module = null;
485
-			$viewFile = null;
486
-			$obj = & get_instance();
487
-			//check if the request class contains module name
488
-			if(strpos($view, '/') !== false){
489
-				$viewPath = explode('/', $view);
490
-				if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
491
-					$module = $viewPath[0];
492
-					array_shift($viewPath);
493
-					$view = implode('/', $viewPath);
494
-					$viewFile = $view . '.php';
495
-				}
496
-			}
497
-			if(! $module && !empty($obj->moduleName)){
498
-				$module = $obj->moduleName;
499
-			}
500
-			return array(
501
-						'view' => $view,
502
-						'module' => $module,
503
-						'viewFile' => $viewFile
504
-					);
505
-		}
472
+        /**
473
+         * Get the module information for the view to load
474
+         * @param  string $view the view name like moduleName/viewName, viewName
475
+         * 
476
+         * @return array        the module information
477
+         * array(
478
+         * 	'module'=> 'module_name'
479
+         * 	'view' => 'view_name'
480
+         * 	'viewFile' => 'view_file'
481
+         * )
482
+         */
483
+        protected  function getModuleInfoForView($view){
484
+            $module = null;
485
+            $viewFile = null;
486
+            $obj = & get_instance();
487
+            //check if the request class contains module name
488
+            if(strpos($view, '/') !== false){
489
+                $viewPath = explode('/', $view);
490
+                if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
491
+                    $module = $viewPath[0];
492
+                    array_shift($viewPath);
493
+                    $view = implode('/', $viewPath);
494
+                    $viewFile = $view . '.php';
495
+                }
496
+            }
497
+            if(! $module && !empty($obj->moduleName)){
498
+                $module = $obj->moduleName;
499
+            }
500
+            return array(
501
+                        'view' => $view,
502
+                        'module' => $module,
503
+                        'viewFile' => $viewFile
504
+                    );
505
+        }
506 506
 
507
-		/**
508
-		 * Render the view page
509
-		 * @see  Response::render
510
-		 * @return void|string
511
-		 */
512
-		protected  function loadView($path, array $data = array(), $return = false){
513
-			$found = false;
514
-			if(file_exists($path)){
515
-				//super instance
516
-				$obj = & get_instance();
517
-				foreach(get_object_vars($obj) as $key => $value){
518
-					if(! isset($this->{$key})){
519
-						$this->{$key} = & $obj->{$key};
520
-					}
521
-				}
522
-				ob_start();
523
-				extract($data);
524
-				//need use require() instead of require_once because can load this view many time
525
-				require $path;
526
-				$content = ob_get_clean();
527
-				if($return){
528
-					return $content;
529
-				}
530
-				$this->_pageRender .= $content;
531
-				$found = true;
532
-			}
533
-			if(! $found){
534
-				show_error('Unable to find view [' .$view . ']');
535
-			}
536
-		}
507
+        /**
508
+         * Render the view page
509
+         * @see  Response::render
510
+         * @return void|string
511
+         */
512
+        protected  function loadView($path, array $data = array(), $return = false){
513
+            $found = false;
514
+            if(file_exists($path)){
515
+                //super instance
516
+                $obj = & get_instance();
517
+                foreach(get_object_vars($obj) as $key => $value){
518
+                    if(! isset($this->{$key})){
519
+                        $this->{$key} = & $obj->{$key};
520
+                    }
521
+                }
522
+                ob_start();
523
+                extract($data);
524
+                //need use require() instead of require_once because can load this view many time
525
+                require $path;
526
+                $content = ob_get_clean();
527
+                if($return){
528
+                    return $content;
529
+                }
530
+                $this->_pageRender .= $content;
531
+                $found = true;
532
+            }
533
+            if(! $found){
534
+                show_error('Unable to find view [' .$view . ']');
535
+            }
536
+        }
537 537
 
538
-	}
538
+    }
Please login to merge, or discard this patch.
Spacing   +77 added lines, -77 removed lines patch added patch discarded remove patch
@@ -24,7 +24,7 @@  discard block
 block discarded – undo
24 24
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25 25
 	*/
26 26
 
27
-	class Response{
27
+	class Response {
28 28
 
29 29
 		/**
30 30
 		 * The list of request header to send with response
@@ -65,15 +65,15 @@  discard block
 block discarded – undo
65 65
 		/**
66 66
 		 * Construct new response instance
67 67
 		 */
68
-		public function __construct(){
68
+		public function __construct() {
69 69
 			$currentUrl = '';
70
-			if (! empty($_SERVER['REQUEST_URI'])){
70
+			if (!empty($_SERVER['REQUEST_URI'])) {
71 71
 				$currentUrl = $_SERVER['REQUEST_URI'];
72 72
 			}
73
-			if (! empty($_SERVER['QUERY_STRING'])){
73
+			if (!empty($_SERVER['QUERY_STRING'])) {
74 74
 				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
75 75
 			}
76
-			$this->_currentUrl =  $currentUrl;
76
+			$this->_currentUrl = $currentUrl;
77 77
 					
78 78
 			$this->_currentUrlCacheKey = md5($this->_currentUrl);
79 79
 			
@@ -89,10 +89,10 @@  discard block
 block discarded – undo
89 89
 		 * The signleton of the logger
90 90
 		 * @return Object the Log instance
91 91
 		 */
92
-		public static function getLogger(){
93
-			if(self::$logger == null){
92
+		public static function getLogger() {
93
+			if (self::$logger == null) {
94 94
 				$logger = array();
95
-				$logger[0] =& class_loader('Log', 'classes');
95
+				$logger[0] = & class_loader('Log', 'classes');
96 96
 				$logger[0]->setLogger('Library::Response');
97 97
 				self::$logger = $logger[0];
98 98
 			}
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
 		 * @param object $logger the log object
105 105
 		 * @return object the log instance
106 106
 		 */
107
-		public static function setLogger($logger){
107
+		public static function setLogger($logger) {
108 108
 			self::$logger = $logger;
109 109
 			return self::$logger;
110 110
 		}
@@ -115,12 +115,12 @@  discard block
 block discarded – undo
115 115
 		 * @param  integer $httpCode the HTTP status code
116 116
 		 * @param  array   $headers   the additional headers to add to the existing headers list
117 117
 		 */
118
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
118
+		public static function sendHeaders($httpCode = 200, array $headers = array()) {
119 119
 			set_http_status_header($httpCode);
120 120
 			self::setHeaders($headers);
121
-			if(! headers_sent()){
122
-				foreach(self::getHeaders() as $key => $value){
123
-					header($key .': '.$value);
121
+			if (!headers_sent()) {
122
+				foreach (self::getHeaders() as $key => $value) {
123
+					header($key . ': ' . $value);
124 124
 				}
125 125
 			}
126 126
 		}
@@ -129,7 +129,7 @@  discard block
 block discarded – undo
129 129
 		 * Get the list of the headers
130 130
 		 * @return array the headers list
131 131
 		 */
132
-		public static function getHeaders(){
132
+		public static function getHeaders() {
133 133
 			return self::$headers;
134 134
 		}
135 135
 
@@ -138,8 +138,8 @@  discard block
 block discarded – undo
138 138
 		 * @param  string $name the header name
139 139
 		 * @return string|null       the header value
140 140
 		 */
141
-		public static function getHeader($name){
142
-			if(array_key_exists($name, self::$headers)){
141
+		public static function getHeader($name) {
142
+			if (array_key_exists($name, self::$headers)) {
143 143
 				return self::$headers[$name];
144 144
 			}
145 145
 			return null;
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
151 151
 		 * @param string $name  the header name
152 152
 		 * @param string $value the header value to be set
153 153
 		 */
154
-		public static function setHeader($name, $value){
154
+		public static function setHeader($name, $value) {
155 155
 			self::$headers[$name] = $value;
156 156
 		}
157 157
 
@@ -160,7 +160,7 @@  discard block
 block discarded – undo
160 160
 		 * @param array $headers the list of the headers to set. 
161 161
 		 * Note: this will merge with the existing headers
162 162
 		 */
163
-		public static function setHeaders(array $headers){
163
+		public static function setHeaders(array $headers) {
164 164
 			self::$headers = array_merge(self::getHeaders(), $headers);
165 165
 		}
166 166
 		
@@ -168,16 +168,16 @@  discard block
 block discarded – undo
168 168
 		 * Redirect user to the specified page
169 169
 		 * @param  string $path the URL or URI to be redirect to
170 170
 		 */
171
-		public static function redirect($path = ''){
171
+		public static function redirect($path = '') {
172 172
 			$logger = self::getLogger();
173 173
 			$url = Url::site_url($path);
174
-			$logger->info('Redirect to URL [' .$url. ']');
175
-			if(! headers_sent()){
176
-				header('Location: '.$url);
174
+			$logger->info('Redirect to URL [' . $url . ']');
175
+			if (!headers_sent()) {
176
+				header('Location: ' . $url);
177 177
 				exit;
178 178
 			}
179 179
 			echo '<script>
180
-					location.href = "'.$url.'";
180
+					location.href = "'.$url . '";
181 181
 				</script>';
182 182
 		}
183 183
 
@@ -189,7 +189,7 @@  discard block
 block discarded – undo
189 189
 		 * @return void|string          if $return is true will return the view content otherwise
190 190
 		 * will display the view content.
191 191
 		 */
192
-		public function render($view, $data = null, $return = false){
192
+		public function render($view, $data = null, $return = false) {
193 193
 			$logger = self::getLogger();
194 194
 			//convert data to an array
195 195
 			$data = (array) $data;
@@ -202,23 +202,23 @@  discard block
 block discarded – undo
202 202
 			$logger->debug('Checking the view [' . $view . '] from module list ...');
203 203
 			$moduleInfo = self::getModuleInfoForView($view);
204 204
 			$module    = $moduleInfo['module'];
205
-			$view  = $moduleInfo['view'];
206
-			if(! empty($moduleInfo['viewFile'])){
205
+			$view = $moduleInfo['view'];
206
+			if (!empty($moduleInfo['viewFile'])) {
207 207
 				$viewFile = $moduleInfo['viewFile'];
208 208
 			}
209 209
 			$moduleViewPath = Module::findViewFullPath($view, $module);
210
-			if($moduleViewPath){
210
+			if ($moduleViewPath) {
211 211
 				$path = $moduleViewPath;
212
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
212
+				$logger->info('Found view [' . $view . '] in module [' . $module . '], the file path is [' . $moduleViewPath . '] we will used it');
213 213
 			}
214
-			else{
215
-				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
214
+			else {
215
+				$logger->info('Cannot find view [' . $view . '] in module [' . $module . '] using the default location');
216 216
 			}
217 217
 			
218 218
 			$logger->info('The view file path to be loaded is [' . $path . ']');
219 219
 			
220 220
 			/////////
221
-			if($return){
221
+			if ($return) {
222 222
 				return $this->loadView($path, $data, true);
223 223
 			}
224 224
 			$this->loadView($path, $data, false);
@@ -228,28 +228,28 @@  discard block
 block discarded – undo
228 228
 		/**
229 229
 		* Send the final page output to user
230 230
 		*/
231
-		public function renderFinalPage(){
231
+		public function renderFinalPage() {
232 232
 			$logger = self::getLogger();
233 233
 			$obj = & get_instance();
234 234
 			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
235 235
 			$dispatcher = $obj->eventdispatcher;
236 236
 			$content = $this->_pageRender;
237
-			if(! $content){
237
+			if (!$content) {
238 238
 				$logger->warning('The final view content is empty.');
239 239
 				return;
240 240
 			}
241 241
 			//dispatch
242 242
 			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
243 243
 			$content = null;
244
-			if(! empty($event->payload)){
244
+			if (!empty($event->payload)) {
245 245
 				$content = $event->payload;
246 246
 			}
247
-			if(empty($content)){
247
+			if (empty($content)) {
248 248
 				$logger->warning('The view content is empty after dispatch to event listeners.');
249 249
 			}
250 250
 			
251 251
 			//check whether need save the page into cache.
252
-			if($cachePageStatus){
252
+			if ($cachePageStatus) {
253 253
 				$this->savePageContentIntoCache($content);
254 254
 			}
255 255
 			
@@ -261,7 +261,7 @@  discard block
 block discarded – undo
261 261
 			
262 262
 			//compress the output if is available
263 263
 			$type = null;
264
-			if (self::$_canCompressOutput){
264
+			if (self::$_canCompressOutput) {
265 265
 				$type = 'ob_gzhandler';
266 266
 			}
267 267
 			ob_start($type);
@@ -277,7 +277,7 @@  discard block
 block discarded – undo
277 277
 		*
278 278
 		* @return boolean whether the page content if available or not
279 279
 		*/
280
-		public function renderFinalPageFromCache(&$cache){
280
+		public function renderFinalPageFromCache(&$cache) {
281 281
 			$logger = self::getLogger();
282 282
 			//the current page cache key for identification
283 283
 			$pageCacheKey = $this->_currentUrlCacheKey;
@@ -285,9 +285,9 @@  discard block
 block discarded – undo
285 285
 			$logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
286 286
 			//get the cache information to prepare header to send to browser
287 287
 			$cacheInfo = $cache->getInfo($pageCacheKey);
288
-			if($cacheInfo){
288
+			if ($cacheInfo) {
289 289
 				$status = $this->sendCacheNotYetExpireInfo($cacheInfo);
290
-				if($status === false){
290
+				if ($status === false) {
291 291
 					return $this->sendPageContentToBrowser($cache);
292 292
 				}
293 293
 			}
@@ -299,7 +299,7 @@  discard block
 block discarded – undo
299 299
 		* Get the final page to be rendered
300 300
 		* @return string
301 301
 		*/
302
-		public function getFinalPageRendered(){
302
+		public function getFinalPageRendered() {
303 303
 			return $this->_pageRender;
304 304
 		}
305 305
 
@@ -307,14 +307,14 @@  discard block
 block discarded – undo
307 307
 		 * Send the HTTP 404 error if can not found the 
308 308
 		 * routing information for the current request
309 309
 		 */
310
-		public static function send404(){
310
+		public static function send404() {
311 311
 			/********* for logs **************/
312 312
 			//can't use $obj = & get_instance()  here because the global super object will be available until
313 313
 			//the main controller is loaded even for Loader::library('xxxx');
314 314
 			$logger = self::getLogger();
315
-			$request =& class_loader('Request', 'classes');
316
-			$userAgent =& class_loader('Browser');
317
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
315
+			$request = & class_loader('Request', 'classes');
316
+			$userAgent = & class_loader('Browser');
317
+			$browser = $userAgent->getPlatform() . ', ' . $userAgent->getBrowser() . ' ' . $userAgent->getVersion();
318 318
 			
319 319
 			//here can't use Loader::functions just include the helper manually
320 320
 			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
@@ -324,10 +324,10 @@  discard block
 block discarded – undo
324 324
 			$logger->error($str);
325 325
 			/***********************************/
326 326
 			$path = CORE_VIEWS_PATH . '404.php';
327
-			if(file_exists($path)){
327
+			if (file_exists($path)) {
328 328
 				//compress the output if is available
329 329
 				$type = null;
330
-				if (self::$_canCompressOutput){
330
+				if (self::$_canCompressOutput) {
331 331
 					$type = 'ob_gzhandler';
332 332
 				}
333 333
 				ob_start($type);
@@ -336,8 +336,8 @@  discard block
 block discarded – undo
336 336
 				self::sendHeaders(404);
337 337
 				echo $output;
338 338
 			}
339
-			else{
340
-				show_error('The 404 view [' .$path. '] does not exist');
339
+			else {
340
+				show_error('The 404 view [' . $path . '] does not exist');
341 341
 			}
342 342
 		}
343 343
 
@@ -345,12 +345,12 @@  discard block
 block discarded – undo
345 345
 		 * Display the error to user
346 346
 		 * @param  array  $data the error information
347 347
 		 */
348
-		public static function sendError(array $data = array()){
348
+		public static function sendError(array $data = array()) {
349 349
 			$path = CORE_VIEWS_PATH . 'errors.php';
350
-			if(file_exists($path)){
350
+			if (file_exists($path)) {
351 351
 				//compress the output if is available
352 352
 				$type = null;
353
-				if (self::$_canCompressOutput){
353
+				if (self::$_canCompressOutput) {
354 354
 					$type = 'ob_gzhandler';
355 355
 				}
356 356
 				ob_start($type);
@@ -360,7 +360,7 @@  discard block
 block discarded – undo
360 360
 				self::sendHeaders(503);
361 361
 				echo $output;
362 362
 			}
363
-			else{
363
+			else {
364 364
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
365 365
 				set_http_status_header(503);
366 366
 				echo 'The error view [' . $path . '] does not exist';
@@ -372,17 +372,17 @@  discard block
 block discarded – undo
372 372
 		 * @param  array $cacheInfo the cache information
373 373
 		 * @return boolean            true if the information is sent otherwise false
374 374
 		 */
375
-		protected function sendCacheNotYetExpireInfo($cacheInfo){
376
-			if(! empty($cacheInfo)){
375
+		protected function sendCacheNotYetExpireInfo($cacheInfo) {
376
+			if (!empty($cacheInfo)) {
377 377
 				$logger = self::getLogger();
378 378
 				$lastModified = $cacheInfo['mtime'];
379 379
 				$expire = $cacheInfo['expire'];
380 380
 				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
381 381
 				self::setHeader('Pragma', 'public');
382 382
 				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
383
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
384
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
385
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
383
+				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
384
+				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
385
+				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
386 386
 					$logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
387 387
 					self::sendHeaders(304);
388 388
 					return true;
@@ -396,7 +396,7 @@  discard block
 block discarded – undo
396 396
 		 * @param object $cache the cache instance
397 397
 		 * @return boolean     the status of the operation
398 398
 		 */
399
-		protected function sendPageContentToBrowser(&$cache){
399
+		protected function sendPageContentToBrowser(&$cache) {
400 400
 			$logger = self::getLogger();
401 401
 			$logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
402 402
 			self::sendHeaders(200);
@@ -404,7 +404,7 @@  discard block
 block discarded – undo
404 404
 			$pageCacheKey = $this->_currentUrlCacheKey;
405 405
 			//get the cache content
406 406
 			$content = $cache->get($pageCacheKey);
407
-			if($content){
407
+			if ($content) {
408 408
 				$logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
409 409
 				//load benchmark class
410 410
 				$benchmark = & class_loader('Benchmark');
@@ -418,7 +418,7 @@  discard block
 block discarded – undo
418 418
 				///display the final output
419 419
 				//compress the output if is available
420 420
 				$type = null;
421
-				if (self::$_canCompressOutput){
421
+				if (self::$_canCompressOutput) {
422 422
 					$type = 'ob_gzhandler';
423 423
 				}
424 424
 				ob_start($type);
@@ -436,7 +436,7 @@  discard block
 block discarded – undo
436 436
 		 * @param  string $content the page content to be saved
437 437
 		 * @return void
438 438
 		 */
439
-		protected function savePageContentIntoCache($content){
439
+		protected function savePageContentIntoCache($content) {
440 440
 			$obj = & get_instance();
441 441
 			$logger = self::getLogger();
442 442
 
@@ -444,7 +444,7 @@  discard block
 block discarded – undo
444 444
 			$url = $this->_currentUrl;
445 445
 			//Cache view Time to live in second
446 446
 			$viewCacheTtl = get_config('cache_ttl');
447
-			if (!empty($obj->view_cache_ttl)){
447
+			if (!empty($obj->view_cache_ttl)) {
448 448
 				$viewCacheTtl = $obj->view_cache_ttl;
449 449
 			}
450 450
 			//the cache handler instance
@@ -457,14 +457,14 @@  discard block
 block discarded – undo
457 457
 			
458 458
 			//get the cache information to prepare header to send to browser
459 459
 			$cacheInfo = $cacheInstance->getInfo($cacheKey);
460
-			if($cacheInfo){
460
+			if ($cacheInfo) {
461 461
 				$lastModified = $cacheInfo['mtime'];
462 462
 				$expire = $cacheInfo['expire'];
463 463
 				$maxAge = $expire - time();
464 464
 				self::setHeader('Pragma', 'public');
465 465
 				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
466
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
467
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
466
+				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
467
+				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');	
468 468
 			}
469 469
 		}
470 470
 		
@@ -480,21 +480,21 @@  discard block
 block discarded – undo
480 480
 		 * 	'viewFile' => 'view_file'
481 481
 		 * )
482 482
 		 */
483
-		protected  function getModuleInfoForView($view){
483
+		protected  function getModuleInfoForView($view) {
484 484
 			$module = null;
485 485
 			$viewFile = null;
486 486
 			$obj = & get_instance();
487 487
 			//check if the request class contains module name
488
-			if(strpos($view, '/') !== false){
488
+			if (strpos($view, '/') !== false) {
489 489
 				$viewPath = explode('/', $view);
490
-				if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
490
+				if (isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())) {
491 491
 					$module = $viewPath[0];
492 492
 					array_shift($viewPath);
493 493
 					$view = implode('/', $viewPath);
494 494
 					$viewFile = $view . '.php';
495 495
 				}
496 496
 			}
497
-			if(! $module && !empty($obj->moduleName)){
497
+			if (!$module && !empty($obj->moduleName)) {
498 498
 				$module = $obj->moduleName;
499 499
 			}
500 500
 			return array(
@@ -509,13 +509,13 @@  discard block
 block discarded – undo
509 509
 		 * @see  Response::render
510 510
 		 * @return void|string
511 511
 		 */
512
-		protected  function loadView($path, array $data = array(), $return = false){
512
+		protected  function loadView($path, array $data = array(), $return = false) {
513 513
 			$found = false;
514
-			if(file_exists($path)){
514
+			if (file_exists($path)) {
515 515
 				//super instance
516 516
 				$obj = & get_instance();
517
-				foreach(get_object_vars($obj) as $key => $value){
518
-					if(! isset($this->{$key})){
517
+				foreach (get_object_vars($obj) as $key => $value) {
518
+					if (!isset($this->{$key})) {
519 519
 						$this->{$key} = & $obj->{$key};
520 520
 					}
521 521
 				}
@@ -524,14 +524,14 @@  discard block
 block discarded – undo
524 524
 				//need use require() instead of require_once because can load this view many time
525 525
 				require $path;
526 526
 				$content = ob_get_clean();
527
-				if($return){
527
+				if ($return) {
528 528
 					return $content;
529 529
 				}
530 530
 				$this->_pageRender .= $content;
531 531
 				$found = true;
532 532
 			}
533
-			if(! $found){
534
-				show_error('Unable to find view [' .$view . ']');
533
+			if (!$found) {
534
+				show_error('Unable to find view [' . $view . ']');
535 535
 			}
536 536
 		}
537 537
 
Please login to merge, or discard this patch.
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -210,8 +210,7 @@  discard block
 block discarded – undo
210 210
 			if($moduleViewPath){
211 211
 				$path = $moduleViewPath;
212 212
 				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
213
-			}
214
-			else{
213
+			} else{
215 214
 				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
216 215
 			}
217 216
 			
@@ -335,8 +334,7 @@  discard block
 block discarded – undo
335 334
 				$output = ob_get_clean();
336 335
 				self::sendHeaders(404);
337 336
 				echo $output;
338
-			}
339
-			else{
337
+			} else{
340 338
 				show_error('The 404 view [' .$path. '] does not exist');
341 339
 			}
342 340
 		}
@@ -359,8 +357,7 @@  discard block
 block discarded – undo
359 357
 				$output = ob_get_clean();
360 358
 				self::sendHeaders(503);
361 359
 				echo $output;
362
-			}
363
-			else{
360
+			} else{
364 361
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
365 362
 				set_http_status_header(503);
366 363
 				echo 'The error view [' . $path . '] does not exist';
Please login to merge, or discard this patch.