txmodxoops /
tdmcreate
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 TDMCreateXoopsCode 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 TDMCreateXoopsCode, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class TDMCreateXoopsCode |
||
| 29 | { |
||
| 30 | /* |
||
| 31 | * @var mixed |
||
| 32 | */ |
||
| 33 | private $phpcode = null; |
||
| 34 | |||
| 35 | /* |
||
| 36 | * @public function constructor |
||
| 37 | * @param null |
||
| 38 | */ |
||
| 39 | /** |
||
| 40 | * |
||
| 41 | */ |
||
| 42 | public function __construct() |
||
| 46 | |||
| 47 | /* |
||
| 48 | * @static function &getInstance |
||
| 49 | * @param null |
||
| 50 | */ |
||
| 51 | /** |
||
| 52 | * @return TDMCreateXoopsCode |
||
| 53 | */ |
||
| 54 | public static function &getInstance() |
||
| 63 | |||
| 64 | /* |
||
| 65 | * @public function getXoopsCodeSetVar |
||
| 66 | * @param string $tableName |
||
| 67 | * @param string $fieldName |
||
| 68 | * @param string $var |
||
| 69 | * @return string |
||
| 70 | */ |
||
| 71 | public function getXoopsCodeSetVar($tableName, $fieldName, $var) |
||
| 75 | |||
| 76 | /* |
||
| 77 | * @public function getXoopsCodeTextDateSelectSetVar |
||
| 78 | * @param string $tableName |
||
| 79 | * @param string $fieldName |
||
| 80 | * @return string |
||
| 81 | */ |
||
| 82 | public function getXoopsCodeTextDateSelectSetVar($tableName, $fieldName) |
||
| 86 | |||
| 87 | /* |
||
| 88 | * @public function getXoopsCodeCheckBoxOrRadioYNSetVar |
||
| 89 | * @param $tableName |
||
| 90 | * @param $fieldName |
||
| 91 | * @return string |
||
| 92 | */ |
||
| 93 | public function getXoopsCodeCheckBoxOrRadioYNSetVar($tableName, $fieldName) |
||
| 99 | |||
| 100 | /* |
||
| 101 | * @public function getXoopsCodeGetConfig |
||
| 102 | * @param $moduleDirname |
||
| 103 | * @param $name |
||
| 104 | * @return string |
||
| 105 | */ |
||
| 106 | public function getXoopsCodeGetConfig($moduleDirname, $name) |
||
| 110 | |||
| 111 | /* |
||
| 112 | * @public function getXoopsCodeGetConfig |
||
| 113 | * @param $var |
||
| 114 | * @param $dirPath |
||
| 115 | * @param $tableName |
||
| 116 | * @param $moduleDirname |
||
| 117 | * @return string |
||
| 118 | */ |
||
| 119 | public function getXoopsCodeMediaUploader($var = '', $dirPath, $tableName, $moduleDirname) |
||
| 125 | |||
| 126 | /* |
||
| 127 | * @public function getXoopsCodeImageListSetVar |
||
| 128 | * @param string $moduleDirname |
||
| 129 | * @param string $tableName |
||
| 130 | * @param string $fieldName |
||
| 131 | * @return string |
||
| 132 | */ |
||
| 133 | public function getXoopsCodeImageListSetVar($moduleDirname, $tableName, $fieldName) |
||
| 151 | |||
| 152 | /* |
||
| 153 | * @public function getXoopsCodeUploadImageSetVar |
||
| 154 | * @param string $moduleDirname |
||
| 155 | * @param string $tableName |
||
| 156 | * @param string $fieldName |
||
| 157 | * @return string |
||
| 158 | */ |
||
| 159 | public function getXoopsCodeUploadImageSetVar($moduleDirname, $tableName, $fieldName, $fieldMain) |
||
| 181 | |||
| 182 | /* |
||
| 183 | * @public function getXoopsCodeFileSetVar |
||
| 184 | * @param $moduleDirname |
||
| 185 | * @param $tableName |
||
| 186 | * @param $fieldName |
||
| 187 | * @param $formatUrl |
||
| 188 | * @return string |
||
| 189 | */ |
||
| 190 | public function getXoopsCodeFileSetVar($moduleDirname, $tableName, $fieldName, $formatUrl = false) |
||
| 217 | |||
| 218 | /* |
||
| 219 | * @public function getXoopsCodeIdGetVar |
||
| 220 | * @param string $lpFieldName |
||
| 221 | * @return string |
||
| 222 | */ |
||
| 223 | public function getXoopsCodeIdGetVar($lpFieldName) |
||
| 227 | |||
| 228 | /* |
||
| 229 | * @public function getXoopsCodeGetVarAll |
||
| 230 | * @param string $lpFieldName |
||
| 231 | * @param string $rpFieldName |
||
| 232 | * @param string $tableName |
||
| 233 | * @param string $fieldName |
||
| 234 | * @return string |
||
| 235 | */ |
||
| 236 | public function getXoopsCodeGetVarAll($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 240 | |||
| 241 | /* |
||
| 242 | * @public function getXoopsCodeTopicGetVar |
||
| 243 | * @param string $lpFieldName |
||
| 244 | * @param string $rpFieldName |
||
| 245 | * @param string $tableName |
||
| 246 | * @param string $tableNameTopic |
||
| 247 | * @param string $fieldNameParent |
||
| 248 | * @param string $fieldNameTopic |
||
| 249 | * @return string |
||
| 250 | */ |
||
| 251 | public function getXoopsCodeTopicGetVar($lpFieldName, $rpFieldName, $tableName, $tableNameTopic, $fieldNameParent, $fieldNameTopic) |
||
| 261 | |||
| 262 | /* |
||
| 263 | * @public function getXoopsCodeParentTopicGetVar |
||
| 264 | * @param string $moduleDirname |
||
| 265 | * @param string $lpFieldName |
||
| 266 | * @param string $rpFieldName |
||
| 267 | * @param string $tableName |
||
| 268 | * @param string $tableSoleNameTopic |
||
| 269 | * @param string $tableNameTopic |
||
| 270 | * @param string $fieldNameParent |
||
| 271 | * @return string |
||
| 272 | */ |
||
| 273 | View Code Duplication | public function getXoopsCodeParentTopicGetVar($moduleDirname, $lpFieldName, $rpFieldName, $tableName, $tableSoleNameTopic, $tableNameTopic, $fieldNameParent) |
|
| 286 | |||
| 287 | /* |
||
| 288 | * @public function getXoopsCodeUploadImageGetVar |
||
| 289 | * @param string $lpFieldName |
||
| 290 | * @param string $rpFieldName |
||
| 291 | * @param string $tableName |
||
| 292 | * @param string $fieldName |
||
| 293 | * @return string |
||
| 294 | */ |
||
| 295 | public function getXoopsCodeUploadImageGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 305 | /* |
||
| 306 | * @public function getXoopsCodeUrlFileGetVar |
||
| 307 | * @param string $lpFieldName |
||
| 308 | * @param string $rpFieldName |
||
| 309 | * @param string $tableName |
||
| 310 | * @param string $fieldName |
||
| 311 | * @return string |
||
| 312 | */ |
||
| 313 | public function getXoopsCodeUrlFileGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 317 | /* |
||
| 318 | * @public function getXoopsCodeTextAreaGetVar |
||
| 319 | * @param string $lpFieldName |
||
| 320 | * @param string $rpFieldName |
||
| 321 | * @param string $tableName |
||
| 322 | * @param string $fieldName |
||
| 323 | * @return string |
||
| 324 | */ |
||
| 325 | public function getXoopsCodeTextAreaGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 329 | |||
| 330 | /* |
||
| 331 | * @public function getXoopsCodeSelectUserGetVar |
||
| 332 | * @param string $lpFieldName |
||
| 333 | * @param string $rpFieldName |
||
| 334 | * @param string $tableName |
||
| 335 | * @param string $fieldName |
||
| 336 | * @return string |
||
| 337 | */ |
||
| 338 | public function getXoopsCodeSelectUserGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 342 | |||
| 343 | /* |
||
| 344 | * @public function getXoopsCodeTextDateSelectGetVar |
||
| 345 | * @param string $lpFieldName |
||
| 346 | * @param string $rpFieldName |
||
| 347 | * @param string $tableName |
||
| 348 | * @param string $fieldName |
||
| 349 | * @return string |
||
| 350 | */ |
||
| 351 | public function getXoopsCodeTextDateSelectGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 355 | |||
| 356 | /* |
||
| 357 | * @public function getXoopsCodeUserHeader |
||
| 358 | * @param string $moduleDirname |
||
| 359 | * @param string $tableName |
||
| 360 | * @return string |
||
| 361 | */ |
||
| 362 | public function getXoopsCodeXoopsOptionTemplateMain($moduleDirname, $tableName) |
||
| 366 | |||
| 367 | /* |
||
| 368 | * @public function getXoopsCodeUserHeader |
||
| 369 | * @param string $moduleDirname |
||
| 370 | * @param string $tableName |
||
| 371 | * @return string |
||
| 372 | */ |
||
| 373 | public function getXoopsCodeUserHeader($moduleDirname, $tableName) |
||
| 381 | |||
| 382 | /* |
||
| 383 | * @public function getXoopsCodePermissionsHeader |
||
| 384 | * @param null |
||
| 385 | */ |
||
| 386 | /** |
||
| 387 | * @return string |
||
| 388 | */ |
||
| 389 | public function getXoopsCodePermissionsHeader() |
||
| 404 | |||
| 405 | /** |
||
| 406 | * @public function getXoopsCodeGetFieldId |
||
| 407 | * |
||
| 408 | * @param $fields |
||
| 409 | * |
||
| 410 | * @return string |
||
| 411 | */ |
||
| 412 | View Code Duplication | public function getXoopsCodeGetFieldId($fields) |
|
| 424 | |||
| 425 | /** |
||
| 426 | * @public function getXoopsCodeGetFieldName |
||
| 427 | * |
||
| 428 | * @param $fields |
||
| 429 | * |
||
| 430 | * @return string |
||
| 431 | */ |
||
| 432 | public function getXoopsCodeGetFieldName($fields) |
||
| 440 | |||
| 441 | /** |
||
| 442 | * @public function getXoopsCodeGetFieldParentId |
||
| 443 | * |
||
| 444 | * @param $fields |
||
| 445 | * |
||
| 446 | * @return string |
||
| 447 | */ |
||
| 448 | View Code Duplication | public function getXoopsCodeGetFieldParentId($fields) |
|
| 460 | |||
| 461 | /** |
||
| 462 | * @public function getXoopsCodeUserSaveElements |
||
| 463 | * |
||
| 464 | * @param $moduleDirname |
||
| 465 | * @param $tableName |
||
| 466 | * @param $fields |
||
| 467 | * |
||
| 468 | * @return string |
||
| 469 | */ |
||
| 470 | public function getXoopsCodeUserSaveElements($moduleDirname, $tableName, $fields) |
||
| 494 | |||
| 495 | /* |
||
| 496 | * @public function getXoopsCodeXoopsRequest |
||
| 497 | * @param $left |
||
| 498 | * @param $var1 |
||
| 499 | * @param $var2 |
||
| 500 | * @param $type |
||
| 501 | * @param $metod |
||
| 502 | * @return string |
||
| 503 | */ |
||
| 504 | public function getXoopsCodeXoopsRequest($left = '', $var1 = '', $var2 = '', $type = 'String', $metod = false) |
||
| 516 | |||
| 517 | /* |
||
| 518 | * @public function getXoopsCodeTemplateMain |
||
| 519 | * @param $moduleDirname |
||
| 520 | * @param $filename |
||
| 521 | * @return string |
||
| 522 | */ |
||
| 523 | public function getXoopsCodeTemplateMain($moduleDirname, $filename) |
||
| 527 | |||
| 528 | /** |
||
| 529 | * @public function getXoopsCodeTplAssign |
||
| 530 | * |
||
| 531 | * @param string $tplString |
||
| 532 | * @param string $phpRender |
||
| 533 | * |
||
| 534 | * @return string |
||
| 535 | */ |
||
| 536 | public function getXoopsCodeTplAssign($tplString, $phpRender) |
||
| 540 | |||
| 541 | /** |
||
| 542 | * @public function getXoopsCodeXoopsTplAppend |
||
| 543 | * |
||
| 544 | * @param string $tplString |
||
| 545 | * @param string $phpRender |
||
| 546 | * |
||
| 547 | * @return string |
||
| 548 | */ |
||
| 549 | public function getXoopsCodeXoopsTplAppend($tplString, $phpRender) |
||
| 553 | |||
| 554 | /** |
||
| 555 | * @public function getXoopsCodeXoopsTplAppendByRef |
||
| 556 | * |
||
| 557 | * @param string $tplString |
||
| 558 | * @param string $phpRender |
||
| 559 | * |
||
| 560 | * @return string |
||
| 561 | */ |
||
| 562 | public function getXoopsCodeXoopsTplAppendByRef($tplString, $phpRender) |
||
| 566 | |||
| 567 | /** |
||
| 568 | * @public function getXoopsCodeTplDisplay |
||
| 569 | * |
||
| 570 | * @param null |
||
| 571 | * |
||
| 572 | * @return string |
||
| 573 | */ |
||
| 574 | public function getXoopsCodeTplDisplay() |
||
| 578 | |||
| 579 | /* |
||
| 580 | * @public function getXoopsCodeItemButton |
||
| 581 | * @param $language |
||
| 582 | * @param $tableName |
||
| 583 | * @param $admin |
||
| 584 | * @return string |
||
| 585 | */ |
||
| 586 | public function getXoopsCodeItemButton($language, $tableName, $tableSoleName, $op = '?op=new', $type = 'add') |
||
| 601 | |||
| 602 | /** |
||
| 603 | * @public function getXoopsCodeObjHandlerCreate |
||
| 604 | * |
||
| 605 | * @param string $tableName |
||
| 606 | * |
||
| 607 | * @return string |
||
| 608 | */ |
||
| 609 | public function getXoopsCodeObjHandlerCreate($tableName) |
||
| 615 | |||
| 616 | /** |
||
| 617 | * @public function getXoopsCodeSetVarsObjects |
||
| 618 | * |
||
| 619 | * @param $moduleDirname |
||
| 620 | * @param $tableName |
||
| 621 | * @param $fields |
||
| 622 | * |
||
| 623 | * @return string |
||
| 624 | */ |
||
| 625 | public function getXoopsCodeSetVarsObjects($moduleDirname, $tableName, $fields) |
||
| 665 | |||
| 666 | /** |
||
| 667 | * @public function getXoopsCodeSecurity |
||
| 668 | * |
||
| 669 | * @param $tableName |
||
| 670 | * |
||
| 671 | * @return string |
||
| 672 | */ |
||
| 673 | public function getXoopsCodeSecurity($tableName) |
||
| 682 | |||
| 683 | /* |
||
| 684 | * @public function getXoopsCodeInsertData |
||
| 685 | * @param $tableName |
||
| 686 | * @param $language |
||
| 687 | * @return string |
||
| 688 | */ |
||
| 689 | public function getXoopsCodeInsertData($tableName, $language) |
||
| 696 | |||
| 697 | /* |
||
| 698 | * @public function getXoopsCodeRedirectHeader |
||
| 699 | * @param $tableName |
||
| 700 | * @param $options |
||
| 701 | * @param $numb |
||
| 702 | * @param $var |
||
| 703 | * @return string |
||
| 704 | */ |
||
| 705 | public function getXoopsCodeRedirectHeader($tableName, $options = '', $numb = 2, $var) |
||
| 709 | |||
| 710 | /* |
||
| 711 | * @public function getXoopsCodeSecurityCheck |
||
| 712 | * @param null |
||
| 713 | * @return boolean |
||
| 714 | */ |
||
| 715 | public function getXoopsCodeSecurityCheck() |
||
| 719 | |||
| 720 | /* |
||
| 721 | * @public function getXoopsCodeSecurityGetError |
||
| 722 | * @param null |
||
| 723 | * @return string |
||
| 724 | */ |
||
| 725 | public function getXoopsCodeSecurityGetError() |
||
| 729 | |||
| 730 | /** |
||
| 731 | * @public function getXoopsCodeGetFormError |
||
| 732 | * |
||
| 733 | * @param $tableName |
||
| 734 | * |
||
| 735 | * @return string |
||
| 736 | */ |
||
| 737 | public function getXoopsCodeGetFormError($tableName) |
||
| 748 | |||
| 749 | /** |
||
| 750 | * @public function getXoopsCodeGetFormId |
||
| 751 | * |
||
| 752 | * @param string $tableName |
||
| 753 | * @param string $fieldId |
||
| 754 | * |
||
| 755 | * @return string |
||
| 756 | */ |
||
| 757 | public function getXoopsCodeGetFormId($tableName, $fieldId) |
||
| 768 | |||
| 769 | /** |
||
| 770 | * @public function getXoopsCodeHandler |
||
| 771 | * |
||
| 772 | * @param string $tableName |
||
| 773 | * @param string $var |
||
| 774 | * |
||
| 775 | * @return string |
||
| 776 | */ |
||
| 777 | public function getXoopsCodeHandler($tableName, $var, $get = false, $insert = false, $delete = false, $obj = '') |
||
| 789 | |||
| 790 | /* |
||
| 791 | * @public function getXoopsCodeCaseDelete |
||
| 792 | * @param string $tableName |
||
| 793 | * @param string $language |
||
| 794 | * @param string $fieldId |
||
| 795 | * @param string $fieldMain |
||
| 796 | * @return string |
||
| 797 | */ |
||
| 798 | public function getXoopsCodeCaseDelete($language, $tableName, $fieldId, $fieldMain) |
||
| 830 | |||
| 831 | /* |
||
| 832 | * @public function getXoopsCodeUpdate |
||
| 833 | * @param $language |
||
| 834 | * @param $tableName |
||
| 835 | * @param $fieldId |
||
| 836 | * @param $fieldName |
||
| 837 | * @return string |
||
| 838 | */ |
||
| 839 | public function getXoopsCodeUpdate($language, $tableName, $fieldId, $fieldName) |
||
| 853 | } |
||
| 854 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.