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 $tdmcfile = null; |
||
| 34 | |||
| 35 | /* |
||
| 36 | * @var mixed |
||
| 37 | */ |
||
| 38 | private $phpcode = null; |
||
| 39 | |||
| 40 | /* |
||
| 41 | * @var string |
||
| 42 | */ |
||
| 43 | protected $xoopscode; |
||
| 44 | |||
| 45 | /* |
||
| 46 | * @public function constructor |
||
| 47 | * @param null |
||
| 48 | */ |
||
| 49 | /** |
||
| 50 | * |
||
| 51 | */ |
||
| 52 | public function __construct() |
||
| 57 | |||
| 58 | /* |
||
| 59 | * @static function &getInstance |
||
| 60 | * @param null |
||
| 61 | */ |
||
| 62 | /** |
||
| 63 | * @return TDMCreateXoopsCode |
||
| 64 | */ |
||
| 65 | public static function &getInstance() |
||
| 74 | |||
| 75 | /* |
||
| 76 | * @public function getXoopsCodeSwitch |
||
| 77 | * @param $op |
||
| 78 | * @param $cases |
||
| 79 | * @param $defaultAfterCase |
||
| 80 | * @param $default |
||
| 81 | * @param $tabulation |
||
| 82 | * |
||
| 83 | * @return string |
||
| 84 | */ |
||
| 85 | public function getXoopsCodeSwitch($op = '', $cases = array(), $defaultAfterCase = false, $default = false, $t = '') |
||
| 91 | |||
| 92 | /* |
||
| 93 | * @public function getXoopsCodeEqualsOperator |
||
| 94 | * @param $left |
||
| 95 | * @param $right |
||
| 96 | * @param $ref |
||
| 97 | * |
||
| 98 | * @return string |
||
| 99 | */ |
||
| 100 | public function getXoopsCodeEqualsOperator($left, $right, $ref = false) |
||
| 110 | |||
| 111 | /* |
||
| 112 | * @public function getXoopsCodeCPHeader |
||
| 113 | * @param null |
||
| 114 | * @return string |
||
| 115 | */ |
||
| 116 | public function getXoopsCodeCPHeader() |
||
| 120 | |||
| 121 | /* |
||
| 122 | * @public function getXoopsCodeCPFooter |
||
| 123 | * @param null |
||
| 124 | * @return string |
||
| 125 | */ |
||
| 126 | public function getXoopsCodeCPFooter() |
||
| 130 | |||
| 131 | /** |
||
| 132 | * @public function getXoopsCodeLoad |
||
| 133 | * |
||
| 134 | * @param $var |
||
| 135 | * |
||
| 136 | * @return string |
||
| 137 | */ |
||
| 138 | public function getXoopsCodeLoad($var = '') |
||
| 142 | |||
| 143 | /** |
||
| 144 | * @public function getXoopsCodeLoadLanguage |
||
| 145 | * |
||
| 146 | * @param $lang |
||
| 147 | * |
||
| 148 | * @return string |
||
| 149 | */ |
||
| 150 | public function getXoopsCodeLoadLanguage($lang) |
||
| 154 | |||
| 155 | /* |
||
| 156 | * @public function getXoopsCodeAnchorFunction |
||
| 157 | * @param $anchor |
||
| 158 | * @param $name |
||
| 159 | * @param $vars |
||
| 160 | * |
||
| 161 | * @return string |
||
| 162 | */ |
||
| 163 | public function getXoopsCodeAnchorFunction($anchor, $name, $vars) |
||
| 167 | |||
| 168 | /* |
||
| 169 | * @public function getXoopsCodeSetVar |
||
| 170 | * @param $tableName |
||
| 171 | * @param $fieldName |
||
| 172 | * @param $var |
||
| 173 | * @return string |
||
| 174 | */ |
||
| 175 | public function getXoopsCodeSetVar($tableName, $fieldName, $var) |
||
| 179 | |||
| 180 | /* |
||
| 181 | * @public function getXoopsCodeGetVar |
||
| 182 | * @param $varLeft |
||
| 183 | * @param $handle |
||
| 184 | * @param $var |
||
| 185 | * @param $isParam |
||
| 186 | * |
||
| 187 | * @return string |
||
| 188 | */ |
||
| 189 | public function getXoopsCodeGetVar($varLeft = '', $handle = '', $var = '', $isParam = false) |
||
| 199 | |||
| 200 | /* |
||
| 201 | * @public function getXoopsCodeGroupPermForm |
||
| 202 | * @param $varLeft |
||
| 203 | * @param $formTitle |
||
| 204 | * @param $moduleId |
||
| 205 | * @param $permName |
||
| 206 | * @param $permDesc |
||
| 207 | * @param $filename |
||
| 208 | * |
||
| 209 | * @return string |
||
| 210 | */ |
||
| 211 | public function getXoopsCodeGroupPermForm($varLeft = '', $formTitle = '', $moduleId = '', $permName = '', $permDesc = '', $filename = '') |
||
| 215 | |||
| 216 | /* |
||
| 217 | * @public function getXoopsCodeAddItem |
||
| 218 | * @param $varLeft |
||
| 219 | * @param $paramLeft |
||
| 220 | * @param $paramRight |
||
| 221 | * |
||
| 222 | * @return string |
||
| 223 | */ |
||
| 224 | public function getXoopsCodeAddItem($varLeft = '', $paramLeft = '', $paramRight = '') |
||
| 228 | |||
| 229 | /* |
||
| 230 | * @public function getXoopsCodeTextDateSelectSetVar |
||
| 231 | * @param $tableName |
||
| 232 | * @param $fieldName |
||
| 233 | * @return string |
||
| 234 | */ |
||
| 235 | public function getXoopsCodeTextDateSelectSetVar($tableName, $fieldName) |
||
| 239 | |||
| 240 | /* |
||
| 241 | * @public function getXoopsCodeCheckBoxOrRadioYNSetVar |
||
| 242 | * @param $tableName |
||
| 243 | * @param $fieldName |
||
| 244 | * @return string |
||
| 245 | */ |
||
| 246 | public function getXoopsCodeCheckBoxOrRadioYNSetVar($tableName, $fieldName) |
||
| 250 | |||
| 251 | /* |
||
| 252 | * @public function getXoopsCodeXoopsMediaUploader |
||
| 253 | * @param $var |
||
| 254 | * @param $dirPath |
||
| 255 | * @param $tableName |
||
| 256 | * @param $moduleDirname |
||
| 257 | * @return string |
||
| 258 | */ |
||
| 259 | public function getXoopsCodeXoopsMediaUploader($var = '', $dirPath, $tableName, $moduleDirname) |
||
| 266 | |||
| 267 | /* |
||
| 268 | * @public function getXoopsCodeXoopsCaptcha |
||
| 269 | * @param null |
||
| 270 | * @return string |
||
| 271 | */ |
||
| 272 | public function getXoopsCodeXoopsCaptcha() |
||
| 276 | |||
| 277 | /* |
||
| 278 | * @public function getXoopsCodeGetConfig |
||
| 279 | * @param $moduleDirname |
||
| 280 | * @param $name |
||
| 281 | * @return string |
||
| 282 | */ |
||
| 283 | public function getXoopsCodeGetConfig($moduleDirname, $name) |
||
| 287 | |||
| 288 | /* |
||
| 289 | * @public function getXoopsCodeIdGetVar |
||
| 290 | * @param $lpFieldName |
||
| 291 | * @return string |
||
| 292 | */ |
||
| 293 | public function getXoopsCodeIdGetVar($lpFieldName) |
||
| 297 | |||
| 298 | /* |
||
| 299 | * @public function getXoopsCodeGetVarAll |
||
| 300 | * @param $lpFieldName |
||
| 301 | * @param $rpFieldName |
||
| 302 | * @param $tableName |
||
| 303 | * @param $fieldName |
||
| 304 | * @return string |
||
| 305 | */ |
||
| 306 | public function getXoopsCodeGetVarAll($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 310 | |||
| 311 | /* |
||
| 312 | * @public function getXoopsHandlerInstance |
||
| 313 | * @param $moduleDirname |
||
| 314 | * |
||
| 315 | * @return string |
||
| 316 | */ |
||
| 317 | public function getXoopsHandlerInstance($moduleDirname) |
||
| 325 | |||
| 326 | /* |
||
| 327 | * @public function getXoopsHandlerLine |
||
| 328 | * @param $moduleDirname |
||
| 329 | * @param $tableName |
||
| 330 | * @return string |
||
| 331 | */ |
||
| 332 | public function getXoopsHandlerLine($moduleDirname, $tableName) |
||
| 336 | |||
| 337 | /* |
||
| 338 | * @public function getXoopsSimpleForm |
||
| 339 | * @param $left |
||
| 340 | * @param $element |
||
| 341 | * @param $elementsContent |
||
| 342 | * @param $caption |
||
| 343 | * @param $var |
||
| 344 | * @param $filename |
||
| 345 | * @param $type |
||
| 346 | * |
||
| 347 | * @return string |
||
| 348 | */ |
||
| 349 | public function getXoopsSimpleForm($left = '', $element = '', $elementsContent = '', $caption = '', $var = '', $filename = '', $type = 'post') |
||
| 360 | |||
| 361 | /* |
||
| 362 | * @public function getXoopsFormSelect |
||
| 363 | * @param $varSelect |
||
| 364 | * @param $caption |
||
| 365 | * @param $var |
||
| 366 | * @param $options |
||
| 367 | * @param $setExtra |
||
| 368 | * |
||
| 369 | * @return string |
||
| 370 | */ |
||
| 371 | public function getXoopsFormSelect($varSelect = '', $caption = '', $var = '', $options = array(), $setExtra = true) |
||
| 383 | |||
| 384 | /* |
||
| 385 | * @public function getXoopsCodeUnameFromId |
||
| 386 | * @param $left |
||
| 387 | * @param $tableName |
||
| 388 | * |
||
| 389 | * @return string |
||
| 390 | */ |
||
| 391 | public function getXoopsCodeUnameFromId($left, $value) |
||
| 395 | |||
| 396 | /* |
||
| 397 | * @public function getXoopsCodeFormatTimeStamp |
||
| 398 | * @param $lpFieldName |
||
| 399 | * @param $rpFieldName |
||
| 400 | * @param $tableName |
||
| 401 | * @param $fieldName |
||
| 402 | * @return string |
||
| 403 | */ |
||
| 404 | public function getXoopsCodeFormatTimeStamp($left, $value, $format = 's') |
||
| 408 | |||
| 409 | /* |
||
| 410 | * @public function getXoopsCodeTopicGetVar |
||
| 411 | * @param $lpFieldName |
||
| 412 | * @param $rpFieldName |
||
| 413 | * @param $tableName |
||
| 414 | * @param $tableNameTopic |
||
| 415 | * @param $fieldNameParent |
||
| 416 | * @param $fieldNameTopic |
||
| 417 | * @return string |
||
| 418 | */ |
||
| 419 | public function getXoopsCodeTopicGetVar($lpFieldName, $rpFieldName, $tableName, $tableNameTopic, $fieldNameParent, $fieldNameTopic) |
||
| 429 | |||
| 430 | /* |
||
| 431 | * @public function getXoopsCodeParentTopicGetVar |
||
| 432 | * @param $moduleDirname |
||
| 433 | * @param $lpFieldName |
||
| 434 | * @param $rpFieldName |
||
| 435 | * @param $tableName |
||
| 436 | * @param $tableSoleNameTopic |
||
| 437 | * @param $tableNameTopic |
||
| 438 | * @param $fieldNameParent |
||
| 439 | * @return string |
||
| 440 | */ |
||
| 441 | View Code Duplication | public function getXoopsCodeParentTopicGetVar($moduleDirname, $lpFieldName, $rpFieldName, $tableName, $tableSoleNameTopic, $tableNameTopic, $fieldNameParent) |
|
| 454 | |||
| 455 | /* |
||
| 456 | * @public function getXoopsCodeUploadImageGetVar |
||
| 457 | * @param $lpFieldName |
||
| 458 | * @param $rpFieldName |
||
| 459 | * @param $tableName |
||
| 460 | * @param $fieldName |
||
| 461 | * @return string |
||
| 462 | */ |
||
| 463 | public function getXoopsCodeUploadImageGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 473 | /* |
||
| 474 | * @public function getXoopsCodeUrlFileGetVar |
||
| 475 | * @param $lpFieldName |
||
| 476 | * @param $rpFieldName |
||
| 477 | * @param $tableName |
||
| 478 | * @param $fieldName |
||
| 479 | * @return string |
||
| 480 | */ |
||
| 481 | public function getXoopsCodeUrlFileGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 485 | /* |
||
| 486 | * @public function getXoopsCodeTextAreaGetVar |
||
| 487 | * @param $lpFieldName |
||
| 488 | * @param $rpFieldName |
||
| 489 | * @param $tableName |
||
| 490 | * @param $fieldName |
||
| 491 | * @return string |
||
| 492 | */ |
||
| 493 | public function getXoopsCodeTextAreaGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 497 | |||
| 498 | /* |
||
| 499 | * @public function getXoopsCodeSelectUserGetVar |
||
| 500 | * @param $lpFieldName |
||
| 501 | * @param $rpFieldName |
||
| 502 | * @param $tableName |
||
| 503 | * @param $fieldName |
||
| 504 | * @return string |
||
| 505 | */ |
||
| 506 | public function getXoopsCodeSelectUserGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 510 | |||
| 511 | /* |
||
| 512 | * @public function getXoopsCodeTextDateSelectGetVar |
||
| 513 | * @param $lpFieldName |
||
| 514 | * @param $rpFieldName |
||
| 515 | * @param $tableName |
||
| 516 | * @param $fieldName |
||
| 517 | * @return string |
||
| 518 | */ |
||
| 519 | public function getXoopsCodeTextDateSelectGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 523 | |||
| 524 | /* |
||
| 525 | * @public function getXoopsCodeUserHeader |
||
| 526 | * @param $moduleDirname |
||
| 527 | * @param $tableName |
||
| 528 | * @return string |
||
| 529 | */ |
||
| 530 | public function getXoopsCodeXoopsOptionTemplateMain($moduleDirname, $tableName) |
||
| 534 | |||
| 535 | /* |
||
| 536 | * @public function getXoopsCodeUserHeader |
||
| 537 | * @param $moduleDirname |
||
| 538 | * @param $tableName |
||
| 539 | * @return string |
||
| 540 | */ |
||
| 541 | public function getXoopsCodeUserHeader($moduleDirname, $tableName) |
||
| 549 | |||
| 550 | /* |
||
| 551 | * @public function getXoopsCodePermissionsHeader |
||
| 552 | * @param null |
||
| 553 | */ |
||
| 554 | /** |
||
| 555 | * @return string |
||
| 556 | */ |
||
| 557 | public function getXoopsCodePermissionsHeader() |
||
| 568 | |||
| 569 | /** |
||
| 570 | * @public function getXoopsCodeGetFieldId |
||
| 571 | * |
||
| 572 | * @param $fields |
||
| 573 | * |
||
| 574 | * @return string |
||
| 575 | */ |
||
| 576 | View Code Duplication | public function getXoopsCodeGetFieldId($fields) |
|
| 588 | |||
| 589 | /** |
||
| 590 | * @public function getXoopsCodeGetFieldName |
||
| 591 | * |
||
| 592 | * @param $fields |
||
| 593 | * |
||
| 594 | * @return string |
||
| 595 | */ |
||
| 596 | public function getXoopsCodeGetFieldName($fields) |
||
| 604 | |||
| 605 | /** |
||
| 606 | * @public function getXoopsCodeGetFieldParentId |
||
| 607 | * |
||
| 608 | * @param $fields |
||
| 609 | * |
||
| 610 | * @return string |
||
| 611 | */ |
||
| 612 | View Code Duplication | public function getXoopsCodeGetFieldParentId($fields) |
|
| 624 | |||
| 625 | /** |
||
| 626 | * @public function getXoopsCodeUserSaveElements |
||
| 627 | * |
||
| 628 | * @param $moduleDirname |
||
| 629 | * @param $tableName |
||
| 630 | * @param $fields |
||
| 631 | * |
||
| 632 | * @return string |
||
| 633 | */ |
||
| 634 | View Code Duplication | public function getXoopsCodeUserSaveElements($moduleDirname, $tableName, $fields) |
|
| 658 | |||
| 659 | /* |
||
| 660 | * @public function getXoopsCodeXoopsRequest |
||
| 661 | * @param $left |
||
| 662 | * @param $var1 |
||
| 663 | * @param $var2 |
||
| 664 | * @param $type |
||
| 665 | * @param $metod |
||
| 666 | * @return string |
||
| 667 | */ |
||
| 668 | public function getXoopsCodeXoopsRequest($left = '', $var1 = '', $var2 = '', $type = 'String', $metod = false) |
||
| 682 | |||
| 683 | /** |
||
| 684 | * @public function getXoopsCodeTplAssign |
||
| 685 | * |
||
| 686 | * @param $tplString |
||
| 687 | * @param $phpRender |
||
| 688 | * @param $leftIsString |
||
| 689 | * |
||
| 690 | * @return string |
||
| 691 | */ |
||
| 692 | public function getXoopsCodeTplAssign($tplString, $phpRender, $leftIsString = true) |
||
| 703 | |||
| 704 | /** |
||
| 705 | * @public function getXoopsCodeXoopsTplAppend |
||
| 706 | * |
||
| 707 | * @param $tplString |
||
| 708 | * @param $phpRender |
||
| 709 | * |
||
| 710 | * @return string |
||
| 711 | */ |
||
| 712 | public function getXoopsCodeXoopsTplAppend($tplString, $phpRender) |
||
| 716 | |||
| 717 | /** |
||
| 718 | * @public function getXoopsCodeXoopsTplAppendByRef |
||
| 719 | * |
||
| 720 | * @param $tplString |
||
| 721 | * @param $phpRender |
||
| 722 | * |
||
| 723 | * @return string |
||
| 724 | */ |
||
| 725 | public function getXoopsCodeXoopsTplAppendByRef($tplString, $phpRender) |
||
| 729 | |||
| 730 | /** |
||
| 731 | * @public function getXoopsCodePath |
||
| 732 | * |
||
| 733 | * @param $directory |
||
| 734 | * @param $filename |
||
| 735 | * @param $isParam |
||
| 736 | * |
||
| 737 | * @return string |
||
| 738 | */ |
||
| 739 | public function getXoopsCodePath($directory, $filename, $isParam = false) |
||
| 749 | |||
| 750 | /** |
||
| 751 | * @public function getXoopsCodeTplDisplay |
||
| 752 | * |
||
| 753 | * @param $displayTpl |
||
| 754 | * |
||
| 755 | * @return string |
||
| 756 | */ |
||
| 757 | public function getXoopsCodeTplDisplay($displayTpl = '{$templateMain}') |
||
| 761 | |||
| 762 | /** |
||
| 763 | * @public function getXoopsCodeGetInfo |
||
| 764 | * |
||
| 765 | * @param $left |
||
| 766 | * @param $string |
||
| 767 | * @param $isParam |
||
| 768 | * |
||
| 769 | * @return string |
||
| 770 | */ |
||
| 771 | public function getXoopsCodeGetInfo($left = '', $string, $isParam = false) |
||
| 781 | |||
| 782 | /** |
||
| 783 | * @public function getXoopsCodeCheckRight |
||
| 784 | * |
||
| 785 | * @param $anchor |
||
| 786 | * @param $permString |
||
| 787 | * @param $var |
||
| 788 | * @param $groups |
||
| 789 | * @param $mid |
||
| 790 | * @param $isParam |
||
| 791 | * |
||
| 792 | * @return string |
||
| 793 | */ |
||
| 794 | public function getXoopsCodeCheckRight($anchor, $permString = '', $var = '', $groups = '', $mid = '', $isParam = false) |
||
| 804 | |||
| 805 | /** |
||
| 806 | * @public function getXoopsCodeObjHandlerCreate |
||
| 807 | * |
||
| 808 | * @param $tableName |
||
| 809 | * |
||
| 810 | * @return string |
||
| 811 | */ |
||
| 812 | public function getXoopsCodeObjHandlerCreate($tableName) |
||
| 816 | |||
| 817 | /** |
||
| 818 | * @public function getXoopsCodeObjHandlerCount |
||
| 819 | * |
||
| 820 | * @param $tableName |
||
| 821 | * |
||
| 822 | * @return string |
||
| 823 | */ |
||
| 824 | public function getXoopsCodeObjHandlerCount($tableName) |
||
| 831 | |||
| 832 | /** |
||
| 833 | * @public function getXoopsCodeObjHandlerAll |
||
| 834 | * |
||
| 835 | * @param $tableName |
||
| 836 | * @param $fieldMain |
||
| 837 | * @param $start |
||
| 838 | * @param $limit |
||
| 839 | * |
||
| 840 | * @return string |
||
| 841 | */ |
||
| 842 | public function getXoopsCodeObjHandlerAll($tableName, $fieldMain, $start = '0', $limit = '0') |
||
| 850 | |||
| 851 | /** |
||
| 852 | * @public function getXoopsCodeGetValues |
||
| 853 | * |
||
| 854 | * @param $tableName |
||
| 855 | * @param $tableSoleName |
||
| 856 | * |
||
| 857 | * @return string |
||
| 858 | */ |
||
| 859 | public function getXoopsCodeGetValues($tableName, $tableSoleName, $index = 'i', $noArray = false) |
||
| 870 | |||
| 871 | /** |
||
| 872 | * @public function getXoopsCodeObjectTree |
||
| 873 | * |
||
| 874 | * @param $tableName |
||
| 875 | * @param $fieldId |
||
| 876 | * @param $fieldParent |
||
| 877 | * |
||
| 878 | * @return string |
||
| 879 | */ |
||
| 880 | public function getXoopsCodeObjectTree($tableName, $fieldId, $fieldParent) |
||
| 886 | |||
| 887 | /** |
||
| 888 | * @public function getXoopsCodeSetVarsObjects |
||
| 889 | * |
||
| 890 | * @param $moduleDirname |
||
| 891 | * @param $tableName |
||
| 892 | * @param $fields |
||
| 893 | * |
||
| 894 | * @return string |
||
| 895 | */ |
||
| 896 | public function getXoopsCodeSetVarsObjects($moduleDirname, $tableName, $fields) |
||
| 935 | |||
| 936 | /** |
||
| 937 | * @public function getXoopsCodeSecurity |
||
| 938 | * |
||
| 939 | * @param $tableName |
||
| 940 | * |
||
| 941 | * @return string |
||
| 942 | */ |
||
| 943 | public function getXoopsCodeSecurity($tableName) |
||
| 952 | |||
| 953 | /* |
||
| 954 | * @public function getXoopsCodeInsertData |
||
| 955 | * @param $tableName |
||
| 956 | * @param $language |
||
| 957 | * @return string |
||
| 958 | */ |
||
| 959 | public function getXoopsCodeInsertData($tableName, $language) |
||
| 966 | |||
| 967 | /* |
||
| 968 | * @public function getXoopsCodeRedirectHeader |
||
| 969 | * @param $tableName |
||
| 970 | * @param $options |
||
| 971 | * @param $numb |
||
| 972 | * @param $var |
||
| 973 | * @param $isString |
||
| 974 | * |
||
| 975 | * @return string |
||
| 976 | */ |
||
| 977 | public function getXoopsCodeRedirectHeader($tableName, $options = '', $numb = '2', $var, $isString = true) |
||
| 987 | |||
| 988 | /* |
||
| 989 | * @public function getXoopsCodeXoopsConfirm |
||
| 990 | * @param $tableName |
||
| 991 | * @param $language |
||
| 992 | * @param $fieldId |
||
| 993 | * @param $fieldMain |
||
| 994 | * @param $options |
||
| 995 | * |
||
| 996 | * @return string |
||
| 997 | */ |
||
| 998 | public function getXoopsCodeXoopsConfirm($tableName, $language, $fieldId, $fieldMain, $options = 'delete') |
||
| 1006 | |||
| 1007 | /* |
||
| 1008 | * @public function getXoopsCodeAddStylesheet |
||
| 1009 | * @param $style |
||
| 1010 | * |
||
| 1011 | * @return string |
||
| 1012 | */ |
||
| 1013 | public function getXoopsCodeAddStylesheet($style = 'style') |
||
| 1017 | |||
| 1018 | /* |
||
| 1019 | * @public function getXoopsCodeSecurityCheck |
||
| 1020 | * @param null |
||
| 1021 | * @return boolean |
||
| 1022 | */ |
||
| 1023 | public function getXoopsCodeSecurityCheck() |
||
| 1027 | |||
| 1028 | /* |
||
| 1029 | * @public function getXoopsCodeSecurityErrors |
||
| 1030 | * @param null |
||
| 1031 | * @return string |
||
| 1032 | */ |
||
| 1033 | public function getXoopsCodeSecurityErrors() |
||
| 1037 | |||
| 1038 | /** |
||
| 1039 | * @public function getXoopsCodeHtmlErrors |
||
| 1040 | * |
||
| 1041 | * @param $tableName |
||
| 1042 | * @param $isParam |
||
| 1043 | * @param $obj |
||
| 1044 | * |
||
| 1045 | * @return string |
||
| 1046 | */ |
||
| 1047 | public function getXoopsCodeHtmlErrors($tableName, $isParam = false, $obj = 'Obj') |
||
| 1058 | |||
| 1059 | /** |
||
| 1060 | * @public function getXoopsCodeObjHandlerCount |
||
| 1061 | * |
||
| 1062 | * @param $left |
||
| 1063 | * @param $tableName |
||
| 1064 | * @param $obj |
||
| 1065 | * |
||
| 1066 | * @return string |
||
| 1067 | */ |
||
| 1068 | public function getXoopsCodeGetForm($left, $tableName, $obj = '') |
||
| 1074 | |||
| 1075 | /** |
||
| 1076 | * @public function getXoopsCodeGet |
||
| 1077 | * |
||
| 1078 | * @param $tableName |
||
| 1079 | * @param $var |
||
| 1080 | * @param $obj |
||
| 1081 | * @param $isHandler |
||
| 1082 | * @param $isParam |
||
| 1083 | * |
||
| 1084 | * @return string |
||
| 1085 | */ |
||
| 1086 | View Code Duplication | public function getXoopsCodeGet($tableName, $var, $obj = '', $isHandler = false, $isParam = false) |
|
| 1097 | |||
| 1098 | /** |
||
| 1099 | * @public function getXoopsCodeHandler |
||
| 1100 | * |
||
| 1101 | * @param $tableName |
||
| 1102 | * @param $var |
||
| 1103 | * @param $obj |
||
| 1104 | * @param $isHandler |
||
| 1105 | * |
||
| 1106 | * @return string |
||
| 1107 | */ |
||
| 1108 | View Code Duplication | public function getXoopsCodeInsert($tableName, $var, $obj = '', $isHandler = false) |
|
| 1119 | |||
| 1120 | /** |
||
| 1121 | * @public function getXoopsCodeDelete |
||
| 1122 | * |
||
| 1123 | * @param $tableName |
||
| 1124 | * @param $var |
||
| 1125 | * @param $obj |
||
| 1126 | * @param $isHandler |
||
| 1127 | * |
||
| 1128 | * @return string |
||
| 1129 | */ |
||
| 1130 | View Code Duplication | public function getXoopsCodeDelete($tableName, $var, $obj = '', $isHandler = false) |
|
| 1141 | |||
| 1142 | /** |
||
| 1143 | * @public function getXoopsCodeHandler |
||
| 1144 | * |
||
| 1145 | * @param $tableName |
||
| 1146 | * @param $var |
||
| 1147 | * |
||
| 1148 | * @return string |
||
| 1149 | */ |
||
| 1150 | public function getXoopsCodeHandler($tableName, $var, $get = false, $insert = false, $delete = false, $obj = '') |
||
| 1162 | |||
| 1163 | /* |
||
| 1164 | * @public function getXoopsCodeCaseDelete |
||
| 1165 | * @param $tableName |
||
| 1166 | * @param $language |
||
| 1167 | * @param $fieldId |
||
| 1168 | * @param $fieldMain |
||
| 1169 | * @return string |
||
| 1170 | */ |
||
| 1171 | public function getXoopsCodeCaseDelete($language, $tableName, $fieldId, $fieldMain) |
||
| 1196 | |||
| 1197 | /* |
||
| 1198 | * @public function getTopicGetVar |
||
| 1199 | * @param $lpFieldName |
||
| 1200 | * @param $rpFieldName |
||
| 1201 | * @param $tableName |
||
| 1202 | * @param $tableNameTopic |
||
| 1203 | * @param $fieldNameParent |
||
| 1204 | * @param $fieldNameTopic |
||
| 1205 | * @return string |
||
| 1206 | */ |
||
| 1207 | public function getTopicGetVar($lpFieldName, $rpFieldName, $tableName, $tableNameTopic, $fieldNameParent, $fieldNameTopic) |
||
| 1217 | |||
| 1218 | /* |
||
| 1219 | * @public function getUploadImageGetVar |
||
| 1220 | * @param $lpFieldName |
||
| 1221 | * @param $rpFieldName |
||
| 1222 | * @param $tableName |
||
| 1223 | * @param $fieldName |
||
| 1224 | * @return string |
||
| 1225 | */ |
||
| 1226 | public function getUploadImageGetVar($lpFieldName, $rpFieldName, $tableName, $fieldName) |
||
| 1237 | |||
| 1238 | /* |
||
| 1239 | * @public function getXoopsCodeUpdate |
||
| 1240 | * @param $language |
||
| 1241 | * @param $tableName |
||
| 1242 | * @param $fieldId |
||
| 1243 | * @param $fieldName |
||
| 1244 | * @return string |
||
| 1245 | */ |
||
| 1246 | public function getXoopsCodeUpdate($language, $tableName, $fieldId, $fieldName) |
||
| 1262 | |||
| 1263 | /** |
||
| 1264 | * @public function getXoopsCodeSaveFieldId |
||
| 1265 | * |
||
| 1266 | * @param $fields |
||
| 1267 | * |
||
| 1268 | * @return string |
||
| 1269 | */ |
||
| 1270 | View Code Duplication | public function getXoopsCodeSaveFieldId($fields) |
|
| 1280 | |||
| 1281 | /** |
||
| 1282 | * @public function getXoopsCodeSaveFieldMain |
||
| 1283 | * |
||
| 1284 | * @param $fields |
||
| 1285 | * |
||
| 1286 | * @return string |
||
| 1287 | */ |
||
| 1288 | View Code Duplication | public function getXoopsCodeSaveFieldMain($fields) |
|
| 1298 | |||
| 1299 | /** |
||
| 1300 | * @public function getXoopsCodeSaveElements |
||
| 1301 | * |
||
| 1302 | * @param $moduleDirname |
||
| 1303 | * @param $tableName |
||
| 1304 | * @param $fields |
||
| 1305 | * |
||
| 1306 | * @return string |
||
| 1307 | */ |
||
| 1308 | View Code Duplication | public function getXoopsCodeSaveElements($moduleDirname, $tableName, $fields) |
|
| 1332 | |||
| 1333 | /* |
||
| 1334 | * @public function getXoopsCodePageNav |
||
| 1335 | * @param $tableName |
||
| 1336 | * |
||
| 1337 | * @return string |
||
| 1338 | */ |
||
| 1339 | public function getXoopsCodePageNav($tableName) |
||
| 1349 | } |
||
| 1350 |
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.