txmodxoops /
tdmcreate
Complex classes like ClassXoopsCode 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 ClassXoopsCode, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class ClassXoopsCode |
||
|
|
|||
| 29 | { |
||
| 30 | /* |
||
| 31 | * @var mixed |
||
| 32 | */ |
||
| 33 | private $phpcode = null; |
||
| 34 | |||
| 35 | /* |
||
| 36 | * @var mixed |
||
| 37 | */ |
||
| 38 | private $xoopscode = null; |
||
| 39 | |||
| 40 | /* |
||
| 41 | * @public function constructor |
||
| 42 | * @param null |
||
| 43 | */ |
||
| 44 | /** |
||
| 45 | * |
||
| 46 | */ |
||
| 47 | public function __construct() |
||
| 48 | { |
||
| 49 | $this->phpcode = TDMCreatePhpCode::getInstance(); |
||
| 50 | $this->xoopscode = TDMCreateXoopsCode::getInstance(); |
||
| 51 | } |
||
| 52 | |||
| 53 | /* |
||
| 54 | * @static function &getInstance |
||
| 55 | * @param null |
||
| 56 | */ |
||
| 57 | /** |
||
| 58 | * @return ClassXoopsCode |
||
| 59 | */ |
||
| 60 | public static function &getInstance() |
||
| 61 | { |
||
| 62 | static $instance = false; |
||
| 63 | if (!$instance) { |
||
| 64 | $instance = new self(); |
||
| 65 | } |
||
| 66 | |||
| 67 | return $instance; |
||
| 68 | } |
||
| 69 | |||
| 70 | /* |
||
| 71 | * @public function getClassCriteriaCompo |
||
| 72 | * @param $var |
||
| 73 | * |
||
| 74 | * @return string |
||
| 75 | */ |
||
| 76 | public function getClassCriteriaCompo($var) |
||
| 77 | { |
||
| 78 | return "\${$var} = new CriteriaCompo();\n"; |
||
| 79 | } |
||
| 80 | |||
| 81 | /* |
||
| 82 | * @public function getClassCriteria |
||
| 83 | * @param $var |
||
| 84 | * @param $param1 |
||
| 85 | * @param $param2 |
||
| 86 | * @param $param3 |
||
| 87 | * |
||
| 88 | * @return string |
||
| 89 | */ |
||
| 90 | public function getClassCriteria($var, $param1, $param2 = '', $param3 = '') |
||
| 91 | { |
||
| 92 | $params = ($param2 != '') ? ', '.$param2 : ''; |
||
| 93 | $params .= ($param3 != '') ? ', '.$param3 : ''; |
||
| 94 | |||
| 95 | return "\${$var} = new Criteria( {$param1}{$params} );\n"; |
||
| 96 | } |
||
| 97 | |||
| 98 | /* |
||
| 99 | * @public function getClassAdd |
||
| 100 | * @param $var |
||
| 101 | * @param $param |
||
| 102 | * |
||
| 103 | * @return string |
||
| 104 | */ |
||
| 105 | public function getClassAdd($var, $param) |
||
| 109 | |||
| 110 | /* |
||
| 111 | * @public function XoopsFormElementTray |
||
| 112 | * @param $var |
||
| 113 | * @param $param1 |
||
| 114 | * @param $param2 |
||
| 115 | * |
||
| 116 | * @return string |
||
| 117 | */ |
||
| 118 | public function getClassXoopsFormElementTray($var, $param1, $param2 = '', $isParam = false) |
||
| 128 | |||
| 129 | /* |
||
| 130 | * @public function getClassXoopsFormLabel |
||
| 131 | * @param $var |
||
| 132 | * @param $param1 |
||
| 133 | * @param $param2 |
||
| 134 | * |
||
| 135 | * @return string |
||
| 136 | */ |
||
| 137 | public function getClassXoopsFormLabel($var, $param1 = '', $isParam = false) |
||
| 147 | |||
| 148 | /* |
||
| 149 | * @public function getClassXoopsFormFile |
||
| 150 | * @param $var |
||
| 151 | * @param $param1 |
||
| 152 | * @param $param2 |
||
| 153 | * @param $param3 |
||
| 154 | * |
||
| 155 | * @return string |
||
| 156 | */ |
||
| 157 | public function getClassXoopsFormFile($var, $param1, $param2, $param3, $isParam = false) |
||
| 167 | |||
| 168 | /* |
||
| 169 | * @public function getClassXoopsFormHidden |
||
| 170 | * @param $var |
||
| 171 | * @param $param1 |
||
| 172 | * @param $param2 |
||
| 173 | * |
||
| 174 | * @return string |
||
| 175 | */ |
||
| 176 | public function getClassXoopsFormHidden($var, $param1, $param2, $isParam = false) |
||
| 186 | |||
| 187 | /* |
||
| 188 | * @public function getClassXoopsFormText |
||
| 189 | * @param $var |
||
| 190 | * @param $param1 |
||
| 191 | * @param $param2 |
||
| 192 | * @param $param3 |
||
| 193 | * @param $param4 |
||
| 194 | * @param $param5 |
||
| 195 | * |
||
| 196 | * @return string |
||
| 197 | */ |
||
| 198 | public function getClassXoopsFormText($var, $param1, $param2, $param3 = 75, $param4 = 255, $param5, $isParam = false) |
||
| 208 | |||
| 209 | /* |
||
| 210 | * @public function getClassXoopsFormTextArea |
||
| 211 | * @param $var |
||
| 212 | * @param $param1 |
||
| 213 | * @param $param2 |
||
| 214 | * @param $param3 |
||
| 215 | * @param $param4 |
||
| 216 | * @param $param5 |
||
| 217 | * |
||
| 218 | * @return string |
||
| 219 | */ |
||
| 220 | public function getClassXoopsFormTextArea($var, $param1, $param2, $param3, $param4, $param5, $isParam = false) |
||
| 230 | |||
| 231 | /* |
||
| 232 | * @public function getClassXoopsFormColorPicker |
||
| 233 | * @param $var |
||
| 234 | * @param $param1 |
||
| 235 | * @param $param2 |
||
| 236 | * @param $param3 |
||
| 237 | * |
||
| 238 | * @return string |
||
| 239 | */ |
||
| 240 | public function getClassXoopsFormColorPicker($var, $param1, $param2, $param3, $isParam = false) |
||
| 250 | |||
| 251 | /* |
||
| 252 | * @public function getClassXoopsFormSelectUser |
||
| 253 | * @param $var |
||
| 254 | * @param $param1 |
||
| 255 | * @param $param2 |
||
| 256 | * @param $param3 |
||
| 257 | * |
||
| 258 | * @return string |
||
| 259 | */ |
||
| 260 | public function getClassXoopsFormSelectUser($var, $param1, $param2, $param3 = 'false', $param4, $isParam = false) |
||
| 270 | |||
| 271 | /* |
||
| 272 | * @public function getClassXoopsFormTextDateSelect |
||
| 273 | * @param $var |
||
| 274 | * @param $param1 |
||
| 275 | * @param $param2 |
||
| 276 | * @param $param3 |
||
| 277 | * |
||
| 278 | * @return string |
||
| 279 | */ |
||
| 280 | public function getClassXoopsFormTextDateSelect($var, $param1, $param2, $param3 = '', $param4, $isParam = false) |
||
| 290 | |||
| 291 | /* |
||
| 292 | * @public function getClassXoopsFormEditor |
||
| 293 | * @param $var |
||
| 294 | * @param $param1 |
||
| 295 | * @param $param2 |
||
| 296 | * @param $param3 |
||
| 297 | * |
||
| 298 | * @return string |
||
| 299 | */ |
||
| 300 | public function getClassXoopsFormEditor($var, $param1, $param2, $param3, $isParam = false) |
||
| 310 | |||
| 311 | /* |
||
| 312 | * @public function getClassXoopsFormCheckBox |
||
| 313 | * @param $var |
||
| 314 | * @param $param1 |
||
| 315 | * @param $param2 |
||
| 316 | * @param $param3 |
||
| 317 | * |
||
| 318 | * @return string |
||
| 319 | */ |
||
| 320 | public function getClassXoopsFormCheckBox($var, $param1, $param2, $param3, $isParam = false) |
||
| 330 | |||
| 331 | /* |
||
| 332 | * @public function getClassXoopsFormRadioYN |
||
| 333 | * @param $var |
||
| 334 | * @param $param1 |
||
| 335 | * @param $param2 |
||
| 336 | * @param $param3 |
||
| 337 | * |
||
| 338 | * @return string |
||
| 339 | */ |
||
| 340 | public function getClassXoopsFormRadioYN($var, $param1, $param2, $param3, $isParam = false) |
||
| 350 | |||
| 351 | /* |
||
| 352 | * @public function getClassXoopsFormSelect |
||
| 353 | * @param $var |
||
| 354 | * @param $param1 |
||
| 355 | * @param $param2 |
||
| 356 | * @param $param3 |
||
| 357 | * @param $param4 |
||
| 358 | * @param $param5 |
||
| 359 | * |
||
| 360 | * @return string |
||
| 361 | */ |
||
| 362 | public function getClassXoopsFormSelect($var, $param1, $param2, $param3, $param4, $param5 = 5, $isParam = false) |
||
| 372 | |||
| 373 | /* |
||
| 374 | * @public function getClassXoopsFormTag |
||
| 375 | * @param $var |
||
| 376 | * @param $param1 |
||
| 377 | * @param $param2 |
||
| 378 | * @param $param3 |
||
| 379 | * @param $param4 |
||
| 380 | * @param $param5 |
||
| 381 | * |
||
| 382 | * @return string |
||
| 383 | */ |
||
| 384 | public function getClassXoopsFormTag($var, $param1, $param2, $param3, $param4, $param5 = 0, $isParam = false) |
||
| 394 | |||
| 395 | /* |
||
| 396 | * @public function getClassAddOption |
||
| 397 | * @param $var |
||
| 398 | * @param $params |
||
| 399 | * |
||
| 400 | * @return string |
||
| 401 | */ |
||
| 402 | public function getClassAddOption($var, $params) |
||
| 406 | |||
| 407 | /* |
||
| 408 | * @public function getClassAddOptionArray |
||
| 409 | * @param $var |
||
| 410 | * @param $params |
||
| 411 | * |
||
| 412 | * @return string |
||
| 413 | */ |
||
| 414 | public function getClassAddOptionArray($var, $params) |
||
| 418 | |||
| 419 | /* |
||
| 420 | * @public function getClassAddElement |
||
| 421 | * @param $var |
||
| 422 | * @param $params |
||
| 423 | * |
||
| 424 | * @return string |
||
| 425 | */ |
||
| 426 | public function getClassAddElement($var = '', $params = '') |
||
| 430 | |||
| 431 | /* |
||
| 432 | * @public function getClassSetDescription |
||
| 433 | * @param $var |
||
| 434 | * @param $params |
||
| 435 | * |
||
| 436 | * @return string |
||
| 437 | */ |
||
| 438 | public function getClassSetDescription($var, $params) |
||
| 442 | |||
| 443 | /* |
||
| 444 | * @public function getClassSetExtra |
||
| 445 | * @param $var |
||
| 446 | * @param $params |
||
| 447 | * |
||
| 448 | * @return string |
||
| 449 | */ |
||
| 450 | public function getClassSetExtra($var, $params) |
||
| 454 | } |
||
| 455 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.