Ariadne-CMS /
ariadne
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like sql_compiler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use sql_compiler, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 3 | abstract class sql_compiler { |
||
| 4 | protected $skipDefaultOrderBy; |
||
| 5 | protected $store; |
||
| 6 | public $error; |
||
| 7 | protected $join_target_properties; |
||
| 8 | protected $offset; |
||
| 9 | protected $limit; |
||
| 10 | protected $cache; |
||
| 11 | protected $path; |
||
| 12 | protected $_SCAN_WS = array(" " => true, "\t" => true, "\n" => true ,"\r" => true); |
||
| 13 | protected $_SCAN_AZ = array("a" => true, "A" => true, "b" => true, "B" => true, "c" => true, "C" => true, "d" => true, "D" => true, "e" => true, "E" => true, "f" => true, "F" => true, "g" => true, "G" => true, "h" => true, "H" => true, "i" => true, "I" => true, "j" => true, "J" => true, "k" => true, "K" => true, "l" => true, "L" => true, "m" => true, "M" => true, "n" => true, "N" => true, "o" => true, "O" => true, "p" => true, "P" => true, "q" => true, "Q" => true, "r" => true, "R" => true, "s" => true, "S" => true, "t" => true, "T" => true, "u" => true, "U" => true, "v" => true, "V" => true, "w" => true, "W" => true, "x" => true, "X" => true, "y" => true, "Y" => true, "z" => true, "Z" => true); |
||
| 14 | protected $_SCAN_AZ_09 = array("a" => true, "A" => true, "b" => true, "B" => true, "c" => true, "C" => true, "d" => true, "D" => true, "e" => true, "E" => true, "f" => true, "F" => true, "g" => true, "G" => true, "h" => true, "H" => true, "i" => true, "I" => true, "j" => true, "J" => true, "k" => true, "K" => true, "l" => true, "L" => true, "m" => true, "M" => true, "n" => true, "N" => true, "o" => true, "O" => true, "p" => true, "P" => true, "q" => true, "Q" => true, "r" => true, "R" => true, "s" => true, "S" => true, "t" => true, "T" => true, "u" => true, "U" => true, "v" => true, "V" => true, "w" => true, "W" => true, "x" => true, "X" => true, "y" => true, "Y" => true, "z" => true, "Z" => true, "_" => true, "0" => true, "1" => true, "2" => true, "3" => true, "4" => true, "5" => true, "6" => true, "7" => true, "8" => true, "9" => true); |
||
| 15 | protected $_SCAN_NUM = array("0" => true, "1" => true, "2" => true, "3" => true, "4" => true, "5" => true, "6" => true, "7" => true, "8" => true, "9" => true); |
||
| 16 | protected $_SCAN_NUM_START = array("0" => true, "1" => true, "2" => true, "3" => true, "4" => true, "5" => true, "6" => true, "7" => true, "8" => true, "9" => true, "-" => true); |
||
| 17 | protected $_SCAN_CMP = array("~" => array("=" => array("FIN" => true)), "=" => array("=" => array("FIN" => true), "FIN" => true, "~" => array("FIN" => true, "~" => array("FIN" => true)), "*" => array("FIN" => true, "*" => array("FIN" => true)), "/" => array("FIN" => true)), "!" => array("=" => array("FIN" => true), "~" => array("FIN" => true, "~" => array("FIN" => true)), "*" => array("FIN" => true, "*" => array("FIN" => true)), "/" => array("FIN" => true, "/" => array("FIN" => true))), "<" => array("=" => array("FIN" => true), "FIN" => true), ">" => array("=" => array("FIN" => true), "FIN" => true), "/" => array("=" => array("=" => array("FIN" => true)))); |
||
| 18 | |||
| 19 | |||
| 20 | 192 | protected function parse_const(&$YYBUFFER) { |
|
| 73 | |||
| 74 | 202 | protected function parse_ident(&$YYBUFFER) { |
|
| 183 | |||
| 184 | 198 | protected function parse_cmp_expr(&$YYBUFFER) { |
|
| 217 | |||
| 218 | 198 | protected function parse_group_expr(&$YYBUFFER) { |
|
| 246 | |||
| 247 | 198 | View Code Duplication | protected function parse_and_expr(&$YYBUFFER) { |
| 248 | 198 | $result=$this->parse_group_expr($YYBUFFER); |
|
| 249 | 198 | while (is_array($result)) { |
|
| 250 | 196 | $YYCURSOR = 0; |
|
| 251 | 196 | while (isset($this->_SCAN_WS[$YYBUFFER[$YYCURSOR]])) { |
|
| 252 | 186 | $YYCURSOR++; |
|
| 253 | 140 | } |
|
| 254 | 196 | $ident = strtolower(substr($YYBUFFER, $YYCURSOR, 3)); |
|
| 255 | 196 | if ($ident === 'and' && !isset($this->_SCAN_AZ_09[$YYBUFFER[$YYCURSOR + 3]]) ) { |
|
| 256 | 184 | $YYBUFFER = substr($YYBUFFER, $YYCURSOR + 3); |
|
| 257 | 184 | $right = $this->parse_group_expr($YYBUFFER); |
|
| 258 | 184 | if (is_array($right)) { |
|
| 259 | $result = array( |
||
| 260 | 184 | 'id' => $ident, |
|
| 261 | 184 | 'left' => $result, |
|
| 262 | 46 | 'right' => $right |
|
| 263 | 138 | ); |
|
| 264 | 138 | } else { |
|
| 265 | 46 | unset($result); |
|
| 266 | } |
||
| 267 | 138 | } else { |
|
| 268 | 196 | break; |
|
| 269 | } |
||
| 270 | 138 | } |
|
| 271 | 198 | return $result; |
|
| 272 | } |
||
| 273 | |||
| 274 | 198 | View Code Duplication | protected function parse_or_expr(&$YYBUFFER) { |
| 275 | 198 | $result=$this->parse_and_expr($YYBUFFER); |
|
| 276 | 198 | while (is_array($result)) { |
|
| 277 | 196 | $YYCURSOR = 0; |
|
| 278 | 196 | while (isset($this->_SCAN_WS[$YYBUFFER[$YYCURSOR]])) { |
|
| 279 | 50 | $YYCURSOR++; |
|
| 280 | 38 | } |
|
| 281 | 196 | $ident = strtolower(substr($YYBUFFER, $YYCURSOR, 2)); |
|
| 282 | 196 | if ($ident === 'or' && !isset($this->_SCAN_AZ_09[$YYBUFFER[$YYCURSOR + 2]]) ) { |
|
| 283 | $YYBUFFER = substr($YYBUFFER, $YYCURSOR + 2); |
||
| 284 | $right = $this->parse_and_expr($YYBUFFER); |
||
| 285 | if (is_array($right)) { |
||
| 286 | $result = array( |
||
| 287 | 'id' => $ident, |
||
| 288 | 'left' => $result, |
||
| 289 | 'right' => $right |
||
| 290 | ); |
||
| 291 | } else { |
||
| 292 | unset($result); |
||
| 293 | } |
||
| 294 | } else { |
||
| 295 | 196 | break; |
|
| 296 | } |
||
| 297 | } |
||
| 298 | 198 | return $result; |
|
| 299 | } |
||
| 300 | |||
| 301 | 124 | protected function parse_orderby(&$YYBUFFER) { |
|
| 302 | 52 | $field = $this->parse_ident($YYBUFFER); |
|
| 303 | |||
| 304 | 52 | $YYCURSOR = 0; |
|
| 305 | 52 | while (isset($this->_SCAN_WS[$YYBUFFER[$YYCURSOR]])) { |
|
| 306 | 2 | $YYCURSOR++; |
|
| 307 | 2 | } |
|
| 308 | 52 | $value = ''; |
|
| 309 | 52 | $yych = $YYBUFFER[$YYCURSOR]; |
|
| 310 | 52 | View Code Duplication | if ($this->_SCAN_AZ[$yych]) { |
| 311 | 2 | $value .= $yych; |
|
| 312 | 2 | $yych = $YYBUFFER[++$YYCURSOR]; |
|
| 313 | 2 | while (isset($this->_SCAN_AZ[$yych])) { |
|
| 314 | 2 | $value .= $yych; |
|
| 315 | 2 | $yych = $YYBUFFER[++$YYCURSOR]; |
|
| 316 | 2 | } |
|
| 317 | 2 | $sort_type = strtoupper($value); |
|
| 318 | 2 | if (!($sort_type == 'ASC' || $sort_type == 'DESC')) { // If sort type is anything else than ASC or DESC, it is not part of the order by. |
|
| 319 | 2 | $sort_type = 'ASC'; |
|
| 320 | 2 | $YYCURSOR = $YYCURSOR - strlen($value); |
|
| 321 | 2 | $value = ''; |
|
| 322 | 2 | } |
|
| 323 | 2 | } else { |
|
| 324 | 50 | $sort_type = 'ASC'; |
|
| 325 | } |
||
| 326 | 52 | while (is_array($field)) { |
|
| 327 | $result = array( |
||
| 328 | 124 | 'id' => 'orderbyfield', |
|
| 329 | 52 | 'type' => $sort_type, |
|
| 330 | 52 | 'right' => $field, |
|
| 331 | 12 | 'left' => $result |
|
| 332 | 40 | ); |
|
| 333 | 52 | while (isset($this->_SCAN_WS[$YYBUFFER[$YYCURSOR]])) { |
|
| 334 | $YYCURSOR++; |
||
| 335 | } |
||
| 336 | 52 | $yych = $YYBUFFER[$YYCURSOR]; |
|
| 337 | 52 | if ($yych !== ',') { |
|
| 338 | 52 | $YYBUFFER = substr($YYBUFFER, $YYCURSOR); |
|
| 339 | 52 | unset($field); |
|
| 340 | 40 | } else { |
|
| 341 | 2 | $YYBUFFER = substr($YYBUFFER, $YYCURSOR + 1); |
|
| 342 | 2 | $field = $this->parse_ident($YYBUFFER); |
|
| 343 | 2 | $YYCURSOR = 0; |
|
| 344 | 2 | while (isset($this->_SCAN_WS[$YYBUFFER[$YYCURSOR]])) { |
|
| 345 | $YYCURSOR++; |
||
| 346 | } |
||
| 347 | 2 | $value = ''; |
|
| 348 | 2 | $yych = $YYBUFFER[$YYCURSOR]; |
|
| 349 | 2 | View Code Duplication | if ($this->_SCAN_AZ[$yych]) { |
| 350 | $value .= $yych; |
||
| 351 | $yych = $YYBUFFER[++$YYCURSOR]; |
||
| 352 | while (isset($this->_SCAN_AZ[$yych])) { |
||
| 353 | $value .= $yych; |
||
| 354 | $yych = $YYBUFFER[++$YYCURSOR]; |
||
| 355 | } |
||
| 356 | $sort_type = strtoupper($value); |
||
| 357 | if (!($sort_type == 'ASC' || $sort_type == 'DESC')) { // If sort type is anything else than ASC or DESC, it is not part of the order by. |
||
| 358 | $sort_type = 'ASC'; |
||
| 359 | $YYCURSOR = $YYCURSOR - strlen($value); |
||
| 360 | $value = ''; |
||
| 361 | } |
||
| 362 | } else { |
||
| 363 | 2 | $sort_type = 'ASC'; |
|
| 364 | } |
||
| 365 | } |
||
| 366 | 40 | } |
|
| 367 | 52 | return $result; |
|
| 368 | } |
||
| 369 | |||
| 370 | |||
| 371 | protected function parse_join_target_properties(&$query) { |
||
| 386 | |||
| 387 | 202 | protected function parse_query(&$query) { |
|
| 467 | |||
| 468 | // virtual (&private) method. To be implemented in the sql specific compiler |
||
| 469 | protected abstract function priv_sql_compile($node) ; |
||
| 470 | |||
| 471 | 202 | public function compile($path, $query, $limit=100, $offset=0, $layers = array()) { |
|
| 496 | |||
| 497 | |||
| 498 | } |
||
| 499 |
Loading history...
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.