XoopsModules25x /
lexikon
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 LexikonTree 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 LexikonTree, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class LexikonTree |
||
| 32 | { |
||
| 33 | public $table; //table with parent-child structure |
||
| 34 | public $id; //name of unique id for records in table $table |
||
| 35 | public $pid; // name of parent id used in table $table |
||
| 36 | public $order; //specifies the order of query results |
||
| 37 | public $title; // name of a field in table $table which will be used when selection box and paths are generated |
||
| 38 | public $db; |
||
| 39 | |||
| 40 | //constructor of class LexikonTree |
||
| 41 | //sets the names of table, unique id, and parend id |
||
| 42 | /** |
||
| 43 | * @param $table_name |
||
| 44 | * @param $id_name |
||
| 45 | * @param $pid_name |
||
| 46 | * @return lexikontree |
||
| 47 | */ |
||
| 48 | public function __construct($table_name, $id_name, $pid_name) |
||
| 56 | |||
| 57 | // returns an array of first child objects for a given id($sel_id) |
||
| 58 | |||
| 59 | /** |
||
| 60 | * @param $sel_id |
||
| 61 | * @param string $order |
||
| 62 | * |
||
| 63 | * @return array |
||
| 64 | */ |
||
| 65 | public function getFirstChild($sel_id, $order = '') |
||
| 84 | |||
| 85 | // returns an array of all FIRST child ids of a given id($sel_id) |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @param $sel_id |
||
| 89 | * |
||
| 90 | * @return array |
||
| 91 | */ |
||
| 92 | public function getFirstChildId($sel_id) |
||
| 107 | |||
| 108 | //returns an array of ALL child ids for a given id($sel_id) |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @param $sel_id |
||
| 112 | * @param string $order |
||
| 113 | * @param array $idarray |
||
| 114 | * |
||
| 115 | * @return array |
||
| 116 | */ |
||
| 117 | View Code Duplication | public function getAllChildId($sel_id, $order = '', $idarray = []) |
|
| 136 | |||
| 137 | //returns an array of ALL parent ids for a given id($sel_id) |
||
| 138 | |||
| 139 | /** |
||
| 140 | * @param $sel_id |
||
| 141 | * @param string $order |
||
| 142 | * @param array $idarray |
||
| 143 | * |
||
| 144 | * @return array |
||
| 145 | */ |
||
| 146 | View Code Duplication | public function getAllParentId($sel_id, $order = '', $idarray = []) |
|
| 163 | |||
| 164 | //generates path from the root id to a given id($sel_id) |
||
| 165 | // the path is delimetered with "/" |
||
| 166 | /** |
||
| 167 | * @param $sel_id |
||
| 168 | * @param $title |
||
| 169 | * @param string $path |
||
| 170 | * |
||
| 171 | * @return string |
||
| 172 | */ |
||
| 173 | public function getPathFromId($sel_id, $title, $path = '') |
||
| 191 | |||
| 192 | //makes a nicely ordered selection box |
||
| 193 | //$preset_id is used to specify a preselected item |
||
| 194 | //set $none to 1 to add a option with value 0 |
||
| 195 | /** |
||
| 196 | * @param $title |
||
| 197 | * @param string $order |
||
| 198 | * @param int $preset_id |
||
| 199 | * @param int $none |
||
| 200 | * @param string $sel_name |
||
| 201 | * @param string $onchange |
||
| 202 | */ |
||
| 203 | public function makeMySelBox($title, $order = '', $preset_id = 0, $none = 0, $sel_name = '', $onchange = '') |
||
| 242 | |||
| 243 | //generates nicely formatted linked path from the root id to a given id |
||
| 244 | |||
| 245 | /** |
||
| 246 | * @param $sel_id |
||
| 247 | * @param $title |
||
| 248 | * @param $funcURL |
||
| 249 | * @param string $path |
||
| 250 | * |
||
| 251 | * @return string |
||
| 252 | */ |
||
| 253 | public function getNicePathFromId($sel_id, $title, $funcURL, $path = '') |
||
| 273 | |||
| 274 | //generates id path from the root id to a given id |
||
| 275 | // the path is delimetered with "/" |
||
| 276 | /** |
||
| 277 | * @param $sel_id |
||
| 278 | * @param string $path |
||
| 279 | * |
||
| 280 | * @return string |
||
| 281 | */ |
||
| 282 | public function getIdPathFromId($sel_id, $path = '') |
||
| 298 | |||
| 299 | /** |
||
| 300 | * Enter description here... |
||
| 301 | * |
||
| 302 | * @param int|mixed $sel_id |
||
| 303 | * @param string|mixed $order |
||
| 304 | * @param array|mixed $parray |
||
| 305 | * |
||
| 306 | * @return array|unknown|unknown_type |
||
| 307 | */ |
||
| 308 | View Code Duplication | public function getAllChild($sel_id = 0, $order = '', $parray = []) |
|
| 327 | |||
| 328 | /** |
||
| 329 | * Enter description here... |
||
| 330 | * |
||
| 331 | * @param int|mixed $sel_id |
||
| 332 | * @param string|mixed $order |
||
| 333 | * @param array|mixed $parray |
||
| 334 | * @param string|mixed $r_prefix |
||
| 335 | * @return array|unknown|unknown_type |
||
| 336 | */ |
||
| 337 | public function getChildTreeArray($sel_id = 0, $order = '', $parray = [], $r_prefix = '') |
||
| 357 | } |
||
| 358 |
Loading history...
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.