Complex classes like ClassFormElements 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 ClassFormElements, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class ClassFormElements extends TDMCreateFile |
||
|
|
|||
| 29 | { |
||
| 30 | /* |
||
| 31 | * @public function constructor |
||
| 32 | * @param null |
||
| 33 | */ |
||
| 34 | /** |
||
| 35 | * |
||
| 36 | */ |
||
| 37 | public function __construct() |
||
| 42 | |||
| 43 | /* |
||
| 44 | * @static function &getInstance |
||
| 45 | * @param null |
||
| 46 | */ |
||
| 47 | /** |
||
| 48 | * @return ClassFormElements |
||
| 49 | */ |
||
| 50 | public static function &getInstance() |
||
| 59 | |||
| 60 | /* |
||
| 61 | * @public function initForm |
||
| 62 | * @param string $module |
||
| 63 | * @param string $table |
||
| 64 | */ |
||
| 65 | /** |
||
| 66 | * @param $module |
||
| 67 | * @param $table |
||
| 68 | */ |
||
| 69 | public function initForm($module, $table) |
||
| 74 | |||
| 75 | /* |
||
| 76 | * @private function getXoopsFormText |
||
| 77 | * @param string $language |
||
| 78 | * @param string $fieldName |
||
| 79 | * @param string $required |
||
| 80 | */ |
||
| 81 | /** |
||
| 82 | * @param $language |
||
| 83 | * @param $fieldName |
||
| 84 | * @param $required |
||
| 85 | * |
||
| 86 | * @return string |
||
| 87 | */ |
||
| 88 | private function getXoopsFormText($language, $fieldName, $fieldDefault, $required = 'false') |
||
| 107 | |||
| 108 | /* |
||
| 109 | * @private function getXoopsFormText |
||
| 110 | * @param string $language |
||
| 111 | * @param string $fieldName |
||
| 112 | * @param string $required |
||
| 113 | */ |
||
| 114 | /** |
||
| 115 | * @param $language |
||
| 116 | * @param $fieldName |
||
| 117 | * @param string $required |
||
| 118 | * |
||
| 119 | * @return string |
||
| 120 | */ |
||
| 121 | private function getXoopsFormTextArea($language, $fieldName, $required = 'false') |
||
| 130 | |||
| 131 | /* |
||
| 132 | * @private function getXoopsFormDhtmlTextArea |
||
| 133 | * @param string $language |
||
| 134 | * @param string $moduleDirname |
||
| 135 | * @param string $fieldName |
||
| 136 | * @param string $required |
||
| 137 | */ |
||
| 138 | /** |
||
| 139 | * @param $language |
||
| 140 | * @param $moduleDirname |
||
| 141 | * @param $fieldName |
||
| 142 | * @param string $required |
||
| 143 | * |
||
| 144 | * @return string |
||
| 145 | */ |
||
| 146 | private function getXoopsFormDhtmlTextArea($language, $moduleDirname, $fieldName, $required = 'false') |
||
| 164 | |||
| 165 | /* |
||
| 166 | * @private function getXoopsFormCheckBox |
||
| 167 | * @param string $language |
||
| 168 | * @param string $fieldName |
||
| 169 | * @param string $required |
||
| 170 | */ |
||
| 171 | /** |
||
| 172 | * @param $language |
||
| 173 | * @param $fieldName |
||
| 174 | * @param string $required |
||
| 175 | * |
||
| 176 | * @return string |
||
| 177 | */ |
||
| 178 | private function getXoopsFormCheckBox($language, $tableSoleName, $fieldName, $fieldElementId, $required = 'false') |
||
| 206 | |||
| 207 | /* |
||
| 208 | * @private function getXoopsFormHidden |
||
| 209 | * @param string $fieldName |
||
| 210 | */ |
||
| 211 | /** |
||
| 212 | * @param $fieldName |
||
| 213 | * |
||
| 214 | * @return string |
||
| 215 | */ |
||
| 216 | private function getXoopsFormHidden($fieldName) |
||
| 225 | |||
| 226 | /* |
||
| 227 | * @private function getXoopsFormImageList |
||
| 228 | * @param string $language |
||
| 229 | * @param string $moduleDirname |
||
| 230 | * @param string $tableName |
||
| 231 | * @param string $fieldName |
||
| 232 | * @param string $required |
||
| 233 | */ |
||
| 234 | /** |
||
| 235 | * @param $language |
||
| 236 | * @param $moduleDirname |
||
| 237 | * @param $tableName |
||
| 238 | * @param $tableSoleName |
||
| 239 | * @param $fieldName |
||
| 240 | * @param string $required |
||
| 241 | * |
||
| 242 | * @return string |
||
| 243 | */ |
||
| 244 | private function getXoopsFormImageList($language, $moduleDirname, $tableName, $tableSoleName, $fieldName, $required = 'false') |
||
| 245 | { |
||
| 246 | $stuTableName = strtoupper($tableName); |
||
| 247 | $rpFieldName = $this->getRightString($fieldName); |
||
| 248 | $stuSoleName = strtoupper($tableSoleName.'_'.$rpFieldName); |
||
| 249 | $ucfFieldName = $this->getCamelCase($fieldName, true); |
||
| 250 | $ccFieldName = $this->getCamelCase($fieldName, false, true); |
||
| 251 | $ret = <<<EOT |
||
| 252 | // Form Frameworks Image Files |
||
| 253 | \$get{$ucfFieldName} = \$this->getVar('{$fieldName}'); |
||
| 254 | \${$ccFieldName} = \$get{$ucfFieldName} ? \$get{$ucfFieldName} : 'blank.gif'; |
||
| 255 | \$imageDirectory = '/Frameworks/moduleclasses/icons/32'; |
||
| 256 | \$imageTray = new XoopsFormElementTray({$language}{$stuSoleName},'<br />'); |
||
| 257 | \$imageSelect = new XoopsFormSelect(sprintf({$language}FORM_IMAGE_PATH, ".{\$imageDirectory}/"), '{$fieldName}', \${$ccFieldName}, 5); |
||
| 258 | \$imageArray = XoopsLists::getImgListAsArray( XOOPS_ROOT_PATH . \$imageDirectory ); |
||
| 259 | foreach( \$imageArray as \$image1 ) { |
||
| 260 | \$imageSelect->addOption("{\$image1}", \$image1); |
||
| 261 | } |
||
| 262 | \$imageSelect->setExtra( "onchange='showImgSelected(\"image1\", \"{$fieldName}\", \"".\$imageDirectory."\", \"\", \"".XOOPS_URL."\")'" ); |
||
| 263 | \$imageTray->addElement(\$imageSelect, false); |
||
| 264 | \$imageTray->addElement( new XoopsFormLabel( '', "<br /><img src='".XOOPS_URL."/".\$imageDirectory."/".\${$ccFieldName}."' name='image1' id='image1' alt='' />" ) ); |
||
| 265 | // Form File |
||
| 266 | \$fileSelectTray = new XoopsFormElementTray('','<br />'); |
||
| 267 | \$fileSelectTray->addElement(new XoopsFormFile({$language}FORM_IMAGE_LIST_{$stuTableName} , 'attachedfile', \$this->{$moduleDirname}->getConfig('maxsize'))); |
||
| 268 | \$fileSelectTray->addElement(new XoopsFormLabel('')); |
||
| 269 | \$imageTray->addElement(\$fileSelectTray); |
||
| 270 | \$form->addElement( \$imageTray{$required} );\n |
||
| 271 | EOT; |
||
| 272 | |||
| 273 | return $ret; |
||
| 274 | } |
||
| 275 | |||
| 276 | /* |
||
| 277 | * @private function getXoopsFormSelectFile |
||
| 278 | * @param string $language |
||
| 279 | * @param string $moduleDirname |
||
| 280 | * @param string $fieldName |
||
| 281 | * @param string $fieldDefault |
||
| 282 | * @param string $fieldElement |
||
| 283 | * @param string $required |
||
| 284 | */ |
||
| 285 | /** |
||
| 286 | * @param $language |
||
| 287 | * @param $moduleDirname |
||
| 288 | * @param $fieldName |
||
| 289 | * @param string $required |
||
| 290 | * |
||
| 291 | * @return string |
||
| 292 | */ |
||
| 293 | private function getXoopsFormSelectFile($language, $moduleDirname, $fieldName, $required = 'false') |
||
| 294 | { |
||
| 295 | $ucfFieldName = $this->getCamelCase($fieldName, true); |
||
| 296 | $ccFieldName = $this->getCamelCase($fieldName, false, true); |
||
| 297 | $ret = <<<EOT |
||
| 298 | // Image Select or Upload |
||
| 299 | if ( \$this->{$moduleDirname}->getConfig('useshots') ) { |
||
| 300 | \${$ccFieldName} = \$this->getVar('{$fieldName}'); |
||
| 301 | \$uploadDirectory = '/uploads/{$moduleDirname}/images/shots'; |
||
| 302 | \${$moduleDirname}ShotImage = \${$fieldName} ? \${$fieldName} : 'blank.gif'; |
||
| 303 | // |
||
| 304 | \$imageTray = new XoopsFormElementTray({$language}FORM_IMAGE,'<br />'); |
||
| 305 | \$imageSelect = new XoopsFormSelect(sprintf({$language}_FORM_PATH, \$uploadDirectory ), 'selected_image',\${$moduleDirname}ShotImage); |
||
| 306 | \$imageArray = XoopsLists::getImgListAsArray( XOOPS_ROOT_PATH . \$uploadDirectory ); |
||
| 307 | foreach( \$imageArray as \$image ) { |
||
| 308 | \$imageSelect->addOption("{\$image}", \$image); |
||
| 309 | } |
||
| 310 | \$imageSelect->setExtra( "onchange='showImgSelected(\"image3\", \"selected_image\", \"" . \$uploadDirectory . "\", \"\", \"" . XOOPS_URL . "\")'" ); |
||
| 311 | \$imageTray->addElement(\$imageSelect,false); |
||
| 312 | \$imageTray -> addElement( new XoopsFormLabel( '', "<br /><img src='" . XOOPS_URL . "/" . \$uploadDirectory . "/" . \${$moduleDirname}ShotImage . "' name='image3' id='image3' alt='' />" ) ); |
||
| 313 | \$fileSelectTray= new XoopsFormElementTray('','<br />'); |
||
| 314 | //if (\$permissionUpload == true) { |
||
| 315 | \$fileSelectTray->addElement(new XoopsFormFile({$language}_FORM_UPLOAD , 'attachedimage', \$this->{$moduleDirname}->getConfig('maxuploadsize')){$required}); |
||
| 316 | //} |
||
| 317 | \$imageTray->addElement(\$fileSelectTray); |
||
| 318 | \$form->addElement(\$imageTray); |
||
| 319 | }\n |
||
| 320 | EOT; |
||
| 321 | |||
| 322 | return $ret; |
||
| 323 | } |
||
| 324 | |||
| 325 | /* |
||
| 326 | * @private function getXoopsFormUrlFile |
||
| 327 | * @param string $language |
||
| 328 | * @param string $moduleDirname |
||
| 329 | * @param string $fieldName |
||
| 330 | * @param string $fieldDefault |
||
| 331 | * @param string $fieldElement |
||
| 332 | * @param string $required |
||
| 333 | */ |
||
| 334 | /** |
||
| 335 | * @param $language |
||
| 336 | * @param $moduleDirname |
||
| 337 | * @param $fieldName |
||
| 338 | * @param $fieldDefault |
||
| 339 | * @param $fieldElement |
||
| 340 | * @param string $required |
||
| 341 | * |
||
| 342 | * @return string |
||
| 343 | */ |
||
| 344 | private function getXoopsFormUrlFile($language, $moduleDirname, $fieldName, $fieldDefault, $fieldElement, $required = 'false') |
||
| 358 | |||
| 359 | /* |
||
| 360 | * @private function getXoopsFormUploadImage |
||
| 361 | * @param string $language |
||
| 362 | * @param string $moduleDirname |
||
| 363 | * @param string $tableName |
||
| 364 | * @param string $required |
||
| 365 | */ |
||
| 366 | /** |
||
| 367 | * @param $language |
||
| 368 | * @param $moduleDirname |
||
| 369 | * @param $tableName |
||
| 370 | * @param string $required |
||
| 371 | * |
||
| 372 | * @return string |
||
| 373 | */ |
||
| 374 | private function getXoopsFormUploadImage($language, $moduleDirname, $tableName, $tableSoleName, $fieldName, $required = 'false') |
||
| 375 | { |
||
| 376 | $stuTableName = strtoupper($tableName); |
||
| 377 | $stuSoleName = strtoupper($tableSoleName); |
||
| 378 | $ucfFieldName = $this->getCamelCase($fieldName, true); |
||
| 379 | $ccFieldName = $this->getCamelCase($fieldName, false, true); |
||
| 380 | $ret = <<<EOT |
||
| 381 | // Form Upload Image |
||
| 382 | \$get{$ucfFieldName} = \$this->getVar('{$fieldName}'); |
||
| 383 | \${$ccFieldName} = \$get{$ucfFieldName} ? \$get{$ucfFieldName} : 'blank.gif'; |
||
| 384 | \$imageDirectory = '/uploads/{$moduleDirname}/images/{$tableName}'; |
||
| 385 | // |
||
| 386 | \$imageTray = new XoopsFormElementTray({$language}{$stuSoleName}_IMAGE,'<br />'); |
||
| 387 | \$imageSelect = new XoopsFormSelect(sprintf({$language}FORM_IMAGE_PATH, ".{\$imageDirectory}/"), '{$fieldName}', \${$ccFieldName}, 5); |
||
| 388 | \$imageArray = XoopsLists::getImgListAsArray( XOOPS_ROOT_PATH . \$imageDirectory ); |
||
| 389 | foreach( \$imageArray as \$image ) { |
||
| 390 | \$imageSelect->addOption("{\$image}", \$image); |
||
| 391 | } |
||
| 392 | \$imageSelect->setExtra( "onchange='showImgSelected(\"image2\", \"{$fieldName}\", \"".\$imageDirectory."\", \"\", \"".XOOPS_URL."\")'" ); |
||
| 393 | \$imageTray->addElement(\$imageSelect, false); |
||
| 394 | \$imageTray->addElement( new XoopsFormLabel( '', "<br /><img src='".XOOPS_URL."/".\$imageDirectory."/".\${$ccFieldName}."' name='image2' id='image2' alt='' />" ) ); |
||
| 395 | // Form File |
||
| 396 | \$fileSelectTray = new XoopsFormElementTray('','<br />'); |
||
| 397 | \$fileSelectTray->addElement(new XoopsFormFile({$language}FORM_UPLOAD_IMAGE_{$stuTableName} , 'attachedfile', \$this->{$moduleDirname}->getConfig('maxsize'))); |
||
| 398 | \$fileSelectTray->addElement(new XoopsFormLabel('')); |
||
| 399 | \$imageTray->addElement(\$fileSelectTray); |
||
| 400 | \$form->addElement( \$imageTray{$required} );\n |
||
| 401 | EOT; |
||
| 402 | |||
| 403 | return $ret; |
||
| 404 | } |
||
| 405 | |||
| 406 | /* |
||
| 407 | * @private function getXoopsFormUploadFile |
||
| 408 | * @param string $language |
||
| 409 | * @param string $moduleDirname |
||
| 410 | * @param string $tableName |
||
| 411 | * @param string $fieldName |
||
| 412 | * @param string $required |
||
| 413 | */ |
||
| 414 | /** |
||
| 415 | * @param $language |
||
| 416 | * @param $moduleDirname |
||
| 417 | * @param $tableName |
||
| 418 | * @param $fieldName |
||
| 419 | * @param string $required |
||
| 420 | * |
||
| 421 | * @return string |
||
| 422 | */ |
||
| 423 | private function getXoopsFormUploadFile($language, $moduleDirname, $tableName, $fieldName, $required = 'false') |
||
| 433 | |||
| 434 | /* |
||
| 435 | * @private function getXoopsFormColorPicker |
||
| 436 | * @param string $language |
||
| 437 | * @param string $fieldName |
||
| 438 | * @param string $required |
||
| 439 | */ |
||
| 440 | /** |
||
| 441 | * @param $language |
||
| 442 | * @param $moduleDirname |
||
| 443 | * @param $fieldName |
||
| 444 | * @param string $required |
||
| 445 | * |
||
| 446 | * @return string |
||
| 447 | */ |
||
| 448 | private function getXoopsFormColorPicker($language, $moduleDirname, $fieldName, $required = 'false') |
||
| 457 | |||
| 458 | /* |
||
| 459 | * @private function getXoopsFormSelectBox |
||
| 460 | * @param string $language |
||
| 461 | * @param string $tableName |
||
| 462 | * @param string $fieldName |
||
| 463 | * @param string $required |
||
| 464 | */ |
||
| 465 | /** |
||
| 466 | * @param $language |
||
| 467 | * @param $moduleDirname |
||
| 468 | * @param $tableName |
||
| 469 | * @param $fieldName |
||
| 470 | * @param $required |
||
| 471 | * |
||
| 472 | * @return string |
||
| 473 | */ |
||
| 474 | private function getXoopsFormSelectBox($language, $moduleDirname, $tableName, $fieldName, $required = 'false') |
||
| 475 | { |
||
| 476 | $ucfTableName = ucfirst($tableName); |
||
| 477 | $ccFieldName = $this->getCamelCase($fieldName, false, true); |
||
| 478 | $ret = <<<EOT |
||
| 479 | // {$ucfTableName} handler |
||
| 480 | \${$tableName}Handler =& \$this->{$moduleDirname}->getHandler('{$tableName}'); |
||
| 481 | // Form Select |
||
| 482 | \${$ccFieldName}Select = new XoopsFormSelect({$language}, '{$fieldName}', \$this->getVar('{$fieldName}')); |
||
| 483 | \${$ccFieldName}Select->addOption('Empty'); |
||
| 484 | \${$ccFieldName}Select->addOptionArray(\${$tableName}Handler->getList()); |
||
| 485 | \$form->addElement( \${$ccFieldName}Select{$required} );\n |
||
| 486 | EOT; |
||
| 487 | |||
| 488 | return $ret; |
||
| 489 | } |
||
| 490 | |||
| 491 | /* |
||
| 492 | * @private function getXoopsFormSelectUser |
||
| 493 | * @param string $language |
||
| 494 | * @param string $fieldName |
||
| 495 | * @param string $required |
||
| 496 | */ |
||
| 497 | /** |
||
| 498 | * @param $language |
||
| 499 | * @param $fieldName |
||
| 500 | * @param string $required |
||
| 501 | * |
||
| 502 | * @return string |
||
| 503 | */ |
||
| 504 | private function getXoopsFormSelectUser($language, $fieldName, $required = 'false') |
||
| 513 | |||
| 514 | /* |
||
| 515 | * @private function getXoopsFormRadioYN |
||
| 516 | * @param string $language |
||
| 517 | * @param string $fieldName |
||
| 518 | * @param string $required |
||
| 519 | */ |
||
| 520 | /** |
||
| 521 | * @param $language |
||
| 522 | * @param $fieldName |
||
| 523 | * @param string $required |
||
| 524 | * |
||
| 525 | * @return string |
||
| 526 | */ |
||
| 527 | private function getXoopsFormRadioYN($language, $fieldName, $required = 'false') |
||
| 538 | |||
| 539 | /* |
||
| 540 | * @private function getXoopsFormTextDateSelect |
||
| 541 | * @param string $language |
||
| 542 | * @param string $fieldName |
||
| 543 | * @param string $required |
||
| 544 | */ |
||
| 545 | /** |
||
| 546 | * @param $language |
||
| 547 | * @param $fieldName |
||
| 548 | * @param string $required |
||
| 549 | * |
||
| 550 | * @return string |
||
| 551 | */ |
||
| 552 | private function getXoopsFormTextDateSelect($language, $fieldName, $required = 'false') |
||
| 561 | |||
| 562 | /* |
||
| 563 | * @private function getXoopsFormTable |
||
| 564 | * @param string $language |
||
| 565 | * @param string $moduleDirname |
||
| 566 | * @param string $table |
||
| 567 | * @param string $fields |
||
| 568 | * @param string $required |
||
| 569 | */ |
||
| 570 | /** |
||
| 571 | * @param $language |
||
| 572 | * @param $moduleDirname |
||
| 573 | * @param $tableName |
||
| 574 | * @param $fieldName |
||
| 575 | * @param $fieldElement |
||
| 576 | * @param string $required |
||
| 577 | * |
||
| 578 | * @return string |
||
| 579 | */ |
||
| 580 | private function getXoopsFormTable($language, $moduleDirname, $tableName, $fieldName, $fieldElement, $required = 'false') |
||
| 598 | |||
| 599 | /* |
||
| 600 | * @private function getXoopsFormTopic |
||
| 601 | * @param string $language |
||
| 602 | * @param string $moduleDirname |
||
| 603 | * @param string $table |
||
| 604 | * @param string $fields |
||
| 605 | * @param string $required |
||
| 606 | */ |
||
| 607 | /** |
||
| 608 | * @param $language |
||
| 609 | * @param $moduleDirname |
||
| 610 | * @param $table |
||
| 611 | * @param $fields |
||
| 612 | * @param string $required |
||
| 613 | * |
||
| 614 | * @return string |
||
| 615 | */ |
||
| 616 | private function getXoopsFormTopic($language, $moduleDirname, $topicTableName, $fieldId, $fieldPid, $fieldMain, $required = 'false') |
||
| 638 | |||
| 639 | /* |
||
| 640 | * @private function getXoopsFormTag |
||
| 641 | * @param string $moduleDirname |
||
| 642 | * @param string $fieldId |
||
| 643 | * @param string $required |
||
| 644 | */ |
||
| 645 | /** |
||
| 646 | * @param $moduleDirname |
||
| 647 | * @param $fieldId |
||
| 648 | * @param string $required |
||
| 649 | * |
||
| 650 | * @return string |
||
| 651 | */ |
||
| 652 | private function getXoopsFormTag($moduleDirname, $fieldId, $required = 'false') |
||
| 666 | |||
| 667 | /* |
||
| 668 | * @public function renderElements |
||
| 669 | * @param null |
||
| 670 | */ |
||
| 671 | /** |
||
| 672 | * @return string |
||
| 673 | */ |
||
| 674 | public function renderElements() |
||
| 796 | } |
||
| 797 |
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.