XOOPS /
XoopsCore
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:
| 1 | <?php |
||
| 24 | class ElementTray extends Element implements ContainerInterface |
||
| 25 | { |
||
| 26 | /** |
||
| 27 | * array of form element objects |
||
| 28 | * |
||
| 29 | * @var Element[] |
||
| 30 | */ |
||
| 31 | protected $elements = array(); |
||
| 32 | |||
| 33 | /** |
||
| 34 | * __construct |
||
| 35 | * |
||
| 36 | * @param string|array $caption caption or array of all attributes |
||
| 37 | * Control attributes: |
||
| 38 | * :joiner joiner for elements in tray |
||
| 39 | * @param string $joiner joiner for elements in tray |
||
| 40 | * @param string $name name |
||
| 41 | */ |
||
| 42 | 1 | View Code Duplication | public function __construct($caption, $joiner = ' ', $name = '') |
| 43 | { |
||
| 44 | 1 | if (is_array($caption)) { |
|
| 45 | parent::__construct($caption); |
||
| 46 | $this->setIfNotSet(':joiner', ' '); |
||
| 47 | } else { |
||
| 48 | 1 | parent::__construct(); |
|
| 49 | 1 | $this->setName($name); |
|
| 50 | 1 | $this->setCaption($caption); |
|
| 51 | 1 | $this->set(':joiner', $joiner); |
|
| 52 | } |
||
| 53 | 1 | } |
|
| 54 | |||
| 55 | /** |
||
| 56 | * Are there are required elements? |
||
| 57 | * |
||
| 58 | * @return bool |
||
| 59 | */ |
||
| 60 | 2 | public function isRequired() |
|
| 61 | { |
||
| 62 | 2 | foreach ($this->elements as $el) { |
|
| 63 | 2 | if ($el->isRequired()) { |
|
| 64 | 2 | return true; |
|
| 65 | } |
||
| 66 | } |
||
| 67 | 2 | return false; |
|
| 68 | } |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Add an element to the tray |
||
| 72 | * |
||
| 73 | * @param Element $formElement Element to add |
||
| 74 | * @param boolean $required true = entry required |
||
| 75 | * |
||
| 76 | * @return void |
||
| 77 | */ |
||
| 78 | 1 | public function addElement(Element $formElement, $required = false) |
|
| 79 | { |
||
| 80 | 1 | $this->elements[] = $formElement; |
|
| 81 | 1 | if ($required) { |
|
| 82 | $formElement->setRequired(); |
||
| 83 | } |
||
| 84 | 1 | } |
|
| 85 | |||
| 86 | // ContainerInterface |
||
| 87 | /** |
||
| 88 | * get an array of "required" form elements |
||
| 89 | * |
||
| 90 | * @return array array of Element objects |
||
| 91 | */ |
||
| 92 | View Code Duplication | public function getRequired() |
|
| 93 | { |
||
| 94 | $required = []; |
||
| 95 | foreach ($this->elements as $el) { |
||
| 96 | if ($el->isRequired()) { |
||
| 97 | $required[] = $el; |
||
| 98 | } |
||
| 99 | } |
||
| 100 | return $required; |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Get an array of the elements in this group |
||
| 105 | * |
||
| 106 | * @param bool $recurse get elements recursively? |
||
| 107 | * |
||
| 108 | * @return array Array of Element objects. |
||
| 109 | */ |
||
| 110 | 1 | View Code Duplication | public function getElements($recurse = false) |
| 111 | { |
||
| 112 | 1 | if (!$recurse) { |
|
| 113 | 1 | return $this->elements; |
|
| 114 | } else { |
||
| 115 | 1 | $ret = array(); |
|
| 116 | 1 | foreach ($this->elements as $ele) { |
|
| 117 | 1 | if ($ele instanceof ContainerInterface) { |
|
| 118 | /* @var ContainerInterface $ele */ |
||
| 119 | $elements = $ele->getElements(true); |
||
| 120 | foreach ($elements as $ele2) { |
||
| 121 | $ret[] = $ele2; |
||
| 122 | } |
||
| 123 | unset($elements); |
||
| 124 | unset($ele2); |
||
| 125 | } else { |
||
| 126 | 1 | $ret[] = $ele; |
|
| 127 | } |
||
| 128 | 1 | unset($ele); |
|
| 129 | } |
||
| 130 | 1 | return $ret; |
|
| 131 | } |
||
| 132 | } |
||
| 133 | |||
| 134 | /** |
||
| 135 | * Get the delimiter of this group |
||
| 136 | * |
||
| 137 | * @param boolean $encode True to encode special characters |
||
| 138 | * |
||
| 139 | * @return string The delimiter |
||
| 140 | */ |
||
| 141 | 1 | protected function getJoiner($encode = false) |
|
| 146 | |||
| 147 | /** |
||
| 148 | * prepare HTML to output this group |
||
| 149 | * |
||
| 150 | * @return string HTML output |
||
| 151 | */ |
||
| 152 | 5 | public function render() |
|
| 174 | } |
||
| 175 |
