ByTIC /
framework
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 AbstractForm 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 AbstractForm, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | abstract class AbstractForm |
||
| 17 | { |
||
| 18 | use MagicMethodElementsFormTrait; |
||
| 19 | |||
| 20 | const ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded'; |
||
| 21 | const ENCTYPE_MULTIPART = 'multipart/form-data'; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | protected $methods = ['delete', 'get', 'post', 'put']; |
||
| 27 | |||
| 28 | protected $_attribs = []; |
||
| 29 | protected $_options = []; |
||
| 30 | protected $_displayGroups = []; |
||
| 31 | |||
| 32 | protected $_elements = []; |
||
| 33 | protected $_elementsLabel; |
||
| 34 | protected $_elementsOrder = []; |
||
| 35 | |||
| 36 | protected $_buttons; |
||
| 37 | |||
| 38 | protected $_decorators = []; |
||
| 39 | protected $_renderer; |
||
| 40 | protected $_messages = [ |
||
| 41 | 'error' => [], |
||
| 42 | ]; |
||
| 43 | protected $_messageTemplates = []; |
||
| 44 | protected $_cache; |
||
| 45 | |||
| 46 | protected $__controllerView = false; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * AbstractForm constructor. |
||
| 50 | */ |
||
| 51 | 1 | public function __construct() |
|
| 56 | |||
| 57 | 1 | public function init() |
|
| 61 | |||
| 62 | /** |
||
| 63 | * @param $action |
||
| 64 | * @return AbstractForm |
||
| 65 | */ |
||
| 66 | 1 | public function setAction($action) |
|
| 70 | |||
| 71 | /** |
||
| 72 | * @param $key |
||
| 73 | * @param $value |
||
| 74 | * @return $this |
||
| 75 | */ |
||
| 76 | 1 | public function setAttrib($key, $value) |
|
| 83 | |||
| 84 | 1 | public function postInit() |
|
| 87 | |||
| 88 | /** |
||
| 89 | * @param $name |
||
| 90 | * @param bool $label |
||
| 91 | * @param string $type |
||
| 92 | * @param bool $isRequired |
||
| 93 | * @return $this |
||
| 94 | */ |
||
| 95 | 1 | View Code Duplication | public function add($name, $label = false, $type = 'input', $isRequired = false) |
|
|
|||
| 96 | { |
||
| 97 | 1 | $label = ($label) ? $label : ucfirst($name); |
|
| 98 | 1 | $element = $this->getNewElement($type) |
|
| 99 | 1 | ->setName($name) |
|
| 100 | 1 | ->setLabel($label) |
|
| 101 | 1 | ->setRequired($isRequired); |
|
| 102 | 1 | $this->addElement($element); |
|
| 103 | |||
| 104 | 1 | return $this; |
|
| 105 | } |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @param $type |
||
| 109 | * @return ElementAbstract |
||
| 110 | */ |
||
| 111 | 1 | public function getNewElement($type) |
|
| 117 | |||
| 118 | /** |
||
| 119 | * @param $type |
||
| 120 | * @return string |
||
| 121 | */ |
||
| 122 | 1 | public function getElementClassName($type) |
|
| 126 | |||
| 127 | /** |
||
| 128 | * @param $className |
||
| 129 | * @return ElementAbstract |
||
| 130 | */ |
||
| 131 | 1 | public function getNewElementByClass($className) |
|
| 137 | |||
| 138 | /** |
||
| 139 | * @param ElementAbstract $element |
||
| 140 | * @return ElementAbstract |
||
| 141 | */ |
||
| 142 | 1 | public function initNewElement($element) |
|
| 148 | |||
| 149 | /** |
||
| 150 | * @param ElementAbstract $element |
||
| 151 | * @return $this |
||
| 152 | */ |
||
| 153 | 1 | public function addElement(ElementAbstract $element) |
|
| 162 | |||
| 163 | /** |
||
| 164 | * @param $name |
||
| 165 | * @return ElementAbstract|null |
||
| 166 | */ |
||
| 167 | 1 | public function __get($name) |
|
| 176 | |||
| 177 | /** |
||
| 178 | * @param $name |
||
| 179 | * @return ElementAbstract |
||
| 180 | */ |
||
| 181 | 1 | public function getElement($name) |
|
| 189 | |||
| 190 | /** |
||
| 191 | * @param $className |
||
| 192 | * @param $name |
||
| 193 | * @param bool $label |
||
| 194 | * @param bool $isRequired |
||
| 195 | * @return $this |
||
| 196 | */ |
||
| 197 | View Code Duplication | public function addCustom($className, $name, $label = false, $isRequired = false) |
|
| 198 | { |
||
| 199 | $label = ($label) ? $label : ucfirst($name); |
||
| 200 | $element = $this->getNewElementByClass($className) |
||
| 201 | ->setName($name) |
||
| 202 | ->setLabel($label) |
||
| 203 | ->setRequired($isRequired); |
||
| 204 | $this->addElement($element); |
||
| 205 | |||
| 206 | return $this; |
||
| 207 | } |
||
| 208 | |||
| 209 | /** |
||
| 210 | * @param $name |
||
| 211 | * @return $this |
||
| 212 | */ |
||
| 213 | public function removeElement($name) |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Add a display group |
||
| 227 | * Groups named elements for display purposes. |
||
| 228 | * @param array $elements |
||
| 229 | * @param $name |
||
| 230 | * @return $this |
||
| 231 | */ |
||
| 232 | public function addDisplayGroup(array $elements, $name) |
||
| 254 | |||
| 255 | /** |
||
| 256 | * @return Nip_Form_DisplayGroup |
||
| 257 | */ |
||
| 258 | public function newDisplayGroup() |
||
| 265 | |||
| 266 | /** |
||
| 267 | * @return Nip_Form_DisplayGroup |
||
| 268 | */ |
||
| 269 | public function getDisplayGroup($name) |
||
| 277 | |||
| 278 | /** |
||
| 279 | * @return array |
||
| 280 | */ |
||
| 281 | public function getDisplayGroups() |
||
| 285 | |||
| 286 | /** |
||
| 287 | * @param $name |
||
| 288 | * @param bool $label |
||
| 289 | * @param string $type |
||
| 290 | * @return $this |
||
| 291 | */ |
||
| 292 | public function addButton($name, $label = false, $type = 'button') |
||
| 298 | |||
| 299 | /** |
||
| 300 | * @param $name |
||
| 301 | * @param bool $label |
||
| 302 | * @param string $type |
||
| 303 | * @return mixed |
||
| 304 | */ |
||
| 305 | protected function newButton($name, $label = false, $type = 'button') |
||
| 314 | |||
| 315 | /** |
||
| 316 | * @param $name |
||
| 317 | * @return ElementAbstract |
||
| 318 | */ |
||
| 319 | public function getButton($name) |
||
| 327 | |||
| 328 | /** |
||
| 329 | * @param $name |
||
| 330 | * @return bool |
||
| 331 | */ |
||
| 332 | public function hasElement($name) |
||
| 336 | |||
| 337 | /** |
||
| 338 | * @param $label |
||
| 339 | * @return ElementAbstract |
||
| 340 | */ |
||
| 341 | public function getElementByLabel($label) |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param $element |
||
| 352 | * @param $neighbour |
||
| 353 | * @param string $type |
||
| 354 | * @return $this |
||
| 355 | */ |
||
| 356 | public function setElementOrder($element, $neighbour, $type = 'bellow') |
||
| 379 | |||
| 380 | public function getButtons() |
||
| 384 | |||
| 385 | /** |
||
| 386 | * @param bool $params |
||
| 387 | * @return array |
||
| 388 | */ |
||
| 389 | public function findElements($params = false) |
||
| 410 | |||
| 411 | /** |
||
| 412 | * @param $key |
||
| 413 | * @param $value |
||
| 414 | * @return $this |
||
| 415 | */ |
||
| 416 | public function setOption($key, $value) |
||
| 423 | |||
| 424 | /** |
||
| 425 | * @param $key |
||
| 426 | * @return mixed|null |
||
| 427 | */ |
||
| 428 | View Code Duplication | public function getOption($key) |
|
| 437 | |||
| 438 | /** |
||
| 439 | * @return $this |
||
| 440 | */ |
||
| 441 | View Code Duplication | public function addClass() |
|
| 442 | { |
||
| 443 | $classes = func_get_args(); |
||
| 444 | if (is_array($classes)) { |
||
| 445 | $oldClasses = explode(' ', $this->getAttrib('class')); |
||
| 446 | $classes = array_merge($classes, $oldClasses); |
||
| 447 | $this->setAttrib('class', implode(' ', $classes)); |
||
| 448 | } |
||
| 449 | |||
| 450 | return $this; |
||
| 451 | } |
||
| 452 | |||
| 453 | /** |
||
| 454 | * @param $key |
||
| 455 | * @return mixed|null |
||
| 456 | */ |
||
| 457 | View Code Duplication | public function getAttrib($key) |
|
| 466 | |||
| 467 | /** |
||
| 468 | * @return $this |
||
| 469 | */ |
||
| 470 | View Code Duplication | public function removeClass() |
|
| 471 | { |
||
| 472 | $removeClasses = func_get_args(); |
||
| 473 | if (is_array($removeClasses)) { |
||
| 474 | $classes = explode(' ', $this->getAttrib('class')); |
||
| 475 | foreach ($removeClasses as $class) { |
||
| 476 | $key = array_search($class, $classes); |
||
| 477 | if ($key !== false) { |
||
| 478 | unset($classes[$key]); |
||
| 479 | } |
||
| 480 | } |
||
| 481 | $this->setAttrib('class', implode(' ', $classes)); |
||
| 482 | } |
||
| 483 | |||
| 484 | return $this; |
||
| 485 | } |
||
| 486 | |||
| 487 | /** |
||
| 488 | * @param $class |
||
| 489 | * @return bool |
||
| 490 | */ |
||
| 491 | public function hasClass($class) |
||
| 495 | |||
| 496 | /** |
||
| 497 | * @return array |
||
| 498 | */ |
||
| 499 | public function getAttribs() |
||
| 503 | |||
| 504 | /** |
||
| 505 | * @param array $attribs |
||
| 506 | * @return $this |
||
| 507 | */ |
||
| 508 | public function setAttribs(array $attribs) |
||
| 514 | |||
| 515 | /** |
||
| 516 | * @return $this |
||
| 517 | */ |
||
| 518 | public function clearAttribs() |
||
| 524 | |||
| 525 | /** |
||
| 526 | * @param array $attribs |
||
| 527 | * @return $this |
||
| 528 | */ |
||
| 529 | public function addAttribs(array $attribs) |
||
| 537 | |||
| 538 | /** |
||
| 539 | * @param $key |
||
| 540 | * @return bool |
||
| 541 | */ |
||
| 542 | View Code Duplication | public function removeAttrib($key) |
|
| 543 | { |
||
| 544 | if (isset($this->_attribs[$key])) { |
||
| 545 | unset($this->_attribs[$key]); |
||
| 546 | |||
| 547 | return true; |
||
| 548 | } |
||
| 549 | |||
| 550 | return false; |
||
| 551 | } |
||
| 552 | |||
| 553 | /** |
||
| 554 | * @param $method |
||
| 555 | * @return AbstractForm |
||
| 556 | */ |
||
| 557 | public function setMethod($method) |
||
| 564 | |||
| 565 | /** |
||
| 566 | * @return bool |
||
| 567 | */ |
||
| 568 | public function execute() |
||
| 576 | |||
| 577 | /** |
||
| 578 | * @return bool |
||
| 579 | */ |
||
| 580 | public function submited() |
||
| 589 | |||
| 590 | /** |
||
| 591 | * @return bool |
||
| 592 | */ |
||
| 593 | public function processRequest() |
||
| 603 | |||
| 604 | /** |
||
| 605 | * @return bool |
||
| 606 | */ |
||
| 607 | public function validate() |
||
| 615 | |||
| 616 | /** |
||
| 617 | * @param $request |
||
| 618 | */ |
||
| 619 | protected function getDataFromRequest($request) |
||
| 645 | |||
| 646 | /** |
||
| 647 | * @return array |
||
| 648 | */ |
||
| 649 | public function getElements() |
||
| 658 | |||
| 659 | public function processValidation() |
||
| 668 | |||
| 669 | /** |
||
| 670 | * @return bool |
||
| 671 | */ |
||
| 672 | public function isValid() |
||
| 676 | |||
| 677 | /** |
||
| 678 | * @return array |
||
| 679 | */ |
||
| 680 | public function getErrors() |
||
| 686 | |||
| 687 | /** |
||
| 688 | * @param string $type |
||
| 689 | * @return mixed |
||
| 690 | */ |
||
| 691 | public function getMessagesType($type = 'error') |
||
| 695 | |||
| 696 | /** |
||
| 697 | * @return array |
||
| 698 | */ |
||
| 699 | View Code Duplication | public function getElementsErrors() |
|
| 700 | { |
||
| 701 | $elements = $this->getElements(); |
||
| 702 | $errors = []; |
||
| 703 | if (is_array($elements)) { |
||
| 704 | foreach ($elements as $name => $element) { |
||
| 705 | $errors = array_merge($errors, $element->getErrors()); |
||
| 706 | } |
||
| 707 | } |
||
| 708 | |||
| 709 | return $errors; |
||
| 710 | } |
||
| 711 | |||
| 712 | public function process() |
||
| 715 | |||
| 716 | /** |
||
| 717 | * @param $message |
||
| 718 | * @return $this |
||
| 719 | */ |
||
| 720 | public function addError($message) |
||
| 726 | |||
| 727 | /** |
||
| 728 | * @param $message |
||
| 729 | * @param string $type |
||
| 730 | * @return $this |
||
| 731 | */ |
||
| 732 | public function addMessage($message, $type = 'error') |
||
| 738 | |||
| 739 | /** |
||
| 740 | * @return array |
||
| 741 | */ |
||
| 742 | public function getMessages() |
||
| 749 | |||
| 750 | /** |
||
| 751 | * @param $name |
||
| 752 | * @return mixed |
||
| 753 | */ |
||
| 754 | public function getMessageTemplate($name) |
||
| 758 | |||
| 759 | |||
| 760 | /** |
||
| 761 | * @param $type |
||
| 762 | * @return $this |
||
| 763 | */ |
||
| 764 | public function setRendererType($type) |
||
| 770 | |||
| 771 | /** |
||
| 772 | * @param string $type |
||
| 773 | * @return AbstractRenderer |
||
| 774 | */ |
||
| 775 | public function getNewRenderer($type = 'basic') |
||
| 784 | |||
| 785 | /** |
||
| 786 | * @param $key |
||
| 787 | * @return mixed |
||
| 788 | */ |
||
| 789 | 1 | public function getCache($key) |
|
| 793 | |||
| 794 | /** |
||
| 795 | * @param $key |
||
| 796 | * @param $value |
||
| 797 | */ |
||
| 798 | 1 | public function setCache($key, $value) |
|
| 802 | |||
| 803 | /** |
||
| 804 | * @param $key |
||
| 805 | * @return bool |
||
| 806 | */ |
||
| 807 | public function isCache($key) |
||
| 811 | |||
| 812 | /** |
||
| 813 | * @return string |
||
| 814 | */ |
||
| 815 | public function getName() |
||
| 819 | |||
| 820 | /** |
||
| 821 | * @return null |
||
| 822 | */ |
||
| 823 | public function __toString() |
||
| 833 | |||
| 834 | /** |
||
| 835 | * @return string |
||
| 836 | */ |
||
| 837 | public function render() |
||
| 841 | |||
| 842 | /** |
||
| 843 | * @return AbstractRenderer |
||
| 844 | */ |
||
| 845 | public function getRenderer() |
||
| 853 | |||
| 854 | /** |
||
| 855 | * @return View|null |
||
| 856 | */ |
||
| 857 | public function getControllerView() |
||
| 865 | |||
| 866 | /** |
||
| 867 | * @return array |
||
| 868 | */ |
||
| 869 | View Code Duplication | protected function getData() |
|
| 870 | { |
||
| 871 | $data = []; |
||
| 881 | |||
| 882 | } |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.