@@ -149,8 +149,7 @@ discard block |
||
| 149 | 149 | $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false; |
| 150 | 150 | if($isSqlSELECTQuery){ |
| 151 | 151 | $this->setResultForSelect(); |
| 152 | - } |
|
| 153 | - else{ |
|
| 152 | + } else{ |
|
| 154 | 153 | $this->setResultForNonSelect(); |
| 155 | 154 | } |
| 156 | 155 | return $this->queryResult; |
@@ -172,15 +171,13 @@ discard block |
||
| 172 | 171 | } |
| 173 | 172 | if ($this->returnAsList){ |
| 174 | 173 | $result = $this->pdoStatment->fetchAll($fetchMode); |
| 175 | - } |
|
| 176 | - else{ |
|
| 174 | + } else{ |
|
| 177 | 175 | $result = $this->pdoStatment->fetch($fetchMode); |
| 178 | 176 | } |
| 179 | 177 | //Sqlite and pgsql always return 0 when using rowCount() |
| 180 | 178 | if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
| 181 | 179 | $numRows = count($result); |
| 182 | - } |
|
| 183 | - else{ |
|
| 180 | + } else{ |
|
| 184 | 181 | $numRows = $this->pdoStatment->rowCount(); |
| 185 | 182 | } |
| 186 | 183 | if(! is_object($this->queryResult)){ |
@@ -201,8 +198,7 @@ discard block |
||
| 201 | 198 | if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
| 202 | 199 | $result = true; //to test the result for the query like UPDATE, INSERT, DELETE |
| 203 | 200 | $numRows = 1; //TODO use the correct method to get the exact affected row |
| 204 | - } |
|
| 205 | - else{ |
|
| 201 | + } else{ |
|
| 206 | 202 | //to test the result for the query like UPDATE, INSERT, DELETE |
| 207 | 203 | $result = $this->pdoStatment->rowCount() >= 0; |
| 208 | 204 | $numRows = $this->pdoStatment->rowCount(); |
@@ -380,8 +376,7 @@ discard block |
||
| 380 | 376 | protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
| 381 | 377 | if ($logger !== null){ |
| 382 | 378 | $this->logger = $logger; |
| 383 | - } |
|
| 384 | - else{ |
|
| 379 | + } else{ |
|
| 385 | 380 | $this->logger =& class_loader('Log', 'classes'); |
| 386 | 381 | $this->logger->setLogger('Library::DatabaseQueryRunner'); |
| 387 | 382 | } |
@@ -1,90 +1,90 @@ discard block |
||
| 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 DatabaseQueryRunner{ |
|
| 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 DatabaseQueryRunner{ |
|
| 27 | 27 | |
| 28 | 28 | /** |
| 29 | - * The logger instance |
|
| 30 | - * @var object |
|
| 31 | - */ |
|
| 29 | + * The logger instance |
|
| 30 | + * @var object |
|
| 31 | + */ |
|
| 32 | 32 | private $logger = null; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * The last query result |
|
| 36 | - * @var object |
|
| 37 | - */ |
|
| 38 | - private $queryResult = null; |
|
| 34 | + /** |
|
| 35 | + * The last query result |
|
| 36 | + * @var object |
|
| 37 | + */ |
|
| 38 | + private $queryResult = null; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * The benchmark instance |
|
| 42 | - * @var object |
|
| 43 | - */ |
|
| 40 | + /** |
|
| 41 | + * The benchmark instance |
|
| 42 | + * @var object |
|
| 43 | + */ |
|
| 44 | 44 | private $benchmarkInstance = null; |
| 45 | 45 | |
| 46 | 46 | /** |
| 47 | - * The SQL query statment to execute |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + * The SQL query statment to execute |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | private $query = null; |
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | - * Indicate if we need return result as list (boolean) |
|
| 53 | + * Indicate if we need return result as list (boolean) |
|
| 54 | 54 | * or the data used to replace the placeholder (array) |
| 55 | - * @var array|boolean |
|
| 56 | - */ |
|
| 57 | - private $returnAsList = true; |
|
| 55 | + * @var array|boolean |
|
| 56 | + */ |
|
| 57 | + private $returnAsList = true; |
|
| 58 | 58 | |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Indicate if we need return result as array or not |
|
| 62 | - * @var boolean |
|
| 63 | - */ |
|
| 64 | - private $returnAsArray = true; |
|
| 60 | + /** |
|
| 61 | + * Indicate if we need return result as array or not |
|
| 62 | + * @var boolean |
|
| 63 | + */ |
|
| 64 | + private $returnAsArray = true; |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * The last PDOStatment instance |
|
| 68 | - * @var object |
|
| 69 | - */ |
|
| 70 | - private $pdoStatment = null; |
|
| 66 | + /** |
|
| 67 | + * The last PDOStatment instance |
|
| 68 | + * @var object |
|
| 69 | + */ |
|
| 70 | + private $pdoStatment = null; |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * The error returned for the last query |
|
| 74 | - * @var string |
|
| 75 | - */ |
|
| 76 | - private $error = null; |
|
| 72 | + /** |
|
| 73 | + * The error returned for the last query |
|
| 74 | + * @var string |
|
| 75 | + */ |
|
| 76 | + private $error = null; |
|
| 77 | 77 | |
| 78 | 78 | /** |
| 79 | 79 | * The PDO instance |
| 80 | 80 | * @var object |
| 81 | - */ |
|
| 81 | + */ |
|
| 82 | 82 | private $pdo = null; |
| 83 | 83 | |
| 84 | 84 | /** |
| 85 | 85 | * The database driver name used |
| 86 | 86 | * @var string |
| 87 | - */ |
|
| 87 | + */ |
|
| 88 | 88 | private $driver = null; |
| 89 | 89 | |
| 90 | 90 | |
@@ -98,7 +98,7 @@ discard block |
||
| 98 | 98 | */ |
| 99 | 99 | public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){ |
| 100 | 100 | if (is_object($pdo)){ |
| 101 | - $this->pdo = $pdo; |
|
| 101 | + $this->pdo = $pdo; |
|
| 102 | 102 | } |
| 103 | 103 | $this->query = $query; |
| 104 | 104 | $this->returnAsList = $returnAsList; |
@@ -116,10 +116,10 @@ discard block |
||
| 116 | 116 | //reset instance |
| 117 | 117 | $this->reset(); |
| 118 | 118 | |
| 119 | - //for database query execution time |
|
| 119 | + //for database query execution time |
|
| 120 | 120 | $benchmarkMarkerKey = $this->getBenchmarkKey(); |
| 121 | 121 | if (! is_object($this->benchmarkInstance)){ |
| 122 | - $this->benchmarkInstance = & class_loader('Benchmark'); |
|
| 122 | + $this->benchmarkInstance = & class_loader('Benchmark'); |
|
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | $this->logger->info('Execute SQL query [' . $this->query . ']'); |
@@ -132,101 +132,101 @@ discard block |
||
| 132 | 132 | $responseTime = $this->benchmarkInstance->elapsedTime( |
| 133 | 133 | 'DATABASE_QUERY_START(' . $benchmarkMarkerKey . ')', |
| 134 | 134 | 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')' |
| 135 | - ); |
|
| 136 | - //TODO use the configuration value for the high response time currently is 1 second |
|
| 135 | + ); |
|
| 136 | + //TODO use the configuration value for the high response time currently is 1 second |
|
| 137 | 137 | if ($responseTime >= 1 ){ |
| 138 | 138 | $this->logger->warning( |
| 139 | 139 | 'High response time while processing database query [' . $this->query . ']. |
| 140 | 140 | The response time is [' .$responseTime. '] sec.' |
| 141 | - ); |
|
| 141 | + ); |
|
| 142 | 142 | } |
| 143 | 143 | |
| 144 | 144 | if ($this->pdoStatment !== false){ |
| 145 | - $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false; |
|
| 146 | - if($isSqlSELECTQuery){ |
|
| 147 | - $this->setResultForSelect(); |
|
| 148 | - } |
|
| 149 | - else{ |
|
| 150 | - $this->setResultForNonSelect(); |
|
| 151 | - } |
|
| 152 | - return $this->queryResult; |
|
| 145 | + $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false; |
|
| 146 | + if($isSqlSELECTQuery){ |
|
| 147 | + $this->setResultForSelect(); |
|
| 148 | + } |
|
| 149 | + else{ |
|
| 150 | + $this->setResultForNonSelect(); |
|
| 151 | + } |
|
| 152 | + return $this->queryResult; |
|
| 153 | 153 | } |
| 154 | 154 | $this->setQueryRunnerError(); |
| 155 | 155 | } |
| 156 | 156 | |
| 157 | - /** |
|
| 158 | - * Return the result for SELECT query |
|
| 159 | - * @see DatabaseQueryRunner::execute |
|
| 160 | - */ |
|
| 157 | + /** |
|
| 158 | + * Return the result for SELECT query |
|
| 159 | + * @see DatabaseQueryRunner::execute |
|
| 160 | + */ |
|
| 161 | 161 | protected function setResultForSelect(){ |
| 162 | - //if need return all result like list of record |
|
| 163 | - $result = null; |
|
| 164 | - $numRows = 0; |
|
| 165 | - $fetchMode = PDO::FETCH_OBJ; |
|
| 166 | - if($this->returnAsArray){ |
|
| 162 | + //if need return all result like list of record |
|
| 163 | + $result = null; |
|
| 164 | + $numRows = 0; |
|
| 165 | + $fetchMode = PDO::FETCH_OBJ; |
|
| 166 | + if($this->returnAsArray){ |
|
| 167 | 167 | $fetchMode = PDO::FETCH_ASSOC; |
| 168 | - } |
|
| 169 | - if ($this->returnAsList){ |
|
| 170 | - $result = $this->pdoStatment->fetchAll($fetchMode); |
|
| 171 | - } |
|
| 172 | - else{ |
|
| 173 | - $result = $this->pdoStatment->fetch($fetchMode); |
|
| 174 | - } |
|
| 175 | - //Sqlite and pgsql always return 0 when using rowCount() |
|
| 176 | - if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 168 | + } |
|
| 169 | + if ($this->returnAsList){ |
|
| 170 | + $result = $this->pdoStatment->fetchAll($fetchMode); |
|
| 171 | + } |
|
| 172 | + else{ |
|
| 173 | + $result = $this->pdoStatment->fetch($fetchMode); |
|
| 174 | + } |
|
| 175 | + //Sqlite and pgsql always return 0 when using rowCount() |
|
| 176 | + if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 177 | 177 | $numRows = count($result); |
| 178 | - } |
|
| 179 | - else{ |
|
| 178 | + } |
|
| 179 | + else{ |
|
| 180 | 180 | $numRows = $this->pdoStatment->rowCount(); |
| 181 | - } |
|
| 182 | - if(! is_object($this->queryResult)){ |
|
| 183 | - $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
|
| 184 | - } |
|
| 185 | - $this->queryResult->setResult($result); |
|
| 186 | - $this->queryResult->setNumRows($numRows); |
|
| 181 | + } |
|
| 182 | + if(! is_object($this->queryResult)){ |
|
| 183 | + $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
|
| 184 | + } |
|
| 185 | + $this->queryResult->setResult($result); |
|
| 186 | + $this->queryResult->setNumRows($numRows); |
|
| 187 | 187 | } |
| 188 | 188 | |
| 189 | 189 | /** |
| 190 | - * Return the result for non SELECT query |
|
| 191 | - * @see DatabaseQueryRunner::execute |
|
| 192 | - */ |
|
| 190 | + * Return the result for non SELECT query |
|
| 191 | + * @see DatabaseQueryRunner::execute |
|
| 192 | + */ |
|
| 193 | 193 | protected function setResultForNonSelect(){ |
| 194 | - //Sqlite and pgsql always return 0 when using rowCount() |
|
| 195 | - $result = false; |
|
| 196 | - $numRows = 0; |
|
| 197 | - if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 194 | + //Sqlite and pgsql always return 0 when using rowCount() |
|
| 195 | + $result = false; |
|
| 196 | + $numRows = 0; |
|
| 197 | + if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 198 | 198 | $result = true; //to test the result for the query like UPDATE, INSERT, DELETE |
| 199 | 199 | $numRows = 1; //TODO use the correct method to get the exact affected row |
| 200 | - } |
|
| 201 | - else{ |
|
| 202 | - //to test the result for the query like UPDATE, INSERT, DELETE |
|
| 203 | - $result = $this->pdoStatment->rowCount() >= 0; |
|
| 204 | - $numRows = $this->pdoStatment->rowCount(); |
|
| 205 | - } |
|
| 206 | - if(! is_object($this->queryResult)){ |
|
| 207 | - $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
|
| 208 | - } |
|
| 209 | - $this->queryResult->setResult($result); |
|
| 210 | - $this->queryResult->setNumRows($numRows); |
|
| 200 | + } |
|
| 201 | + else{ |
|
| 202 | + //to test the result for the query like UPDATE, INSERT, DELETE |
|
| 203 | + $result = $this->pdoStatment->rowCount() >= 0; |
|
| 204 | + $numRows = $this->pdoStatment->rowCount(); |
|
| 205 | + } |
|
| 206 | + if(! is_object($this->queryResult)){ |
|
| 207 | + $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
|
| 208 | + } |
|
| 209 | + $this->queryResult->setResult($result); |
|
| 210 | + $this->queryResult->setNumRows($numRows); |
|
| 211 | 211 | } |
| 212 | 212 | |
| 213 | 213 | |
| 214 | - /** |
|
| 214 | + /** |
|
| 215 | 215 | * Return the benchmark instance |
| 216 | 216 | * @return Benchmark |
| 217 | 217 | */ |
| 218 | 218 | public function getBenchmark(){ |
| 219 | - return $this->benchmarkInstance; |
|
| 219 | + return $this->benchmarkInstance; |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
| 223 | 223 | * Set the benchmark instance |
| 224 | 224 | * @param Benchmark $benchmark the benchmark object |
| 225 | - * @return object DatabaseQueryRunner |
|
| 225 | + * @return object DatabaseQueryRunner |
|
| 226 | 226 | */ |
| 227 | 227 | public function setBenchmark($benchmark){ |
| 228 | - $this->benchmarkInstance = $benchmark; |
|
| 229 | - return $this; |
|
| 228 | + $this->benchmarkInstance = $benchmark; |
|
| 229 | + return $this; |
|
| 230 | 230 | } |
| 231 | 231 | |
| 232 | 232 | /** |
@@ -235,18 +235,18 @@ discard block |
||
| 235 | 235 | * @return object DatabaseQueryResult |
| 236 | 236 | */ |
| 237 | 237 | public function getQueryResult(){ |
| 238 | - return $this->queryResult; |
|
| 238 | + return $this->queryResult; |
|
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | /** |
| 242 | 242 | * Set the database query result instance |
| 243 | 243 | * @param object $queryResult the query result |
| 244 | 244 | * |
| 245 | - * @return object DatabaseQueryRunner |
|
| 245 | + * @return object DatabaseQueryRunner |
|
| 246 | 246 | */ |
| 247 | 247 | public function setQueryResult(DatabaseQueryResult $queryResult){ |
| 248 | - $this->queryResult = $queryResult; |
|
| 249 | - return $this; |
|
| 248 | + $this->queryResult = $queryResult; |
|
| 249 | + return $this; |
|
| 250 | 250 | } |
| 251 | 251 | |
| 252 | 252 | /** |
@@ -254,17 +254,17 @@ discard block |
||
| 254 | 254 | * @return Log |
| 255 | 255 | */ |
| 256 | 256 | public function getLogger(){ |
| 257 | - return $this->logger; |
|
| 257 | + return $this->logger; |
|
| 258 | 258 | } |
| 259 | 259 | |
| 260 | 260 | /** |
| 261 | 261 | * Set the log instance |
| 262 | 262 | * @param Log $logger the log object |
| 263 | - * @return object DatabaseQueryRunner |
|
| 263 | + * @return object DatabaseQueryRunner |
|
| 264 | 264 | */ |
| 265 | 265 | public function setLogger($logger){ |
| 266 | - $this->logger = $logger; |
|
| 267 | - return $this; |
|
| 266 | + $this->logger = $logger; |
|
| 267 | + return $this; |
|
| 268 | 268 | } |
| 269 | 269 | |
| 270 | 270 | /** |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | * @return string |
| 273 | 273 | */ |
| 274 | 274 | public function getQuery(){ |
| 275 | - return $this->query; |
|
| 275 | + return $this->query; |
|
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | /** |
@@ -281,8 +281,8 @@ discard block |
||
| 281 | 281 | * @return object DatabaseQueryRunner |
| 282 | 282 | */ |
| 283 | 283 | public function setQuery($query){ |
| 284 | - $this->query = $query; |
|
| 285 | - return $this; |
|
| 284 | + $this->query = $query; |
|
| 285 | + return $this; |
|
| 286 | 286 | } |
| 287 | 287 | |
| 288 | 288 | /** |
@@ -291,8 +291,8 @@ discard block |
||
| 291 | 291 | * @return object DatabaseQueryRunner |
| 292 | 292 | */ |
| 293 | 293 | public function setReturnType($returnType){ |
| 294 | - $this->returnAsList = $returnType; |
|
| 295 | - return $this; |
|
| 294 | + $this->returnAsList = $returnType; |
|
| 295 | + return $this; |
|
| 296 | 296 | } |
| 297 | 297 | |
| 298 | 298 | /** |
@@ -301,8 +301,8 @@ discard block |
||
| 301 | 301 | * @return object DatabaseQueryRunner |
| 302 | 302 | */ |
| 303 | 303 | public function setReturnAsArray($status = true){ |
| 304 | - $this->returnAsArray = $status; |
|
| 305 | - return $this; |
|
| 304 | + $this->returnAsArray = $status; |
|
| 305 | + return $this; |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
@@ -310,7 +310,7 @@ discard block |
||
| 310 | 310 | * @return string |
| 311 | 311 | */ |
| 312 | 312 | public function getQueryError(){ |
| 313 | - return $this->error; |
|
| 313 | + return $this->error; |
|
| 314 | 314 | } |
| 315 | 315 | |
| 316 | 316 | /** |
@@ -318,7 +318,7 @@ discard block |
||
| 318 | 318 | * @return object |
| 319 | 319 | */ |
| 320 | 320 | public function getPdo(){ |
| 321 | - return $this->pdo; |
|
| 321 | + return $this->pdo; |
|
| 322 | 322 | } |
| 323 | 323 | |
| 324 | 324 | /** |
@@ -327,16 +327,16 @@ discard block |
||
| 327 | 327 | * @return object DatabaseQueryRunner |
| 328 | 328 | */ |
| 329 | 329 | public function setPdo(PDO $pdo = null){ |
| 330 | - $this->pdo = $pdo; |
|
| 331 | - return $this; |
|
| 330 | + $this->pdo = $pdo; |
|
| 331 | + return $this; |
|
| 332 | 332 | } |
| 333 | 333 | |
| 334 | - /** |
|
| 335 | - * Return the database driver |
|
| 336 | - * @return string |
|
| 337 | - */ |
|
| 334 | + /** |
|
| 335 | + * Return the database driver |
|
| 336 | + * @return string |
|
| 337 | + */ |
|
| 338 | 338 | public function getDriver(){ |
| 339 | - return $this->driver; |
|
| 339 | + return $this->driver; |
|
| 340 | 340 | } |
| 341 | 341 | |
| 342 | 342 | /** |
@@ -345,8 +345,8 @@ discard block |
||
| 345 | 345 | * @return object DatabaseQueryRunner |
| 346 | 346 | */ |
| 347 | 347 | public function setDriver($driver){ |
| 348 | - $this->driver = $driver; |
|
| 349 | - return $this; |
|
| 348 | + $this->driver = $driver; |
|
| 349 | + return $this; |
|
| 350 | 350 | } |
| 351 | 351 | |
| 352 | 352 | /** |
@@ -355,18 +355,18 @@ discard block |
||
| 355 | 355 | * @return string |
| 356 | 356 | */ |
| 357 | 357 | protected function getBenchmarkKey(){ |
| 358 | - return md5($this->query . $this->returnAsList . $this->returnAsArray); |
|
| 358 | + return md5($this->query . $this->returnAsList . $this->returnAsArray); |
|
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | 362 | * Set error for database query execution |
| 363 | 363 | */ |
| 364 | 364 | protected function setQueryRunnerError(){ |
| 365 | - $error = $this->pdo->errorInfo(); |
|
| 366 | - $this->error = isset($error[2]) ? $error[2] : ''; |
|
| 367 | - $this->logger->error('The database query execution got an error: ' . stringfy_vars($error)); |
|
| 368 | - //show error message |
|
| 369 | - show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error'); |
|
| 365 | + $error = $this->pdo->errorInfo(); |
|
| 366 | + $this->error = isset($error[2]) ? $error[2] : ''; |
|
| 367 | + $this->logger->error('The database query execution got an error: ' . stringfy_vars($error)); |
|
| 368 | + //show error message |
|
| 369 | + show_error('Query: "' . $this->query . '" Error: ' . $this->error, 'Database Error'); |
|
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
@@ -374,19 +374,19 @@ discard block |
||
| 374 | 374 | * @param object $logger the Log instance if not null |
| 375 | 375 | */ |
| 376 | 376 | protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
| 377 | - if ($logger !== null){ |
|
| 377 | + if ($logger !== null){ |
|
| 378 | 378 | $this->logger = $logger; |
| 379 | - } |
|
| 380 | - else{ |
|
| 381 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 382 | - $this->logger->setLogger('Library::DatabaseQueryRunner'); |
|
| 383 | - } |
|
| 379 | + } |
|
| 380 | + else{ |
|
| 381 | + $this->logger =& class_loader('Log', 'classes'); |
|
| 382 | + $this->logger->setLogger('Library::DatabaseQueryRunner'); |
|
| 383 | + } |
|
| 384 | 384 | } |
| 385 | 385 | |
| 386 | 386 | |
| 387 | 387 | /** |
| 388 | - * Reset the instance before run each query |
|
| 389 | - */ |
|
| 388 | + * Reset the instance before run each query |
|
| 389 | + */ |
|
| 390 | 390 | private function reset(){ |
| 391 | 391 | $this->error = null; |
| 392 | 392 | $this->pdoStatment = null; |
@@ -23,19 +23,19 @@ discard block |
||
| 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 DatabaseQueryRunner{ |
|
| 26 | + class DatabaseQueryRunner { |
|
| 27 | 27 | |
| 28 | 28 | /** |
| 29 | 29 | * The logger instance |
| 30 | 30 | * @var object |
| 31 | 31 | */ |
| 32 | - private $logger = null; |
|
| 32 | + private $logger = null; |
|
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | 35 | * The last query result |
| 36 | 36 | * @var object |
| 37 | 37 | */ |
| 38 | - private $queryResult = null; |
|
| 38 | + private $queryResult = null; |
|
| 39 | 39 | |
| 40 | 40 | /** |
| 41 | 41 | * The benchmark instance |
@@ -47,45 +47,45 @@ discard block |
||
| 47 | 47 | * The SQL query statment to execute |
| 48 | 48 | * @var string |
| 49 | 49 | */ |
| 50 | - private $query = null; |
|
| 50 | + private $query = null; |
|
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | 53 | * Indicate if we need return result as list (boolean) |
| 54 | 54 | * or the data used to replace the placeholder (array) |
| 55 | 55 | * @var array|boolean |
| 56 | 56 | */ |
| 57 | - private $returnAsList = true; |
|
| 57 | + private $returnAsList = true; |
|
| 58 | 58 | |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | 61 | * Indicate if we need return result as array or not |
| 62 | 62 | * @var boolean |
| 63 | 63 | */ |
| 64 | - private $returnAsArray = true; |
|
| 64 | + private $returnAsArray = true; |
|
| 65 | 65 | |
| 66 | 66 | /** |
| 67 | 67 | * The last PDOStatment instance |
| 68 | 68 | * @var object |
| 69 | 69 | */ |
| 70 | - private $pdoStatment = null; |
|
| 70 | + private $pdoStatment = null; |
|
| 71 | 71 | |
| 72 | 72 | /** |
| 73 | 73 | * The error returned for the last query |
| 74 | 74 | * @var string |
| 75 | 75 | */ |
| 76 | - private $error = null; |
|
| 76 | + private $error = null; |
|
| 77 | 77 | |
| 78 | 78 | /** |
| 79 | 79 | * The PDO instance |
| 80 | 80 | * @var object |
| 81 | 81 | */ |
| 82 | - private $pdo = null; |
|
| 82 | + private $pdo = null; |
|
| 83 | 83 | |
| 84 | 84 | /** |
| 85 | 85 | * The database driver name used |
| 86 | 86 | * @var string |
| 87 | 87 | */ |
| 88 | - private $driver = null; |
|
| 88 | + private $driver = null; |
|
| 89 | 89 | |
| 90 | 90 | |
| 91 | 91 | |
@@ -96,8 +96,8 @@ discard block |
||
| 96 | 96 | * @param boolean $returnAsList if need return as list or just one row |
| 97 | 97 | * @param boolean $returnAsArray whether to return the result as array or not |
| 98 | 98 | */ |
| 99 | - public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false){ |
|
| 100 | - if (is_object($pdo)){ |
|
| 99 | + public function __construct(PDO $pdo = null, $query = null, $returnAsList = true, $returnAsArray = false) { |
|
| 100 | + if (is_object($pdo)) { |
|
| 101 | 101 | $this->pdo = $pdo; |
| 102 | 102 | } |
| 103 | 103 | $this->query = $query; |
@@ -112,13 +112,13 @@ discard block |
||
| 112 | 112 | * |
| 113 | 113 | * @return object|void |
| 114 | 114 | */ |
| 115 | - public function execute(){ |
|
| 115 | + public function execute() { |
|
| 116 | 116 | //reset instance |
| 117 | 117 | $this->reset(); |
| 118 | 118 | |
| 119 | 119 | //for database query execution time |
| 120 | 120 | $benchmarkMarkerKey = $this->getBenchmarkKey(); |
| 121 | - if (! is_object($this->benchmarkInstance)){ |
|
| 121 | + if (!is_object($this->benchmarkInstance)) { |
|
| 122 | 122 | $this->benchmarkInstance = & class_loader('Benchmark'); |
| 123 | 123 | } |
| 124 | 124 | |
@@ -134,19 +134,19 @@ discard block |
||
| 134 | 134 | 'DATABASE_QUERY_END(' . $benchmarkMarkerKey . ')' |
| 135 | 135 | ); |
| 136 | 136 | //TODO use the configuration value for the high response time currently is 1 second |
| 137 | - if ($responseTime >= 1 ){ |
|
| 137 | + if ($responseTime >= 1) { |
|
| 138 | 138 | $this->logger->warning( |
| 139 | 139 | 'High response time while processing database query [' . $this->query . ']. |
| 140 | - The response time is [' .$responseTime. '] sec.' |
|
| 140 | + The response time is [' .$responseTime . '] sec.' |
|
| 141 | 141 | ); |
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - if ($this->pdoStatment !== false){ |
|
| 144 | + if ($this->pdoStatment !== false) { |
|
| 145 | 145 | $isSqlSELECTQuery = stristr($this->query, 'SELECT') !== false; |
| 146 | - if($isSqlSELECTQuery){ |
|
| 146 | + if ($isSqlSELECTQuery) { |
|
| 147 | 147 | $this->setResultForSelect(); |
| 148 | 148 | } |
| 149 | - else{ |
|
| 149 | + else { |
|
| 150 | 150 | $this->setResultForNonSelect(); |
| 151 | 151 | } |
| 152 | 152 | return $this->queryResult; |
@@ -158,28 +158,28 @@ discard block |
||
| 158 | 158 | * Return the result for SELECT query |
| 159 | 159 | * @see DatabaseQueryRunner::execute |
| 160 | 160 | */ |
| 161 | - protected function setResultForSelect(){ |
|
| 161 | + protected function setResultForSelect() { |
|
| 162 | 162 | //if need return all result like list of record |
| 163 | 163 | $result = null; |
| 164 | 164 | $numRows = 0; |
| 165 | 165 | $fetchMode = PDO::FETCH_OBJ; |
| 166 | - if($this->returnAsArray){ |
|
| 166 | + if ($this->returnAsArray) { |
|
| 167 | 167 | $fetchMode = PDO::FETCH_ASSOC; |
| 168 | 168 | } |
| 169 | - if ($this->returnAsList){ |
|
| 169 | + if ($this->returnAsList) { |
|
| 170 | 170 | $result = $this->pdoStatment->fetchAll($fetchMode); |
| 171 | 171 | } |
| 172 | - else{ |
|
| 172 | + else { |
|
| 173 | 173 | $result = $this->pdoStatment->fetch($fetchMode); |
| 174 | 174 | } |
| 175 | 175 | //Sqlite and pgsql always return 0 when using rowCount() |
| 176 | - if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 176 | + if (in_array($this->driver, array('sqlite', 'pgsql'))) { |
|
| 177 | 177 | $numRows = count($result); |
| 178 | 178 | } |
| 179 | - else{ |
|
| 179 | + else { |
|
| 180 | 180 | $numRows = $this->pdoStatment->rowCount(); |
| 181 | 181 | } |
| 182 | - if(! is_object($this->queryResult)){ |
|
| 182 | + if (!is_object($this->queryResult)) { |
|
| 183 | 183 | $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
| 184 | 184 | } |
| 185 | 185 | $this->queryResult->setResult($result); |
@@ -190,20 +190,20 @@ discard block |
||
| 190 | 190 | * Return the result for non SELECT query |
| 191 | 191 | * @see DatabaseQueryRunner::execute |
| 192 | 192 | */ |
| 193 | - protected function setResultForNonSelect(){ |
|
| 193 | + protected function setResultForNonSelect() { |
|
| 194 | 194 | //Sqlite and pgsql always return 0 when using rowCount() |
| 195 | 195 | $result = false; |
| 196 | 196 | $numRows = 0; |
| 197 | - if (in_array($this->driver, array('sqlite', 'pgsql'))){ |
|
| 197 | + if (in_array($this->driver, array('sqlite', 'pgsql'))) { |
|
| 198 | 198 | $result = true; //to test the result for the query like UPDATE, INSERT, DELETE |
| 199 | 199 | $numRows = 1; //TODO use the correct method to get the exact affected row |
| 200 | 200 | } |
| 201 | - else{ |
|
| 201 | + else { |
|
| 202 | 202 | //to test the result for the query like UPDATE, INSERT, DELETE |
| 203 | 203 | $result = $this->pdoStatment->rowCount() >= 0; |
| 204 | 204 | $numRows = $this->pdoStatment->rowCount(); |
| 205 | 205 | } |
| 206 | - if(! is_object($this->queryResult)){ |
|
| 206 | + if (!is_object($this->queryResult)) { |
|
| 207 | 207 | $this->queryResult = & class_loader('DatabaseQueryResult', 'classes/database'); |
| 208 | 208 | } |
| 209 | 209 | $this->queryResult->setResult($result); |
@@ -215,7 +215,7 @@ discard block |
||
| 215 | 215 | * Return the benchmark instance |
| 216 | 216 | * @return Benchmark |
| 217 | 217 | */ |
| 218 | - public function getBenchmark(){ |
|
| 218 | + public function getBenchmark() { |
|
| 219 | 219 | return $this->benchmarkInstance; |
| 220 | 220 | } |
| 221 | 221 | |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | * @param Benchmark $benchmark the benchmark object |
| 225 | 225 | * @return object DatabaseQueryRunner |
| 226 | 226 | */ |
| 227 | - public function setBenchmark($benchmark){ |
|
| 227 | + public function setBenchmark($benchmark) { |
|
| 228 | 228 | $this->benchmarkInstance = $benchmark; |
| 229 | 229 | return $this; |
| 230 | 230 | } |
@@ -234,7 +234,7 @@ discard block |
||
| 234 | 234 | * |
| 235 | 235 | * @return object DatabaseQueryResult |
| 236 | 236 | */ |
| 237 | - public function getQueryResult(){ |
|
| 237 | + public function getQueryResult() { |
|
| 238 | 238 | return $this->queryResult; |
| 239 | 239 | } |
| 240 | 240 | |
@@ -244,7 +244,7 @@ discard block |
||
| 244 | 244 | * |
| 245 | 245 | * @return object DatabaseQueryRunner |
| 246 | 246 | */ |
| 247 | - public function setQueryResult(DatabaseQueryResult $queryResult){ |
|
| 247 | + public function setQueryResult(DatabaseQueryResult $queryResult) { |
|
| 248 | 248 | $this->queryResult = $queryResult; |
| 249 | 249 | return $this; |
| 250 | 250 | } |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | * Return the Log instance |
| 254 | 254 | * @return Log |
| 255 | 255 | */ |
| 256 | - public function getLogger(){ |
|
| 256 | + public function getLogger() { |
|
| 257 | 257 | return $this->logger; |
| 258 | 258 | } |
| 259 | 259 | |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @param Log $logger the log object |
| 263 | 263 | * @return object DatabaseQueryRunner |
| 264 | 264 | */ |
| 265 | - public function setLogger($logger){ |
|
| 265 | + public function setLogger($logger) { |
|
| 266 | 266 | $this->logger = $logger; |
| 267 | 267 | return $this; |
| 268 | 268 | } |
@@ -271,7 +271,7 @@ discard block |
||
| 271 | 271 | * Return the current query SQL string |
| 272 | 272 | * @return string |
| 273 | 273 | */ |
| 274 | - public function getQuery(){ |
|
| 274 | + public function getQuery() { |
|
| 275 | 275 | return $this->query; |
| 276 | 276 | } |
| 277 | 277 | |
@@ -280,7 +280,7 @@ discard block |
||
| 280 | 280 | * @param string $query the SQL query to set |
| 281 | 281 | * @return object DatabaseQueryRunner |
| 282 | 282 | */ |
| 283 | - public function setQuery($query){ |
|
| 283 | + public function setQuery($query) { |
|
| 284 | 284 | $this->query = $query; |
| 285 | 285 | return $this; |
| 286 | 286 | } |
@@ -290,7 +290,7 @@ discard block |
||
| 290 | 290 | * @param boolean $returnType |
| 291 | 291 | * @return object DatabaseQueryRunner |
| 292 | 292 | */ |
| 293 | - public function setReturnType($returnType){ |
|
| 293 | + public function setReturnType($returnType) { |
|
| 294 | 294 | $this->returnAsList = $returnType; |
| 295 | 295 | return $this; |
| 296 | 296 | } |
@@ -300,7 +300,7 @@ discard block |
||
| 300 | 300 | * @param boolean $status the status if true will return as array |
| 301 | 301 | * @return object DatabaseQueryRunner |
| 302 | 302 | */ |
| 303 | - public function setReturnAsArray($status = true){ |
|
| 303 | + public function setReturnAsArray($status = true) { |
|
| 304 | 304 | $this->returnAsArray = $status; |
| 305 | 305 | return $this; |
| 306 | 306 | } |
@@ -309,7 +309,7 @@ discard block |
||
| 309 | 309 | * Return the error for last query execution |
| 310 | 310 | * @return string |
| 311 | 311 | */ |
| 312 | - public function getQueryError(){ |
|
| 312 | + public function getQueryError() { |
|
| 313 | 313 | return $this->error; |
| 314 | 314 | } |
| 315 | 315 | |
@@ -317,7 +317,7 @@ discard block |
||
| 317 | 317 | * Return the PDO instance |
| 318 | 318 | * @return object |
| 319 | 319 | */ |
| 320 | - public function getPdo(){ |
|
| 320 | + public function getPdo() { |
|
| 321 | 321 | return $this->pdo; |
| 322 | 322 | } |
| 323 | 323 | |
@@ -326,7 +326,7 @@ discard block |
||
| 326 | 326 | * @param PDO $pdo the pdo object |
| 327 | 327 | * @return object DatabaseQueryRunner |
| 328 | 328 | */ |
| 329 | - public function setPdo(PDO $pdo = null){ |
|
| 329 | + public function setPdo(PDO $pdo = null) { |
|
| 330 | 330 | $this->pdo = $pdo; |
| 331 | 331 | return $this; |
| 332 | 332 | } |
@@ -335,7 +335,7 @@ discard block |
||
| 335 | 335 | * Return the database driver |
| 336 | 336 | * @return string |
| 337 | 337 | */ |
| 338 | - public function getDriver(){ |
|
| 338 | + public function getDriver() { |
|
| 339 | 339 | return $this->driver; |
| 340 | 340 | } |
| 341 | 341 | |
@@ -344,7 +344,7 @@ discard block |
||
| 344 | 344 | * @param string $driver the new driver |
| 345 | 345 | * @return object DatabaseQueryRunner |
| 346 | 346 | */ |
| 347 | - public function setDriver($driver){ |
|
| 347 | + public function setDriver($driver) { |
|
| 348 | 348 | $this->driver = $driver; |
| 349 | 349 | return $this; |
| 350 | 350 | } |
@@ -354,14 +354,14 @@ discard block |
||
| 354 | 354 | * |
| 355 | 355 | * @return string |
| 356 | 356 | */ |
| 357 | - protected function getBenchmarkKey(){ |
|
| 357 | + protected function getBenchmarkKey() { |
|
| 358 | 358 | return md5($this->query . $this->returnAsList . $this->returnAsArray); |
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | 362 | * Set error for database query execution |
| 363 | 363 | */ |
| 364 | - protected function setQueryRunnerError(){ |
|
| 364 | + protected function setQueryRunnerError() { |
|
| 365 | 365 | $error = $this->pdo->errorInfo(); |
| 366 | 366 | $this->error = isset($error[2]) ? $error[2] : ''; |
| 367 | 367 | $this->logger->error('The database query execution got an error: ' . stringfy_vars($error)); |
@@ -373,12 +373,12 @@ discard block |
||
| 373 | 373 | * Set the Log instance using argument or create new instance |
| 374 | 374 | * @param object $logger the Log instance if not null |
| 375 | 375 | */ |
| 376 | - protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
|
| 377 | - if ($logger !== null){ |
|
| 376 | + protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) { |
|
| 377 | + if ($logger !== null) { |
|
| 378 | 378 | $this->logger = $logger; |
| 379 | 379 | } |
| 380 | - else{ |
|
| 381 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 380 | + else { |
|
| 381 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 382 | 382 | $this->logger->setLogger('Library::DatabaseQueryRunner'); |
| 383 | 383 | } |
| 384 | 384 | } |
@@ -387,7 +387,7 @@ discard block |
||
| 387 | 387 | /** |
| 388 | 388 | * Reset the instance before run each query |
| 389 | 389 | */ |
| 390 | - private function reset(){ |
|
| 390 | + private function reset() { |
|
| 391 | 391 | $this->error = null; |
| 392 | 392 | $this->pdoStatment = null; |
| 393 | 393 | } |
@@ -1,81 +1,81 @@ |
||
| 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 | - /** |
|
| 28 | - * @file constants.php |
|
| 29 | - * |
|
| 30 | - * This file contains the declaration of most of the constants used in the system, |
|
| 31 | - * for example: the version, the name of the framework, etc. |
|
| 32 | - * |
|
| 33 | - * @package core |
|
| 34 | - * @author Tony NGUEREZA |
|
| 35 | - * @copyright Copyright (c) 2017 |
|
| 36 | - * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 37 | - * @link http://www.iacademy.cf |
|
| 38 | - * @version 1.0.0 |
|
| 39 | - * @filesource |
|
| 40 | - */ |
|
| 27 | + /** |
|
| 28 | + * @file constants.php |
|
| 29 | + * |
|
| 30 | + * This file contains the declaration of most of the constants used in the system, |
|
| 31 | + * for example: the version, the name of the framework, etc. |
|
| 32 | + * |
|
| 33 | + * @package core |
|
| 34 | + * @author Tony NGUEREZA |
|
| 35 | + * @copyright Copyright (c) 2017 |
|
| 36 | + * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 37 | + * @link http://www.iacademy.cf |
|
| 38 | + * @version 1.0.0 |
|
| 39 | + * @filesource |
|
| 40 | + */ |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * The framework name |
|
| 44 | - */ |
|
| 45 | - define('TNH_NAME', 'TNH Framework'); |
|
| 42 | + /** |
|
| 43 | + * The framework name |
|
| 44 | + */ |
|
| 45 | + define('TNH_NAME', 'TNH Framework'); |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * The version of the framework in X.Y.Z format (Major, minor and bugs). |
|
| 49 | - * If there is the presence of the word "dev", it means that |
|
| 50 | - * it is a version under development. |
|
| 51 | - */ |
|
| 52 | - define('TNH_VERSION', '1.0.0-dev'); |
|
| 47 | + /** |
|
| 48 | + * The version of the framework in X.Y.Z format (Major, minor and bugs). |
|
| 49 | + * If there is the presence of the word "dev", it means that |
|
| 50 | + * it is a version under development. |
|
| 51 | + */ |
|
| 52 | + define('TNH_VERSION', '1.0.0-dev'); |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * The date of publication or release of the framework |
|
| 56 | - */ |
|
| 57 | - define('TNH_RELEASE_DATE', '2017/02/05'); |
|
| 54 | + /** |
|
| 55 | + * The date of publication or release of the framework |
|
| 56 | + */ |
|
| 57 | + define('TNH_RELEASE_DATE', '2017/02/05'); |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * The author of the framework, the person who developed the framework. |
|
| 61 | - */ |
|
| 62 | - define('TNH_AUTHOR', 'Tony NGUEREZA'); |
|
| 59 | + /** |
|
| 60 | + * The author of the framework, the person who developed the framework. |
|
| 61 | + */ |
|
| 62 | + define('TNH_AUTHOR', 'Tony NGUEREZA'); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Email address of the author of the framework. |
|
| 66 | - */ |
|
| 67 | - define('TNH_AUTHOR_EMAIL', '[email protected]'); |
|
| 64 | + /** |
|
| 65 | + * Email address of the author of the framework. |
|
| 66 | + */ |
|
| 67 | + define('TNH_AUTHOR_EMAIL', '[email protected]'); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * The minimum PHP version required to use the framework. |
|
| 71 | - * If the version of PHP installed is lower, then the application will not work. |
|
| 72 | - * Note: we use the PHP version_compare function to compare the required version with |
|
| 73 | - * the version installed on your system. |
|
| 74 | - */ |
|
| 75 | - define('TNH_REQUIRED_PHP_MIN_VERSION', '5.4'); |
|
| 69 | + /** |
|
| 70 | + * The minimum PHP version required to use the framework. |
|
| 71 | + * If the version of PHP installed is lower, then the application will not work. |
|
| 72 | + * Note: we use the PHP version_compare function to compare the required version with |
|
| 73 | + * the version installed on your system. |
|
| 74 | + */ |
|
| 75 | + define('TNH_REQUIRED_PHP_MIN_VERSION', '5.4'); |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * The maximum version of PHP required to use the framework. |
|
| 79 | - * If the version of PHP installed is higher than the required one, then the application will not work. |
|
| 80 | - */ |
|
| 81 | - define('TNH_REQUIRED_PHP_MAX_VERSION', '7.1'); |
|
| 82 | 77 | \ No newline at end of file |
| 78 | + /** |
|
| 79 | + * The maximum version of PHP required to use the framework. |
|
| 80 | + * If the version of PHP installed is higher than the required one, then the application will not work. |
|
| 81 | + */ |
|
| 82 | + define('TNH_REQUIRED_PHP_MAX_VERSION', '7.1'); |
|
| 83 | 83 | \ No newline at end of file |
@@ -62,8 +62,7 @@ |
||
| 62 | 62 | $query[0] = rtrim($query[0], '/'); |
| 63 | 63 | $query[0] .= $suffix; |
| 64 | 64 | $path = implode('?', $query); |
| 65 | - } |
|
| 66 | - else{ |
|
| 65 | + } else{ |
|
| 67 | 66 | $path .= $suffix; |
| 68 | 67 | } |
| 69 | 68 | } |
@@ -1,149 +1,149 @@ |
||
| 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 | 27 | |
| 28 | - class Url{ |
|
| 28 | + class Url{ |
|
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * Return the link using base_url config without front controller "index.php" |
|
| 32 | - * @param string $path the link path or full URL |
|
| 33 | - * @return string the full link URL |
|
| 34 | - */ |
|
| 35 | - public static function base_url($path = ''){ |
|
| 36 | - if(is_url($path)){ |
|
| 37 | - return $path; |
|
| 38 | - } |
|
| 39 | - return get_config('base_url') . $path; |
|
| 40 | - } |
|
| 30 | + /** |
|
| 31 | + * Return the link using base_url config without front controller "index.php" |
|
| 32 | + * @param string $path the link path or full URL |
|
| 33 | + * @return string the full link URL |
|
| 34 | + */ |
|
| 35 | + public static function base_url($path = ''){ |
|
| 36 | + if(is_url($path)){ |
|
| 37 | + return $path; |
|
| 38 | + } |
|
| 39 | + return get_config('base_url') . $path; |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Return the link using base_url config with front controller "index.php" |
|
| 44 | - * @param string $path the link path or full URL |
|
| 45 | - * @return string the full link URL |
|
| 46 | - */ |
|
| 47 | - public static function site_url($path = ''){ |
|
| 48 | - if(is_url($path)){ |
|
| 49 | - return $path; |
|
| 50 | - } |
|
| 51 | - $path = rtrim($path, '/'); |
|
| 52 | - $baseUrl = get_config('base_url'); |
|
| 53 | - $frontController = get_config('front_controller'); |
|
| 54 | - $url = $baseUrl; |
|
| 55 | - if($frontController){ |
|
| 56 | - $url .= $frontController . '/'; |
|
| 57 | - } |
|
| 58 | - if(($suffix = get_config('url_suffix')) && $path){ |
|
| 59 | - if(strpos($path, '?') !== false){ |
|
| 60 | - $query = explode('?', $path); |
|
| 61 | - $query[0] = str_ireplace($suffix, '', $query[0]); |
|
| 62 | - $query[0] = rtrim($query[0], '/'); |
|
| 63 | - $query[0] .= $suffix; |
|
| 64 | - $path = implode('?', $query); |
|
| 65 | - } |
|
| 66 | - else{ |
|
| 67 | - $path .= $suffix; |
|
| 68 | - } |
|
| 69 | - } |
|
| 70 | - return $url . $path; |
|
| 71 | - } |
|
| 42 | + /** |
|
| 43 | + * Return the link using base_url config with front controller "index.php" |
|
| 44 | + * @param string $path the link path or full URL |
|
| 45 | + * @return string the full link URL |
|
| 46 | + */ |
|
| 47 | + public static function site_url($path = ''){ |
|
| 48 | + if(is_url($path)){ |
|
| 49 | + return $path; |
|
| 50 | + } |
|
| 51 | + $path = rtrim($path, '/'); |
|
| 52 | + $baseUrl = get_config('base_url'); |
|
| 53 | + $frontController = get_config('front_controller'); |
|
| 54 | + $url = $baseUrl; |
|
| 55 | + if($frontController){ |
|
| 56 | + $url .= $frontController . '/'; |
|
| 57 | + } |
|
| 58 | + if(($suffix = get_config('url_suffix')) && $path){ |
|
| 59 | + if(strpos($path, '?') !== false){ |
|
| 60 | + $query = explode('?', $path); |
|
| 61 | + $query[0] = str_ireplace($suffix, '', $query[0]); |
|
| 62 | + $query[0] = rtrim($query[0], '/'); |
|
| 63 | + $query[0] .= $suffix; |
|
| 64 | + $path = implode('?', $query); |
|
| 65 | + } |
|
| 66 | + else{ |
|
| 67 | + $path .= $suffix; |
|
| 68 | + } |
|
| 69 | + } |
|
| 70 | + return $url . $path; |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Return the current site URL |
|
| 75 | - * @return string |
|
| 76 | - */ |
|
| 77 | - public static function current(){ |
|
| 78 | - $current = '/'; |
|
| 79 | - $requestUri = get_instance()->request->requestUri(); |
|
| 80 | - if($requestUri){ |
|
| 81 | - $current = $requestUri; |
|
| 82 | - } |
|
| 83 | - return static::domain() . $current; |
|
| 84 | - } |
|
| 73 | + /** |
|
| 74 | + * Return the current site URL |
|
| 75 | + * @return string |
|
| 76 | + */ |
|
| 77 | + public static function current(){ |
|
| 78 | + $current = '/'; |
|
| 79 | + $requestUri = get_instance()->request->requestUri(); |
|
| 80 | + if($requestUri){ |
|
| 81 | + $current = $requestUri; |
|
| 82 | + } |
|
| 83 | + return static::domain() . $current; |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * Generate a friendly text to use in link (slugs) |
|
| 88 | - * @param string $str the title or text to use to get the friendly text |
|
| 89 | - * @param string $separator the caracters separator |
|
| 90 | - * @param boolean $lowercase whether to set the final text to lowe case or not |
|
| 91 | - * @return string the friendly generated text |
|
| 92 | - */ |
|
| 93 | - public static function title($str = null, $separator = '-', $lowercase = true){ |
|
| 94 | - $str = trim($str); |
|
| 95 | - $from = array('ç','À','Á','Â','Ã','Ä','Å','à','á','â','ã','ä','å','Ò','Ó','Ô','Õ','Ö','Ø','ò','ó','ô','õ','ö','ø','È','É','Ê','Ë','è','é','ê','ë','Ç','ç','Ì','Í','Î','Ï','ì','í','î','ï','Ù','Ú','Û','Ü','ù','ú','û','ü','ÿ','Ñ','ñ'); |
|
| 96 | - $to = array('c','a','a','a','a','a','a','a','a','a','a','a','a','o','o','o','o','o','o','o','o','o','o','o','o','e','e','e','e','e','e','e','e','e','e','i','i','i','i','i','i','i','i','u','u','u','u','u','u','u','u','y','n','n'); |
|
| 97 | - $str = str_replace($from, $to, $str); |
|
| 98 | - $str = preg_replace('#([^a-z0-9]+)#i', $separator, $str); |
|
| 99 | - $str = str_replace('--', $separator, $str); |
|
| 100 | - //if after process we get something like one-two-three-, need truncate the last separator "-" |
|
| 101 | - if(substr($str, -1) == $separator){ |
|
| 102 | - $str = substr($str, 0, -1); |
|
| 103 | - } |
|
| 104 | - if($lowercase){ |
|
| 105 | - $str = strtolower($str); |
|
| 106 | - } |
|
| 107 | - return $str; |
|
| 108 | - } |
|
| 86 | + /** |
|
| 87 | + * Generate a friendly text to use in link (slugs) |
|
| 88 | + * @param string $str the title or text to use to get the friendly text |
|
| 89 | + * @param string $separator the caracters separator |
|
| 90 | + * @param boolean $lowercase whether to set the final text to lowe case or not |
|
| 91 | + * @return string the friendly generated text |
|
| 92 | + */ |
|
| 93 | + public static function title($str = null, $separator = '-', $lowercase = true){ |
|
| 94 | + $str = trim($str); |
|
| 95 | + $from = array('ç','À','Á','Â','Ã','Ä','Å','à','á','â','ã','ä','å','Ò','Ó','Ô','Õ','Ö','Ø','ò','ó','ô','õ','ö','ø','È','É','Ê','Ë','è','é','ê','ë','Ç','ç','Ì','Í','Î','Ï','ì','í','î','ï','Ù','Ú','Û','Ü','ù','ú','û','ü','ÿ','Ñ','ñ'); |
|
| 96 | + $to = array('c','a','a','a','a','a','a','a','a','a','a','a','a','o','o','o','o','o','o','o','o','o','o','o','o','e','e','e','e','e','e','e','e','e','e','i','i','i','i','i','i','i','i','u','u','u','u','u','u','u','u','y','n','n'); |
|
| 97 | + $str = str_replace($from, $to, $str); |
|
| 98 | + $str = preg_replace('#([^a-z0-9]+)#i', $separator, $str); |
|
| 99 | + $str = str_replace('--', $separator, $str); |
|
| 100 | + //if after process we get something like one-two-three-, need truncate the last separator "-" |
|
| 101 | + if(substr($str, -1) == $separator){ |
|
| 102 | + $str = substr($str, 0, -1); |
|
| 103 | + } |
|
| 104 | + if($lowercase){ |
|
| 105 | + $str = strtolower($str); |
|
| 106 | + } |
|
| 107 | + return $str; |
|
| 108 | + } |
|
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Get the current application domain with protocol |
|
| 112 | - * @return string the domain name |
|
| 113 | - */ |
|
| 114 | - public static function domain(){ |
|
| 115 | - $domain = 'localhost'; |
|
| 116 | - $port = get_instance()->request->server('SERVER_PORT'); |
|
| 117 | - $protocol = 'http'; |
|
| 118 | - if(is_https()){ |
|
| 119 | - $protocol = 'https'; |
|
| 120 | - } |
|
| 110 | + /** |
|
| 111 | + * Get the current application domain with protocol |
|
| 112 | + * @return string the domain name |
|
| 113 | + */ |
|
| 114 | + public static function domain(){ |
|
| 115 | + $domain = 'localhost'; |
|
| 116 | + $port = get_instance()->request->server('SERVER_PORT'); |
|
| 117 | + $protocol = 'http'; |
|
| 118 | + if(is_https()){ |
|
| 119 | + $protocol = 'https'; |
|
| 120 | + } |
|
| 121 | 121 | |
| 122 | - $domainserverVars = array( |
|
| 123 | - 'HTTP_HOST', |
|
| 124 | - 'SERVER_NAME', |
|
| 125 | - 'SERVER_ADDR' |
|
| 126 | - ); |
|
| 122 | + $domainserverVars = array( |
|
| 123 | + 'HTTP_HOST', |
|
| 124 | + 'SERVER_NAME', |
|
| 125 | + 'SERVER_ADDR' |
|
| 126 | + ); |
|
| 127 | 127 | |
| 128 | - foreach ($domainserverVars as $var) { |
|
| 129 | - $value = get_instance()->request->server($var); |
|
| 130 | - if($value){ |
|
| 131 | - $domain = $value; |
|
| 132 | - break; |
|
| 133 | - } |
|
| 134 | - } |
|
| 128 | + foreach ($domainserverVars as $var) { |
|
| 129 | + $value = get_instance()->request->server($var); |
|
| 130 | + if($value){ |
|
| 131 | + $domain = $value; |
|
| 132 | + break; |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | 135 | |
| 136 | - if($port && ((is_https() && $port != 443) || (!is_https() && $port != 80))){ |
|
| 137 | - $domain .= ':'.$port; |
|
| 138 | - } |
|
| 139 | - return $protocol.'://'.$domain; |
|
| 140 | - } |
|
| 136 | + if($port && ((is_https() && $port != 443) || (!is_https() && $port != 80))){ |
|
| 137 | + $domain .= ':'.$port; |
|
| 138 | + } |
|
| 139 | + return $protocol.'://'.$domain; |
|
| 140 | + } |
|
| 141 | 141 | |
| 142 | - /** |
|
| 143 | - * Get the current request query string |
|
| 144 | - * @return string |
|
| 145 | - */ |
|
| 146 | - public static function queryString(){ |
|
| 147 | - return get_instance()->request->server('QUERY_STRING'); |
|
| 148 | - } |
|
| 149 | - } |
|
| 142 | + /** |
|
| 143 | + * Get the current request query string |
|
| 144 | + * @return string |
|
| 145 | + */ |
|
| 146 | + public static function queryString(){ |
|
| 147 | + return get_instance()->request->server('QUERY_STRING'); |
|
| 148 | + } |
|
| 149 | + } |
|
@@ -25,15 +25,15 @@ discard block |
||
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | 27 | |
| 28 | - class Url{ |
|
| 28 | + class Url { |
|
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * Return the link using base_url config without front controller "index.php" |
| 32 | 32 | * @param string $path the link path or full URL |
| 33 | 33 | * @return string the full link URL |
| 34 | 34 | */ |
| 35 | - public static function base_url($path = ''){ |
|
| 36 | - if(is_url($path)){ |
|
| 35 | + public static function base_url($path = '') { |
|
| 36 | + if (is_url($path)) { |
|
| 37 | 37 | return $path; |
| 38 | 38 | } |
| 39 | 39 | return get_config('base_url') . $path; |
@@ -44,26 +44,26 @@ discard block |
||
| 44 | 44 | * @param string $path the link path or full URL |
| 45 | 45 | * @return string the full link URL |
| 46 | 46 | */ |
| 47 | - public static function site_url($path = ''){ |
|
| 48 | - if(is_url($path)){ |
|
| 47 | + public static function site_url($path = '') { |
|
| 48 | + if (is_url($path)) { |
|
| 49 | 49 | return $path; |
| 50 | 50 | } |
| 51 | 51 | $path = rtrim($path, '/'); |
| 52 | 52 | $baseUrl = get_config('base_url'); |
| 53 | 53 | $frontController = get_config('front_controller'); |
| 54 | 54 | $url = $baseUrl; |
| 55 | - if($frontController){ |
|
| 55 | + if ($frontController) { |
|
| 56 | 56 | $url .= $frontController . '/'; |
| 57 | 57 | } |
| 58 | - if(($suffix = get_config('url_suffix')) && $path){ |
|
| 59 | - if(strpos($path, '?') !== false){ |
|
| 58 | + if (($suffix = get_config('url_suffix')) && $path) { |
|
| 59 | + if (strpos($path, '?') !== false) { |
|
| 60 | 60 | $query = explode('?', $path); |
| 61 | 61 | $query[0] = str_ireplace($suffix, '', $query[0]); |
| 62 | 62 | $query[0] = rtrim($query[0], '/'); |
| 63 | 63 | $query[0] .= $suffix; |
| 64 | 64 | $path = implode('?', $query); |
| 65 | 65 | } |
| 66 | - else{ |
|
| 66 | + else { |
|
| 67 | 67 | $path .= $suffix; |
| 68 | 68 | } |
| 69 | 69 | } |
@@ -74,10 +74,10 @@ discard block |
||
| 74 | 74 | * Return the current site URL |
| 75 | 75 | * @return string |
| 76 | 76 | */ |
| 77 | - public static function current(){ |
|
| 77 | + public static function current() { |
|
| 78 | 78 | $current = '/'; |
| 79 | 79 | $requestUri = get_instance()->request->requestUri(); |
| 80 | - if($requestUri){ |
|
| 80 | + if ($requestUri) { |
|
| 81 | 81 | $current = $requestUri; |
| 82 | 82 | } |
| 83 | 83 | return static::domain() . $current; |
@@ -90,18 +90,18 @@ discard block |
||
| 90 | 90 | * @param boolean $lowercase whether to set the final text to lowe case or not |
| 91 | 91 | * @return string the friendly generated text |
| 92 | 92 | */ |
| 93 | - public static function title($str = null, $separator = '-', $lowercase = true){ |
|
| 93 | + public static function title($str = null, $separator = '-', $lowercase = true) { |
|
| 94 | 94 | $str = trim($str); |
| 95 | - $from = array('ç','À','Á','Â','Ã','Ä','Å','à','á','â','ã','ä','å','Ò','Ó','Ô','Õ','Ö','Ø','ò','ó','ô','õ','ö','ø','È','É','Ê','Ë','è','é','ê','ë','Ç','ç','Ì','Í','Î','Ï','ì','í','î','ï','Ù','Ú','Û','Ü','ù','ú','û','ü','ÿ','Ñ','ñ'); |
|
| 96 | - $to = array('c','a','a','a','a','a','a','a','a','a','a','a','a','o','o','o','o','o','o','o','o','o','o','o','o','e','e','e','e','e','e','e','e','e','e','i','i','i','i','i','i','i','i','u','u','u','u','u','u','u','u','y','n','n'); |
|
| 95 | + $from = array('ç', 'À', 'Á', 'Â', 'Ã', 'Ä', 'Å', 'à', 'á', 'â', 'ã', 'ä', 'å', 'Ò', 'Ó', 'Ô', 'Õ', 'Ö', 'Ø', 'ò', 'ó', 'ô', 'õ', 'ö', 'ø', 'È', 'É', 'Ê', 'Ë', 'è', 'é', 'ê', 'ë', 'Ç', 'ç', 'Ì', 'Í', 'Î', 'Ï', 'ì', 'í', 'î', 'ï', 'Ù', 'Ú', 'Û', 'Ü', 'ù', 'ú', 'û', 'ü', 'ÿ', 'Ñ', 'ñ'); |
|
| 96 | + $to = array('c', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'o', 'e', 'e', 'e', 'e', 'e', 'e', 'e', 'e', 'e', 'e', 'i', 'i', 'i', 'i', 'i', 'i', 'i', 'i', 'u', 'u', 'u', 'u', 'u', 'u', 'u', 'u', 'y', 'n', 'n'); |
|
| 97 | 97 | $str = str_replace($from, $to, $str); |
| 98 | 98 | $str = preg_replace('#([^a-z0-9]+)#i', $separator, $str); |
| 99 | 99 | $str = str_replace('--', $separator, $str); |
| 100 | 100 | //if after process we get something like one-two-three-, need truncate the last separator "-" |
| 101 | - if(substr($str, -1) == $separator){ |
|
| 101 | + if (substr($str, -1) == $separator) { |
|
| 102 | 102 | $str = substr($str, 0, -1); |
| 103 | 103 | } |
| 104 | - if($lowercase){ |
|
| 104 | + if ($lowercase) { |
|
| 105 | 105 | $str = strtolower($str); |
| 106 | 106 | } |
| 107 | 107 | return $str; |
@@ -111,11 +111,11 @@ discard block |
||
| 111 | 111 | * Get the current application domain with protocol |
| 112 | 112 | * @return string the domain name |
| 113 | 113 | */ |
| 114 | - public static function domain(){ |
|
| 114 | + public static function domain() { |
|
| 115 | 115 | $domain = 'localhost'; |
| 116 | 116 | $port = get_instance()->request->server('SERVER_PORT'); |
| 117 | 117 | $protocol = 'http'; |
| 118 | - if(is_https()){ |
|
| 118 | + if (is_https()) { |
|
| 119 | 119 | $protocol = 'https'; |
| 120 | 120 | } |
| 121 | 121 | |
@@ -127,23 +127,23 @@ discard block |
||
| 127 | 127 | |
| 128 | 128 | foreach ($domainserverVars as $var) { |
| 129 | 129 | $value = get_instance()->request->server($var); |
| 130 | - if($value){ |
|
| 130 | + if ($value) { |
|
| 131 | 131 | $domain = $value; |
| 132 | 132 | break; |
| 133 | 133 | } |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | - if($port && ((is_https() && $port != 443) || (!is_https() && $port != 80))){ |
|
| 137 | - $domain .= ':'.$port; |
|
| 136 | + if ($port && ((is_https() && $port != 443) || (!is_https() && $port != 80))) { |
|
| 137 | + $domain .= ':' . $port; |
|
| 138 | 138 | } |
| 139 | - return $protocol.'://'.$domain; |
|
| 139 | + return $protocol . '://' . $domain; |
|
| 140 | 140 | } |
| 141 | 141 | |
| 142 | 142 | /** |
| 143 | 143 | * Get the current request query string |
| 144 | 144 | * @return string |
| 145 | 145 | */ |
| 146 | - public static function queryString(){ |
|
| 146 | + public static function queryString() { |
|
| 147 | 147 | return get_instance()->request->server('QUERY_STRING'); |
| 148 | 148 | } |
| 149 | 149 | } |
@@ -1,75 +1,75 @@ |
||
| 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 | 27 | |
| 28 | - /** |
|
| 29 | - * @file function_user_agent.php |
|
| 30 | - * |
|
| 31 | - * Contains most of the utility functions for agent, platform, mobile, browser, and other management. |
|
| 32 | - * |
|
| 33 | - * @package core |
|
| 34 | - * @author Tony NGUEREZA |
|
| 35 | - * @copyright Copyright (c) 2017 |
|
| 36 | - * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 37 | - * @link http://www.iacademy.cf |
|
| 38 | - * @version 1.0.0 |
|
| 39 | - * @since 1.0.0 |
|
| 40 | - * @filesource |
|
| 41 | - */ |
|
| 28 | + /** |
|
| 29 | + * @file function_user_agent.php |
|
| 30 | + * |
|
| 31 | + * Contains most of the utility functions for agent, platform, mobile, browser, and other management. |
|
| 32 | + * |
|
| 33 | + * @package core |
|
| 34 | + * @author Tony NGUEREZA |
|
| 35 | + * @copyright Copyright (c) 2017 |
|
| 36 | + * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 37 | + * @link http://www.iacademy.cf |
|
| 38 | + * @version 1.0.0 |
|
| 39 | + * @since 1.0.0 |
|
| 40 | + * @filesource |
|
| 41 | + */ |
|
| 42 | 42 | |
| 43 | 43 | |
| 44 | - if(! function_exists('get_ip')){ |
|
| 45 | - /** |
|
| 46 | - * Retrieves the user's IP address |
|
| 47 | - * |
|
| 48 | - * This function allows to retrieve the IP address of the client |
|
| 49 | - * even if it uses a proxy, the actual IP address is retrieved. |
|
| 50 | - * |
|
| 51 | - * @return string the IP address. |
|
| 52 | - */ |
|
| 53 | - function get_ip(){ |
|
| 54 | - $ip = '127.0.0.1'; |
|
| 55 | - $ipServerVars = array( |
|
| 56 | - 'REMOTE_ADDR', |
|
| 57 | - 'HTTP_CLIENT_IP', |
|
| 58 | - 'HTTP_X_FORWARDED_FOR', |
|
| 59 | - 'HTTP_X_FORWARDED', |
|
| 60 | - 'HTTP_FORWARDED_FOR', |
|
| 61 | - 'HTTP_FORWARDED' |
|
| 62 | - ); |
|
| 63 | - foreach ($ipServerVars as $var) { |
|
| 64 | - if(isset($_SERVER[$var])){ |
|
| 65 | - $ip = $_SERVER[$var]; |
|
| 66 | - break; |
|
| 67 | - } |
|
| 68 | - } |
|
| 69 | - // Strip any secondary IP etc from the IP address |
|
| 70 | - if (strpos($ip, ',') > 0) { |
|
| 71 | - $ip = substr($ip, 0, strpos($ip, ',')); |
|
| 72 | - } |
|
| 73 | - return $ip; |
|
| 74 | - } |
|
| 75 | - } |
|
| 44 | + if(! function_exists('get_ip')){ |
|
| 45 | + /** |
|
| 46 | + * Retrieves the user's IP address |
|
| 47 | + * |
|
| 48 | + * This function allows to retrieve the IP address of the client |
|
| 49 | + * even if it uses a proxy, the actual IP address is retrieved. |
|
| 50 | + * |
|
| 51 | + * @return string the IP address. |
|
| 52 | + */ |
|
| 53 | + function get_ip(){ |
|
| 54 | + $ip = '127.0.0.1'; |
|
| 55 | + $ipServerVars = array( |
|
| 56 | + 'REMOTE_ADDR', |
|
| 57 | + 'HTTP_CLIENT_IP', |
|
| 58 | + 'HTTP_X_FORWARDED_FOR', |
|
| 59 | + 'HTTP_X_FORWARDED', |
|
| 60 | + 'HTTP_FORWARDED_FOR', |
|
| 61 | + 'HTTP_FORWARDED' |
|
| 62 | + ); |
|
| 63 | + foreach ($ipServerVars as $var) { |
|
| 64 | + if(isset($_SERVER[$var])){ |
|
| 65 | + $ip = $_SERVER[$var]; |
|
| 66 | + break; |
|
| 67 | + } |
|
| 68 | + } |
|
| 69 | + // Strip any secondary IP etc from the IP address |
|
| 70 | + if (strpos($ip, ',') > 0) { |
|
| 71 | + $ip = substr($ip, 0, strpos($ip, ',')); |
|
| 72 | + } |
|
| 73 | + return $ip; |
|
| 74 | + } |
|
| 75 | + } |
|
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | */ |
| 42 | 42 | |
| 43 | 43 | |
| 44 | - if(! function_exists('get_ip')){ |
|
| 44 | + if (!function_exists('get_ip')) { |
|
| 45 | 45 | /** |
| 46 | 46 | * Retrieves the user's IP address |
| 47 | 47 | * |
@@ -50,7 +50,7 @@ discard block |
||
| 50 | 50 | * |
| 51 | 51 | * @return string the IP address. |
| 52 | 52 | */ |
| 53 | - function get_ip(){ |
|
| 53 | + function get_ip() { |
|
| 54 | 54 | $ip = '127.0.0.1'; |
| 55 | 55 | $ipServerVars = array( |
| 56 | 56 | 'REMOTE_ADDR', |
@@ -61,7 +61,7 @@ discard block |
||
| 61 | 61 | 'HTTP_FORWARDED' |
| 62 | 62 | ); |
| 63 | 63 | foreach ($ipServerVars as $var) { |
| 64 | - if(isset($_SERVER[$var])){ |
|
| 64 | + if (isset($_SERVER[$var])) { |
|
| 65 | 65 | $ip = $_SERVER[$var]; |
| 66 | 66 | break; |
| 67 | 67 | } |
@@ -1,168 +1,168 @@ |
||
| 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 | - /** |
|
| 28 | - * @file Assets.php |
|
| 29 | - * |
|
| 30 | - * This class contains static methods for generating static content links (images, Javascript, CSS, etc.). |
|
| 31 | - * |
|
| 32 | - * @package core |
|
| 33 | - * @author Tony NGUEREZA |
|
| 34 | - * @copyright Copyright (c) 2017 |
|
| 35 | - * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 36 | - * @link http://www.iacademy.cf |
|
| 37 | - * @version 1.0.0 |
|
| 38 | - * @since 1.0.0 |
|
| 39 | - * @filesource |
|
| 40 | - */ |
|
| 41 | - class Assets{ |
|
| 27 | + /** |
|
| 28 | + * @file Assets.php |
|
| 29 | + * |
|
| 30 | + * This class contains static methods for generating static content links (images, Javascript, CSS, etc.). |
|
| 31 | + * |
|
| 32 | + * @package core |
|
| 33 | + * @author Tony NGUEREZA |
|
| 34 | + * @copyright Copyright (c) 2017 |
|
| 35 | + * @license https://opensource.org/licenses/gpl-3.0.html GNU GPL License (GPL) |
|
| 36 | + * @link http://www.iacademy.cf |
|
| 37 | + * @version 1.0.0 |
|
| 38 | + * @since 1.0.0 |
|
| 39 | + * @filesource |
|
| 40 | + */ |
|
| 41 | + class Assets{ |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * The logger instance |
|
| 45 | - * @var object |
|
| 46 | - */ |
|
| 47 | - private static $logger; |
|
| 43 | + /** |
|
| 44 | + * The logger instance |
|
| 45 | + * @var object |
|
| 46 | + */ |
|
| 47 | + private static $logger; |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * The signleton of the logger |
|
| 51 | - * @return Object the Log instance |
|
| 52 | - */ |
|
| 53 | - private static function getLogger(){ |
|
| 54 | - if(self::$logger == null){ |
|
| 55 | - //can't assign reference to static variable |
|
| 56 | - self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 57 | - self::$logger[0]->setLogger('Library::Assets'); |
|
| 58 | - } |
|
| 59 | - return self::$logger[0]; |
|
| 60 | - } |
|
| 49 | + /** |
|
| 50 | + * The signleton of the logger |
|
| 51 | + * @return Object the Log instance |
|
| 52 | + */ |
|
| 53 | + private static function getLogger(){ |
|
| 54 | + if(self::$logger == null){ |
|
| 55 | + //can't assign reference to static variable |
|
| 56 | + self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 57 | + self::$logger[0]->setLogger('Library::Assets'); |
|
| 58 | + } |
|
| 59 | + return self::$logger[0]; |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Generate the link of the assets file. |
|
| 65 | - * |
|
| 66 | - * Generates the absolute link of a file inside ASSETS_PATH folder. |
|
| 67 | - * For example : |
|
| 68 | - * echo Assets::path('foo/bar/css/style.css'); => http://mysite.com/assets/foo/bar/css/style.css |
|
| 69 | - * Note: |
|
| 70 | - * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 71 | - * |
|
| 72 | - * @param string $asset the name of the assets file path with the extension. |
|
| 73 | - * @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist. |
|
| 74 | - */ |
|
| 75 | - public static function path($asset){ |
|
| 76 | - $logger = self::getLogger(); |
|
| 77 | - $path = ASSETS_PATH . $asset; |
|
| 63 | + /** |
|
| 64 | + * Generate the link of the assets file. |
|
| 65 | + * |
|
| 66 | + * Generates the absolute link of a file inside ASSETS_PATH folder. |
|
| 67 | + * For example : |
|
| 68 | + * echo Assets::path('foo/bar/css/style.css'); => http://mysite.com/assets/foo/bar/css/style.css |
|
| 69 | + * Note: |
|
| 70 | + * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 71 | + * |
|
| 72 | + * @param string $asset the name of the assets file path with the extension. |
|
| 73 | + * @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist. |
|
| 74 | + */ |
|
| 75 | + public static function path($asset){ |
|
| 76 | + $logger = self::getLogger(); |
|
| 77 | + $path = ASSETS_PATH . $asset; |
|
| 78 | 78 | |
| 79 | - $logger->debug('Including the Assets file [' . $path . ']'); |
|
| 80 | - //Check if the file exists |
|
| 81 | - if(file_exists($path)){ |
|
| 82 | - $logger->info('Assets file [' . $path . '] included successfully'); |
|
| 83 | - return Url::base_url($path); |
|
| 84 | - } |
|
| 85 | - $logger->warning('Assets file [' . $path . '] does not exist'); |
|
| 86 | - return null; |
|
| 87 | - } |
|
| 79 | + $logger->debug('Including the Assets file [' . $path . ']'); |
|
| 80 | + //Check if the file exists |
|
| 81 | + if(file_exists($path)){ |
|
| 82 | + $logger->info('Assets file [' . $path . '] included successfully'); |
|
| 83 | + return Url::base_url($path); |
|
| 84 | + } |
|
| 85 | + $logger->warning('Assets file [' . $path . '] does not exist'); |
|
| 86 | + return null; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Generate the link of the css file. |
|
| 91 | - * |
|
| 92 | - * Generates the absolute link of a file containing the CSS style. |
|
| 93 | - * For example : |
|
| 94 | - * echo Assets::css('mystyle'); => http://mysite.com/assets/css/mystyle.css |
|
| 95 | - * Note: |
|
| 96 | - * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 97 | - * |
|
| 98 | - * @param string $path the name of the css file without the extension. |
|
| 99 | - * @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist. |
|
| 100 | - */ |
|
| 101 | - public static function css($path){ |
|
| 102 | - $logger = self::getLogger(); |
|
| 103 | - /* |
|
| 89 | + /** |
|
| 90 | + * Generate the link of the css file. |
|
| 91 | + * |
|
| 92 | + * Generates the absolute link of a file containing the CSS style. |
|
| 93 | + * For example : |
|
| 94 | + * echo Assets::css('mystyle'); => http://mysite.com/assets/css/mystyle.css |
|
| 95 | + * Note: |
|
| 96 | + * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 97 | + * |
|
| 98 | + * @param string $path the name of the css file without the extension. |
|
| 99 | + * @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist. |
|
| 100 | + */ |
|
| 101 | + public static function css($path){ |
|
| 102 | + $logger = self::getLogger(); |
|
| 103 | + /* |
|
| 104 | 104 | * if the file name contains the ".css" extension, replace it with |
| 105 | 105 | * an empty string for better processing. |
| 106 | 106 | */ |
| 107 | - $path = str_ireplace('.css', '', $path); |
|
| 108 | - $path = ASSETS_PATH . 'css/' . $path . '.css'; |
|
| 107 | + $path = str_ireplace('.css', '', $path); |
|
| 108 | + $path = ASSETS_PATH . 'css/' . $path . '.css'; |
|
| 109 | 109 | |
| 110 | - $logger->debug('Including the Assets file [' . $path . '] for CSS'); |
|
| 111 | - //Check if the file exists |
|
| 112 | - if(file_exists($path)){ |
|
| 113 | - $logger->info('Assets file [' . $path . '] for CSS included successfully'); |
|
| 114 | - return Url::base_url($path); |
|
| 115 | - } |
|
| 116 | - $logger->warning('Assets file [' . $path . '] for CSS does not exist'); |
|
| 117 | - return null; |
|
| 118 | - } |
|
| 110 | + $logger->debug('Including the Assets file [' . $path . '] for CSS'); |
|
| 111 | + //Check if the file exists |
|
| 112 | + if(file_exists($path)){ |
|
| 113 | + $logger->info('Assets file [' . $path . '] for CSS included successfully'); |
|
| 114 | + return Url::base_url($path); |
|
| 115 | + } |
|
| 116 | + $logger->warning('Assets file [' . $path . '] for CSS does not exist'); |
|
| 117 | + return null; |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Generate the link of the javascript file. |
|
| 122 | - * |
|
| 123 | - * Generates the absolute link of a file containing the javascript. |
|
| 124 | - * For example : |
|
| 125 | - * echo Assets::js('myscript'); => http://mysite.com/assets/js/myscript.js |
|
| 126 | - * Note: |
|
| 127 | - * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 128 | - * |
|
| 129 | - * @param string $path the name of the javascript file without the extension. |
|
| 130 | - * @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist. |
|
| 131 | - */ |
|
| 132 | - public static function js($path){ |
|
| 133 | - $logger = self::getLogger(); |
|
| 134 | - $path = str_ireplace('.js', '', $path); |
|
| 135 | - $path = ASSETS_PATH . 'js/' . $path . '.js'; |
|
| 136 | - $logger->debug('Including the Assets file [' . $path . '] for javascript'); |
|
| 137 | - if(file_exists($path)){ |
|
| 138 | - $logger->info('Assets file [' . $path . '] for Javascript included successfully'); |
|
| 139 | - return Url::base_url($path); |
|
| 140 | - } |
|
| 141 | - $logger->warning('Assets file [' . $path . '] for Javascript does not exist'); |
|
| 142 | - return null; |
|
| 143 | - } |
|
| 120 | + /** |
|
| 121 | + * Generate the link of the javascript file. |
|
| 122 | + * |
|
| 123 | + * Generates the absolute link of a file containing the javascript. |
|
| 124 | + * For example : |
|
| 125 | + * echo Assets::js('myscript'); => http://mysite.com/assets/js/myscript.js |
|
| 126 | + * Note: |
|
| 127 | + * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 128 | + * |
|
| 129 | + * @param string $path the name of the javascript file without the extension. |
|
| 130 | + * @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist. |
|
| 131 | + */ |
|
| 132 | + public static function js($path){ |
|
| 133 | + $logger = self::getLogger(); |
|
| 134 | + $path = str_ireplace('.js', '', $path); |
|
| 135 | + $path = ASSETS_PATH . 'js/' . $path . '.js'; |
|
| 136 | + $logger->debug('Including the Assets file [' . $path . '] for javascript'); |
|
| 137 | + if(file_exists($path)){ |
|
| 138 | + $logger->info('Assets file [' . $path . '] for Javascript included successfully'); |
|
| 139 | + return Url::base_url($path); |
|
| 140 | + } |
|
| 141 | + $logger->warning('Assets file [' . $path . '] for Javascript does not exist'); |
|
| 142 | + return null; |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Generate the link of the image file. |
|
| 147 | - * |
|
| 148 | - * Generates the absolute link of a file containing the image. |
|
| 149 | - * For example : |
|
| 150 | - * echo Assets::img('myimage.png'); => http://mysite.com/assets/images/myimage.png |
|
| 151 | - * Note: |
|
| 152 | - * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 153 | - * |
|
| 154 | - * @param string $path the name of the image file with the extension. |
|
| 155 | - * @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist. |
|
| 156 | - */ |
|
| 157 | - public static function img($path){ |
|
| 158 | - $logger = self::getLogger(); |
|
| 159 | - $path = ASSETS_PATH . 'images/' . $path; |
|
| 160 | - $logger->debug('Including the Assets file [' . $path . '] for image'); |
|
| 161 | - if(file_exists($path)){ |
|
| 162 | - $logger->info('Assets file [' . $path . '] for image included successfully'); |
|
| 163 | - return Url::base_url($path); |
|
| 164 | - } |
|
| 165 | - $logger->warning('Assets file [' . $path . '] for image does not exist'); |
|
| 166 | - return null; |
|
| 167 | - } |
|
| 168 | - } |
|
| 145 | + /** |
|
| 146 | + * Generate the link of the image file. |
|
| 147 | + * |
|
| 148 | + * Generates the absolute link of a file containing the image. |
|
| 149 | + * For example : |
|
| 150 | + * echo Assets::img('myimage.png'); => http://mysite.com/assets/images/myimage.png |
|
| 151 | + * Note: |
|
| 152 | + * The argument passed to this function must be the relative link to the folder that contains the static contents defined by the constant ASSETS_PATH. |
|
| 153 | + * |
|
| 154 | + * @param string $path the name of the image file with the extension. |
|
| 155 | + * @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist. |
|
| 156 | + */ |
|
| 157 | + public static function img($path){ |
|
| 158 | + $logger = self::getLogger(); |
|
| 159 | + $path = ASSETS_PATH . 'images/' . $path; |
|
| 160 | + $logger->debug('Including the Assets file [' . $path . '] for image'); |
|
| 161 | + if(file_exists($path)){ |
|
| 162 | + $logger->info('Assets file [' . $path . '] for image included successfully'); |
|
| 163 | + return Url::base_url($path); |
|
| 164 | + } |
|
| 165 | + $logger->warning('Assets file [' . $path . '] for image does not exist'); |
|
| 166 | + return null; |
|
| 167 | + } |
|
| 168 | + } |
|
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | * @since 1.0.0 |
| 39 | 39 | * @filesource |
| 40 | 40 | */ |
| 41 | - class Assets{ |
|
| 41 | + class Assets { |
|
| 42 | 42 | |
| 43 | 43 | /** |
| 44 | 44 | * The logger instance |
@@ -50,10 +50,10 @@ discard block |
||
| 50 | 50 | * The signleton of the logger |
| 51 | 51 | * @return Object the Log instance |
| 52 | 52 | */ |
| 53 | - private static function getLogger(){ |
|
| 54 | - if(self::$logger == null){ |
|
| 53 | + private static function getLogger() { |
|
| 54 | + if (self::$logger == null) { |
|
| 55 | 55 | //can't assign reference to static variable |
| 56 | - self::$logger[0] =& class_loader('Log', 'classes'); |
|
| 56 | + self::$logger[0] = & class_loader('Log', 'classes'); |
|
| 57 | 57 | self::$logger[0]->setLogger('Library::Assets'); |
| 58 | 58 | } |
| 59 | 59 | return self::$logger[0]; |
@@ -72,13 +72,13 @@ discard block |
||
| 72 | 72 | * @param string $asset the name of the assets file path with the extension. |
| 73 | 73 | * @return string|null the absolute path of the assets file, if it exists otherwise returns null if the file does not exist. |
| 74 | 74 | */ |
| 75 | - public static function path($asset){ |
|
| 75 | + public static function path($asset) { |
|
| 76 | 76 | $logger = self::getLogger(); |
| 77 | 77 | $path = ASSETS_PATH . $asset; |
| 78 | 78 | |
| 79 | 79 | $logger->debug('Including the Assets file [' . $path . ']'); |
| 80 | 80 | //Check if the file exists |
| 81 | - if(file_exists($path)){ |
|
| 81 | + if (file_exists($path)) { |
|
| 82 | 82 | $logger->info('Assets file [' . $path . '] included successfully'); |
| 83 | 83 | return Url::base_url($path); |
| 84 | 84 | } |
@@ -98,7 +98,7 @@ discard block |
||
| 98 | 98 | * @param string $path the name of the css file without the extension. |
| 99 | 99 | * @return string|null the absolute path of the css file, if it exists otherwise returns null if the file does not exist. |
| 100 | 100 | */ |
| 101 | - public static function css($path){ |
|
| 101 | + public static function css($path) { |
|
| 102 | 102 | $logger = self::getLogger(); |
| 103 | 103 | /* |
| 104 | 104 | * if the file name contains the ".css" extension, replace it with |
@@ -109,7 +109,7 @@ discard block |
||
| 109 | 109 | |
| 110 | 110 | $logger->debug('Including the Assets file [' . $path . '] for CSS'); |
| 111 | 111 | //Check if the file exists |
| 112 | - if(file_exists($path)){ |
|
| 112 | + if (file_exists($path)) { |
|
| 113 | 113 | $logger->info('Assets file [' . $path . '] for CSS included successfully'); |
| 114 | 114 | return Url::base_url($path); |
| 115 | 115 | } |
@@ -129,12 +129,12 @@ discard block |
||
| 129 | 129 | * @param string $path the name of the javascript file without the extension. |
| 130 | 130 | * @return string|null the absolute path of the javascript file, if it exists otherwise returns null if the file does not exist. |
| 131 | 131 | */ |
| 132 | - public static function js($path){ |
|
| 132 | + public static function js($path) { |
|
| 133 | 133 | $logger = self::getLogger(); |
| 134 | 134 | $path = str_ireplace('.js', '', $path); |
| 135 | 135 | $path = ASSETS_PATH . 'js/' . $path . '.js'; |
| 136 | 136 | $logger->debug('Including the Assets file [' . $path . '] for javascript'); |
| 137 | - if(file_exists($path)){ |
|
| 137 | + if (file_exists($path)) { |
|
| 138 | 138 | $logger->info('Assets file [' . $path . '] for Javascript included successfully'); |
| 139 | 139 | return Url::base_url($path); |
| 140 | 140 | } |
@@ -154,11 +154,11 @@ discard block |
||
| 154 | 154 | * @param string $path the name of the image file with the extension. |
| 155 | 155 | * @return string|null the absolute path of the image file, if it exists otherwise returns null if the file does not exist. |
| 156 | 156 | */ |
| 157 | - public static function img($path){ |
|
| 157 | + public static function img($path) { |
|
| 158 | 158 | $logger = self::getLogger(); |
| 159 | 159 | $path = ASSETS_PATH . 'images/' . $path; |
| 160 | 160 | $logger->debug('Including the Assets file [' . $path . '] for image'); |
| 161 | - if(file_exists($path)){ |
|
| 161 | + if (file_exists($path)) { |
|
| 162 | 162 | $logger->info('Assets file [' . $path . '] for image included successfully'); |
| 163 | 163 | return Url::base_url($path); |
| 164 | 164 | } |
@@ -128,8 +128,7 @@ discard block |
||
| 128 | 128 | $logger->info('Delete config item ['.$item.']'); |
| 129 | 129 | unset(self::$config[$item]); |
| 130 | 130 | return true; |
| 131 | - } |
|
| 132 | - else{ |
|
| 131 | + } else{ |
|
| 133 | 132 | $logger->warning('Config item ['.$item.'] to be deleted does not exists'); |
| 134 | 133 | return false; |
| 135 | 134 | } |
@@ -179,8 +178,7 @@ discard block |
||
| 179 | 178 | 0, |
| 180 | 179 | strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME'])) |
| 181 | 180 | ); |
| 182 | - } |
|
| 183 | - else{ |
|
| 181 | + } else{ |
|
| 184 | 182 | $logger->warning('Can not determine the application base URL automatically, use http://localhost as default'); |
| 185 | 183 | $baseUrl = 'http://localhost/'; |
| 186 | 184 | } |
@@ -1,190 +1,190 @@ |
||
| 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 Config{ |
|
| 27 | + class Config{ |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * The list of loaded configuration |
|
| 31 | - * @var array |
|
| 32 | - */ |
|
| 33 | - private static $config = array(); |
|
| 29 | + /** |
|
| 30 | + * The list of loaded configuration |
|
| 31 | + * @var array |
|
| 32 | + */ |
|
| 33 | + private static $config = 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 signleton of the logger |
|
| 43 | - * @return Object the Log instance |
|
| 44 | - */ |
|
| 45 | - public static function getLogger(){ |
|
| 46 | - if(self::$logger == null){ |
|
| 47 | - $logger = array(); |
|
| 48 | - $logger[0] =& class_loader('Log', 'classes'); |
|
| 49 | - $logger[0]->setLogger('Library::Config'); |
|
| 50 | - self::$logger = $logger[0]; |
|
| 51 | - } |
|
| 52 | - return self::$logger; |
|
| 53 | - } |
|
| 41 | + /** |
|
| 42 | + * The signleton of the logger |
|
| 43 | + * @return Object the Log instance |
|
| 44 | + */ |
|
| 45 | + public static function getLogger(){ |
|
| 46 | + if(self::$logger == null){ |
|
| 47 | + $logger = array(); |
|
| 48 | + $logger[0] =& class_loader('Log', 'classes'); |
|
| 49 | + $logger[0]->setLogger('Library::Config'); |
|
| 50 | + self::$logger = $logger[0]; |
|
| 51 | + } |
|
| 52 | + return self::$logger; |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Set the log instance for future use |
|
| 57 | - * @param object $logger the log object |
|
| 58 | - * @return object the log instance |
|
| 59 | - */ |
|
| 60 | - public static function setLogger($logger){ |
|
| 61 | - self::$logger = $logger; |
|
| 62 | - return self::$logger; |
|
| 63 | - } |
|
| 55 | + /** |
|
| 56 | + * Set the log instance for future use |
|
| 57 | + * @param object $logger the log object |
|
| 58 | + * @return object the log instance |
|
| 59 | + */ |
|
| 60 | + public static function setLogger($logger){ |
|
| 61 | + self::$logger = $logger; |
|
| 62 | + return self::$logger; |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Initialize the configuration by loading all the configuration from config file |
|
| 67 | - */ |
|
| 68 | - public static function init(){ |
|
| 69 | - $logger = static::getLogger(); |
|
| 70 | - $logger->debug('Initialization of the configuration'); |
|
| 71 | - self::$config = & load_configurations(); |
|
| 72 | - self::setBaseUrlUsingServerVar(); |
|
| 73 | - if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){ |
|
| 74 | - $logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance'); |
|
| 75 | - } |
|
| 76 | - $logger->info('Configuration initialized successfully'); |
|
| 77 | - $logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config)); |
|
| 78 | - } |
|
| 65 | + /** |
|
| 66 | + * Initialize the configuration by loading all the configuration from config file |
|
| 67 | + */ |
|
| 68 | + public static function init(){ |
|
| 69 | + $logger = static::getLogger(); |
|
| 70 | + $logger->debug('Initialization of the configuration'); |
|
| 71 | + self::$config = & load_configurations(); |
|
| 72 | + self::setBaseUrlUsingServerVar(); |
|
| 73 | + if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){ |
|
| 74 | + $logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance'); |
|
| 75 | + } |
|
| 76 | + $logger->info('Configuration initialized successfully'); |
|
| 77 | + $logger->info('The application configuration are listed below: ' . stringfy_vars(self::$config)); |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Get the configuration item value |
|
| 82 | - * @param string $item the configuration item name to get |
|
| 83 | - * @param mixed $default the default value to use if can not find the config item in the list |
|
| 84 | - * @return mixed the config value if exist or the default value |
|
| 85 | - */ |
|
| 86 | - public static function get($item, $default = null){ |
|
| 87 | - $logger = static::getLogger(); |
|
| 88 | - if(array_key_exists($item, self::$config)){ |
|
| 89 | - return self::$config[$item]; |
|
| 90 | - } |
|
| 91 | - $logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']'); |
|
| 92 | - return $default; |
|
| 93 | - } |
|
| 80 | + /** |
|
| 81 | + * Get the configuration item value |
|
| 82 | + * @param string $item the configuration item name to get |
|
| 83 | + * @param mixed $default the default value to use if can not find the config item in the list |
|
| 84 | + * @return mixed the config value if exist or the default value |
|
| 85 | + */ |
|
| 86 | + public static function get($item, $default = null){ |
|
| 87 | + $logger = static::getLogger(); |
|
| 88 | + if(array_key_exists($item, self::$config)){ |
|
| 89 | + return self::$config[$item]; |
|
| 90 | + } |
|
| 91 | + $logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']'); |
|
| 92 | + return $default; |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Set the configuration item value |
|
| 97 | - * @param string $item the config item name to set |
|
| 98 | - * @param mixed $value the config item value |
|
| 99 | - */ |
|
| 100 | - public static function set($item, $value){ |
|
| 101 | - self::$config[$item] = $value; |
|
| 102 | - } |
|
| 95 | + /** |
|
| 96 | + * Set the configuration item value |
|
| 97 | + * @param string $item the config item name to set |
|
| 98 | + * @param mixed $value the config item value |
|
| 99 | + */ |
|
| 100 | + public static function set($item, $value){ |
|
| 101 | + self::$config[$item] = $value; |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | - /** |
|
| 105 | - * Get all the configuration values |
|
| 106 | - * @return array the config values |
|
| 107 | - */ |
|
| 108 | - public static function getAll(){ |
|
| 109 | - return self::$config; |
|
| 110 | - } |
|
| 104 | + /** |
|
| 105 | + * Get all the configuration values |
|
| 106 | + * @return array the config values |
|
| 107 | + */ |
|
| 108 | + public static function getAll(){ |
|
| 109 | + return self::$config; |
|
| 110 | + } |
|
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Set the configuration values bu merged with the existing configuration |
|
| 114 | - * @param array $config the config values to add in the configuration list |
|
| 115 | - */ |
|
| 116 | - public static function setAll(array $config = array()){ |
|
| 117 | - self::$config = array_merge(self::$config, $config); |
|
| 118 | - } |
|
| 112 | + /** |
|
| 113 | + * Set the configuration values bu merged with the existing configuration |
|
| 114 | + * @param array $config the config values to add in the configuration list |
|
| 115 | + */ |
|
| 116 | + public static function setAll(array $config = array()){ |
|
| 117 | + self::$config = array_merge(self::$config, $config); |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Delete the configuration item in the list |
|
| 122 | - * @param string $item the config item name to be deleted |
|
| 123 | - * @return boolean true if the item exists and is deleted successfully otherwise will return false. |
|
| 124 | - */ |
|
| 125 | - public static function delete($item){ |
|
| 126 | - $logger = static::getLogger(); |
|
| 127 | - if(array_key_exists($item, self::$config)){ |
|
| 128 | - $logger->info('Delete config item ['.$item.']'); |
|
| 129 | - unset(self::$config[$item]); |
|
| 130 | - return true; |
|
| 131 | - } |
|
| 132 | - else{ |
|
| 133 | - $logger->warning('Config item ['.$item.'] to be deleted does not exists'); |
|
| 134 | - return false; |
|
| 135 | - } |
|
| 136 | - } |
|
| 120 | + /** |
|
| 121 | + * Delete the configuration item in the list |
|
| 122 | + * @param string $item the config item name to be deleted |
|
| 123 | + * @return boolean true if the item exists and is deleted successfully otherwise will return false. |
|
| 124 | + */ |
|
| 125 | + public static function delete($item){ |
|
| 126 | + $logger = static::getLogger(); |
|
| 127 | + if(array_key_exists($item, self::$config)){ |
|
| 128 | + $logger->info('Delete config item ['.$item.']'); |
|
| 129 | + unset(self::$config[$item]); |
|
| 130 | + return true; |
|
| 131 | + } |
|
| 132 | + else{ |
|
| 133 | + $logger->warning('Config item ['.$item.'] to be deleted does not exists'); |
|
| 134 | + return false; |
|
| 135 | + } |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | - /** |
|
| 139 | - * Load the configuration file. This an alias to Loader::config() |
|
| 140 | - * @param string $config the config name to be loaded |
|
| 141 | - */ |
|
| 142 | - public static function load($config){ |
|
| 143 | - Loader::config($config); |
|
| 144 | - } |
|
| 138 | + /** |
|
| 139 | + * Load the configuration file. This an alias to Loader::config() |
|
| 140 | + * @param string $config the config name to be loaded |
|
| 141 | + */ |
|
| 142 | + public static function load($config){ |
|
| 143 | + Loader::config($config); |
|
| 144 | + } |
|
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Set the configuration for "base_url" if is not set in the configuration |
|
| 148 | - */ |
|
| 149 | - private static function setBaseUrlUsingServerVar(){ |
|
| 150 | - $logger = static::getLogger(); |
|
| 151 | - if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){ |
|
| 152 | - if(ENVIRONMENT == 'production'){ |
|
| 153 | - $logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time'); |
|
| 154 | - } |
|
| 155 | - $baseUrl = null; |
|
| 156 | - $protocol = 'http'; |
|
| 157 | - if(is_https()){ |
|
| 158 | - $protocol = 'https'; |
|
| 159 | - } |
|
| 160 | - $protocol .='://'; |
|
| 146 | + /** |
|
| 147 | + * Set the configuration for "base_url" if is not set in the configuration |
|
| 148 | + */ |
|
| 149 | + private static function setBaseUrlUsingServerVar(){ |
|
| 150 | + $logger = static::getLogger(); |
|
| 151 | + if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){ |
|
| 152 | + if(ENVIRONMENT == 'production'){ |
|
| 153 | + $logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time'); |
|
| 154 | + } |
|
| 155 | + $baseUrl = null; |
|
| 156 | + $protocol = 'http'; |
|
| 157 | + if(is_https()){ |
|
| 158 | + $protocol = 'https'; |
|
| 159 | + } |
|
| 160 | + $protocol .='://'; |
|
| 161 | 161 | |
| 162 | - if (isset($_SERVER['SERVER_ADDR'])){ |
|
| 163 | - $baseUrl = $_SERVER['SERVER_ADDR']; |
|
| 164 | - //check if the server is running under IPv6 |
|
| 165 | - if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){ |
|
| 166 | - $baseUrl = '['.$_SERVER['SERVER_ADDR'].']'; |
|
| 167 | - } |
|
| 168 | - $serverPort = 80; |
|
| 169 | - if (isset($_SERVER['SERVER_PORT'])) { |
|
| 170 | - $serverPort = $_SERVER['SERVER_PORT']; |
|
| 171 | - } |
|
| 172 | - $port = ''; |
|
| 173 | - if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){ |
|
| 174 | - $port = ':'.$serverPort; |
|
| 175 | - } |
|
| 176 | - $baseUrl = $protocol . $baseUrl . $port . substr( |
|
| 177 | - $_SERVER['SCRIPT_NAME'], |
|
| 178 | - 0, |
|
| 179 | - strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME'])) |
|
| 180 | - ); |
|
| 181 | - } |
|
| 182 | - else{ |
|
| 183 | - $logger->warning('Can not determine the application base URL automatically, use http://localhost as default'); |
|
| 184 | - $baseUrl = 'http://localhost/'; |
|
| 185 | - } |
|
| 186 | - self::set('base_url', $baseUrl); |
|
| 187 | - } |
|
| 188 | - self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/'; |
|
| 189 | - } |
|
| 190 | - } |
|
| 162 | + if (isset($_SERVER['SERVER_ADDR'])){ |
|
| 163 | + $baseUrl = $_SERVER['SERVER_ADDR']; |
|
| 164 | + //check if the server is running under IPv6 |
|
| 165 | + if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){ |
|
| 166 | + $baseUrl = '['.$_SERVER['SERVER_ADDR'].']'; |
|
| 167 | + } |
|
| 168 | + $serverPort = 80; |
|
| 169 | + if (isset($_SERVER['SERVER_PORT'])) { |
|
| 170 | + $serverPort = $_SERVER['SERVER_PORT']; |
|
| 171 | + } |
|
| 172 | + $port = ''; |
|
| 173 | + if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){ |
|
| 174 | + $port = ':'.$serverPort; |
|
| 175 | + } |
|
| 176 | + $baseUrl = $protocol . $baseUrl . $port . substr( |
|
| 177 | + $_SERVER['SCRIPT_NAME'], |
|
| 178 | + 0, |
|
| 179 | + strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME'])) |
|
| 180 | + ); |
|
| 181 | + } |
|
| 182 | + else{ |
|
| 183 | + $logger->warning('Can not determine the application base URL automatically, use http://localhost as default'); |
|
| 184 | + $baseUrl = 'http://localhost/'; |
|
| 185 | + } |
|
| 186 | + self::set('base_url', $baseUrl); |
|
| 187 | + } |
|
| 188 | + self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/'; |
|
| 189 | + } |
|
| 190 | + } |
|
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class Config{ |
|
| 27 | + class Config { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * The list of loaded configuration |
@@ -42,10 +42,10 @@ discard block |
||
| 42 | 42 | * The signleton of the logger |
| 43 | 43 | * @return Object the Log instance |
| 44 | 44 | */ |
| 45 | - public static function getLogger(){ |
|
| 46 | - if(self::$logger == null){ |
|
| 45 | + public static function getLogger() { |
|
| 46 | + if (self::$logger == null) { |
|
| 47 | 47 | $logger = array(); |
| 48 | - $logger[0] =& class_loader('Log', 'classes'); |
|
| 48 | + $logger[0] = & class_loader('Log', 'classes'); |
|
| 49 | 49 | $logger[0]->setLogger('Library::Config'); |
| 50 | 50 | self::$logger = $logger[0]; |
| 51 | 51 | } |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | * @param object $logger the log object |
| 58 | 58 | * @return object the log instance |
| 59 | 59 | */ |
| 60 | - public static function setLogger($logger){ |
|
| 60 | + public static function setLogger($logger) { |
|
| 61 | 61 | self::$logger = $logger; |
| 62 | 62 | return self::$logger; |
| 63 | 63 | } |
@@ -65,12 +65,12 @@ discard block |
||
| 65 | 65 | /** |
| 66 | 66 | * Initialize the configuration by loading all the configuration from config file |
| 67 | 67 | */ |
| 68 | - public static function init(){ |
|
| 68 | + public static function init() { |
|
| 69 | 69 | $logger = static::getLogger(); |
| 70 | 70 | $logger->debug('Initialization of the configuration'); |
| 71 | 71 | self::$config = & load_configurations(); |
| 72 | 72 | self::setBaseUrlUsingServerVar(); |
| 73 | - if(ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info','all'))){ |
|
| 73 | + if (ENVIRONMENT == 'production' && in_array(strtolower(self::$config['log_level']), array('debug', 'info', 'all'))) { |
|
| 74 | 74 | $logger->warning('You are in production environment, please set log level to WARNING, ERROR, FATAL to increase the application performance'); |
| 75 | 75 | } |
| 76 | 76 | $logger->info('Configuration initialized successfully'); |
@@ -83,12 +83,12 @@ discard block |
||
| 83 | 83 | * @param mixed $default the default value to use if can not find the config item in the list |
| 84 | 84 | * @return mixed the config value if exist or the default value |
| 85 | 85 | */ |
| 86 | - public static function get($item, $default = null){ |
|
| 86 | + public static function get($item, $default = null) { |
|
| 87 | 87 | $logger = static::getLogger(); |
| 88 | - if(array_key_exists($item, self::$config)){ |
|
| 88 | + if (array_key_exists($item, self::$config)) { |
|
| 89 | 89 | return self::$config[$item]; |
| 90 | 90 | } |
| 91 | - $logger->warning('Cannot find config item ['.$item.'] using the default value ['.$default.']'); |
|
| 91 | + $logger->warning('Cannot find config item [' . $item . '] using the default value [' . $default . ']'); |
|
| 92 | 92 | return $default; |
| 93 | 93 | } |
| 94 | 94 | |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | * @param string $item the config item name to set |
| 98 | 98 | * @param mixed $value the config item value |
| 99 | 99 | */ |
| 100 | - public static function set($item, $value){ |
|
| 100 | + public static function set($item, $value) { |
|
| 101 | 101 | self::$config[$item] = $value; |
| 102 | 102 | } |
| 103 | 103 | |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | * Get all the configuration values |
| 106 | 106 | * @return array the config values |
| 107 | 107 | */ |
| 108 | - public static function getAll(){ |
|
| 108 | + public static function getAll() { |
|
| 109 | 109 | return self::$config; |
| 110 | 110 | } |
| 111 | 111 | |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | * Set the configuration values bu merged with the existing configuration |
| 114 | 114 | * @param array $config the config values to add in the configuration list |
| 115 | 115 | */ |
| 116 | - public static function setAll(array $config = array()){ |
|
| 116 | + public static function setAll(array $config = array()) { |
|
| 117 | 117 | self::$config = array_merge(self::$config, $config); |
| 118 | 118 | } |
| 119 | 119 | |
@@ -122,15 +122,15 @@ discard block |
||
| 122 | 122 | * @param string $item the config item name to be deleted |
| 123 | 123 | * @return boolean true if the item exists and is deleted successfully otherwise will return false. |
| 124 | 124 | */ |
| 125 | - public static function delete($item){ |
|
| 125 | + public static function delete($item) { |
|
| 126 | 126 | $logger = static::getLogger(); |
| 127 | - if(array_key_exists($item, self::$config)){ |
|
| 128 | - $logger->info('Delete config item ['.$item.']'); |
|
| 127 | + if (array_key_exists($item, self::$config)) { |
|
| 128 | + $logger->info('Delete config item [' . $item . ']'); |
|
| 129 | 129 | unset(self::$config[$item]); |
| 130 | 130 | return true; |
| 131 | 131 | } |
| 132 | - else{ |
|
| 133 | - $logger->warning('Config item ['.$item.'] to be deleted does not exists'); |
|
| 132 | + else { |
|
| 133 | + $logger->warning('Config item [' . $item . '] to be deleted does not exists'); |
|
| 134 | 134 | return false; |
| 135 | 135 | } |
| 136 | 136 | } |
@@ -139,39 +139,39 @@ discard block |
||
| 139 | 139 | * Load the configuration file. This an alias to Loader::config() |
| 140 | 140 | * @param string $config the config name to be loaded |
| 141 | 141 | */ |
| 142 | - public static function load($config){ |
|
| 142 | + public static function load($config) { |
|
| 143 | 143 | Loader::config($config); |
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
| 147 | 147 | * Set the configuration for "base_url" if is not set in the configuration |
| 148 | 148 | */ |
| 149 | - private static function setBaseUrlUsingServerVar(){ |
|
| 149 | + private static function setBaseUrlUsingServerVar() { |
|
| 150 | 150 | $logger = static::getLogger(); |
| 151 | - if (! isset(self::$config['base_url']) || ! is_url(self::$config['base_url'])){ |
|
| 152 | - if(ENVIRONMENT == 'production'){ |
|
| 151 | + if (!isset(self::$config['base_url']) || !is_url(self::$config['base_url'])) { |
|
| 152 | + if (ENVIRONMENT == 'production') { |
|
| 153 | 153 | $logger->warning('Application base URL is not set or invalid, please set application base URL to increase the application loading time'); |
| 154 | 154 | } |
| 155 | 155 | $baseUrl = null; |
| 156 | 156 | $protocol = 'http'; |
| 157 | - if(is_https()){ |
|
| 157 | + if (is_https()) { |
|
| 158 | 158 | $protocol = 'https'; |
| 159 | 159 | } |
| 160 | - $protocol .='://'; |
|
| 160 | + $protocol .= '://'; |
|
| 161 | 161 | |
| 162 | - if (isset($_SERVER['SERVER_ADDR'])){ |
|
| 162 | + if (isset($_SERVER['SERVER_ADDR'])) { |
|
| 163 | 163 | $baseUrl = $_SERVER['SERVER_ADDR']; |
| 164 | 164 | //check if the server is running under IPv6 |
| 165 | - if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE){ |
|
| 166 | - $baseUrl = '['.$_SERVER['SERVER_ADDR'].']'; |
|
| 165 | + if (strpos($_SERVER['SERVER_ADDR'], ':') !== FALSE) { |
|
| 166 | + $baseUrl = '[' . $_SERVER['SERVER_ADDR'] . ']'; |
|
| 167 | 167 | } |
| 168 | 168 | $serverPort = 80; |
| 169 | 169 | if (isset($_SERVER['SERVER_PORT'])) { |
| 170 | 170 | $serverPort = $_SERVER['SERVER_PORT']; |
| 171 | 171 | } |
| 172 | 172 | $port = ''; |
| 173 | - if($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))){ |
|
| 174 | - $port = ':'.$serverPort; |
|
| 173 | + if ($serverPort && ((is_https() && $serverPort != 443) || (!is_https() && $serverPort != 80))) { |
|
| 174 | + $port = ':' . $serverPort; |
|
| 175 | 175 | } |
| 176 | 176 | $baseUrl = $protocol . $baseUrl . $port . substr( |
| 177 | 177 | $_SERVER['SCRIPT_NAME'], |
@@ -179,12 +179,12 @@ discard block |
||
| 179 | 179 | strpos($_SERVER['SCRIPT_NAME'], basename($_SERVER['SCRIPT_FILENAME'])) |
| 180 | 180 | ); |
| 181 | 181 | } |
| 182 | - else{ |
|
| 182 | + else { |
|
| 183 | 183 | $logger->warning('Can not determine the application base URL automatically, use http://localhost as default'); |
| 184 | 184 | $baseUrl = 'http://localhost/'; |
| 185 | 185 | } |
| 186 | 186 | self::set('base_url', $baseUrl); |
| 187 | 187 | } |
| 188 | - self::$config['base_url'] = rtrim(self::$config['base_url'], '/') .'/'; |
|
| 188 | + self::$config['base_url'] = rtrim(self::$config['base_url'], '/') . '/'; |
|
| 189 | 189 | } |
| 190 | 190 | } |
@@ -234,8 +234,7 @@ discard block |
||
| 234 | 234 | //first check for CSRF |
| 235 | 235 | if (get_config('csrf_enable', false) && ! Security::validateCSRF()){ |
| 236 | 236 | show_error('Invalide data, Cross Site Request Forgery do his job, the data to validate is corrupted.'); |
| 237 | - } |
|
| 238 | - else{ |
|
| 237 | + } else{ |
|
| 239 | 238 | $this->logger->info('CSRF is not enabled in configuration or not set manully, no need to check it'); |
| 240 | 239 | } |
| 241 | 240 | } |
@@ -255,8 +254,7 @@ discard block |
||
| 255 | 254 | foreach ($this->getData() as $inputName => $inputVal) { |
| 256 | 255 | if(is_array($this->data[$inputName])){ |
| 257 | 256 | $this->data[$inputName] = array_map('trim', $this->data[$inputName]); |
| 258 | - } |
|
| 259 | - else{ |
|
| 257 | + } else{ |
|
| 260 | 258 | $this->data[$inputName] = trim($this->data[$inputName]); |
| 261 | 259 | } |
| 262 | 260 | |
@@ -624,8 +622,7 @@ discard block |
||
| 624 | 622 | if ($inputVal == '' && $callbackReturn == true) { |
| 625 | 623 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
| 626 | 624 | } |
| 627 | - } |
|
| 628 | - else if($inputVal == '') { |
|
| 625 | + } else if($inputVal == '') { |
|
| 629 | 626 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
| 630 | 627 | } |
| 631 | 628 | } |
@@ -684,8 +681,7 @@ discard block |
||
| 684 | 681 | $this->_setError($inputName, $ruleName . ',post:key', array($this->_getLabel($inputName), $this->_getLabel(str_replace('post:', '', $doNotEqual)))); |
| 685 | 682 | continue; |
| 686 | 683 | } |
| 687 | - } |
|
| 688 | - else{ |
|
| 684 | + } else{ |
|
| 689 | 685 | if ($inputVal == $doNotEqual) { |
| 690 | 686 | $this->_setError($inputName, $ruleName . ',string', array($this->_getLabel($inputName), $doNotEqual)); |
| 691 | 687 | continue; |
@@ -22,10 +22,10 @@ discard block |
||
| 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 | 27 | |
| 28 | - class FormValidation{ |
|
| 28 | + class FormValidation{ |
|
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * The form validation status |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | */ |
| 61 | 61 | protected $_eachErrorDelimiter = array('<p class="error">', '</p>'); |
| 62 | 62 | |
| 63 | - /** |
|
| 63 | + /** |
|
| 64 | 64 | * Indicated if need force the validation to be failed |
| 65 | 65 | * @var boolean |
| 66 | 66 | */ |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | $this->logger =& class_loader('Log', 'classes'); |
| 101 | 101 | $this->logger->setLogger('Library::FormValidation'); |
| 102 | 102 | |
| 103 | - //Load form validation language message |
|
| 103 | + //Load form validation language message |
|
| 104 | 104 | Loader::lang('form_validation'); |
| 105 | 105 | $obj = & get_instance(); |
| 106 | 106 | $this->_errorsMessages = array( |
@@ -162,13 +162,13 @@ discard block |
||
| 162 | 162 | /** |
| 163 | 163 | * Set the form validation data |
| 164 | 164 | * @param array $data the values to be validated |
| 165 | - * |
|
| 165 | + * |
|
| 166 | 166 | * @return FormValidation Current instance of object. |
| 167 | 167 | */ |
| 168 | 168 | public function setData(array $data){ |
| 169 | 169 | $this->logger->debug('Setting the form validation data, the values are: ' . stringfy_vars($data)); |
| 170 | 170 | $this->data = $data; |
| 171 | - return $this; |
|
| 171 | + return $this; |
|
| 172 | 172 | } |
| 173 | 173 | |
| 174 | 174 | /** |
@@ -179,11 +179,11 @@ discard block |
||
| 179 | 179 | return $this->data; |
| 180 | 180 | } |
| 181 | 181 | |
| 182 | - /** |
|
| 183 | - * Get the validation function name to validate a rule |
|
| 184 | - * |
|
| 185 | - * @return string the function name |
|
| 186 | - */ |
|
| 182 | + /** |
|
| 183 | + * Get the validation function name to validate a rule |
|
| 184 | + * |
|
| 185 | + * @return string the function name |
|
| 186 | + */ |
|
| 187 | 187 | protected function _toCallCase($funcName, $prefix='_validate') { |
| 188 | 188 | $funcName = strtolower($funcName); |
| 189 | 189 | $finalFuncName = $prefix; |
@@ -253,12 +253,12 @@ discard block |
||
| 253 | 253 | $this->_forceFail = false; |
| 254 | 254 | |
| 255 | 255 | foreach ($this->getData() as $inputName => $inputVal) { |
| 256 | - if(is_array($this->data[$inputName])){ |
|
| 257 | - $this->data[$inputName] = array_map('trim', $this->data[$inputName]); |
|
| 258 | - } |
|
| 259 | - else{ |
|
| 260 | - $this->data[$inputName] = trim($this->data[$inputName]); |
|
| 261 | - } |
|
| 256 | + if(is_array($this->data[$inputName])){ |
|
| 257 | + $this->data[$inputName] = array_map('trim', $this->data[$inputName]); |
|
| 258 | + } |
|
| 259 | + else{ |
|
| 260 | + $this->data[$inputName] = trim($this->data[$inputName]); |
|
| 261 | + } |
|
| 262 | 262 | |
| 263 | 263 | if (array_key_exists($inputName, $this->_rules)) { |
| 264 | 264 | foreach ($this->_parseRuleString($this->_rules[$inputName]) as $eachRule) { |
@@ -274,7 +274,7 @@ discard block |
||
| 274 | 274 | * |
| 275 | 275 | * @param string $inputField Name of the field or the data key to add a rule to |
| 276 | 276 | * @param string $ruleSets PIPE seperated string of rules |
| 277 | - * |
|
| 277 | + * |
|
| 278 | 278 | * @return FormValidation Current instance of object. |
| 279 | 279 | */ |
| 280 | 280 | public function setRule($inputField, $inputLabel, $ruleSets) { |
@@ -288,8 +288,8 @@ discard block |
||
| 288 | 288 | * Takes an array of rules and uses setRule() to set them, accepts an array |
| 289 | 289 | * of rule names rather than a pipe-delimited string as well. |
| 290 | 290 | * @param array $ruleSets |
| 291 | - * |
|
| 292 | - * @return FormValidation Current instance of object. |
|
| 291 | + * |
|
| 292 | + * @return FormValidation Current instance of object. |
|
| 293 | 293 | */ |
| 294 | 294 | public function setRules(array $ruleSets) { |
| 295 | 295 | foreach ($ruleSets as $ruleSet) { |
@@ -311,7 +311,7 @@ discard block |
||
| 311 | 311 | * @param string $start Before block of errors gets displayed, HTML allowed. |
| 312 | 312 | * @param string $end After the block of errors gets displayed, HTML allowed. |
| 313 | 313 | * |
| 314 | - * @return FormValidation Current instance of object. |
|
| 314 | + * @return FormValidation Current instance of object. |
|
| 315 | 315 | */ |
| 316 | 316 | public function setErrorsDelimiter($start, $end) { |
| 317 | 317 | $this->_allErrorsDelimiter[0] = $start; |
@@ -326,7 +326,7 @@ discard block |
||
| 326 | 326 | * @param string $start Displayed before each error. |
| 327 | 327 | * @param string $end Displayed after each error. |
| 328 | 328 | * |
| 329 | - * @return FormValidation Current instance of object. |
|
| 329 | + * @return FormValidation Current instance of object. |
|
| 330 | 330 | */ |
| 331 | 331 | public function setErrorDelimiter($start, $end) { |
| 332 | 332 | $this->_eachErrorDelimiter[0] = $start; |
@@ -334,21 +334,21 @@ discard block |
||
| 334 | 334 | return $this; |
| 335 | 335 | } |
| 336 | 336 | |
| 337 | - /** |
|
| 338 | - * Get the each errors delimiters |
|
| 339 | - * |
|
| 340 | - * @return array |
|
| 341 | - */ |
|
| 342 | - public function getErrorDelimiter() { |
|
| 337 | + /** |
|
| 338 | + * Get the each errors delimiters |
|
| 339 | + * |
|
| 340 | + * @return array |
|
| 341 | + */ |
|
| 342 | + public function getErrorDelimiter() { |
|
| 343 | 343 | return $this->_eachErrorDelimiter; |
| 344 | 344 | } |
| 345 | 345 | |
| 346 | - /** |
|
| 347 | - * Get the all errors delimiters |
|
| 348 | - * |
|
| 349 | - * @return array |
|
| 350 | - */ |
|
| 351 | - public function getErrorsDelimiter() { |
|
| 346 | + /** |
|
| 347 | + * Get the all errors delimiters |
|
| 348 | + * |
|
| 349 | + * @return array |
|
| 350 | + */ |
|
| 351 | + public function getErrorsDelimiter() { |
|
| 352 | 352 | return $this->_allErrorsDelimiter; |
| 353 | 353 | } |
| 354 | 354 | |
@@ -386,7 +386,7 @@ discard block |
||
| 386 | 386 | * |
| 387 | 387 | * @param string $inputName The form input name or data key |
| 388 | 388 | * @param string $errorMessage Error to display |
| 389 | - * |
|
| 389 | + * |
|
| 390 | 390 | * @return formValidation Current instance of the object |
| 391 | 391 | */ |
| 392 | 392 | public function setCustomError($inputName, $errorMessage) { |
@@ -423,17 +423,17 @@ discard block |
||
| 423 | 423 | * |
| 424 | 424 | * @param boolean $limit number of error to display or return |
| 425 | 425 | * @param boolean $echo Whether or not the values are to be returned or displayed |
| 426 | - * |
|
| 426 | + * |
|
| 427 | 427 | * @return string Errors formatted for output |
| 428 | 428 | */ |
| 429 | 429 | public function displayErrors($limit = null, $echo = true) { |
| 430 | 430 | list($errorsStart, $errorsEnd) = $this->_allErrorsDelimiter; |
| 431 | 431 | list($errorStart, $errorEnd) = $this->_eachErrorDelimiter; |
| 432 | 432 | $errorOutput = $errorsStart; |
| 433 | - $i = 0; |
|
| 433 | + $i = 0; |
|
| 434 | 434 | if (!empty($this->_errors)) { |
| 435 | 435 | foreach ($this->_errors as $fieldName => $error) { |
| 436 | - if ($i === $limit) { |
|
| 436 | + if ($i === $limit) { |
|
| 437 | 437 | break; |
| 438 | 438 | } |
| 439 | 439 | $errorOutput .= $errorStart; |
@@ -461,7 +461,7 @@ discard block |
||
| 461 | 461 | * Breaks up a PIPE seperated string of rules, and puts them into an array. |
| 462 | 462 | * |
| 463 | 463 | * @param string $ruleString String to be parsed. |
| 464 | - * |
|
| 464 | + * |
|
| 465 | 465 | * @return array Array of each value in original string. |
| 466 | 466 | */ |
| 467 | 467 | protected function _parseRuleString($ruleString) { |
@@ -474,10 +474,10 @@ discard block |
||
| 474 | 474 | $rule = '#regex\[\/(.*)\/([a-zA-Z0-9]?)\]#'; |
| 475 | 475 | preg_match($rule, $ruleString, $regexRule); |
| 476 | 476 | $ruleStringTemp = preg_replace($rule, '', $ruleString); |
| 477 | - if(!empty($regexRule[0])){ |
|
| 478 | - $ruleSets[] = $regexRule[0]; |
|
| 479 | - } |
|
| 480 | - $ruleStringRegex = explode('|', $ruleStringTemp); |
|
| 477 | + if(!empty($regexRule[0])){ |
|
| 478 | + $ruleSets[] = $regexRule[0]; |
|
| 479 | + } |
|
| 480 | + $ruleStringRegex = explode('|', $ruleStringTemp); |
|
| 481 | 481 | foreach ($ruleStringRegex as $rule) { |
| 482 | 482 | $rule = trim($rule); |
| 483 | 483 | if($rule){ |
@@ -493,7 +493,7 @@ discard block |
||
| 493 | 493 | } else { |
| 494 | 494 | $ruleSets[] = $ruleString; |
| 495 | 495 | } |
| 496 | - } |
|
| 496 | + } |
|
| 497 | 497 | return $ruleSets; |
| 498 | 498 | } |
| 499 | 499 | |
@@ -501,7 +501,7 @@ discard block |
||
| 501 | 501 | * Returns whether or not a field obtains the rule "required". |
| 502 | 502 | * |
| 503 | 503 | * @param string $fieldName Field to check if required. |
| 504 | - * |
|
| 504 | + * |
|
| 505 | 505 | * @return boolean Whether or not the field is required. |
| 506 | 506 | */ |
| 507 | 507 | protected function _fieldIsRequired($fieldName) { |
@@ -536,13 +536,13 @@ discard block |
||
| 536 | 536 | return; |
| 537 | 537 | } |
| 538 | 538 | |
| 539 | - /** |
|
| 540 | - * Set error for the given field or key |
|
| 541 | - * |
|
| 542 | - * @param string $inputName the input or key name |
|
| 543 | - * @param string $ruleName the rule name |
|
| 544 | - * @param array|string $replacements |
|
| 545 | - */ |
|
| 539 | + /** |
|
| 540 | + * Set error for the given field or key |
|
| 541 | + * |
|
| 542 | + * @param string $inputName the input or key name |
|
| 543 | + * @param string $ruleName the rule name |
|
| 544 | + * @param array|string $replacements |
|
| 545 | + */ |
|
| 546 | 546 | protected function _setError($inputName, $ruleName, $replacements = array()) { |
| 547 | 547 | $rulePhraseKeyParts = explode(',', $ruleName); |
| 548 | 548 | $rulePhrase = null; |
@@ -559,7 +559,7 @@ discard block |
||
| 559 | 559 | } |
| 560 | 560 | // Type cast to array in case it's a string |
| 561 | 561 | $replacements = (array) $replacements; |
| 562 | - $replacementCount = count($replacements); |
|
| 562 | + $replacementCount = count($replacements); |
|
| 563 | 563 | for ($i = 1; $i <= $replacementCount; $i++) { |
| 564 | 564 | $key = $i - 1; |
| 565 | 565 | $rulePhrase = str_replace('%' . $i, $replacements[$key], $rulePhrase); |
@@ -577,11 +577,11 @@ discard block |
||
| 577 | 577 | * |
| 578 | 578 | * @param type $inputArg |
| 579 | 579 | * @param string $callbackFunc |
| 580 | - * |
|
| 580 | + * |
|
| 581 | 581 | * @return mixed |
| 582 | 582 | */ |
| 583 | 583 | protected function _runCallback($inputArg, $callbackFunc) { |
| 584 | - return eval('return ' . $callbackFunc . '("' . $inputArg . '");'); |
|
| 584 | + return eval('return ' . $callbackFunc . '("' . $inputArg . '");'); |
|
| 585 | 585 | } |
| 586 | 586 | |
| 587 | 587 | /** |
@@ -590,7 +590,7 @@ discard block |
||
| 590 | 590 | * arguments. |
| 591 | 591 | * |
| 592 | 592 | * @param string $callbackFunc |
| 593 | - * |
|
| 593 | + * |
|
| 594 | 594 | * @return mixed |
| 595 | 595 | */ |
| 596 | 596 | protected function _runEmptyCallback($callbackFunc) { |
@@ -601,7 +601,7 @@ discard block |
||
| 601 | 601 | * Gets a specific label of a specific field input name. |
| 602 | 602 | * |
| 603 | 603 | * @param string $inputName |
| 604 | - * |
|
| 604 | + * |
|
| 605 | 605 | * @return string |
| 606 | 606 | */ |
| 607 | 607 | protected function _getLabel($inputName) { |
@@ -614,7 +614,7 @@ discard block |
||
| 614 | 614 | * @param string $ruleName the rule name for this validation ("required") |
| 615 | 615 | * @param array $ruleArgs the rules argument |
| 616 | 616 | */ |
| 617 | - protected function _validateRequired($inputName, $ruleName, array $ruleArgs) { |
|
| 617 | + protected function _validateRequired($inputName, $ruleName, array $ruleArgs) { |
|
| 618 | 618 | $inputVal = $this->post($inputName); |
| 619 | 619 | if(array_key_exists(1, $ruleArgs) && function_exists($ruleArgs[1])) { |
| 620 | 620 | $callbackReturn = $this->_runEmptyCallback($ruleArgs[1]); |
@@ -622,8 +622,8 @@ discard block |
||
| 622 | 622 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
| 623 | 623 | } |
| 624 | 624 | } |
| 625 | - else if($inputVal == '') { |
|
| 626 | - $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
|
| 625 | + else if($inputVal == '') { |
|
| 626 | + $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
|
| 627 | 627 | } |
| 628 | 628 | } |
| 629 | 629 | |
@@ -647,10 +647,10 @@ discard block |
||
| 647 | 647 | */ |
| 648 | 648 | protected function _validateCallback($inputName, $ruleName, array $ruleArgs) { |
| 649 | 649 | if (function_exists($ruleArgs[1]) && !empty($this->data[$inputName])) { |
| 650 | - $result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]); |
|
| 651 | - if(! $result){ |
|
| 652 | - $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
|
| 653 | - } |
|
| 650 | + $result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]); |
|
| 651 | + if(! $result){ |
|
| 652 | + $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
|
| 653 | + } |
|
| 654 | 654 | } |
| 655 | 655 | } |
| 656 | 656 | |
@@ -682,7 +682,7 @@ discard block |
||
| 682 | 682 | continue; |
| 683 | 683 | } |
| 684 | 684 | } |
| 685 | - else{ |
|
| 685 | + else{ |
|
| 686 | 686 | if ($inputVal == $doNotEqual) { |
| 687 | 687 | $this->_setError($inputName, $ruleName . ',string', array($this->_getLabel($inputName), $doNotEqual)); |
| 688 | 688 | continue; |
@@ -774,7 +774,7 @@ discard block |
||
| 774 | 774 | * @param string $ruleName the rule name for this validation ("less_than") |
| 775 | 775 | * @param array $ruleArgs the rules argument |
| 776 | 776 | */ |
| 777 | - protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) { |
|
| 777 | + protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) { |
|
| 778 | 778 | $inputVal = $this->post($inputName); |
| 779 | 779 | if ($inputVal >= $ruleArgs[1]) { |
| 780 | 780 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
@@ -790,7 +790,7 @@ discard block |
||
| 790 | 790 | * @param string $ruleName the rule name for this validation ("greater_than") |
| 791 | 791 | * @param array $ruleArgs the rules argument |
| 792 | 792 | */ |
| 793 | - protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) { |
|
| 793 | + protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) { |
|
| 794 | 794 | $inputVal = $this->post($inputName); |
| 795 | 795 | if ($inputVal <= $ruleArgs[1]) { |
| 796 | 796 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
@@ -806,7 +806,7 @@ discard block |
||
| 806 | 806 | * @param string $ruleName the rule name for this validation ("numeric") |
| 807 | 807 | * @param array $ruleArgs the rules argument |
| 808 | 808 | */ |
| 809 | - protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) { |
|
| 809 | + protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) { |
|
| 810 | 810 | $inputVal = $this->post($inputName); |
| 811 | 811 | if (! is_numeric($inputVal)) { |
| 812 | 812 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
@@ -822,18 +822,18 @@ discard block |
||
| 822 | 822 | * @param string $ruleName the rule name for this validation ("exists") |
| 823 | 823 | * @param array $ruleArgs the rules argument |
| 824 | 824 | */ |
| 825 | - protected function _validateExists($inputName, $ruleName, array $ruleArgs) { |
|
| 825 | + protected function _validateExists($inputName, $ruleName, array $ruleArgs) { |
|
| 826 | 826 | $inputVal = $this->post($inputName); |
| 827 | - if (! is_object($this->databaseInstance)){ |
|
| 827 | + if (! is_object($this->databaseInstance)){ |
|
| 828 | 828 | $obj = & get_instance(); |
| 829 | 829 | if(isset($obj->database)){ |
| 830 | 830 | $this->databaseInstance = $obj->database; |
| 831 | 831 | } |
| 832 | 832 | } |
| 833 | - list($table, $column) = explode('.', $ruleArgs[1]); |
|
| 834 | - $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 835 | - ->where($column, $inputVal); |
|
| 836 | - $this->databaseInstance->get(); |
|
| 833 | + list($table, $column) = explode('.', $ruleArgs[1]); |
|
| 834 | + $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 835 | + ->where($column, $inputVal); |
|
| 836 | + $this->databaseInstance->get(); |
|
| 837 | 837 | if ($this->databaseInstance->numRows() <= 0) { |
| 838 | 838 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
| 839 | 839 | return; |
@@ -848,7 +848,7 @@ discard block |
||
| 848 | 848 | * @param string $ruleName the rule name for this validation ("is_unique") |
| 849 | 849 | * @param array $ruleArgs the rules argument |
| 850 | 850 | */ |
| 851 | - protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) { |
|
| 851 | + protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) { |
|
| 852 | 852 | $inputVal = $this->post($inputName); |
| 853 | 853 | if (! is_object($this->databaseInstance)){ |
| 854 | 854 | $obj = & get_instance(); |
@@ -856,11 +856,11 @@ discard block |
||
| 856 | 856 | $this->databaseInstance = $obj->database; |
| 857 | 857 | } |
| 858 | 858 | } |
| 859 | - list($table, $column) = explode('.', $ruleArgs[1]); |
|
| 860 | - $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 861 | - ->where($column, $inputVal); |
|
| 862 | - $this->databaseInstance->get(); |
|
| 863 | - if ($this->databaseInstance->numRows() > 0) { |
|
| 859 | + list($table, $column) = explode('.', $ruleArgs[1]); |
|
| 860 | + $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 861 | + ->where($column, $inputVal); |
|
| 862 | + $this->databaseInstance->get(); |
|
| 863 | + if ($this->databaseInstance->numRows() > 0) { |
|
| 864 | 864 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
| 865 | 865 | return; |
| 866 | 866 | } |
@@ -874,25 +874,25 @@ discard block |
||
| 874 | 874 | * @param string $ruleName the rule name for this validation ("is_unique_update") |
| 875 | 875 | * @param array $ruleArgs the rules argument |
| 876 | 876 | */ |
| 877 | - protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) { |
|
| 877 | + protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) { |
|
| 878 | 878 | $inputVal = $this->post($inputName); |
| 879 | - if (! is_object($this->databaseInstance)){ |
|
| 879 | + if (! is_object($this->databaseInstance)){ |
|
| 880 | 880 | $obj = & get_instance(); |
| 881 | 881 | if(isset($obj->database)){ |
| 882 | 882 | $this->databaseInstance = $obj->database; |
| 883 | 883 | } |
| 884 | 884 | } |
| 885 | - $data = explode(',', $ruleArgs[1]); |
|
| 886 | - if(count($data) < 2){ |
|
| 887 | - return; |
|
| 888 | - } |
|
| 889 | - list($table, $column) = explode('.', $data[0]); |
|
| 890 | - list($field, $val) = explode('=', $data[1]); |
|
| 891 | - $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 892 | - ->where($column, $inputVal) |
|
| 893 | - ->where($field, '!=', trim($val)); |
|
| 885 | + $data = explode(',', $ruleArgs[1]); |
|
| 886 | + if(count($data) < 2){ |
|
| 887 | + return; |
|
| 888 | + } |
|
| 889 | + list($table, $column) = explode('.', $data[0]); |
|
| 890 | + list($field, $val) = explode('=', $data[1]); |
|
| 891 | + $this->databaseInstance->getQueryBuilder()->from($table) |
|
| 892 | + ->where($column, $inputVal) |
|
| 893 | + ->where($field, '!=', trim($val)); |
|
| 894 | 894 | $this->databaseInstance->get(); |
| 895 | - if ($this->databaseInstance->numRows() > 0) { |
|
| 895 | + if ($this->databaseInstance->numRows() > 0) { |
|
| 896 | 896 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
| 897 | 897 | return; |
| 898 | 898 | } |
@@ -908,7 +908,7 @@ discard block |
||
| 908 | 908 | */ |
| 909 | 909 | protected function _validateInList($inputName, $ruleName, array $ruleArgs) { |
| 910 | 910 | $inputVal = $this->post($inputName); |
| 911 | - $list = explode(',', $ruleArgs[1]); |
|
| 911 | + $list = explode(',', $ruleArgs[1]); |
|
| 912 | 912 | $list = array_map('trim', $list); |
| 913 | 913 | if (! in_array($inputVal, $list)) { |
| 914 | 914 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
@@ -926,7 +926,7 @@ discard block |
||
| 926 | 926 | */ |
| 927 | 927 | protected function _validateRegex($inputName, $ruleName, array $ruleArgs) { |
| 928 | 928 | $inputVal = $this->post($inputName); |
| 929 | - $regex = $ruleArgs[1]; |
|
| 929 | + $regex = $ruleArgs[1]; |
|
| 930 | 930 | if (! preg_match($regex, $inputVal)) { |
| 931 | 931 | if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
| 932 | 932 | return; |
@@ -25,13 +25,13 @@ discard block |
||
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | 27 | |
| 28 | - class FormValidation{ |
|
| 28 | + class FormValidation { |
|
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * The form validation status |
| 32 | 32 | * @var boolean |
| 33 | 33 | */ |
| 34 | - protected $_success = false; |
|
| 34 | + protected $_success = false; |
|
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | 37 | * The list of errors messages |
@@ -40,31 +40,31 @@ discard block |
||
| 40 | 40 | protected $_errorsMessages = array(); |
| 41 | 41 | |
| 42 | 42 | // Array of rule sets, fieldName => PIPE seperated ruleString |
| 43 | - protected $_rules = array(); |
|
| 43 | + protected $_rules = array(); |
|
| 44 | 44 | |
| 45 | 45 | // Array of errors, niceName => Error Message |
| 46 | - protected $_errors = array(); |
|
| 46 | + protected $_errors = array(); |
|
| 47 | 47 | |
| 48 | 48 | // Array of post Key => Nice name labels |
| 49 | - protected $_labels = array(); |
|
| 49 | + protected $_labels = array(); |
|
| 50 | 50 | |
| 51 | 51 | /** |
| 52 | 52 | * The errors delimiters |
| 53 | 53 | * @var array |
| 54 | 54 | */ |
| 55 | - protected $_allErrorsDelimiter = array('<div class="error">', '</div>'); |
|
| 55 | + protected $_allErrorsDelimiter = array('<div class="error">', '</div>'); |
|
| 56 | 56 | |
| 57 | 57 | /** |
| 58 | 58 | * The each error delimiter |
| 59 | 59 | * @var array |
| 60 | 60 | */ |
| 61 | - protected $_eachErrorDelimiter = array('<p class="error">', '</p>'); |
|
| 61 | + protected $_eachErrorDelimiter = array('<p class="error">', '</p>'); |
|
| 62 | 62 | |
| 63 | 63 | /** |
| 64 | 64 | * Indicated if need force the validation to be failed |
| 65 | 65 | * @var boolean |
| 66 | 66 | */ |
| 67 | - protected $_forceFail = false; |
|
| 67 | + protected $_forceFail = false; |
|
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | 70 | * The list of the error messages overrides by the original |
@@ -97,13 +97,13 @@ discard block |
||
| 97 | 97 | * @return void |
| 98 | 98 | */ |
| 99 | 99 | public function __construct() { |
| 100 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 100 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 101 | 101 | $this->logger->setLogger('Library::FormValidation'); |
| 102 | 102 | |
| 103 | 103 | //Load form validation language message |
| 104 | 104 | Loader::lang('form_validation'); |
| 105 | 105 | $obj = & get_instance(); |
| 106 | - $this->_errorsMessages = array( |
|
| 106 | + $this->_errorsMessages = array( |
|
| 107 | 107 | 'required' => $obj->lang->get('fv_required'), |
| 108 | 108 | 'min_length' => $obj->lang->get('fv_min_length'), |
| 109 | 109 | 'max_length' => $obj->lang->get('fv_max_length'), |
@@ -133,7 +133,7 @@ discard block |
||
| 133 | 133 | * Set the database instance |
| 134 | 134 | * @param object $database the database instance |
| 135 | 135 | */ |
| 136 | - public function setDatabase(Database $database){ |
|
| 136 | + public function setDatabase(Database $database) { |
|
| 137 | 137 | $this->databaseInstance = $database; |
| 138 | 138 | return $this; |
| 139 | 139 | } |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | * Get the database instance |
| 143 | 143 | * @return object the database instance |
| 144 | 144 | */ |
| 145 | - public function getDatabase(){ |
|
| 145 | + public function getDatabase() { |
|
| 146 | 146 | return $this->databaseInstance; |
| 147 | 147 | } |
| 148 | 148 | |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | * |
| 166 | 166 | * @return FormValidation Current instance of object. |
| 167 | 167 | */ |
| 168 | - public function setData(array $data){ |
|
| 168 | + public function setData(array $data) { |
|
| 169 | 169 | $this->logger->debug('Setting the form validation data, the values are: ' . stringfy_vars($data)); |
| 170 | 170 | $this->data = $data; |
| 171 | 171 | return $this; |
@@ -175,7 +175,7 @@ discard block |
||
| 175 | 175 | * Get the form validation data |
| 176 | 176 | * @return array the form validation data to be validated |
| 177 | 177 | */ |
| 178 | - public function getData(){ |
|
| 178 | + public function getData() { |
|
| 179 | 179 | return $this->data; |
| 180 | 180 | } |
| 181 | 181 | |
@@ -184,7 +184,7 @@ discard block |
||
| 184 | 184 | * |
| 185 | 185 | * @return string the function name |
| 186 | 186 | */ |
| 187 | - protected function _toCallCase($funcName, $prefix='_validate') { |
|
| 187 | + protected function _toCallCase($funcName, $prefix = '_validate') { |
|
| 188 | 188 | $funcName = strtolower($funcName); |
| 189 | 189 | $finalFuncName = $prefix; |
| 190 | 190 | foreach (explode('_', $funcName) as $funcNamePart) { |
@@ -208,7 +208,7 @@ discard block |
||
| 208 | 208 | * @return boolean Whether or not the form has been submitted or the data is available for validation. |
| 209 | 209 | */ |
| 210 | 210 | public function canDoValidation() { |
| 211 | - return get_instance()->request->method() === 'POST' || ! empty($this->data); |
|
| 211 | + return get_instance()->request->method() === 'POST' || !empty($this->data); |
|
| 212 | 212 | } |
| 213 | 213 | |
| 214 | 214 | /** |
@@ -228,14 +228,14 @@ discard block |
||
| 228 | 228 | * Validate the CSRF |
| 229 | 229 | * @return void |
| 230 | 230 | */ |
| 231 | - protected function validateCSRF(){ |
|
| 232 | - if(get_instance()->request->method() == 'POST'){ |
|
| 231 | + protected function validateCSRF() { |
|
| 232 | + if (get_instance()->request->method() == 'POST') { |
|
| 233 | 233 | $this->logger->debug('Check if CSRF is enabled in configuration'); |
| 234 | 234 | //first check for CSRF |
| 235 | - if (get_config('csrf_enable', false) && ! Security::validateCSRF()){ |
|
| 235 | + if (get_config('csrf_enable', false) && !Security::validateCSRF()) { |
|
| 236 | 236 | show_error('Invalide data, Cross Site Request Forgery do his job, the data to validate is corrupted.'); |
| 237 | 237 | } |
| 238 | - else{ |
|
| 238 | + else { |
|
| 239 | 239 | $this->logger->info('CSRF is not enabled in configuration or not set manully, no need to check it'); |
| 240 | 240 | } |
| 241 | 241 | } |
@@ -253,10 +253,10 @@ discard block |
||
| 253 | 253 | $this->_forceFail = false; |
| 254 | 254 | |
| 255 | 255 | foreach ($this->getData() as $inputName => $inputVal) { |
| 256 | - if(is_array($this->data[$inputName])){ |
|
| 256 | + if (is_array($this->data[$inputName])) { |
|
| 257 | 257 | $this->data[$inputName] = array_map('trim', $this->data[$inputName]); |
| 258 | 258 | } |
| 259 | - else{ |
|
| 259 | + else { |
|
| 260 | 260 | $this->data[$inputName] = trim($this->data[$inputName]); |
| 261 | 261 | } |
| 262 | 262 | |
@@ -266,7 +266,7 @@ discard block |
||
| 266 | 266 | } |
| 267 | 267 | } |
| 268 | 268 | } |
| 269 | - $this->_success = empty($this->_errors) && $this->_forceFail === false; |
|
| 269 | + $this->_success = empty($this->_errors) && $this->_forceFail === false; |
|
| 270 | 270 | } |
| 271 | 271 | |
| 272 | 272 | /** |
@@ -280,7 +280,7 @@ discard block |
||
| 280 | 280 | public function setRule($inputField, $inputLabel, $ruleSets) { |
| 281 | 281 | $this->_rules[$inputField] = $ruleSets; |
| 282 | 282 | $this->_labels[$inputField] = $inputLabel; |
| 283 | - $this->logger->info('Set the field rule: name [' .$inputField. '], label [' .$inputLabel. '], rules [' .$ruleSets. ']'); |
|
| 283 | + $this->logger->info('Set the field rule: name [' . $inputField . '], label [' . $inputLabel . '], rules [' . $ruleSets . ']'); |
|
| 284 | 284 | return $this; |
| 285 | 285 | } |
| 286 | 286 | |
@@ -444,7 +444,7 @@ discard block |
||
| 444 | 444 | } |
| 445 | 445 | $errorOutput .= $errorsEnd; |
| 446 | 446 | echo ($echo) ? $errorOutput : ''; |
| 447 | - return (! $echo) ? $errorOutput : null; |
|
| 447 | + return (!$echo) ? $errorOutput : null; |
|
| 448 | 448 | } |
| 449 | 449 | |
| 450 | 450 | /** |
@@ -469,25 +469,25 @@ discard block |
||
| 469 | 469 | /* |
| 470 | 470 | //////////////// hack for regex rule that can contain "|" |
| 471 | 471 | */ |
| 472 | - if(strpos($ruleString, 'regex') !== false){ |
|
| 472 | + if (strpos($ruleString, 'regex') !== false) { |
|
| 473 | 473 | $regexRule = array(); |
| 474 | 474 | $rule = '#regex\[\/(.*)\/([a-zA-Z0-9]?)\]#'; |
| 475 | 475 | preg_match($rule, $ruleString, $regexRule); |
| 476 | 476 | $ruleStringTemp = preg_replace($rule, '', $ruleString); |
| 477 | - if(!empty($regexRule[0])){ |
|
| 477 | + if (!empty($regexRule[0])) { |
|
| 478 | 478 | $ruleSets[] = $regexRule[0]; |
| 479 | 479 | } |
| 480 | 480 | $ruleStringRegex = explode('|', $ruleStringTemp); |
| 481 | 481 | foreach ($ruleStringRegex as $rule) { |
| 482 | 482 | $rule = trim($rule); |
| 483 | - if($rule){ |
|
| 483 | + if ($rule) { |
|
| 484 | 484 | $ruleSets[] = $rule; |
| 485 | 485 | } |
| 486 | 486 | } |
| 487 | 487 | |
| 488 | 488 | } |
| 489 | 489 | /***********************************/ |
| 490 | - else{ |
|
| 490 | + else { |
|
| 491 | 491 | if (strpos($ruleString, '|') !== FALSE) { |
| 492 | 492 | $ruleSets = explode('|', $ruleString); |
| 493 | 493 | } else { |
@@ -519,7 +519,7 @@ discard block |
||
| 519 | 519 | * @return void |
| 520 | 520 | */ |
| 521 | 521 | protected function _validateRule($inputName, $inputVal, $ruleName) { |
| 522 | - $this->logger->debug('Rule validation of field [' .$inputName. '], value [' .$inputVal. '], rule [' .$ruleName. ']'); |
|
| 522 | + $this->logger->debug('Rule validation of field [' . $inputName . '], value [' . $inputVal . '], rule [' . $ruleName . ']'); |
|
| 523 | 523 | // Array to store args |
| 524 | 524 | $ruleArgs = array(); |
| 525 | 525 | |
@@ -564,7 +564,7 @@ discard block |
||
| 564 | 564 | $key = $i - 1; |
| 565 | 565 | $rulePhrase = str_replace('%' . $i, $replacements[$key], $rulePhrase); |
| 566 | 566 | } |
| 567 | - if (! array_key_exists($inputName, $this->_errors)) { |
|
| 567 | + if (!array_key_exists($inputName, $this->_errors)) { |
|
| 568 | 568 | $this->_errors[$inputName] = $rulePhrase; |
| 569 | 569 | } |
| 570 | 570 | } |
@@ -616,13 +616,13 @@ discard block |
||
| 616 | 616 | */ |
| 617 | 617 | protected function _validateRequired($inputName, $ruleName, array $ruleArgs) { |
| 618 | 618 | $inputVal = $this->post($inputName); |
| 619 | - if(array_key_exists(1, $ruleArgs) && function_exists($ruleArgs[1])) { |
|
| 619 | + if (array_key_exists(1, $ruleArgs) && function_exists($ruleArgs[1])) { |
|
| 620 | 620 | $callbackReturn = $this->_runEmptyCallback($ruleArgs[1]); |
| 621 | 621 | if ($inputVal == '' && $callbackReturn == true) { |
| 622 | 622 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
| 623 | 623 | } |
| 624 | 624 | } |
| 625 | - else if($inputVal == '') { |
|
| 625 | + else if ($inputVal == '') { |
|
| 626 | 626 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
| 627 | 627 | } |
| 628 | 628 | } |
@@ -648,7 +648,7 @@ discard block |
||
| 648 | 648 | protected function _validateCallback($inputName, $ruleName, array $ruleArgs) { |
| 649 | 649 | if (function_exists($ruleArgs[1]) && !empty($this->data[$inputName])) { |
| 650 | 650 | $result = $this->_runCallback($this->data[$inputName], $ruleArgs[1]); |
| 651 | - if(! $result){ |
|
| 651 | + if (!$result) { |
|
| 652 | 652 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
| 653 | 653 | } |
| 654 | 654 | } |
@@ -682,7 +682,7 @@ discard block |
||
| 682 | 682 | continue; |
| 683 | 683 | } |
| 684 | 684 | } |
| 685 | - else{ |
|
| 685 | + else { |
|
| 686 | 686 | if ($inputVal == $doNotEqual) { |
| 687 | 687 | $this->_setError($inputName, $ruleName . ',string', array($this->_getLabel($inputName), $doNotEqual)); |
| 688 | 688 | continue; |
@@ -712,8 +712,8 @@ discard block |
||
| 712 | 712 | */ |
| 713 | 713 | protected function _validateValidEmail($inputName, $ruleName, array $ruleArgs) { |
| 714 | 714 | $inputVal = $this->post($inputName); |
| 715 | - if (! preg_match("/^([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$/i", $inputVal)) { |
|
| 716 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 715 | + if (!preg_match("/^([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$/i", $inputVal)) { |
|
| 716 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 717 | 717 | return; |
| 718 | 718 | } |
| 719 | 719 | $this->_setError($inputName, $ruleName, $this->_getLabel($inputName)); |
@@ -729,7 +729,7 @@ discard block |
||
| 729 | 729 | protected function _validateExactLength($inputName, $ruleName, array $ruleArgs) { |
| 730 | 730 | $inputVal = $this->post($inputName); |
| 731 | 731 | if (strlen($inputVal) != $ruleArgs[1]) { // $ruleArgs[0] is [length] $rulesArgs[1] is just length |
| 732 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 732 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 733 | 733 | return; |
| 734 | 734 | } |
| 735 | 735 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -745,7 +745,7 @@ discard block |
||
| 745 | 745 | protected function _validateMaxLength($inputName, $ruleName, array $ruleArgs) { |
| 746 | 746 | $inputVal = $this->post($inputName); |
| 747 | 747 | if (strlen($inputVal) > $ruleArgs[1]) { // $ruleArgs[0] is [length] $rulesArgs[1] is just length |
| 748 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 748 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 749 | 749 | return; |
| 750 | 750 | } |
| 751 | 751 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -761,7 +761,7 @@ discard block |
||
| 761 | 761 | protected function _validateMinLength($inputName, $ruleName, array $ruleArgs) { |
| 762 | 762 | $inputVal = $this->post($inputName); |
| 763 | 763 | if (strlen($inputVal) < $ruleArgs[1]) { // $ruleArgs[0] is [length] $rulesArgs[1] is just length |
| 764 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 764 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 765 | 765 | return; |
| 766 | 766 | } |
| 767 | 767 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -777,7 +777,7 @@ discard block |
||
| 777 | 777 | protected function _validateLessThan($inputName, $ruleName, array $ruleArgs) { |
| 778 | 778 | $inputVal = $this->post($inputName); |
| 779 | 779 | if ($inputVal >= $ruleArgs[1]) { |
| 780 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 780 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 781 | 781 | return; |
| 782 | 782 | } |
| 783 | 783 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -793,7 +793,7 @@ discard block |
||
| 793 | 793 | protected function _validateGreaterThan($inputName, $ruleName, array $ruleArgs) { |
| 794 | 794 | $inputVal = $this->post($inputName); |
| 795 | 795 | if ($inputVal <= $ruleArgs[1]) { |
| 796 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 796 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 797 | 797 | return; |
| 798 | 798 | } |
| 799 | 799 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -808,8 +808,8 @@ discard block |
||
| 808 | 808 | */ |
| 809 | 809 | protected function _validateNumeric($inputName, $ruleName, array $ruleArgs) { |
| 810 | 810 | $inputVal = $this->post($inputName); |
| 811 | - if (! is_numeric($inputVal)) { |
|
| 812 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 811 | + if (!is_numeric($inputVal)) { |
|
| 812 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 813 | 813 | return; |
| 814 | 814 | } |
| 815 | 815 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
@@ -824,9 +824,9 @@ discard block |
||
| 824 | 824 | */ |
| 825 | 825 | protected function _validateExists($inputName, $ruleName, array $ruleArgs) { |
| 826 | 826 | $inputVal = $this->post($inputName); |
| 827 | - if (! is_object($this->databaseInstance)){ |
|
| 827 | + if (!is_object($this->databaseInstance)) { |
|
| 828 | 828 | $obj = & get_instance(); |
| 829 | - if(isset($obj->database)){ |
|
| 829 | + if (isset($obj->database)) { |
|
| 830 | 830 | $this->databaseInstance = $obj->database; |
| 831 | 831 | } |
| 832 | 832 | } |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | ->where($column, $inputVal); |
| 836 | 836 | $this->databaseInstance->get(); |
| 837 | 837 | if ($this->databaseInstance->numRows() <= 0) { |
| 838 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 838 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 839 | 839 | return; |
| 840 | 840 | } |
| 841 | 841 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
@@ -850,9 +850,9 @@ discard block |
||
| 850 | 850 | */ |
| 851 | 851 | protected function _validateIsUnique($inputName, $ruleName, array $ruleArgs) { |
| 852 | 852 | $inputVal = $this->post($inputName); |
| 853 | - if (! is_object($this->databaseInstance)){ |
|
| 853 | + if (!is_object($this->databaseInstance)) { |
|
| 854 | 854 | $obj = & get_instance(); |
| 855 | - if(isset($obj->database)){ |
|
| 855 | + if (isset($obj->database)) { |
|
| 856 | 856 | $this->databaseInstance = $obj->database; |
| 857 | 857 | } |
| 858 | 858 | } |
@@ -861,7 +861,7 @@ discard block |
||
| 861 | 861 | ->where($column, $inputVal); |
| 862 | 862 | $this->databaseInstance->get(); |
| 863 | 863 | if ($this->databaseInstance->numRows() > 0) { |
| 864 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 864 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 865 | 865 | return; |
| 866 | 866 | } |
| 867 | 867 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
@@ -876,14 +876,14 @@ discard block |
||
| 876 | 876 | */ |
| 877 | 877 | protected function _validateIsUniqueUpdate($inputName, $ruleName, array $ruleArgs) { |
| 878 | 878 | $inputVal = $this->post($inputName); |
| 879 | - if (! is_object($this->databaseInstance)){ |
|
| 879 | + if (!is_object($this->databaseInstance)) { |
|
| 880 | 880 | $obj = & get_instance(); |
| 881 | - if(isset($obj->database)){ |
|
| 881 | + if (isset($obj->database)) { |
|
| 882 | 882 | $this->databaseInstance = $obj->database; |
| 883 | 883 | } |
| 884 | 884 | } |
| 885 | 885 | $data = explode(',', $ruleArgs[1]); |
| 886 | - if(count($data) < 2){ |
|
| 886 | + if (count($data) < 2) { |
|
| 887 | 887 | return; |
| 888 | 888 | } |
| 889 | 889 | list($table, $column) = explode('.', $data[0]); |
@@ -893,7 +893,7 @@ discard block |
||
| 893 | 893 | ->where($field, '!=', trim($val)); |
| 894 | 894 | $this->databaseInstance->get(); |
| 895 | 895 | if ($this->databaseInstance->numRows() > 0) { |
| 896 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 896 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 897 | 897 | return; |
| 898 | 898 | } |
| 899 | 899 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
@@ -910,8 +910,8 @@ discard block |
||
| 910 | 910 | $inputVal = $this->post($inputName); |
| 911 | 911 | $list = explode(',', $ruleArgs[1]); |
| 912 | 912 | $list = array_map('trim', $list); |
| 913 | - if (! in_array($inputVal, $list)) { |
|
| 914 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 913 | + if (!in_array($inputVal, $list)) { |
|
| 914 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 915 | 915 | return; |
| 916 | 916 | } |
| 917 | 917 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName), $this->_getLabel($ruleArgs[1]))); |
@@ -927,8 +927,8 @@ discard block |
||
| 927 | 927 | protected function _validateRegex($inputName, $ruleName, array $ruleArgs) { |
| 928 | 928 | $inputVal = $this->post($inputName); |
| 929 | 929 | $regex = $ruleArgs[1]; |
| 930 | - if (! preg_match($regex, $inputVal)) { |
|
| 931 | - if (! $this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 930 | + if (!preg_match($regex, $inputVal)) { |
|
| 931 | + if (!$this->_fieldIsRequired($inputName) && empty($this->data[$inputName])) { |
|
| 932 | 932 | return; |
| 933 | 933 | } |
| 934 | 934 | $this->_setError($inputName, $ruleName, array($this->_getLabel($inputName))); |
@@ -1,312 +1,312 @@ |
||
| 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 FileCache implements CacheInterface{ |
|
| 27 | + class FileCache implements CacheInterface{ |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * Whether to enable compression of the cache data file. |
|
| 31 | - * @var boolean |
|
| 32 | - */ |
|
| 33 | - private $compressCacheData = true; |
|
| 29 | + /** |
|
| 30 | + * Whether to enable compression of the cache data file. |
|
| 31 | + * @var boolean |
|
| 32 | + */ |
|
| 33 | + private $compressCacheData = true; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * The logger instance |
|
| 37 | - * @var Log |
|
| 38 | - */ |
|
| 39 | - private $logger; |
|
| 35 | + /** |
|
| 36 | + * The logger instance |
|
| 37 | + * @var Log |
|
| 38 | + */ |
|
| 39 | + private $logger; |
|
| 40 | 40 | |
| 41 | 41 | |
| 42 | - public function __construct(Log $logger = null){ |
|
| 43 | - if(! $this->isSupported()){ |
|
| 44 | - show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.'); |
|
| 45 | - } |
|
| 46 | - /** |
|
| 47 | - * instance of the Log class |
|
| 48 | - */ |
|
| 49 | - if(is_object($logger)){ |
|
| 50 | - $this->logger = $logger; |
|
| 51 | - } |
|
| 52 | - else{ |
|
| 53 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 54 | - $this->logger->setLogger('Library::FileCache'); |
|
| 55 | - } |
|
| 42 | + public function __construct(Log $logger = null){ |
|
| 43 | + if(! $this->isSupported()){ |
|
| 44 | + show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.'); |
|
| 45 | + } |
|
| 46 | + /** |
|
| 47 | + * instance of the Log class |
|
| 48 | + */ |
|
| 49 | + if(is_object($logger)){ |
|
| 50 | + $this->logger = $logger; |
|
| 51 | + } |
|
| 52 | + else{ |
|
| 53 | + $this->logger =& class_loader('Log', 'classes'); |
|
| 54 | + $this->logger->setLogger('Library::FileCache'); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - //if Zlib extension is not loaded set compressCacheData to false |
|
| 58 | - if(! extension_loaded('zlib')){ |
|
| 59 | - $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
|
| 60 | - $this->compressCacheData = false; |
|
| 61 | - } |
|
| 62 | - } |
|
| 57 | + //if Zlib extension is not loaded set compressCacheData to false |
|
| 58 | + if(! extension_loaded('zlib')){ |
|
| 59 | + $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
|
| 60 | + $this->compressCacheData = false; |
|
| 61 | + } |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * This is used to get the cache data using the key |
|
| 66 | - * @param string $key the key to identify the cache data |
|
| 67 | - * @return mixed the cache data if exists else return false |
|
| 68 | - */ |
|
| 69 | - public function get($key){ |
|
| 70 | - $this->logger->debug('Getting cache data for key ['. $key .']'); |
|
| 71 | - $filePath = $this->getFilePath($key); |
|
| 72 | - if(! file_exists($filePath)){ |
|
| 73 | - $this->logger->info('No cache file found for the key ['. $key .'], return false'); |
|
| 74 | - return false; |
|
| 75 | - } |
|
| 76 | - $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid'); |
|
| 77 | - $handle = fopen($filePath,'r'); |
|
| 78 | - if(! is_resource($handle)){ |
|
| 79 | - $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 80 | - return false; |
|
| 81 | - } |
|
| 82 | - // Getting a shared lock |
|
| 83 | - flock($handle, LOCK_SH); |
|
| 84 | - $data = file_get_contents($filePath); |
|
| 85 | - fclose($handle); |
|
| 86 | - $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 87 | - if (! $data) { |
|
| 88 | - $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false'); |
|
| 89 | - // If unserializing somehow didn't work out, we'll delete the file |
|
| 90 | - unlink($filePath); |
|
| 91 | - return false; |
|
| 92 | - } |
|
| 93 | - if (time() > $data['expire']) { |
|
| 94 | - $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']'); |
|
| 95 | - // Unlinking when the file was expired |
|
| 96 | - unlink($filePath); |
|
| 97 | - return false; |
|
| 98 | - } |
|
| 99 | - else{ |
|
| 100 | - $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']'); |
|
| 101 | - return $data['data']; |
|
| 102 | - } |
|
| 103 | - } |
|
| 64 | + /** |
|
| 65 | + * This is used to get the cache data using the key |
|
| 66 | + * @param string $key the key to identify the cache data |
|
| 67 | + * @return mixed the cache data if exists else return false |
|
| 68 | + */ |
|
| 69 | + public function get($key){ |
|
| 70 | + $this->logger->debug('Getting cache data for key ['. $key .']'); |
|
| 71 | + $filePath = $this->getFilePath($key); |
|
| 72 | + if(! file_exists($filePath)){ |
|
| 73 | + $this->logger->info('No cache file found for the key ['. $key .'], return false'); |
|
| 74 | + return false; |
|
| 75 | + } |
|
| 76 | + $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid'); |
|
| 77 | + $handle = fopen($filePath,'r'); |
|
| 78 | + if(! is_resource($handle)){ |
|
| 79 | + $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 80 | + return false; |
|
| 81 | + } |
|
| 82 | + // Getting a shared lock |
|
| 83 | + flock($handle, LOCK_SH); |
|
| 84 | + $data = file_get_contents($filePath); |
|
| 85 | + fclose($handle); |
|
| 86 | + $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 87 | + if (! $data) { |
|
| 88 | + $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false'); |
|
| 89 | + // If unserializing somehow didn't work out, we'll delete the file |
|
| 90 | + unlink($filePath); |
|
| 91 | + return false; |
|
| 92 | + } |
|
| 93 | + if (time() > $data['expire']) { |
|
| 94 | + $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']'); |
|
| 95 | + // Unlinking when the file was expired |
|
| 96 | + unlink($filePath); |
|
| 97 | + return false; |
|
| 98 | + } |
|
| 99 | + else{ |
|
| 100 | + $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']'); |
|
| 101 | + return $data['data']; |
|
| 102 | + } |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Save data to the cache |
|
| 108 | - * @param string $key the key to identify this cache data |
|
| 109 | - * @param mixed $data the cache data |
|
| 110 | - * @param integer $ttl the cache life time |
|
| 111 | - * @return boolean true if success otherwise will return false |
|
| 112 | - */ |
|
| 113 | - public function set($key, $data, $ttl = 0){ |
|
| 114 | - $expire = time() + $ttl; |
|
| 115 | - $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']'); |
|
| 116 | - $filePath = $this->getFilePath($key); |
|
| 117 | - $handle = fopen($filePath,'w'); |
|
| 118 | - if(! is_resource($handle)){ |
|
| 119 | - $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 120 | - return false; |
|
| 121 | - } |
|
| 122 | - flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed |
|
| 123 | - //Serializing along with the TTL |
|
| 124 | - $cacheData = serialize(array( |
|
| 125 | - 'mtime' => time(), |
|
| 126 | - 'expire' => $expire, |
|
| 127 | - 'data' => $data, |
|
| 128 | - 'ttl' => $ttl |
|
| 129 | - ) |
|
| 130 | - ); |
|
| 131 | - $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData); |
|
| 132 | - if(! $result){ |
|
| 133 | - $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 134 | - fclose($handle); |
|
| 135 | - return false; |
|
| 136 | - } |
|
| 137 | - else{ |
|
| 138 | - $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']'); |
|
| 139 | - fclose($handle); |
|
| 140 | - chmod($filePath, 0640); |
|
| 141 | - return true; |
|
| 142 | - } |
|
| 143 | - } |
|
| 106 | + /** |
|
| 107 | + * Save data to the cache |
|
| 108 | + * @param string $key the key to identify this cache data |
|
| 109 | + * @param mixed $data the cache data |
|
| 110 | + * @param integer $ttl the cache life time |
|
| 111 | + * @return boolean true if success otherwise will return false |
|
| 112 | + */ |
|
| 113 | + public function set($key, $data, $ttl = 0){ |
|
| 114 | + $expire = time() + $ttl; |
|
| 115 | + $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']'); |
|
| 116 | + $filePath = $this->getFilePath($key); |
|
| 117 | + $handle = fopen($filePath,'w'); |
|
| 118 | + if(! is_resource($handle)){ |
|
| 119 | + $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 120 | + return false; |
|
| 121 | + } |
|
| 122 | + flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed |
|
| 123 | + //Serializing along with the TTL |
|
| 124 | + $cacheData = serialize(array( |
|
| 125 | + 'mtime' => time(), |
|
| 126 | + 'expire' => $expire, |
|
| 127 | + 'data' => $data, |
|
| 128 | + 'ttl' => $ttl |
|
| 129 | + ) |
|
| 130 | + ); |
|
| 131 | + $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData); |
|
| 132 | + if(! $result){ |
|
| 133 | + $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 134 | + fclose($handle); |
|
| 135 | + return false; |
|
| 136 | + } |
|
| 137 | + else{ |
|
| 138 | + $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']'); |
|
| 139 | + fclose($handle); |
|
| 140 | + chmod($filePath, 0640); |
|
| 141 | + return true; |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | 144 | |
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Delete the cache data for given key |
|
| 148 | - * @param string $key the key for cache to be deleted |
|
| 149 | - * @return boolean true if the cache is delete, false if can't delete |
|
| 150 | - * the cache or the cache with the given key not exist |
|
| 151 | - */ |
|
| 152 | - public function delete($key){ |
|
| 153 | - $this->logger->debug('Deleting of cache data for key [' .$key. ']'); |
|
| 154 | - $filePath = $this->getFilePath($key); |
|
| 155 | - $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 156 | - if(! file_exists($filePath)){ |
|
| 157 | - $this->logger->info('This cache file does not exists skipping'); |
|
| 158 | - return false; |
|
| 159 | - } |
|
| 160 | - else{ |
|
| 161 | - $this->logger->info('Found cache file [' .$filePath. '] remove it'); |
|
| 162 | - unlink($filePath); |
|
| 163 | - return true; |
|
| 164 | - } |
|
| 165 | - } |
|
| 146 | + /** |
|
| 147 | + * Delete the cache data for given key |
|
| 148 | + * @param string $key the key for cache to be deleted |
|
| 149 | + * @return boolean true if the cache is delete, false if can't delete |
|
| 150 | + * the cache or the cache with the given key not exist |
|
| 151 | + */ |
|
| 152 | + public function delete($key){ |
|
| 153 | + $this->logger->debug('Deleting of cache data for key [' .$key. ']'); |
|
| 154 | + $filePath = $this->getFilePath($key); |
|
| 155 | + $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 156 | + if(! file_exists($filePath)){ |
|
| 157 | + $this->logger->info('This cache file does not exists skipping'); |
|
| 158 | + return false; |
|
| 159 | + } |
|
| 160 | + else{ |
|
| 161 | + $this->logger->info('Found cache file [' .$filePath. '] remove it'); |
|
| 162 | + unlink($filePath); |
|
| 163 | + return true; |
|
| 164 | + } |
|
| 165 | + } |
|
| 166 | 166 | |
| 167 | - /** |
|
| 168 | - * Get the cache information for given key |
|
| 169 | - * @param string $key the key for cache to get the information for |
|
| 170 | - * @return boolean|array the cache information. The associative array and must contains the following information: |
|
| 171 | - * 'mtime' => creation time of the cache (Unix timestamp), |
|
| 172 | - * 'expire' => expiration time of the cache (Unix timestamp), |
|
| 173 | - * 'ttl' => the time to live of the cache in second |
|
| 174 | - */ |
|
| 175 | - public function getInfo($key){ |
|
| 176 | - $this->logger->debug('Getting of cache info for key [' .$key. ']'); |
|
| 177 | - $filePath = $this->getFilePath($key); |
|
| 178 | - $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 179 | - if(! file_exists($filePath)){ |
|
| 180 | - $this->logger->info('This cache file does not exists skipping'); |
|
| 181 | - return false; |
|
| 182 | - } |
|
| 183 | - $this->logger->info('Found cache file [' .$filePath. '] check the validity'); |
|
| 184 | - $data = file_get_contents($filePath); |
|
| 185 | - $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 186 | - if(! $data){ |
|
| 187 | - $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']'); |
|
| 188 | - return false; |
|
| 189 | - } |
|
| 190 | - $this->logger->info('This cache data is OK check for expire'); |
|
| 191 | - if(isset($data['expire']) && $data['expire'] > time()){ |
|
| 192 | - $this->logger->info('This cache not yet expired return cache informations'); |
|
| 193 | - $info = array( |
|
| 194 | - 'mtime' => $data['mtime'], |
|
| 195 | - 'expire' => $data['expire'], |
|
| 196 | - 'ttl' => $data['ttl'] |
|
| 197 | - ); |
|
| 198 | - return $info; |
|
| 199 | - } |
|
| 200 | - $this->logger->info('This cache already expired return false'); |
|
| 201 | - return false; |
|
| 202 | - } |
|
| 167 | + /** |
|
| 168 | + * Get the cache information for given key |
|
| 169 | + * @param string $key the key for cache to get the information for |
|
| 170 | + * @return boolean|array the cache information. The associative array and must contains the following information: |
|
| 171 | + * 'mtime' => creation time of the cache (Unix timestamp), |
|
| 172 | + * 'expire' => expiration time of the cache (Unix timestamp), |
|
| 173 | + * 'ttl' => the time to live of the cache in second |
|
| 174 | + */ |
|
| 175 | + public function getInfo($key){ |
|
| 176 | + $this->logger->debug('Getting of cache info for key [' .$key. ']'); |
|
| 177 | + $filePath = $this->getFilePath($key); |
|
| 178 | + $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 179 | + if(! file_exists($filePath)){ |
|
| 180 | + $this->logger->info('This cache file does not exists skipping'); |
|
| 181 | + return false; |
|
| 182 | + } |
|
| 183 | + $this->logger->info('Found cache file [' .$filePath. '] check the validity'); |
|
| 184 | + $data = file_get_contents($filePath); |
|
| 185 | + $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 186 | + if(! $data){ |
|
| 187 | + $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']'); |
|
| 188 | + return false; |
|
| 189 | + } |
|
| 190 | + $this->logger->info('This cache data is OK check for expire'); |
|
| 191 | + if(isset($data['expire']) && $data['expire'] > time()){ |
|
| 192 | + $this->logger->info('This cache not yet expired return cache informations'); |
|
| 193 | + $info = array( |
|
| 194 | + 'mtime' => $data['mtime'], |
|
| 195 | + 'expire' => $data['expire'], |
|
| 196 | + 'ttl' => $data['ttl'] |
|
| 197 | + ); |
|
| 198 | + return $info; |
|
| 199 | + } |
|
| 200 | + $this->logger->info('This cache already expired return false'); |
|
| 201 | + return false; |
|
| 202 | + } |
|
| 203 | 203 | |
| 204 | 204 | |
| 205 | - /** |
|
| 206 | - * Used to delete expired cache data |
|
| 207 | - */ |
|
| 208 | - public function deleteExpiredCache(){ |
|
| 209 | - $this->logger->debug('Deleting of expired cache files'); |
|
| 210 | - $list = glob(CACHE_PATH . '*.cache'); |
|
| 211 | - if(! $list){ |
|
| 212 | - $this->logger->info('No cache files were found skipping'); |
|
| 213 | - } |
|
| 214 | - else{ |
|
| 215 | - $this->logger->info('Found [' . count($list) . '] cache files to remove if expired'); |
|
| 216 | - foreach ($list as $file) { |
|
| 217 | - $this->logger->debug('Processing the cache file [' . $file . ']'); |
|
| 218 | - $data = file_get_contents($file); |
|
| 219 | - $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 220 | - if(! $data){ |
|
| 221 | - $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']'); |
|
| 222 | - } |
|
| 223 | - else if(time() > $data['expire']){ |
|
| 224 | - $this->logger->info('The cache data for file [' . $file . '] already expired remove it'); |
|
| 225 | - unlink($file); |
|
| 226 | - } |
|
| 227 | - else{ |
|
| 228 | - $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it'); |
|
| 229 | - } |
|
| 230 | - } |
|
| 231 | - } |
|
| 232 | - } |
|
| 205 | + /** |
|
| 206 | + * Used to delete expired cache data |
|
| 207 | + */ |
|
| 208 | + public function deleteExpiredCache(){ |
|
| 209 | + $this->logger->debug('Deleting of expired cache files'); |
|
| 210 | + $list = glob(CACHE_PATH . '*.cache'); |
|
| 211 | + if(! $list){ |
|
| 212 | + $this->logger->info('No cache files were found skipping'); |
|
| 213 | + } |
|
| 214 | + else{ |
|
| 215 | + $this->logger->info('Found [' . count($list) . '] cache files to remove if expired'); |
|
| 216 | + foreach ($list as $file) { |
|
| 217 | + $this->logger->debug('Processing the cache file [' . $file . ']'); |
|
| 218 | + $data = file_get_contents($file); |
|
| 219 | + $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
|
| 220 | + if(! $data){ |
|
| 221 | + $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']'); |
|
| 222 | + } |
|
| 223 | + else if(time() > $data['expire']){ |
|
| 224 | + $this->logger->info('The cache data for file [' . $file . '] already expired remove it'); |
|
| 225 | + unlink($file); |
|
| 226 | + } |
|
| 227 | + else{ |
|
| 228 | + $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it'); |
|
| 229 | + } |
|
| 230 | + } |
|
| 231 | + } |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Remove all file from cache folder |
|
| 236 | - */ |
|
| 237 | - public function clean(){ |
|
| 238 | - $this->logger->debug('Deleting of all cache files'); |
|
| 239 | - $list = glob(CACHE_PATH . '*.cache'); |
|
| 240 | - if(! $list){ |
|
| 241 | - $this->logger->info('No cache files were found skipping'); |
|
| 242 | - } |
|
| 243 | - else{ |
|
| 244 | - $this->logger->info('Found [' . count($list) . '] cache files to remove'); |
|
| 245 | - foreach ($list as $file) { |
|
| 246 | - $this->logger->debug('Processing the cache file [' . $file . ']'); |
|
| 247 | - unlink($file); |
|
| 248 | - } |
|
| 249 | - } |
|
| 250 | - } |
|
| 234 | + /** |
|
| 235 | + * Remove all file from cache folder |
|
| 236 | + */ |
|
| 237 | + public function clean(){ |
|
| 238 | + $this->logger->debug('Deleting of all cache files'); |
|
| 239 | + $list = glob(CACHE_PATH . '*.cache'); |
|
| 240 | + if(! $list){ |
|
| 241 | + $this->logger->info('No cache files were found skipping'); |
|
| 242 | + } |
|
| 243 | + else{ |
|
| 244 | + $this->logger->info('Found [' . count($list) . '] cache files to remove'); |
|
| 245 | + foreach ($list as $file) { |
|
| 246 | + $this->logger->debug('Processing the cache file [' . $file . ']'); |
|
| 247 | + unlink($file); |
|
| 248 | + } |
|
| 249 | + } |
|
| 250 | + } |
|
| 251 | 251 | |
| 252 | - /** |
|
| 253 | - * @return boolean |
|
| 254 | - */ |
|
| 255 | - public function isCompressCacheData(){ |
|
| 256 | - return $this->compressCacheData; |
|
| 257 | - } |
|
| 252 | + /** |
|
| 253 | + * @return boolean |
|
| 254 | + */ |
|
| 255 | + public function isCompressCacheData(){ |
|
| 256 | + return $this->compressCacheData; |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | - /** |
|
| 260 | - * @param boolean $compressCacheData |
|
| 261 | - * |
|
| 262 | - * @return object |
|
| 263 | - */ |
|
| 264 | - public function setCompressCacheData($status = true){ |
|
| 265 | - //if Zlib extension is not loaded set compressCacheData to false |
|
| 266 | - if($status === true && ! extension_loaded('zlib')){ |
|
| 259 | + /** |
|
| 260 | + * @param boolean $compressCacheData |
|
| 261 | + * |
|
| 262 | + * @return object |
|
| 263 | + */ |
|
| 264 | + public function setCompressCacheData($status = true){ |
|
| 265 | + //if Zlib extension is not loaded set compressCacheData to false |
|
| 266 | + if($status === true && ! extension_loaded('zlib')){ |
|
| 267 | 267 | |
| 268 | - $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
|
| 269 | - $this->compressCacheData = false; |
|
| 270 | - } |
|
| 271 | - else{ |
|
| 272 | - $this->compressCacheData = $status; |
|
| 273 | - } |
|
| 274 | - return $this; |
|
| 275 | - } |
|
| 268 | + $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
|
| 269 | + $this->compressCacheData = false; |
|
| 270 | + } |
|
| 271 | + else{ |
|
| 272 | + $this->compressCacheData = $status; |
|
| 273 | + } |
|
| 274 | + return $this; |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Check whether the cache feature for the handle is supported |
|
| 279 | - * |
|
| 280 | - * @return bool |
|
| 281 | - */ |
|
| 282 | - public function isSupported(){ |
|
| 283 | - return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH); |
|
| 284 | - } |
|
| 277 | + /** |
|
| 278 | + * Check whether the cache feature for the handle is supported |
|
| 279 | + * |
|
| 280 | + * @return bool |
|
| 281 | + */ |
|
| 282 | + public function isSupported(){ |
|
| 283 | + return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * Return the Log instance |
|
| 288 | - * @return object |
|
| 289 | - */ |
|
| 290 | - public function getLogger(){ |
|
| 291 | - return $this->logger; |
|
| 292 | - } |
|
| 286 | + /** |
|
| 287 | + * Return the Log instance |
|
| 288 | + * @return object |
|
| 289 | + */ |
|
| 290 | + public function getLogger(){ |
|
| 291 | + return $this->logger; |
|
| 292 | + } |
|
| 293 | 293 | |
| 294 | - /** |
|
| 295 | - * Set the log instance |
|
| 296 | - * @param Log $logger the log object |
|
| 297 | - */ |
|
| 298 | - public function setLogger(Log $logger){ |
|
| 299 | - $this->logger = $logger; |
|
| 300 | - return $this; |
|
| 301 | - } |
|
| 294 | + /** |
|
| 295 | + * Set the log instance |
|
| 296 | + * @param Log $logger the log object |
|
| 297 | + */ |
|
| 298 | + public function setLogger(Log $logger){ |
|
| 299 | + $this->logger = $logger; |
|
| 300 | + return $this; |
|
| 301 | + } |
|
| 302 | 302 | |
| 303 | - /** |
|
| 304 | - * Get the cache file full path for the given key |
|
| 305 | - * |
|
| 306 | - * @param string $key the cache item key |
|
| 307 | - * @return string the full cache file path for this key |
|
| 308 | - */ |
|
| 309 | - private function getFilePath($key){ |
|
| 310 | - return CACHE_PATH . md5($key) . '.cache'; |
|
| 311 | - } |
|
| 312 | - } |
|
| 303 | + /** |
|
| 304 | + * Get the cache file full path for the given key |
|
| 305 | + * |
|
| 306 | + * @param string $key the cache item key |
|
| 307 | + * @return string the full cache file path for this key |
|
| 308 | + */ |
|
| 309 | + private function getFilePath($key){ |
|
| 310 | + return CACHE_PATH . md5($key) . '.cache'; |
|
| 311 | + } |
|
| 312 | + } |
|
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 25 | 25 | */ |
| 26 | 26 | |
| 27 | - class FileCache implements CacheInterface{ |
|
| 27 | + class FileCache implements CacheInterface { |
|
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * Whether to enable compression of the cache data file. |
@@ -39,23 +39,23 @@ discard block |
||
| 39 | 39 | private $logger; |
| 40 | 40 | |
| 41 | 41 | |
| 42 | - public function __construct(Log $logger = null){ |
|
| 43 | - if(! $this->isSupported()){ |
|
| 42 | + public function __construct(Log $logger = null) { |
|
| 43 | + if (!$this->isSupported()) { |
|
| 44 | 44 | show_error('The cache for file system is not available. Check the cache directory if is exists or is writable.'); |
| 45 | 45 | } |
| 46 | 46 | /** |
| 47 | 47 | * instance of the Log class |
| 48 | 48 | */ |
| 49 | - if(is_object($logger)){ |
|
| 49 | + if (is_object($logger)) { |
|
| 50 | 50 | $this->logger = $logger; |
| 51 | 51 | } |
| 52 | - else{ |
|
| 53 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 52 | + else { |
|
| 53 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 54 | 54 | $this->logger->setLogger('Library::FileCache'); |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | 57 | //if Zlib extension is not loaded set compressCacheData to false |
| 58 | - if(! extension_loaded('zlib')){ |
|
| 58 | + if (!extension_loaded('zlib')) { |
|
| 59 | 59 | $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
| 60 | 60 | $this->compressCacheData = false; |
| 61 | 61 | } |
@@ -66,17 +66,17 @@ discard block |
||
| 66 | 66 | * @param string $key the key to identify the cache data |
| 67 | 67 | * @return mixed the cache data if exists else return false |
| 68 | 68 | */ |
| 69 | - public function get($key){ |
|
| 70 | - $this->logger->debug('Getting cache data for key ['. $key .']'); |
|
| 69 | + public function get($key) { |
|
| 70 | + $this->logger->debug('Getting cache data for key [' . $key . ']'); |
|
| 71 | 71 | $filePath = $this->getFilePath($key); |
| 72 | - if(! file_exists($filePath)){ |
|
| 73 | - $this->logger->info('No cache file found for the key ['. $key .'], return false'); |
|
| 72 | + if (!file_exists($filePath)) { |
|
| 73 | + $this->logger->info('No cache file found for the key [' . $key . '], return false'); |
|
| 74 | 74 | return false; |
| 75 | 75 | } |
| 76 | - $this->logger->info('The cache file [' .$filePath. '] for the key ['. $key .'] exists, check if the cache data is valid'); |
|
| 77 | - $handle = fopen($filePath,'r'); |
|
| 78 | - if(! is_resource($handle)){ |
|
| 79 | - $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 76 | + $this->logger->info('The cache file [' . $filePath . '] for the key [' . $key . '] exists, check if the cache data is valid'); |
|
| 77 | + $handle = fopen($filePath, 'r'); |
|
| 78 | + if (!is_resource($handle)) { |
|
| 79 | + $this->logger->error('Can not open the file cache [' . $filePath . '] for the key [' . $key . '], return false'); |
|
| 80 | 80 | return false; |
| 81 | 81 | } |
| 82 | 82 | // Getting a shared lock |
@@ -84,20 +84,20 @@ discard block |
||
| 84 | 84 | $data = file_get_contents($filePath); |
| 85 | 85 | fclose($handle); |
| 86 | 86 | $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
| 87 | - if (! $data) { |
|
| 88 | - $this->logger->error('Can not unserialize the cache data for the key ['. $key .'], return false'); |
|
| 87 | + if (!$data) { |
|
| 88 | + $this->logger->error('Can not unserialize the cache data for the key [' . $key . '], return false'); |
|
| 89 | 89 | // If unserializing somehow didn't work out, we'll delete the file |
| 90 | 90 | unlink($filePath); |
| 91 | 91 | return false; |
| 92 | 92 | } |
| 93 | 93 | if (time() > $data['expire']) { |
| 94 | - $this->logger->info('The cache data for the key ['. $key .'] already expired delete the cache file [' .$filePath. ']'); |
|
| 94 | + $this->logger->info('The cache data for the key [' . $key . '] already expired delete the cache file [' . $filePath . ']'); |
|
| 95 | 95 | // Unlinking when the file was expired |
| 96 | 96 | unlink($filePath); |
| 97 | 97 | return false; |
| 98 | 98 | } |
| 99 | - else{ |
|
| 100 | - $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']'); |
|
| 99 | + else { |
|
| 100 | + $this->logger->info('The cache not yet expire, now return the cache data for key [' . $key . '], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']'); |
|
| 101 | 101 | return $data['data']; |
| 102 | 102 | } |
| 103 | 103 | } |
@@ -110,13 +110,13 @@ discard block |
||
| 110 | 110 | * @param integer $ttl the cache life time |
| 111 | 111 | * @return boolean true if success otherwise will return false |
| 112 | 112 | */ |
| 113 | - public function set($key, $data, $ttl = 0){ |
|
| 113 | + public function set($key, $data, $ttl = 0) { |
|
| 114 | 114 | $expire = time() + $ttl; |
| 115 | - $this->logger->debug('Setting cache data for key ['. $key .'], time to live [' .$ttl. '], expire at [' . date('Y-m-d H:i:s', $expire) . ']'); |
|
| 115 | + $this->logger->debug('Setting cache data for key [' . $key . '], time to live [' . $ttl . '], expire at [' . date('Y-m-d H:i:s', $expire) . ']'); |
|
| 116 | 116 | $filePath = $this->getFilePath($key); |
| 117 | - $handle = fopen($filePath,'w'); |
|
| 118 | - if(! is_resource($handle)){ |
|
| 119 | - $this->logger->error('Can not open the file cache [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 117 | + $handle = fopen($filePath, 'w'); |
|
| 118 | + if (!is_resource($handle)) { |
|
| 119 | + $this->logger->error('Can not open the file cache [' . $filePath . '] for the key [' . $key . '], return false'); |
|
| 120 | 120 | return false; |
| 121 | 121 | } |
| 122 | 122 | flock($handle, LOCK_EX); // exclusive lock, will get released when the file is closed |
@@ -129,13 +129,13 @@ discard block |
||
| 129 | 129 | ) |
| 130 | 130 | ); |
| 131 | 131 | $result = fwrite($handle, $this->compressCacheData ? gzdeflate($cacheData, 9) : $cacheData); |
| 132 | - if(! $result){ |
|
| 133 | - $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false'); |
|
| 132 | + if (!$result) { |
|
| 133 | + $this->logger->error('Can not write cache data into file [' . $filePath . '] for the key [' . $key . '], return false'); |
|
| 134 | 134 | fclose($handle); |
| 135 | 135 | return false; |
| 136 | 136 | } |
| 137 | - else{ |
|
| 138 | - $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']'); |
|
| 137 | + else { |
|
| 138 | + $this->logger->info('Cache data saved into file [' . $filePath . '] for the key [' . $key . ']'); |
|
| 139 | 139 | fclose($handle); |
| 140 | 140 | chmod($filePath, 0640); |
| 141 | 141 | return true; |
@@ -149,16 +149,16 @@ discard block |
||
| 149 | 149 | * @return boolean true if the cache is delete, false if can't delete |
| 150 | 150 | * the cache or the cache with the given key not exist |
| 151 | 151 | */ |
| 152 | - public function delete($key){ |
|
| 153 | - $this->logger->debug('Deleting of cache data for key [' .$key. ']'); |
|
| 152 | + public function delete($key) { |
|
| 153 | + $this->logger->debug('Deleting of cache data for key [' . $key . ']'); |
|
| 154 | 154 | $filePath = $this->getFilePath($key); |
| 155 | - $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 156 | - if(! file_exists($filePath)){ |
|
| 155 | + $this->logger->info('The file path for the key [' . $key . '] is [' . $filePath . ']'); |
|
| 156 | + if (!file_exists($filePath)) { |
|
| 157 | 157 | $this->logger->info('This cache file does not exists skipping'); |
| 158 | 158 | return false; |
| 159 | 159 | } |
| 160 | - else{ |
|
| 161 | - $this->logger->info('Found cache file [' .$filePath. '] remove it'); |
|
| 160 | + else { |
|
| 161 | + $this->logger->info('Found cache file [' . $filePath . '] remove it'); |
|
| 162 | 162 | unlink($filePath); |
| 163 | 163 | return true; |
| 164 | 164 | } |
@@ -172,23 +172,23 @@ discard block |
||
| 172 | 172 | * 'expire' => expiration time of the cache (Unix timestamp), |
| 173 | 173 | * 'ttl' => the time to live of the cache in second |
| 174 | 174 | */ |
| 175 | - public function getInfo($key){ |
|
| 176 | - $this->logger->debug('Getting of cache info for key [' .$key. ']'); |
|
| 175 | + public function getInfo($key) { |
|
| 176 | + $this->logger->debug('Getting of cache info for key [' . $key . ']'); |
|
| 177 | 177 | $filePath = $this->getFilePath($key); |
| 178 | - $this->logger->info('The file path for the key [' .$key. '] is [' .$filePath. ']'); |
|
| 179 | - if(! file_exists($filePath)){ |
|
| 178 | + $this->logger->info('The file path for the key [' . $key . '] is [' . $filePath . ']'); |
|
| 179 | + if (!file_exists($filePath)) { |
|
| 180 | 180 | $this->logger->info('This cache file does not exists skipping'); |
| 181 | 181 | return false; |
| 182 | 182 | } |
| 183 | - $this->logger->info('Found cache file [' .$filePath. '] check the validity'); |
|
| 183 | + $this->logger->info('Found cache file [' . $filePath . '] check the validity'); |
|
| 184 | 184 | $data = file_get_contents($filePath); |
| 185 | 185 | $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
| 186 | - if(! $data){ |
|
| 186 | + if (!$data) { |
|
| 187 | 187 | $this->logger->warning('Can not unserialize the cache data for file [' . $filePath . ']'); |
| 188 | 188 | return false; |
| 189 | 189 | } |
| 190 | 190 | $this->logger->info('This cache data is OK check for expire'); |
| 191 | - if(isset($data['expire']) && $data['expire'] > time()){ |
|
| 191 | + if (isset($data['expire']) && $data['expire'] > time()) { |
|
| 192 | 192 | $this->logger->info('This cache not yet expired return cache informations'); |
| 193 | 193 | $info = array( |
| 194 | 194 | 'mtime' => $data['mtime'], |
@@ -205,26 +205,26 @@ discard block |
||
| 205 | 205 | /** |
| 206 | 206 | * Used to delete expired cache data |
| 207 | 207 | */ |
| 208 | - public function deleteExpiredCache(){ |
|
| 208 | + public function deleteExpiredCache() { |
|
| 209 | 209 | $this->logger->debug('Deleting of expired cache files'); |
| 210 | 210 | $list = glob(CACHE_PATH . '*.cache'); |
| 211 | - if(! $list){ |
|
| 211 | + if (!$list) { |
|
| 212 | 212 | $this->logger->info('No cache files were found skipping'); |
| 213 | 213 | } |
| 214 | - else{ |
|
| 214 | + else { |
|
| 215 | 215 | $this->logger->info('Found [' . count($list) . '] cache files to remove if expired'); |
| 216 | 216 | foreach ($list as $file) { |
| 217 | 217 | $this->logger->debug('Processing the cache file [' . $file . ']'); |
| 218 | 218 | $data = file_get_contents($file); |
| 219 | 219 | $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
| 220 | - if(! $data){ |
|
| 220 | + if (!$data) { |
|
| 221 | 221 | $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']'); |
| 222 | 222 | } |
| 223 | - else if(time() > $data['expire']){ |
|
| 223 | + else if (time() > $data['expire']) { |
|
| 224 | 224 | $this->logger->info('The cache data for file [' . $file . '] already expired remove it'); |
| 225 | 225 | unlink($file); |
| 226 | 226 | } |
| 227 | - else{ |
|
| 227 | + else { |
|
| 228 | 228 | $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it'); |
| 229 | 229 | } |
| 230 | 230 | } |
@@ -234,13 +234,13 @@ discard block |
||
| 234 | 234 | /** |
| 235 | 235 | * Remove all file from cache folder |
| 236 | 236 | */ |
| 237 | - public function clean(){ |
|
| 237 | + public function clean() { |
|
| 238 | 238 | $this->logger->debug('Deleting of all cache files'); |
| 239 | 239 | $list = glob(CACHE_PATH . '*.cache'); |
| 240 | - if(! $list){ |
|
| 240 | + if (!$list) { |
|
| 241 | 241 | $this->logger->info('No cache files were found skipping'); |
| 242 | 242 | } |
| 243 | - else{ |
|
| 243 | + else { |
|
| 244 | 244 | $this->logger->info('Found [' . count($list) . '] cache files to remove'); |
| 245 | 245 | foreach ($list as $file) { |
| 246 | 246 | $this->logger->debug('Processing the cache file [' . $file . ']'); |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | /** |
| 253 | 253 | * @return boolean |
| 254 | 254 | */ |
| 255 | - public function isCompressCacheData(){ |
|
| 255 | + public function isCompressCacheData() { |
|
| 256 | 256 | return $this->compressCacheData; |
| 257 | 257 | } |
| 258 | 258 | |
@@ -261,14 +261,14 @@ discard block |
||
| 261 | 261 | * |
| 262 | 262 | * @return object |
| 263 | 263 | */ |
| 264 | - public function setCompressCacheData($status = true){ |
|
| 264 | + public function setCompressCacheData($status = true) { |
|
| 265 | 265 | //if Zlib extension is not loaded set compressCacheData to false |
| 266 | - if($status === true && ! extension_loaded('zlib')){ |
|
| 266 | + if ($status === true && !extension_loaded('zlib')) { |
|
| 267 | 267 | |
| 268 | 268 | $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
| 269 | 269 | $this->compressCacheData = false; |
| 270 | 270 | } |
| 271 | - else{ |
|
| 271 | + else { |
|
| 272 | 272 | $this->compressCacheData = $status; |
| 273 | 273 | } |
| 274 | 274 | return $this; |
@@ -279,7 +279,7 @@ discard block |
||
| 279 | 279 | * |
| 280 | 280 | * @return bool |
| 281 | 281 | */ |
| 282 | - public function isSupported(){ |
|
| 282 | + public function isSupported() { |
|
| 283 | 283 | return CACHE_PATH && is_dir(CACHE_PATH) && is_writable(CACHE_PATH); |
| 284 | 284 | } |
| 285 | 285 | |
@@ -287,7 +287,7 @@ discard block |
||
| 287 | 287 | * Return the Log instance |
| 288 | 288 | * @return object |
| 289 | 289 | */ |
| 290 | - public function getLogger(){ |
|
| 290 | + public function getLogger() { |
|
| 291 | 291 | return $this->logger; |
| 292 | 292 | } |
| 293 | 293 | |
@@ -295,7 +295,7 @@ discard block |
||
| 295 | 295 | * Set the log instance |
| 296 | 296 | * @param Log $logger the log object |
| 297 | 297 | */ |
| 298 | - public function setLogger(Log $logger){ |
|
| 298 | + public function setLogger(Log $logger) { |
|
| 299 | 299 | $this->logger = $logger; |
| 300 | 300 | return $this; |
| 301 | 301 | } |
@@ -306,7 +306,7 @@ discard block |
||
| 306 | 306 | * @param string $key the cache item key |
| 307 | 307 | * @return string the full cache file path for this key |
| 308 | 308 | */ |
| 309 | - private function getFilePath($key){ |
|
| 309 | + private function getFilePath($key) { |
|
| 310 | 310 | return CACHE_PATH . md5($key) . '.cache'; |
| 311 | 311 | } |
| 312 | 312 | } |
@@ -48,8 +48,7 @@ discard block |
||
| 48 | 48 | */ |
| 49 | 49 | if(is_object($logger)){ |
| 50 | 50 | $this->logger = $logger; |
| 51 | - } |
|
| 52 | - else{ |
|
| 51 | + } else{ |
|
| 53 | 52 | $this->logger =& class_loader('Log', 'classes'); |
| 54 | 53 | $this->logger->setLogger('Library::FileCache'); |
| 55 | 54 | } |
@@ -95,8 +94,7 @@ discard block |
||
| 95 | 94 | // Unlinking when the file was expired |
| 96 | 95 | unlink($filePath); |
| 97 | 96 | return false; |
| 98 | - } |
|
| 99 | - else{ |
|
| 97 | + } else{ |
|
| 100 | 98 | $this->logger->info('The cache not yet expire, now return the cache data for key ['. $key .'], the cache will expire at [' . date('Y-m-d H:i:s', $data['expire']) . ']'); |
| 101 | 99 | return $data['data']; |
| 102 | 100 | } |
@@ -133,8 +131,7 @@ discard block |
||
| 133 | 131 | $this->logger->error('Can not write cache data into file [' .$filePath. '] for the key ['. $key .'], return false'); |
| 134 | 132 | fclose($handle); |
| 135 | 133 | return false; |
| 136 | - } |
|
| 137 | - else{ |
|
| 134 | + } else{ |
|
| 138 | 135 | $this->logger->info('Cache data saved into file [' .$filePath. '] for the key ['. $key .']'); |
| 139 | 136 | fclose($handle); |
| 140 | 137 | chmod($filePath, 0640); |
@@ -156,8 +153,7 @@ discard block |
||
| 156 | 153 | if(! file_exists($filePath)){ |
| 157 | 154 | $this->logger->info('This cache file does not exists skipping'); |
| 158 | 155 | return false; |
| 159 | - } |
|
| 160 | - else{ |
|
| 156 | + } else{ |
|
| 161 | 157 | $this->logger->info('Found cache file [' .$filePath. '] remove it'); |
| 162 | 158 | unlink($filePath); |
| 163 | 159 | return true; |
@@ -210,8 +206,7 @@ discard block |
||
| 210 | 206 | $list = glob(CACHE_PATH . '*.cache'); |
| 211 | 207 | if(! $list){ |
| 212 | 208 | $this->logger->info('No cache files were found skipping'); |
| 213 | - } |
|
| 214 | - else{ |
|
| 209 | + } else{ |
|
| 215 | 210 | $this->logger->info('Found [' . count($list) . '] cache files to remove if expired'); |
| 216 | 211 | foreach ($list as $file) { |
| 217 | 212 | $this->logger->debug('Processing the cache file [' . $file . ']'); |
@@ -219,12 +214,10 @@ discard block |
||
| 219 | 214 | $data = @unserialize($this->compressCacheData ? gzinflate($data) : $data); |
| 220 | 215 | if(! $data){ |
| 221 | 216 | $this->logger->warning('Can not unserialize the cache data for file [' . $file . ']'); |
| 222 | - } |
|
| 223 | - else if(time() > $data['expire']){ |
|
| 217 | + } else if(time() > $data['expire']){ |
|
| 224 | 218 | $this->logger->info('The cache data for file [' . $file . '] already expired remove it'); |
| 225 | 219 | unlink($file); |
| 226 | - } |
|
| 227 | - else{ |
|
| 220 | + } else{ |
|
| 228 | 221 | $this->logger->info('The cache data for file [' . $file . '] not yet expired skip it'); |
| 229 | 222 | } |
| 230 | 223 | } |
@@ -239,8 +232,7 @@ discard block |
||
| 239 | 232 | $list = glob(CACHE_PATH . '*.cache'); |
| 240 | 233 | if(! $list){ |
| 241 | 234 | $this->logger->info('No cache files were found skipping'); |
| 242 | - } |
|
| 243 | - else{ |
|
| 235 | + } else{ |
|
| 244 | 236 | $this->logger->info('Found [' . count($list) . '] cache files to remove'); |
| 245 | 237 | foreach ($list as $file) { |
| 246 | 238 | $this->logger->debug('Processing the cache file [' . $file . ']'); |
@@ -267,8 +259,7 @@ discard block |
||
| 267 | 259 | |
| 268 | 260 | $this->logger->warning('The zlib extension is not loaded set cache compress data to FALSE'); |
| 269 | 261 | $this->compressCacheData = false; |
| 270 | - } |
|
| 271 | - else{ |
|
| 262 | + } else{ |
|
| 272 | 263 | $this->compressCacheData = $status; |
| 273 | 264 | } |
| 274 | 265 | return $this; |
@@ -266,8 +266,7 @@ discard block |
||
| 266 | 266 | //if the application is running in CLI mode use the first argument |
| 267 | 267 | else if(IS_CLI && isset($_SERVER['argv'][1])){ |
| 268 | 268 | $routeUri = $_SERVER['argv'][1]; |
| 269 | - } |
|
| 270 | - else if(isset($_SERVER['REQUEST_URI'])){ |
|
| 269 | + } else if(isset($_SERVER['REQUEST_URI'])){ |
|
| 271 | 270 | $routeUri = $_SERVER['REQUEST_URI']; |
| 272 | 271 | } |
| 273 | 272 | $this->logger->debug('Check if URL suffix is enabled in the configuration'); |
@@ -363,15 +362,13 @@ discard block |
||
| 363 | 362 | if(! class_exists($controller, false)){ |
| 364 | 363 | $e404 = true; |
| 365 | 364 | $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']'); |
| 366 | - } |
|
| 367 | - else{ |
|
| 365 | + } else{ |
|
| 368 | 366 | $controllerInstance = new $controller(); |
| 369 | 367 | $controllerMethod = $this->getMethod(); |
| 370 | 368 | if(! method_exists($controllerInstance, $controllerMethod)){ |
| 371 | 369 | $e404 = true; |
| 372 | 370 | $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']'); |
| 373 | - } |
|
| 374 | - else{ |
|
| 371 | + } else{ |
|
| 375 | 372 | $this->logger->info('Routing data is set correctly now GO!'); |
| 376 | 373 | call_user_func_array(array($controllerInstance, $controllerMethod), $this->args); |
| 377 | 374 | //render the final page to user |
@@ -379,8 +376,7 @@ discard block |
||
| 379 | 376 | get_instance()->response->renderFinalPage(); |
| 380 | 377 | } |
| 381 | 378 | } |
| 382 | - } |
|
| 383 | - else{ |
|
| 379 | + } else{ |
|
| 384 | 380 | $this->logger->info('The controller file path [' . $classFilePath . '] does not exist'); |
| 385 | 381 | $e404 = true; |
| 386 | 382 | } |
@@ -486,8 +482,7 @@ discard block |
||
| 486 | 482 | $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']'); |
| 487 | 483 | $this->module = $moduleControllerMethod[0]; |
| 488 | 484 | $moduleControllerMethod = explode('@', $moduleControllerMethod[1]); |
| 489 | - } |
|
| 490 | - else{ |
|
| 485 | + } else{ |
|
| 491 | 486 | $this->logger->info('The current request does not use the module'); |
| 492 | 487 | $moduleControllerMethod = explode('@', $this->callback[$index]); |
| 493 | 488 | } |
@@ -543,8 +538,7 @@ discard block |
||
| 543 | 538 | } |
| 544 | 539 | //args |
| 545 | 540 | $this->args = $segment; |
| 546 | - } |
|
| 547 | - else{ |
|
| 541 | + } else{ |
|
| 548 | 542 | $this->logger->info('The application contains a loaded module will check if the current request is found in the module list'); |
| 549 | 543 | if(in_array($segment[0], $modules)){ |
| 550 | 544 | $this->logger->info('Found, the current request use the module [' . $segment[0] . ']'); |
@@ -558,8 +552,7 @@ discard block |
||
| 558 | 552 | if(! $path){ |
| 559 | 553 | $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller'); |
| 560 | 554 | $this->controller = $this->module; |
| 561 | - } |
|
| 562 | - else{ |
|
| 555 | + } else{ |
|
| 563 | 556 | $this->controllerPath = $path; |
| 564 | 557 | array_shift($segment); |
| 565 | 558 | } |
@@ -571,8 +564,7 @@ discard block |
||
| 571 | 564 | } |
| 572 | 565 | //the remaining is for args |
| 573 | 566 | $this->args = $segment; |
| 574 | - } |
|
| 575 | - else{ |
|
| 567 | + } else{ |
|
| 576 | 568 | $this->logger->info('The current request information is not found in the module list'); |
| 577 | 569 | //controller |
| 578 | 570 | if(isset($segment[0])){ |
@@ -615,8 +607,7 @@ discard block |
||
| 615 | 607 | protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
| 616 | 608 | if ($logger !== null){ |
| 617 | 609 | $this->logger = $logger; |
| 618 | - } |
|
| 619 | - else{ |
|
| 610 | + } else{ |
|
| 620 | 611 | $this->logger =& class_loader('Log', 'classes'); |
| 621 | 612 | $this->logger->setLogger('Library::Router'); |
| 622 | 613 | } |
@@ -1,624 +1,624 @@ |
||
| 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 | - */ |
|
| 26 | - |
|
| 27 | - class Router { |
|
| 28 | - /** |
|
| 29 | - * @var array $pattern: The list of URIs to validate against |
|
| 30 | - */ |
|
| 31 | - private $pattern = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var array $callback: The list of callback to call |
|
| 35 | - */ |
|
| 36 | - private $callback = array(); |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var string $uriTrim: The char to remove from the URIs |
|
| 40 | - */ |
|
| 41 | - protected $uriTrim = '/\^$'; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @var string $uri: The route URI to use |
|
| 45 | - */ |
|
| 46 | - protected $uri = ''; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * The module name of the current request |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 52 | - protected $module = null; |
|
| 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 | + |
|
| 27 | + class Router { |
|
| 28 | + /** |
|
| 29 | + * @var array $pattern: The list of URIs to validate against |
|
| 30 | + */ |
|
| 31 | + private $pattern = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var array $callback: The list of callback to call |
|
| 35 | + */ |
|
| 36 | + private $callback = array(); |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var string $uriTrim: The char to remove from the URIs |
|
| 40 | + */ |
|
| 41 | + protected $uriTrim = '/\^$'; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @var string $uri: The route URI to use |
|
| 45 | + */ |
|
| 46 | + protected $uri = ''; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * The module name of the current request |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | + protected $module = null; |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * The controller name of the current request |
|
| 56 | - * @var string |
|
| 57 | - */ |
|
| 58 | - protected $controller = null; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * The controller path |
|
| 62 | - * @var string |
|
| 63 | - */ |
|
| 64 | - protected $controllerPath = null; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * The method name. The default value is "index" |
|
| 68 | - * @var string |
|
| 69 | - */ |
|
| 70 | - protected $method = 'index'; |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * List of argument to pass to the method |
|
| 74 | - * @var array |
|
| 75 | - */ |
|
| 76 | - protected $args = array(); |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * List of routes configurations |
|
| 80 | - * @var array |
|
| 81 | - */ |
|
| 82 | - protected $routes = array(); |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * The segments array for the current request |
|
| 86 | - * @var array |
|
| 87 | - */ |
|
| 88 | - protected $segments = array(); |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * The logger instance |
|
| 92 | - * @var Log |
|
| 93 | - */ |
|
| 94 | - private $logger; |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Construct the new Router instance |
|
| 98 | - */ |
|
| 99 | - public function __construct(){ |
|
| 100 | - $this->setLoggerFromParamOrCreateNewInstance(null); |
|
| 54 | + /** |
|
| 55 | + * The controller name of the current request |
|
| 56 | + * @var string |
|
| 57 | + */ |
|
| 58 | + protected $controller = null; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * The controller path |
|
| 62 | + * @var string |
|
| 63 | + */ |
|
| 64 | + protected $controllerPath = null; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * The method name. The default value is "index" |
|
| 68 | + * @var string |
|
| 69 | + */ |
|
| 70 | + protected $method = 'index'; |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * List of argument to pass to the method |
|
| 74 | + * @var array |
|
| 75 | + */ |
|
| 76 | + protected $args = array(); |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * List of routes configurations |
|
| 80 | + * @var array |
|
| 81 | + */ |
|
| 82 | + protected $routes = array(); |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * The segments array for the current request |
|
| 86 | + * @var array |
|
| 87 | + */ |
|
| 88 | + protected $segments = array(); |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * The logger instance |
|
| 92 | + * @var Log |
|
| 93 | + */ |
|
| 94 | + private $logger; |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Construct the new Router instance |
|
| 98 | + */ |
|
| 99 | + public function __construct(){ |
|
| 100 | + $this->setLoggerFromParamOrCreateNewInstance(null); |
|
| 101 | 101 | |
| 102 | - //loading routes for module |
|
| 103 | - $moduleRouteList = array(); |
|
| 104 | - $modulesRoutes = Module::getModulesRoutesConfig(); |
|
| 105 | - if($modulesRoutes && is_array($modulesRoutes)){ |
|
| 106 | - $moduleRouteList = $modulesRoutes; |
|
| 107 | - unset($modulesRoutes); |
|
| 108 | - } |
|
| 109 | - $this->setRouteConfiguration($moduleRouteList); |
|
| 110 | - $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes)); |
|
| 111 | - |
|
| 112 | - //Set route informations |
|
| 113 | - $this->setRouteConfigurationInfos(); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Get the route patterns |
|
| 118 | - * @return array |
|
| 119 | - */ |
|
| 120 | - public function getPattern(){ |
|
| 121 | - return $this->pattern; |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Get the route callbacks |
|
| 126 | - * @return array |
|
| 127 | - */ |
|
| 128 | - public function getCallback(){ |
|
| 129 | - return $this->callback; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Get the module name |
|
| 134 | - * @return string |
|
| 135 | - */ |
|
| 136 | - public function getModule(){ |
|
| 137 | - return $this->module; |
|
| 138 | - } |
|
| 102 | + //loading routes for module |
|
| 103 | + $moduleRouteList = array(); |
|
| 104 | + $modulesRoutes = Module::getModulesRoutesConfig(); |
|
| 105 | + if($modulesRoutes && is_array($modulesRoutes)){ |
|
| 106 | + $moduleRouteList = $modulesRoutes; |
|
| 107 | + unset($modulesRoutes); |
|
| 108 | + } |
|
| 109 | + $this->setRouteConfiguration($moduleRouteList); |
|
| 110 | + $this->logger->info('The routes configuration are listed below: ' . stringfy_vars($this->routes)); |
|
| 111 | + |
|
| 112 | + //Set route informations |
|
| 113 | + $this->setRouteConfigurationInfos(); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Get the route patterns |
|
| 118 | + * @return array |
|
| 119 | + */ |
|
| 120 | + public function getPattern(){ |
|
| 121 | + return $this->pattern; |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Get the route callbacks |
|
| 126 | + * @return array |
|
| 127 | + */ |
|
| 128 | + public function getCallback(){ |
|
| 129 | + return $this->callback; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Get the module name |
|
| 134 | + * @return string |
|
| 135 | + */ |
|
| 136 | + public function getModule(){ |
|
| 137 | + return $this->module; |
|
| 138 | + } |
|
| 139 | 139 | |
| 140 | - /** |
|
| 141 | - * Get the controller name |
|
| 142 | - * @return string |
|
| 143 | - */ |
|
| 144 | - public function getController(){ |
|
| 145 | - return $this->controller; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * Get the controller file path |
|
| 150 | - * @return string |
|
| 151 | - */ |
|
| 152 | - public function getControllerPath(){ |
|
| 153 | - return $this->controllerPath; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Get the controller method |
|
| 158 | - * @return string |
|
| 159 | - */ |
|
| 160 | - public function getMethod(){ |
|
| 161 | - return $this->method; |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Get the request arguments |
|
| 166 | - * @return array |
|
| 167 | - */ |
|
| 168 | - public function getArgs(){ |
|
| 169 | - return $this->args; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Get the URL segments array |
|
| 174 | - * @return array |
|
| 175 | - */ |
|
| 176 | - public function getSegments(){ |
|
| 177 | - return $this->segments; |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Return the Log instance |
|
| 182 | - * @return Log |
|
| 183 | - */ |
|
| 184 | - public function getLogger(){ |
|
| 185 | - return $this->logger; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Set the log instance |
|
| 190 | - * @param Log $logger the log object |
|
| 191 | - * @return object |
|
| 192 | - */ |
|
| 193 | - public function setLogger($logger){ |
|
| 194 | - $this->logger = $logger; |
|
| 195 | - return $this; |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * Get the route URI |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function getRouteUri(){ |
|
| 203 | - return $this->uri; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Add the URI and callback to the list of URIs to validate |
|
| 208 | - * |
|
| 209 | - * @param string $uri the request URI |
|
| 210 | - * @param string $callback the callback function |
|
| 211 | - * |
|
| 212 | - * @return object the current instance |
|
| 213 | - */ |
|
| 214 | - public function add($uri, $callback) { |
|
| 215 | - $uri = trim($uri, $this->uriTrim); |
|
| 216 | - if(in_array($uri, $this->pattern)){ |
|
| 217 | - $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict'); |
|
| 218 | - } |
|
| 219 | - $this->pattern[] = $uri; |
|
| 220 | - $this->callback[] = $callback; |
|
| 221 | - return $this; |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - /** |
|
| 225 | - * Remove the route configuration |
|
| 226 | - * |
|
| 227 | - * @param string $uri the URI |
|
| 228 | - * |
|
| 229 | - * @return object the current instance |
|
| 230 | - */ |
|
| 231 | - public function removeRoute($uri) { |
|
| 232 | - $index = array_search($uri, $this->pattern, true); |
|
| 233 | - if($index !== false){ |
|
| 234 | - $this->logger->info('Remove route for uri [' . $uri . '] from the configuration'); |
|
| 235 | - unset($this->pattern[$index]); |
|
| 236 | - unset($this->callback[$index]); |
|
| 237 | - } |
|
| 238 | - return $this; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * Remove all the routes from the configuration |
|
| 244 | - * |
|
| 245 | - * @return object the current instance |
|
| 246 | - */ |
|
| 247 | - public function removeAllRoute() { |
|
| 248 | - $this->logger->info('Remove all routes from the configuration'); |
|
| 249 | - $this->pattern = array(); |
|
| 250 | - $this->callback = array(); |
|
| 251 | - $this->routes = array(); |
|
| 252 | - return $this; |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * Set the route URI to use later |
|
| 258 | - * @param string $uri the route URI, if is empty will determine automatically |
|
| 259 | - * @return object |
|
| 260 | - */ |
|
| 261 | - public function setRouteUri($uri = ''){ |
|
| 262 | - $routeUri = ''; |
|
| 263 | - if(! empty($uri)){ |
|
| 264 | - $routeUri = $uri; |
|
| 265 | - } |
|
| 266 | - //if the application is running in CLI mode use the first argument |
|
| 267 | - else if(IS_CLI && isset($_SERVER['argv'][1])){ |
|
| 268 | - $routeUri = $_SERVER['argv'][1]; |
|
| 269 | - } |
|
| 270 | - else if(isset($_SERVER['REQUEST_URI'])){ |
|
| 271 | - $routeUri = $_SERVER['REQUEST_URI']; |
|
| 272 | - } |
|
| 273 | - $this->logger->debug('Check if URL suffix is enabled in the configuration'); |
|
| 274 | - //remove url suffix from the request URI |
|
| 275 | - $suffix = get_config('url_suffix'); |
|
| 276 | - if ($suffix) { |
|
| 277 | - $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' ); |
|
| 278 | - $routeUri = str_ireplace($suffix, '', $routeUri); |
|
| 279 | - } |
|
| 280 | - if (strpos($routeUri, '?') !== false){ |
|
| 281 | - $routeUri = substr($routeUri, 0, strpos($routeUri, '?')); |
|
| 282 | - } |
|
| 283 | - $this->uri = trim($routeUri, $this->uriTrim); |
|
| 284 | - return $this; |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - /** |
|
| 288 | - * Set the route segments informations |
|
| 289 | - * @param array $segements the route segments information |
|
| 290 | - * |
|
| 291 | - * @return object |
|
| 292 | - */ |
|
| 293 | - public function setRouteSegments(array $segments = array()){ |
|
| 294 | - if(! empty($segments)){ |
|
| 295 | - $this->segments = $segments; |
|
| 296 | - } else if (!empty($this->uri)) { |
|
| 297 | - $this->segments = explode('/', $this->uri); |
|
| 298 | - } |
|
| 299 | - $segment = $this->segments; |
|
| 300 | - $baseUrl = get_config('base_url'); |
|
| 301 | - //check if the app is not in DOCUMENT_ROOT |
|
| 302 | - if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){ |
|
| 303 | - array_shift($segment); |
|
| 304 | - $this->segments = $segment; |
|
| 305 | - } |
|
| 306 | - $this->logger->debug('Check if the request URI contains the front controller'); |
|
| 307 | - if(isset($segment[0]) && $segment[0] == SELF){ |
|
| 308 | - $this->logger->info('The request URI contains the front controller'); |
|
| 309 | - array_shift($segment); |
|
| 310 | - $this->segments = $segment; |
|
| 311 | - } |
|
| 312 | - return $this; |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Setting the route parameters like module, controller, method, argument |
|
| 317 | - * @return object the current instance |
|
| 318 | - */ |
|
| 319 | - public function determineRouteParamsInformation() { |
|
| 320 | - $this->logger->debug('Routing process start ...'); |
|
| 140 | + /** |
|
| 141 | + * Get the controller name |
|
| 142 | + * @return string |
|
| 143 | + */ |
|
| 144 | + public function getController(){ |
|
| 145 | + return $this->controller; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * Get the controller file path |
|
| 150 | + * @return string |
|
| 151 | + */ |
|
| 152 | + public function getControllerPath(){ |
|
| 153 | + return $this->controllerPath; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Get the controller method |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 160 | + public function getMethod(){ |
|
| 161 | + return $this->method; |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Get the request arguments |
|
| 166 | + * @return array |
|
| 167 | + */ |
|
| 168 | + public function getArgs(){ |
|
| 169 | + return $this->args; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Get the URL segments array |
|
| 174 | + * @return array |
|
| 175 | + */ |
|
| 176 | + public function getSegments(){ |
|
| 177 | + return $this->segments; |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Return the Log instance |
|
| 182 | + * @return Log |
|
| 183 | + */ |
|
| 184 | + public function getLogger(){ |
|
| 185 | + return $this->logger; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Set the log instance |
|
| 190 | + * @param Log $logger the log object |
|
| 191 | + * @return object |
|
| 192 | + */ |
|
| 193 | + public function setLogger($logger){ |
|
| 194 | + $this->logger = $logger; |
|
| 195 | + return $this; |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * Get the route URI |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function getRouteUri(){ |
|
| 203 | + return $this->uri; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Add the URI and callback to the list of URIs to validate |
|
| 208 | + * |
|
| 209 | + * @param string $uri the request URI |
|
| 210 | + * @param string $callback the callback function |
|
| 211 | + * |
|
| 212 | + * @return object the current instance |
|
| 213 | + */ |
|
| 214 | + public function add($uri, $callback) { |
|
| 215 | + $uri = trim($uri, $this->uriTrim); |
|
| 216 | + if(in_array($uri, $this->pattern)){ |
|
| 217 | + $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict'); |
|
| 218 | + } |
|
| 219 | + $this->pattern[] = $uri; |
|
| 220 | + $this->callback[] = $callback; |
|
| 221 | + return $this; |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + /** |
|
| 225 | + * Remove the route configuration |
|
| 226 | + * |
|
| 227 | + * @param string $uri the URI |
|
| 228 | + * |
|
| 229 | + * @return object the current instance |
|
| 230 | + */ |
|
| 231 | + public function removeRoute($uri) { |
|
| 232 | + $index = array_search($uri, $this->pattern, true); |
|
| 233 | + if($index !== false){ |
|
| 234 | + $this->logger->info('Remove route for uri [' . $uri . '] from the configuration'); |
|
| 235 | + unset($this->pattern[$index]); |
|
| 236 | + unset($this->callback[$index]); |
|
| 237 | + } |
|
| 238 | + return $this; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * Remove all the routes from the configuration |
|
| 244 | + * |
|
| 245 | + * @return object the current instance |
|
| 246 | + */ |
|
| 247 | + public function removeAllRoute() { |
|
| 248 | + $this->logger->info('Remove all routes from the configuration'); |
|
| 249 | + $this->pattern = array(); |
|
| 250 | + $this->callback = array(); |
|
| 251 | + $this->routes = array(); |
|
| 252 | + return $this; |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * Set the route URI to use later |
|
| 258 | + * @param string $uri the route URI, if is empty will determine automatically |
|
| 259 | + * @return object |
|
| 260 | + */ |
|
| 261 | + public function setRouteUri($uri = ''){ |
|
| 262 | + $routeUri = ''; |
|
| 263 | + if(! empty($uri)){ |
|
| 264 | + $routeUri = $uri; |
|
| 265 | + } |
|
| 266 | + //if the application is running in CLI mode use the first argument |
|
| 267 | + else if(IS_CLI && isset($_SERVER['argv'][1])){ |
|
| 268 | + $routeUri = $_SERVER['argv'][1]; |
|
| 269 | + } |
|
| 270 | + else if(isset($_SERVER['REQUEST_URI'])){ |
|
| 271 | + $routeUri = $_SERVER['REQUEST_URI']; |
|
| 272 | + } |
|
| 273 | + $this->logger->debug('Check if URL suffix is enabled in the configuration'); |
|
| 274 | + //remove url suffix from the request URI |
|
| 275 | + $suffix = get_config('url_suffix'); |
|
| 276 | + if ($suffix) { |
|
| 277 | + $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' ); |
|
| 278 | + $routeUri = str_ireplace($suffix, '', $routeUri); |
|
| 279 | + } |
|
| 280 | + if (strpos($routeUri, '?') !== false){ |
|
| 281 | + $routeUri = substr($routeUri, 0, strpos($routeUri, '?')); |
|
| 282 | + } |
|
| 283 | + $this->uri = trim($routeUri, $this->uriTrim); |
|
| 284 | + return $this; |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + /** |
|
| 288 | + * Set the route segments informations |
|
| 289 | + * @param array $segements the route segments information |
|
| 290 | + * |
|
| 291 | + * @return object |
|
| 292 | + */ |
|
| 293 | + public function setRouteSegments(array $segments = array()){ |
|
| 294 | + if(! empty($segments)){ |
|
| 295 | + $this->segments = $segments; |
|
| 296 | + } else if (!empty($this->uri)) { |
|
| 297 | + $this->segments = explode('/', $this->uri); |
|
| 298 | + } |
|
| 299 | + $segment = $this->segments; |
|
| 300 | + $baseUrl = get_config('base_url'); |
|
| 301 | + //check if the app is not in DOCUMENT_ROOT |
|
| 302 | + if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){ |
|
| 303 | + array_shift($segment); |
|
| 304 | + $this->segments = $segment; |
|
| 305 | + } |
|
| 306 | + $this->logger->debug('Check if the request URI contains the front controller'); |
|
| 307 | + if(isset($segment[0]) && $segment[0] == SELF){ |
|
| 308 | + $this->logger->info('The request URI contains the front controller'); |
|
| 309 | + array_shift($segment); |
|
| 310 | + $this->segments = $segment; |
|
| 311 | + } |
|
| 312 | + return $this; |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Setting the route parameters like module, controller, method, argument |
|
| 317 | + * @return object the current instance |
|
| 318 | + */ |
|
| 319 | + public function determineRouteParamsInformation() { |
|
| 320 | + $this->logger->debug('Routing process start ...'); |
|
| 321 | 321 | |
| 322 | - //determine route parameters using the config |
|
| 323 | - $this->determineRouteParamsFromConfig(); |
|
| 322 | + //determine route parameters using the config |
|
| 323 | + $this->determineRouteParamsFromConfig(); |
|
| 324 | 324 | |
| 325 | - //if can not determine the module/controller/method via the defined routes configuration we will use |
|
| 326 | - //the URL like http://domain.com/module/controller/method/arg1/arg2 |
|
| 327 | - if(! $this->controller){ |
|
| 328 | - $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters'); |
|
| 329 | - //determine route parameters using the REQUEST_URI param |
|
| 330 | - $this->determineRouteParamsFromRequestUri(); |
|
| 331 | - } |
|
| 332 | - //Set the controller file path if not yet set |
|
| 333 | - $this->setControllerFilePath(); |
|
| 334 | - $this->logger->debug('Routing process end.'); |
|
| 335 | - |
|
| 336 | - return $this; |
|
| 337 | - } |
|
| 325 | + //if can not determine the module/controller/method via the defined routes configuration we will use |
|
| 326 | + //the URL like http://domain.com/module/controller/method/arg1/arg2 |
|
| 327 | + if(! $this->controller){ |
|
| 328 | + $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters'); |
|
| 329 | + //determine route parameters using the REQUEST_URI param |
|
| 330 | + $this->determineRouteParamsFromRequestUri(); |
|
| 331 | + } |
|
| 332 | + //Set the controller file path if not yet set |
|
| 333 | + $this->setControllerFilePath(); |
|
| 334 | + $this->logger->debug('Routing process end.'); |
|
| 335 | + |
|
| 336 | + return $this; |
|
| 337 | + } |
|
| 338 | 338 | |
| 339 | - /** |
|
| 340 | - * Routing the request to the correspondant module/controller/method if exists |
|
| 341 | - * otherwise send 404 error. |
|
| 342 | - */ |
|
| 343 | - public function processRequest(){ |
|
| 344 | - //Setting the route URI |
|
| 345 | - $this->setRouteUri(); |
|
| 346 | - |
|
| 347 | - //setting route segments |
|
| 348 | - $this->setRouteSegments(); |
|
| 349 | - |
|
| 350 | - $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' ); |
|
| 351 | - |
|
| 352 | - //determine the route parameters information |
|
| 353 | - $this->determineRouteParamsInformation(); |
|
| 354 | - |
|
| 355 | - $e404 = false; |
|
| 356 | - $classFilePath = $this->controllerPath; |
|
| 357 | - $controller = ucfirst($this->controller); |
|
| 358 | - $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']'); |
|
| 359 | - $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...'); |
|
| 339 | + /** |
|
| 340 | + * Routing the request to the correspondant module/controller/method if exists |
|
| 341 | + * otherwise send 404 error. |
|
| 342 | + */ |
|
| 343 | + public function processRequest(){ |
|
| 344 | + //Setting the route URI |
|
| 345 | + $this->setRouteUri(); |
|
| 346 | + |
|
| 347 | + //setting route segments |
|
| 348 | + $this->setRouteSegments(); |
|
| 349 | + |
|
| 350 | + $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' ); |
|
| 351 | + |
|
| 352 | + //determine the route parameters information |
|
| 353 | + $this->determineRouteParamsInformation(); |
|
| 354 | + |
|
| 355 | + $e404 = false; |
|
| 356 | + $classFilePath = $this->controllerPath; |
|
| 357 | + $controller = ucfirst($this->controller); |
|
| 358 | + $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']'); |
|
| 359 | + $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...'); |
|
| 360 | 360 | |
| 361 | - if(file_exists($classFilePath)){ |
|
| 362 | - require_once $classFilePath; |
|
| 363 | - if(! class_exists($controller, false)){ |
|
| 364 | - $e404 = true; |
|
| 365 | - $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']'); |
|
| 366 | - } |
|
| 367 | - else{ |
|
| 368 | - $controllerInstance = new $controller(); |
|
| 369 | - $controllerMethod = $this->getMethod(); |
|
| 370 | - if(! method_exists($controllerInstance, $controllerMethod)){ |
|
| 371 | - $e404 = true; |
|
| 372 | - $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']'); |
|
| 373 | - } |
|
| 374 | - else{ |
|
| 375 | - $this->logger->info('Routing data is set correctly now GO!'); |
|
| 376 | - call_user_func_array(array($controllerInstance, $controllerMethod), $this->args); |
|
| 377 | - //render the final page to user |
|
| 378 | - $this->logger->info('Render the final output to the browser'); |
|
| 379 | - get_instance()->response->renderFinalPage(); |
|
| 380 | - } |
|
| 381 | - } |
|
| 382 | - } |
|
| 383 | - else{ |
|
| 384 | - $this->logger->info('The controller file path [' . $classFilePath . '] does not exist'); |
|
| 385 | - $e404 = true; |
|
| 386 | - } |
|
| 387 | - if($e404){ |
|
| 388 | - if(IS_CLI){ |
|
| 389 | - set_http_status_header(404); |
|
| 390 | - echo 'Error 404: page not found.'; |
|
| 391 | - } else { |
|
| 392 | - $response =& class_loader('Response', 'classes'); |
|
| 393 | - $response->send404(); |
|
| 394 | - } |
|
| 395 | - } |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - |
|
| 399 | - /** |
|
| 400 | - * Setting the route configuration using the configuration file and additional configuration from param |
|
| 401 | - * @param array $overwriteConfig the additional configuration to overwrite with the existing one |
|
| 402 | - * @param boolean $useConfigFile whether to use route configuration file |
|
| 403 | - * @return object |
|
| 404 | - */ |
|
| 405 | - public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){ |
|
| 406 | - $route = array(); |
|
| 407 | - if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){ |
|
| 408 | - require_once CONFIG_PATH . 'routes.php'; |
|
| 409 | - } |
|
| 410 | - $route = array_merge($route, $overwriteConfig); |
|
| 411 | - $this->routes = $route; |
|
| 412 | - //if route is empty remove all configuration |
|
| 413 | - if(empty($route)){ |
|
| 414 | - $this->removeAllRoute(); |
|
| 415 | - } |
|
| 416 | - return $this; |
|
| 417 | - } |
|
| 418 | - |
|
| 419 | - /** |
|
| 420 | - * Get the route configuration |
|
| 421 | - * @return array |
|
| 422 | - */ |
|
| 423 | - public function getRouteConfiguration(){ |
|
| 424 | - return $this->routes; |
|
| 425 | - } |
|
| 361 | + if(file_exists($classFilePath)){ |
|
| 362 | + require_once $classFilePath; |
|
| 363 | + if(! class_exists($controller, false)){ |
|
| 364 | + $e404 = true; |
|
| 365 | + $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']'); |
|
| 366 | + } |
|
| 367 | + else{ |
|
| 368 | + $controllerInstance = new $controller(); |
|
| 369 | + $controllerMethod = $this->getMethod(); |
|
| 370 | + if(! method_exists($controllerInstance, $controllerMethod)){ |
|
| 371 | + $e404 = true; |
|
| 372 | + $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']'); |
|
| 373 | + } |
|
| 374 | + else{ |
|
| 375 | + $this->logger->info('Routing data is set correctly now GO!'); |
|
| 376 | + call_user_func_array(array($controllerInstance, $controllerMethod), $this->args); |
|
| 377 | + //render the final page to user |
|
| 378 | + $this->logger->info('Render the final output to the browser'); |
|
| 379 | + get_instance()->response->renderFinalPage(); |
|
| 380 | + } |
|
| 381 | + } |
|
| 382 | + } |
|
| 383 | + else{ |
|
| 384 | + $this->logger->info('The controller file path [' . $classFilePath . '] does not exist'); |
|
| 385 | + $e404 = true; |
|
| 386 | + } |
|
| 387 | + if($e404){ |
|
| 388 | + if(IS_CLI){ |
|
| 389 | + set_http_status_header(404); |
|
| 390 | + echo 'Error 404: page not found.'; |
|
| 391 | + } else { |
|
| 392 | + $response =& class_loader('Response', 'classes'); |
|
| 393 | + $response->send404(); |
|
| 394 | + } |
|
| 395 | + } |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + |
|
| 399 | + /** |
|
| 400 | + * Setting the route configuration using the configuration file and additional configuration from param |
|
| 401 | + * @param array $overwriteConfig the additional configuration to overwrite with the existing one |
|
| 402 | + * @param boolean $useConfigFile whether to use route configuration file |
|
| 403 | + * @return object |
|
| 404 | + */ |
|
| 405 | + public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){ |
|
| 406 | + $route = array(); |
|
| 407 | + if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){ |
|
| 408 | + require_once CONFIG_PATH . 'routes.php'; |
|
| 409 | + } |
|
| 410 | + $route = array_merge($route, $overwriteConfig); |
|
| 411 | + $this->routes = $route; |
|
| 412 | + //if route is empty remove all configuration |
|
| 413 | + if(empty($route)){ |
|
| 414 | + $this->removeAllRoute(); |
|
| 415 | + } |
|
| 416 | + return $this; |
|
| 417 | + } |
|
| 418 | + |
|
| 419 | + /** |
|
| 420 | + * Get the route configuration |
|
| 421 | + * @return array |
|
| 422 | + */ |
|
| 423 | + public function getRouteConfiguration(){ |
|
| 424 | + return $this->routes; |
|
| 425 | + } |
|
| 426 | 426 | |
| 427 | 427 | |
| 428 | - /** |
|
| 429 | - * Set the controller file path if is not set |
|
| 430 | - * @param string $path the file path if is null will using the route |
|
| 431 | - * information |
|
| 432 | - * |
|
| 433 | - * @return object the current instance |
|
| 434 | - */ |
|
| 435 | - public function setControllerFilePath($path = null){ |
|
| 436 | - if($path !== null){ |
|
| 437 | - $this->controllerPath = $path; |
|
| 438 | - return $this; |
|
| 439 | - } |
|
| 440 | - //did we set the controller, so set the controller path |
|
| 441 | - if($this->controller && ! $this->controllerPath){ |
|
| 442 | - $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']'); |
|
| 443 | - $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php'; |
|
| 444 | - //if the controller is in module |
|
| 445 | - if($this->module){ |
|
| 446 | - $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
|
| 447 | - if($path !== false){ |
|
| 448 | - $controllerPath = $path; |
|
| 449 | - } |
|
| 450 | - } |
|
| 451 | - $this->controllerPath = $controllerPath; |
|
| 452 | - } |
|
| 453 | - return $this; |
|
| 454 | - } |
|
| 455 | - |
|
| 456 | - /** |
|
| 457 | - * Determine the route parameters from route configuration |
|
| 458 | - * @return void |
|
| 459 | - */ |
|
| 460 | - protected function determineRouteParamsFromConfig(){ |
|
| 461 | - $uri = implode('/', $this->segments); |
|
| 462 | - /* |
|
| 428 | + /** |
|
| 429 | + * Set the controller file path if is not set |
|
| 430 | + * @param string $path the file path if is null will using the route |
|
| 431 | + * information |
|
| 432 | + * |
|
| 433 | + * @return object the current instance |
|
| 434 | + */ |
|
| 435 | + public function setControllerFilePath($path = null){ |
|
| 436 | + if($path !== null){ |
|
| 437 | + $this->controllerPath = $path; |
|
| 438 | + return $this; |
|
| 439 | + } |
|
| 440 | + //did we set the controller, so set the controller path |
|
| 441 | + if($this->controller && ! $this->controllerPath){ |
|
| 442 | + $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']'); |
|
| 443 | + $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php'; |
|
| 444 | + //if the controller is in module |
|
| 445 | + if($this->module){ |
|
| 446 | + $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
|
| 447 | + if($path !== false){ |
|
| 448 | + $controllerPath = $path; |
|
| 449 | + } |
|
| 450 | + } |
|
| 451 | + $this->controllerPath = $controllerPath; |
|
| 452 | + } |
|
| 453 | + return $this; |
|
| 454 | + } |
|
| 455 | + |
|
| 456 | + /** |
|
| 457 | + * Determine the route parameters from route configuration |
|
| 458 | + * @return void |
|
| 459 | + */ |
|
| 460 | + protected function determineRouteParamsFromConfig(){ |
|
| 461 | + $uri = implode('/', $this->segments); |
|
| 462 | + /* |
|
| 463 | 463 | * Generics routes patterns |
| 464 | 464 | */ |
| 465 | - $pattern = array(':num', ':alpha', ':alnum', ':any'); |
|
| 466 | - $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*'); |
|
| 467 | - |
|
| 468 | - $this->logger->debug( |
|
| 469 | - 'Begin to loop in the predefined routes configuration ' |
|
| 470 | - . 'to check if the current request match' |
|
| 471 | - ); |
|
| 472 | - |
|
| 473 | - // Cycle through the URIs stored in the array |
|
| 474 | - foreach ($this->pattern as $index => $uriList) { |
|
| 475 | - $uriList = str_ireplace($pattern, $replace, $uriList); |
|
| 476 | - // Check for an existant matching URI |
|
| 477 | - if (preg_match("#^$uriList$#", $uri, $args)) { |
|
| 478 | - $this->logger->info( |
|
| 479 | - 'Route found for request URI [' . $uri . '] using the predefined configuration ' |
|
| 480 | - . ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']' |
|
| 481 | - ); |
|
| 482 | - array_shift($args); |
|
| 483 | - //check if this contains an module |
|
| 484 | - $moduleControllerMethod = explode('#', $this->callback[$index]); |
|
| 485 | - if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){ |
|
| 486 | - $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']'); |
|
| 487 | - $this->module = $moduleControllerMethod[0]; |
|
| 488 | - $moduleControllerMethod = explode('@', $moduleControllerMethod[1]); |
|
| 489 | - } |
|
| 490 | - else{ |
|
| 491 | - $this->logger->info('The current request does not use the module'); |
|
| 492 | - $moduleControllerMethod = explode('@', $this->callback[$index]); |
|
| 493 | - } |
|
| 494 | - if(is_array($moduleControllerMethod)){ |
|
| 495 | - if(isset($moduleControllerMethod[0])){ |
|
| 496 | - $this->controller = $moduleControllerMethod[0]; |
|
| 497 | - } |
|
| 498 | - if(isset($moduleControllerMethod[1])){ |
|
| 499 | - $this->method = $moduleControllerMethod[1]; |
|
| 500 | - } |
|
| 501 | - $this->args = $args; |
|
| 502 | - } |
|
| 503 | - // stop here |
|
| 504 | - break; |
|
| 505 | - } |
|
| 506 | - } |
|
| 507 | - |
|
| 508 | - //first if the controller is not set and the module is set use the module name as the controller |
|
| 509 | - if(! $this->controller && $this->module){ |
|
| 510 | - $this->logger->info( |
|
| 511 | - 'After loop in predefined routes configuration, |
|
| 465 | + $pattern = array(':num', ':alpha', ':alnum', ':any'); |
|
| 466 | + $replace = array('[0-9]+', '[a-zA-Z]+', '[a-zA-Z0-9]+', '.*'); |
|
| 467 | + |
|
| 468 | + $this->logger->debug( |
|
| 469 | + 'Begin to loop in the predefined routes configuration ' |
|
| 470 | + . 'to check if the current request match' |
|
| 471 | + ); |
|
| 472 | + |
|
| 473 | + // Cycle through the URIs stored in the array |
|
| 474 | + foreach ($this->pattern as $index => $uriList) { |
|
| 475 | + $uriList = str_ireplace($pattern, $replace, $uriList); |
|
| 476 | + // Check for an existant matching URI |
|
| 477 | + if (preg_match("#^$uriList$#", $uri, $args)) { |
|
| 478 | + $this->logger->info( |
|
| 479 | + 'Route found for request URI [' . $uri . '] using the predefined configuration ' |
|
| 480 | + . ' [' . $this->pattern[$index] . '] --> [' . $this->callback[$index] . ']' |
|
| 481 | + ); |
|
| 482 | + array_shift($args); |
|
| 483 | + //check if this contains an module |
|
| 484 | + $moduleControllerMethod = explode('#', $this->callback[$index]); |
|
| 485 | + if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){ |
|
| 486 | + $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']'); |
|
| 487 | + $this->module = $moduleControllerMethod[0]; |
|
| 488 | + $moduleControllerMethod = explode('@', $moduleControllerMethod[1]); |
|
| 489 | + } |
|
| 490 | + else{ |
|
| 491 | + $this->logger->info('The current request does not use the module'); |
|
| 492 | + $moduleControllerMethod = explode('@', $this->callback[$index]); |
|
| 493 | + } |
|
| 494 | + if(is_array($moduleControllerMethod)){ |
|
| 495 | + if(isset($moduleControllerMethod[0])){ |
|
| 496 | + $this->controller = $moduleControllerMethod[0]; |
|
| 497 | + } |
|
| 498 | + if(isset($moduleControllerMethod[1])){ |
|
| 499 | + $this->method = $moduleControllerMethod[1]; |
|
| 500 | + } |
|
| 501 | + $this->args = $args; |
|
| 502 | + } |
|
| 503 | + // stop here |
|
| 504 | + break; |
|
| 505 | + } |
|
| 506 | + } |
|
| 507 | + |
|
| 508 | + //first if the controller is not set and the module is set use the module name as the controller |
|
| 509 | + if(! $this->controller && $this->module){ |
|
| 510 | + $this->logger->info( |
|
| 511 | + 'After loop in predefined routes configuration, |
|
| 512 | 512 | the module name is set but the controller is not set, |
| 513 | 513 | so we will use module as the controller' |
| 514 | - ); |
|
| 515 | - $this->controller = $this->module; |
|
| 516 | - } |
|
| 517 | - } |
|
| 518 | - |
|
| 519 | - /** |
|
| 520 | - * Determine the route parameters using the server variable "REQUEST_URI" |
|
| 521 | - * @return void |
|
| 522 | - */ |
|
| 523 | - protected function determineRouteParamsFromRequestUri(){ |
|
| 524 | - $segment = $this->segments; |
|
| 525 | - $nbSegment = count($segment); |
|
| 526 | - //if segment is null so means no need to perform |
|
| 527 | - if($nbSegment > 0){ |
|
| 528 | - //get the module list |
|
| 529 | - $modules = Module::getModuleList(); |
|
| 530 | - //first check if no module |
|
| 531 | - if(empty($modules)){ |
|
| 532 | - $this->logger->info('No module was loaded will skip the module checking'); |
|
| 533 | - //the application don't use module |
|
| 534 | - //controller |
|
| 535 | - if(isset($segment[0])){ |
|
| 536 | - $this->controller = $segment[0]; |
|
| 537 | - array_shift($segment); |
|
| 538 | - } |
|
| 539 | - //method |
|
| 540 | - if(isset($segment[0])){ |
|
| 541 | - $this->method = $segment[0]; |
|
| 542 | - array_shift($segment); |
|
| 543 | - } |
|
| 544 | - //args |
|
| 545 | - $this->args = $segment; |
|
| 546 | - } |
|
| 547 | - else{ |
|
| 548 | - $this->logger->info('The application contains a loaded module will check if the current request is found in the module list'); |
|
| 549 | - if(in_array($segment[0], $modules)){ |
|
| 550 | - $this->logger->info('Found, the current request use the module [' . $segment[0] . ']'); |
|
| 551 | - $this->module = $segment[0]; |
|
| 552 | - array_shift($segment); |
|
| 553 | - //check if the second arg is the controller from module |
|
| 554 | - if(isset($segment[0])){ |
|
| 555 | - $this->controller = $segment[0]; |
|
| 556 | - //check if the request use the same module name and controller |
|
| 557 | - $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
|
| 558 | - if(! $path){ |
|
| 559 | - $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller'); |
|
| 560 | - $this->controller = $this->module; |
|
| 561 | - } |
|
| 562 | - else{ |
|
| 563 | - $this->controllerPath = $path; |
|
| 564 | - array_shift($segment); |
|
| 565 | - } |
|
| 566 | - } |
|
| 567 | - //check for method |
|
| 568 | - if(isset($segment[0])){ |
|
| 569 | - $this->method = $segment[0]; |
|
| 570 | - array_shift($segment); |
|
| 571 | - } |
|
| 572 | - //the remaining is for args |
|
| 573 | - $this->args = $segment; |
|
| 574 | - } |
|
| 575 | - else{ |
|
| 576 | - $this->logger->info('The current request information is not found in the module list'); |
|
| 577 | - //controller |
|
| 578 | - if(isset($segment[0])){ |
|
| 579 | - $this->controller = $segment[0]; |
|
| 580 | - array_shift($segment); |
|
| 581 | - } |
|
| 582 | - //method |
|
| 583 | - if(isset($segment[0])){ |
|
| 584 | - $this->method = $segment[0]; |
|
| 585 | - array_shift($segment); |
|
| 586 | - } |
|
| 587 | - //args |
|
| 588 | - $this->args = $segment; |
|
| 589 | - } |
|
| 590 | - } |
|
| 591 | - if(! $this->controller && $this->module){ |
|
| 592 | - $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller'); |
|
| 593 | - $this->controller = $this->module; |
|
| 594 | - } |
|
| 595 | - } |
|
| 596 | - } |
|
| 597 | - |
|
| 598 | - /** |
|
| 599 | - * Set the route informations using the configuration |
|
| 600 | - * |
|
| 601 | - * @return object the current instance |
|
| 602 | - */ |
|
| 603 | - protected function setRouteConfigurationInfos(){ |
|
| 604 | - //adding route |
|
| 605 | - foreach($this->routes as $pattern => $callback){ |
|
| 606 | - $this->add($pattern, $callback); |
|
| 607 | - } |
|
| 608 | - return $this; |
|
| 609 | - } |
|
| 610 | - |
|
| 611 | - /** |
|
| 612 | - * Set the Log instance using argument or create new instance |
|
| 613 | - * @param object $logger the Log instance if not null |
|
| 614 | - */ |
|
| 615 | - protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
|
| 616 | - if ($logger !== null){ |
|
| 617 | - $this->logger = $logger; |
|
| 618 | - } |
|
| 619 | - else{ |
|
| 620 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 621 | - $this->logger->setLogger('Library::Router'); |
|
| 622 | - } |
|
| 623 | - } |
|
| 624 | - } |
|
| 514 | + ); |
|
| 515 | + $this->controller = $this->module; |
|
| 516 | + } |
|
| 517 | + } |
|
| 518 | + |
|
| 519 | + /** |
|
| 520 | + * Determine the route parameters using the server variable "REQUEST_URI" |
|
| 521 | + * @return void |
|
| 522 | + */ |
|
| 523 | + protected function determineRouteParamsFromRequestUri(){ |
|
| 524 | + $segment = $this->segments; |
|
| 525 | + $nbSegment = count($segment); |
|
| 526 | + //if segment is null so means no need to perform |
|
| 527 | + if($nbSegment > 0){ |
|
| 528 | + //get the module list |
|
| 529 | + $modules = Module::getModuleList(); |
|
| 530 | + //first check if no module |
|
| 531 | + if(empty($modules)){ |
|
| 532 | + $this->logger->info('No module was loaded will skip the module checking'); |
|
| 533 | + //the application don't use module |
|
| 534 | + //controller |
|
| 535 | + if(isset($segment[0])){ |
|
| 536 | + $this->controller = $segment[0]; |
|
| 537 | + array_shift($segment); |
|
| 538 | + } |
|
| 539 | + //method |
|
| 540 | + if(isset($segment[0])){ |
|
| 541 | + $this->method = $segment[0]; |
|
| 542 | + array_shift($segment); |
|
| 543 | + } |
|
| 544 | + //args |
|
| 545 | + $this->args = $segment; |
|
| 546 | + } |
|
| 547 | + else{ |
|
| 548 | + $this->logger->info('The application contains a loaded module will check if the current request is found in the module list'); |
|
| 549 | + if(in_array($segment[0], $modules)){ |
|
| 550 | + $this->logger->info('Found, the current request use the module [' . $segment[0] . ']'); |
|
| 551 | + $this->module = $segment[0]; |
|
| 552 | + array_shift($segment); |
|
| 553 | + //check if the second arg is the controller from module |
|
| 554 | + if(isset($segment[0])){ |
|
| 555 | + $this->controller = $segment[0]; |
|
| 556 | + //check if the request use the same module name and controller |
|
| 557 | + $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
|
| 558 | + if(! $path){ |
|
| 559 | + $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller'); |
|
| 560 | + $this->controller = $this->module; |
|
| 561 | + } |
|
| 562 | + else{ |
|
| 563 | + $this->controllerPath = $path; |
|
| 564 | + array_shift($segment); |
|
| 565 | + } |
|
| 566 | + } |
|
| 567 | + //check for method |
|
| 568 | + if(isset($segment[0])){ |
|
| 569 | + $this->method = $segment[0]; |
|
| 570 | + array_shift($segment); |
|
| 571 | + } |
|
| 572 | + //the remaining is for args |
|
| 573 | + $this->args = $segment; |
|
| 574 | + } |
|
| 575 | + else{ |
|
| 576 | + $this->logger->info('The current request information is not found in the module list'); |
|
| 577 | + //controller |
|
| 578 | + if(isset($segment[0])){ |
|
| 579 | + $this->controller = $segment[0]; |
|
| 580 | + array_shift($segment); |
|
| 581 | + } |
|
| 582 | + //method |
|
| 583 | + if(isset($segment[0])){ |
|
| 584 | + $this->method = $segment[0]; |
|
| 585 | + array_shift($segment); |
|
| 586 | + } |
|
| 587 | + //args |
|
| 588 | + $this->args = $segment; |
|
| 589 | + } |
|
| 590 | + } |
|
| 591 | + if(! $this->controller && $this->module){ |
|
| 592 | + $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller'); |
|
| 593 | + $this->controller = $this->module; |
|
| 594 | + } |
|
| 595 | + } |
|
| 596 | + } |
|
| 597 | + |
|
| 598 | + /** |
|
| 599 | + * Set the route informations using the configuration |
|
| 600 | + * |
|
| 601 | + * @return object the current instance |
|
| 602 | + */ |
|
| 603 | + protected function setRouteConfigurationInfos(){ |
|
| 604 | + //adding route |
|
| 605 | + foreach($this->routes as $pattern => $callback){ |
|
| 606 | + $this->add($pattern, $callback); |
|
| 607 | + } |
|
| 608 | + return $this; |
|
| 609 | + } |
|
| 610 | + |
|
| 611 | + /** |
|
| 612 | + * Set the Log instance using argument or create new instance |
|
| 613 | + * @param object $logger the Log instance if not null |
|
| 614 | + */ |
|
| 615 | + protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
|
| 616 | + if ($logger !== null){ |
|
| 617 | + $this->logger = $logger; |
|
| 618 | + } |
|
| 619 | + else{ |
|
| 620 | + $this->logger =& class_loader('Log', 'classes'); |
|
| 621 | + $this->logger->setLogger('Library::Router'); |
|
| 622 | + } |
|
| 623 | + } |
|
| 624 | + } |
|
@@ -96,13 +96,13 @@ discard block |
||
| 96 | 96 | /** |
| 97 | 97 | * Construct the new Router instance |
| 98 | 98 | */ |
| 99 | - public function __construct(){ |
|
| 99 | + public function __construct() { |
|
| 100 | 100 | $this->setLoggerFromParamOrCreateNewInstance(null); |
| 101 | 101 | |
| 102 | 102 | //loading routes for module |
| 103 | 103 | $moduleRouteList = array(); |
| 104 | 104 | $modulesRoutes = Module::getModulesRoutesConfig(); |
| 105 | - if($modulesRoutes && is_array($modulesRoutes)){ |
|
| 105 | + if ($modulesRoutes && is_array($modulesRoutes)) { |
|
| 106 | 106 | $moduleRouteList = $modulesRoutes; |
| 107 | 107 | unset($modulesRoutes); |
| 108 | 108 | } |
@@ -117,7 +117,7 @@ discard block |
||
| 117 | 117 | * Get the route patterns |
| 118 | 118 | * @return array |
| 119 | 119 | */ |
| 120 | - public function getPattern(){ |
|
| 120 | + public function getPattern() { |
|
| 121 | 121 | return $this->pattern; |
| 122 | 122 | } |
| 123 | 123 | |
@@ -125,7 +125,7 @@ discard block |
||
| 125 | 125 | * Get the route callbacks |
| 126 | 126 | * @return array |
| 127 | 127 | */ |
| 128 | - public function getCallback(){ |
|
| 128 | + public function getCallback() { |
|
| 129 | 129 | return $this->callback; |
| 130 | 130 | } |
| 131 | 131 | |
@@ -133,7 +133,7 @@ discard block |
||
| 133 | 133 | * Get the module name |
| 134 | 134 | * @return string |
| 135 | 135 | */ |
| 136 | - public function getModule(){ |
|
| 136 | + public function getModule() { |
|
| 137 | 137 | return $this->module; |
| 138 | 138 | } |
| 139 | 139 | |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | * Get the controller name |
| 142 | 142 | * @return string |
| 143 | 143 | */ |
| 144 | - public function getController(){ |
|
| 144 | + public function getController() { |
|
| 145 | 145 | return $this->controller; |
| 146 | 146 | } |
| 147 | 147 | |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | * Get the controller file path |
| 150 | 150 | * @return string |
| 151 | 151 | */ |
| 152 | - public function getControllerPath(){ |
|
| 152 | + public function getControllerPath() { |
|
| 153 | 153 | return $this->controllerPath; |
| 154 | 154 | } |
| 155 | 155 | |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | * Get the controller method |
| 158 | 158 | * @return string |
| 159 | 159 | */ |
| 160 | - public function getMethod(){ |
|
| 160 | + public function getMethod() { |
|
| 161 | 161 | return $this->method; |
| 162 | 162 | } |
| 163 | 163 | |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | * Get the request arguments |
| 166 | 166 | * @return array |
| 167 | 167 | */ |
| 168 | - public function getArgs(){ |
|
| 168 | + public function getArgs() { |
|
| 169 | 169 | return $this->args; |
| 170 | 170 | } |
| 171 | 171 | |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | * Get the URL segments array |
| 174 | 174 | * @return array |
| 175 | 175 | */ |
| 176 | - public function getSegments(){ |
|
| 176 | + public function getSegments() { |
|
| 177 | 177 | return $this->segments; |
| 178 | 178 | } |
| 179 | 179 | |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | * Return the Log instance |
| 182 | 182 | * @return Log |
| 183 | 183 | */ |
| 184 | - public function getLogger(){ |
|
| 184 | + public function getLogger() { |
|
| 185 | 185 | return $this->logger; |
| 186 | 186 | } |
| 187 | 187 | |
@@ -190,7 +190,7 @@ discard block |
||
| 190 | 190 | * @param Log $logger the log object |
| 191 | 191 | * @return object |
| 192 | 192 | */ |
| 193 | - public function setLogger($logger){ |
|
| 193 | + public function setLogger($logger) { |
|
| 194 | 194 | $this->logger = $logger; |
| 195 | 195 | return $this; |
| 196 | 196 | } |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | * Get the route URI |
| 200 | 200 | * @return string |
| 201 | 201 | */ |
| 202 | - public function getRouteUri(){ |
|
| 202 | + public function getRouteUri() { |
|
| 203 | 203 | return $this->uri; |
| 204 | 204 | } |
| 205 | 205 | |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | */ |
| 214 | 214 | public function add($uri, $callback) { |
| 215 | 215 | $uri = trim($uri, $this->uriTrim); |
| 216 | - if(in_array($uri, $this->pattern)){ |
|
| 216 | + if (in_array($uri, $this->pattern)) { |
|
| 217 | 217 | $this->logger->warning('The route [' . $uri . '] already added, may be adding again can have route conflict'); |
| 218 | 218 | } |
| 219 | 219 | $this->pattern[] = $uri; |
@@ -229,8 +229,8 @@ discard block |
||
| 229 | 229 | * @return object the current instance |
| 230 | 230 | */ |
| 231 | 231 | public function removeRoute($uri) { |
| 232 | - $index = array_search($uri, $this->pattern, true); |
|
| 233 | - if($index !== false){ |
|
| 232 | + $index = array_search($uri, $this->pattern, true); |
|
| 233 | + if ($index !== false) { |
|
| 234 | 234 | $this->logger->info('Remove route for uri [' . $uri . '] from the configuration'); |
| 235 | 235 | unset($this->pattern[$index]); |
| 236 | 236 | unset($this->callback[$index]); |
@@ -258,26 +258,26 @@ discard block |
||
| 258 | 258 | * @param string $uri the route URI, if is empty will determine automatically |
| 259 | 259 | * @return object |
| 260 | 260 | */ |
| 261 | - public function setRouteUri($uri = ''){ |
|
| 261 | + public function setRouteUri($uri = '') { |
|
| 262 | 262 | $routeUri = ''; |
| 263 | - if(! empty($uri)){ |
|
| 263 | + if (!empty($uri)) { |
|
| 264 | 264 | $routeUri = $uri; |
| 265 | 265 | } |
| 266 | 266 | //if the application is running in CLI mode use the first argument |
| 267 | - else if(IS_CLI && isset($_SERVER['argv'][1])){ |
|
| 267 | + else if (IS_CLI && isset($_SERVER['argv'][1])) { |
|
| 268 | 268 | $routeUri = $_SERVER['argv'][1]; |
| 269 | 269 | } |
| 270 | - else if(isset($_SERVER['REQUEST_URI'])){ |
|
| 270 | + else if (isset($_SERVER['REQUEST_URI'])) { |
|
| 271 | 271 | $routeUri = $_SERVER['REQUEST_URI']; |
| 272 | 272 | } |
| 273 | 273 | $this->logger->debug('Check if URL suffix is enabled in the configuration'); |
| 274 | 274 | //remove url suffix from the request URI |
| 275 | 275 | $suffix = get_config('url_suffix'); |
| 276 | 276 | if ($suffix) { |
| 277 | - $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']' ); |
|
| 277 | + $this->logger->info('URL suffix is enabled in the configuration, the value is [' . $suffix . ']'); |
|
| 278 | 278 | $routeUri = str_ireplace($suffix, '', $routeUri); |
| 279 | 279 | } |
| 280 | - if (strpos($routeUri, '?') !== false){ |
|
| 280 | + if (strpos($routeUri, '?') !== false) { |
|
| 281 | 281 | $routeUri = substr($routeUri, 0, strpos($routeUri, '?')); |
| 282 | 282 | } |
| 283 | 283 | $this->uri = trim($routeUri, $this->uriTrim); |
@@ -290,8 +290,8 @@ discard block |
||
| 290 | 290 | * |
| 291 | 291 | * @return object |
| 292 | 292 | */ |
| 293 | - public function setRouteSegments(array $segments = array()){ |
|
| 294 | - if(! empty($segments)){ |
|
| 293 | + public function setRouteSegments(array $segments = array()) { |
|
| 294 | + if (!empty($segments)) { |
|
| 295 | 295 | $this->segments = $segments; |
| 296 | 296 | } else if (!empty($this->uri)) { |
| 297 | 297 | $this->segments = explode('/', $this->uri); |
@@ -299,12 +299,12 @@ discard block |
||
| 299 | 299 | $segment = $this->segments; |
| 300 | 300 | $baseUrl = get_config('base_url'); |
| 301 | 301 | //check if the app is not in DOCUMENT_ROOT |
| 302 | - if(isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false){ |
|
| 302 | + if (isset($segment[0]) && stripos($baseUrl, $segment[0]) !== false) { |
|
| 303 | 303 | array_shift($segment); |
| 304 | 304 | $this->segments = $segment; |
| 305 | 305 | } |
| 306 | 306 | $this->logger->debug('Check if the request URI contains the front controller'); |
| 307 | - if(isset($segment[0]) && $segment[0] == SELF){ |
|
| 307 | + if (isset($segment[0]) && $segment[0] == SELF) { |
|
| 308 | 308 | $this->logger->info('The request URI contains the front controller'); |
| 309 | 309 | array_shift($segment); |
| 310 | 310 | $this->segments = $segment; |
@@ -324,7 +324,7 @@ discard block |
||
| 324 | 324 | |
| 325 | 325 | //if can not determine the module/controller/method via the defined routes configuration we will use |
| 326 | 326 | //the URL like http://domain.com/module/controller/method/arg1/arg2 |
| 327 | - if(! $this->controller){ |
|
| 327 | + if (!$this->controller) { |
|
| 328 | 328 | $this->logger->info('Cannot determine the routing information using the predefined routes configuration, will use the request URI parameters'); |
| 329 | 329 | //determine route parameters using the REQUEST_URI param |
| 330 | 330 | $this->determineRouteParamsFromRequestUri(); |
@@ -340,14 +340,14 @@ discard block |
||
| 340 | 340 | * Routing the request to the correspondant module/controller/method if exists |
| 341 | 341 | * otherwise send 404 error. |
| 342 | 342 | */ |
| 343 | - public function processRequest(){ |
|
| 343 | + public function processRequest() { |
|
| 344 | 344 | //Setting the route URI |
| 345 | 345 | $this->setRouteUri(); |
| 346 | 346 | |
| 347 | 347 | //setting route segments |
| 348 | 348 | $this->setRouteSegments(); |
| 349 | 349 | |
| 350 | - $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']' ); |
|
| 350 | + $this->logger->info('The final Request URI is [' . implode('/', $this->segments) . ']'); |
|
| 351 | 351 | |
| 352 | 352 | //determine the route parameters information |
| 353 | 353 | $this->determineRouteParamsInformation(); |
@@ -358,20 +358,20 @@ discard block |
||
| 358 | 358 | $this->logger->info('The routing information are: module [' . $this->module . '], controller [' . $controller . '], method [' . $this->method . '], args [' . stringfy_vars($this->args) . ']'); |
| 359 | 359 | $this->logger->debug('Loading controller [' . $controller . '], the file path is [' . $classFilePath . ']...'); |
| 360 | 360 | |
| 361 | - if(file_exists($classFilePath)){ |
|
| 361 | + if (file_exists($classFilePath)) { |
|
| 362 | 362 | require_once $classFilePath; |
| 363 | - if(! class_exists($controller, false)){ |
|
| 363 | + if (!class_exists($controller, false)) { |
|
| 364 | 364 | $e404 = true; |
| 365 | - $this->logger->warning('The controller file [' .$classFilePath. '] exists but does not contain the class [' . $controller . ']'); |
|
| 365 | + $this->logger->warning('The controller file [' . $classFilePath . '] exists but does not contain the class [' . $controller . ']'); |
|
| 366 | 366 | } |
| 367 | - else{ |
|
| 367 | + else { |
|
| 368 | 368 | $controllerInstance = new $controller(); |
| 369 | 369 | $controllerMethod = $this->getMethod(); |
| 370 | - if(! method_exists($controllerInstance, $controllerMethod)){ |
|
| 370 | + if (!method_exists($controllerInstance, $controllerMethod)) { |
|
| 371 | 371 | $e404 = true; |
| 372 | 372 | $this->logger->warning('The controller [' . $controller . '] exist but does not contain the method [' . $controllerMethod . ']'); |
| 373 | 373 | } |
| 374 | - else{ |
|
| 374 | + else { |
|
| 375 | 375 | $this->logger->info('Routing data is set correctly now GO!'); |
| 376 | 376 | call_user_func_array(array($controllerInstance, $controllerMethod), $this->args); |
| 377 | 377 | //render the final page to user |
@@ -380,16 +380,16 @@ discard block |
||
| 380 | 380 | } |
| 381 | 381 | } |
| 382 | 382 | } |
| 383 | - else{ |
|
| 383 | + else { |
|
| 384 | 384 | $this->logger->info('The controller file path [' . $classFilePath . '] does not exist'); |
| 385 | 385 | $e404 = true; |
| 386 | 386 | } |
| 387 | - if($e404){ |
|
| 388 | - if(IS_CLI){ |
|
| 387 | + if ($e404) { |
|
| 388 | + if (IS_CLI) { |
|
| 389 | 389 | set_http_status_header(404); |
| 390 | 390 | echo 'Error 404: page not found.'; |
| 391 | 391 | } else { |
| 392 | - $response =& class_loader('Response', 'classes'); |
|
| 392 | + $response = & class_loader('Response', 'classes'); |
|
| 393 | 393 | $response->send404(); |
| 394 | 394 | } |
| 395 | 395 | } |
@@ -402,15 +402,15 @@ discard block |
||
| 402 | 402 | * @param boolean $useConfigFile whether to use route configuration file |
| 403 | 403 | * @return object |
| 404 | 404 | */ |
| 405 | - public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true){ |
|
| 405 | + public function setRouteConfiguration(array $overwriteConfig = array(), $useConfigFile = true) { |
|
| 406 | 406 | $route = array(); |
| 407 | - if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')){ |
|
| 407 | + if ($useConfigFile && file_exists(CONFIG_PATH . 'routes.php')) { |
|
| 408 | 408 | require_once CONFIG_PATH . 'routes.php'; |
| 409 | 409 | } |
| 410 | 410 | $route = array_merge($route, $overwriteConfig); |
| 411 | 411 | $this->routes = $route; |
| 412 | 412 | //if route is empty remove all configuration |
| 413 | - if(empty($route)){ |
|
| 413 | + if (empty($route)) { |
|
| 414 | 414 | $this->removeAllRoute(); |
| 415 | 415 | } |
| 416 | 416 | return $this; |
@@ -420,7 +420,7 @@ discard block |
||
| 420 | 420 | * Get the route configuration |
| 421 | 421 | * @return array |
| 422 | 422 | */ |
| 423 | - public function getRouteConfiguration(){ |
|
| 423 | + public function getRouteConfiguration() { |
|
| 424 | 424 | return $this->routes; |
| 425 | 425 | } |
| 426 | 426 | |
@@ -432,19 +432,19 @@ discard block |
||
| 432 | 432 | * |
| 433 | 433 | * @return object the current instance |
| 434 | 434 | */ |
| 435 | - public function setControllerFilePath($path = null){ |
|
| 436 | - if($path !== null){ |
|
| 435 | + public function setControllerFilePath($path = null) { |
|
| 436 | + if ($path !== null) { |
|
| 437 | 437 | $this->controllerPath = $path; |
| 438 | 438 | return $this; |
| 439 | 439 | } |
| 440 | 440 | //did we set the controller, so set the controller path |
| 441 | - if($this->controller && ! $this->controllerPath){ |
|
| 441 | + if ($this->controller && !$this->controllerPath) { |
|
| 442 | 442 | $this->logger->debug('Setting the file path for the controller [' . $this->controller . ']'); |
| 443 | 443 | $controllerPath = APPS_CONTROLLER_PATH . ucfirst($this->controller) . '.php'; |
| 444 | 444 | //if the controller is in module |
| 445 | - if($this->module){ |
|
| 445 | + if ($this->module) { |
|
| 446 | 446 | $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
| 447 | - if($path !== false){ |
|
| 447 | + if ($path !== false) { |
|
| 448 | 448 | $controllerPath = $path; |
| 449 | 449 | } |
| 450 | 450 | } |
@@ -457,7 +457,7 @@ discard block |
||
| 457 | 457 | * Determine the route parameters from route configuration |
| 458 | 458 | * @return void |
| 459 | 459 | */ |
| 460 | - protected function determineRouteParamsFromConfig(){ |
|
| 460 | + protected function determineRouteParamsFromConfig() { |
|
| 461 | 461 | $uri = implode('/', $this->segments); |
| 462 | 462 | /* |
| 463 | 463 | * Generics routes patterns |
@@ -482,20 +482,20 @@ discard block |
||
| 482 | 482 | array_shift($args); |
| 483 | 483 | //check if this contains an module |
| 484 | 484 | $moduleControllerMethod = explode('#', $this->callback[$index]); |
| 485 | - if(is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2){ |
|
| 485 | + if (is_array($moduleControllerMethod) && count($moduleControllerMethod) >= 2) { |
|
| 486 | 486 | $this->logger->info('The current request use the module [' . $moduleControllerMethod[0] . ']'); |
| 487 | 487 | $this->module = $moduleControllerMethod[0]; |
| 488 | 488 | $moduleControllerMethod = explode('@', $moduleControllerMethod[1]); |
| 489 | 489 | } |
| 490 | - else{ |
|
| 490 | + else { |
|
| 491 | 491 | $this->logger->info('The current request does not use the module'); |
| 492 | 492 | $moduleControllerMethod = explode('@', $this->callback[$index]); |
| 493 | 493 | } |
| 494 | - if(is_array($moduleControllerMethod)){ |
|
| 495 | - if(isset($moduleControllerMethod[0])){ |
|
| 494 | + if (is_array($moduleControllerMethod)) { |
|
| 495 | + if (isset($moduleControllerMethod[0])) { |
|
| 496 | 496 | $this->controller = $moduleControllerMethod[0]; |
| 497 | 497 | } |
| 498 | - if(isset($moduleControllerMethod[1])){ |
|
| 498 | + if (isset($moduleControllerMethod[1])) { |
|
| 499 | 499 | $this->method = $moduleControllerMethod[1]; |
| 500 | 500 | } |
| 501 | 501 | $this->args = $args; |
@@ -506,7 +506,7 @@ discard block |
||
| 506 | 506 | } |
| 507 | 507 | |
| 508 | 508 | //first if the controller is not set and the module is set use the module name as the controller |
| 509 | - if(! $this->controller && $this->module){ |
|
| 509 | + if (!$this->controller && $this->module) { |
|
| 510 | 510 | $this->logger->info( |
| 511 | 511 | 'After loop in predefined routes configuration, |
| 512 | 512 | the module name is set but the controller is not set, |
@@ -520,67 +520,67 @@ discard block |
||
| 520 | 520 | * Determine the route parameters using the server variable "REQUEST_URI" |
| 521 | 521 | * @return void |
| 522 | 522 | */ |
| 523 | - protected function determineRouteParamsFromRequestUri(){ |
|
| 523 | + protected function determineRouteParamsFromRequestUri() { |
|
| 524 | 524 | $segment = $this->segments; |
| 525 | 525 | $nbSegment = count($segment); |
| 526 | 526 | //if segment is null so means no need to perform |
| 527 | - if($nbSegment > 0){ |
|
| 527 | + if ($nbSegment > 0) { |
|
| 528 | 528 | //get the module list |
| 529 | 529 | $modules = Module::getModuleList(); |
| 530 | 530 | //first check if no module |
| 531 | - if(empty($modules)){ |
|
| 531 | + if (empty($modules)) { |
|
| 532 | 532 | $this->logger->info('No module was loaded will skip the module checking'); |
| 533 | 533 | //the application don't use module |
| 534 | 534 | //controller |
| 535 | - if(isset($segment[0])){ |
|
| 535 | + if (isset($segment[0])) { |
|
| 536 | 536 | $this->controller = $segment[0]; |
| 537 | 537 | array_shift($segment); |
| 538 | 538 | } |
| 539 | 539 | //method |
| 540 | - if(isset($segment[0])){ |
|
| 540 | + if (isset($segment[0])) { |
|
| 541 | 541 | $this->method = $segment[0]; |
| 542 | 542 | array_shift($segment); |
| 543 | 543 | } |
| 544 | 544 | //args |
| 545 | 545 | $this->args = $segment; |
| 546 | 546 | } |
| 547 | - else{ |
|
| 547 | + else { |
|
| 548 | 548 | $this->logger->info('The application contains a loaded module will check if the current request is found in the module list'); |
| 549 | - if(in_array($segment[0], $modules)){ |
|
| 549 | + if (in_array($segment[0], $modules)) { |
|
| 550 | 550 | $this->logger->info('Found, the current request use the module [' . $segment[0] . ']'); |
| 551 | 551 | $this->module = $segment[0]; |
| 552 | 552 | array_shift($segment); |
| 553 | 553 | //check if the second arg is the controller from module |
| 554 | - if(isset($segment[0])){ |
|
| 554 | + if (isset($segment[0])) { |
|
| 555 | 555 | $this->controller = $segment[0]; |
| 556 | 556 | //check if the request use the same module name and controller |
| 557 | 557 | $path = Module::findControllerFullPath(ucfirst($this->controller), $this->module); |
| 558 | - if(! $path){ |
|
| 558 | + if (!$path) { |
|
| 559 | 559 | $this->logger->info('The controller [' . $this->controller . '] not found in the module, may be will use the module [' . $this->module . '] as controller'); |
| 560 | 560 | $this->controller = $this->module; |
| 561 | 561 | } |
| 562 | - else{ |
|
| 562 | + else { |
|
| 563 | 563 | $this->controllerPath = $path; |
| 564 | 564 | array_shift($segment); |
| 565 | 565 | } |
| 566 | 566 | } |
| 567 | 567 | //check for method |
| 568 | - if(isset($segment[0])){ |
|
| 568 | + if (isset($segment[0])) { |
|
| 569 | 569 | $this->method = $segment[0]; |
| 570 | 570 | array_shift($segment); |
| 571 | 571 | } |
| 572 | 572 | //the remaining is for args |
| 573 | 573 | $this->args = $segment; |
| 574 | 574 | } |
| 575 | - else{ |
|
| 575 | + else { |
|
| 576 | 576 | $this->logger->info('The current request information is not found in the module list'); |
| 577 | 577 | //controller |
| 578 | - if(isset($segment[0])){ |
|
| 578 | + if (isset($segment[0])) { |
|
| 579 | 579 | $this->controller = $segment[0]; |
| 580 | 580 | array_shift($segment); |
| 581 | 581 | } |
| 582 | 582 | //method |
| 583 | - if(isset($segment[0])){ |
|
| 583 | + if (isset($segment[0])) { |
|
| 584 | 584 | $this->method = $segment[0]; |
| 585 | 585 | array_shift($segment); |
| 586 | 586 | } |
@@ -588,7 +588,7 @@ discard block |
||
| 588 | 588 | $this->args = $segment; |
| 589 | 589 | } |
| 590 | 590 | } |
| 591 | - if(! $this->controller && $this->module){ |
|
| 591 | + if (!$this->controller && $this->module) { |
|
| 592 | 592 | $this->logger->info('After using the request URI the module name is set but the controller is not set so we will use module as the controller'); |
| 593 | 593 | $this->controller = $this->module; |
| 594 | 594 | } |
@@ -600,9 +600,9 @@ discard block |
||
| 600 | 600 | * |
| 601 | 601 | * @return object the current instance |
| 602 | 602 | */ |
| 603 | - protected function setRouteConfigurationInfos(){ |
|
| 603 | + protected function setRouteConfigurationInfos() { |
|
| 604 | 604 | //adding route |
| 605 | - foreach($this->routes as $pattern => $callback){ |
|
| 605 | + foreach ($this->routes as $pattern => $callback) { |
|
| 606 | 606 | $this->add($pattern, $callback); |
| 607 | 607 | } |
| 608 | 608 | return $this; |
@@ -612,12 +612,12 @@ discard block |
||
| 612 | 612 | * Set the Log instance using argument or create new instance |
| 613 | 613 | * @param object $logger the Log instance if not null |
| 614 | 614 | */ |
| 615 | - protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null){ |
|
| 616 | - if ($logger !== null){ |
|
| 615 | + protected function setLoggerFromParamOrCreateNewInstance(Log $logger = null) { |
|
| 616 | + if ($logger !== null) { |
|
| 617 | 617 | $this->logger = $logger; |
| 618 | 618 | } |
| 619 | - else{ |
|
| 620 | - $this->logger =& class_loader('Log', 'classes'); |
|
| 619 | + else { |
|
| 620 | + $this->logger = & class_loader('Log', 'classes'); |
|
| 621 | 621 | $this->logger->setLogger('Library::Router'); |
| 622 | 622 | } |
| 623 | 623 | } |