Stefanius67 /
Formgenerator
| Total Complexity | 63 |
| Total Lines | 417 |
| Duplicated Lines | 0 % |
| Changes | 3 | ||
| Bugs | 0 | Features | 1 |
Complex classes like FormInput 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.
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 FormInput, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class FormInput extends FormElement |
||
| 15 | { |
||
| 16 | /** @var string value input type */ |
||
| 17 | protected string $strType = ''; |
||
| 18 | /** @var int|string size as number or as string including dimension ('%', 'px', 'em') */ |
||
| 19 | protected $size = 0; |
||
| 20 | /** @var string image displayed, if selectbutton is enabled */ |
||
| 21 | protected string $strSelectImg = ''; |
||
| 22 | /** @var string tooltip for selectbutton */ |
||
| 23 | protected string $strSelectImgTitle = ''; |
||
| 24 | /** @var string folder to expand when call the filemanager */ |
||
| 25 | protected string $strExpandFolder = ''; |
||
| 26 | /** @var string suffix directly after the element */ |
||
| 27 | protected string $strSuffix = ''; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Create a simple input element. |
||
| 31 | * @see FormFlags |
||
| 32 | * @param string $strName Name (if no ID specified, name is used also as ID) |
||
| 33 | * @param int|string $size integer value set the size-attribute, a string is used for the width attribute |
||
| 34 | * @param int $wFlags any combination of FormFlag constants |
||
| 35 | * @param int $iMaxLength max. input character count |
||
| 36 | */ |
||
| 37 | public function __construct(string $strName, $size, int $wFlags = 0, int $iMaxLength = 0) |
||
| 38 | { |
||
| 39 | parent::__construct($wFlags); |
||
| 40 | $this->strName = $strName; |
||
| 41 | $this->size = $size; |
||
| 42 | $this->strType = 'text'; |
||
| 43 | $this->strSelectImg = ''; |
||
| 44 | $this->strSelectImgTitle = ''; |
||
| 45 | $this->strSuffix = ''; |
||
| 46 | |||
| 47 | $this->addFlags($wFlags); |
||
| 48 | if ($iMaxLength > 0) { |
||
| 49 | $this->addAttribute('maxlength', (string)$iMaxLength); |
||
| 50 | } |
||
| 51 | } |
||
| 52 | |||
| 53 | /** |
||
| 54 | * {@inheritDoc} |
||
| 55 | * @see \SKien\Formgenerator\FormElement::fromXML() |
||
| 56 | * @internal |
||
| 57 | */ |
||
| 58 | static public function fromXML(\DOMElement $oXMLElement, FormCollection $oFormParent) : ?FormElement |
||
| 59 | { |
||
| 60 | /* only while development |
||
| 61 | if ($oXMLElement->nodeName !== 'Input') { |
||
| 62 | trigger_error('Try to create Form' . $oXMLElement->nodeName . ' - Element from XML without defined method!', E_USER_ERROR); |
||
| 63 | } |
||
| 64 | */ |
||
| 65 | $strName = self::getAttribString($oXMLElement, 'name'); |
||
| 66 | $strSize = self::getAttribString($oXMLElement, 'size'); |
||
| 67 | $wFlags = self::getAttribFlags($oXMLElement); |
||
| 68 | $oFormElement = new self($strName, $strSize, $wFlags); |
||
| 69 | $oFormParent->add($oFormElement); |
||
| 70 | $oFormElement->readAdditionalXML($oXMLElement); |
||
| 71 | return $oFormElement; |
||
| 72 | } |
||
| 73 | |||
| 74 | /** |
||
| 75 | * {@inheritDoc} |
||
| 76 | * @see \SKien\Formgenerator\FormElement::readAdditionalXML() |
||
| 77 | * @internal |
||
| 78 | */ |
||
| 79 | public function readAdditionalXML(\DOMElement $oXMLElement) : void |
||
| 80 | { |
||
| 81 | parent::readAdditionalXML($oXMLElement); |
||
| 82 | if (self::hasAttrib($oXMLElement, 'suffix')) { |
||
| 83 | $this->setSuffix(self::getAttribString($oXMLElement, 'suffix')); |
||
| 84 | } |
||
| 85 | if (self::hasAttrib($oXMLElement, 'selectimg')) { |
||
| 86 | $this->setSelectImg(self::getAttribString($oXMLElement, 'selectimg'), self::getAttribString($oXMLElement, 'selectimgtitle')); |
||
| 87 | } |
||
| 88 | if (self::hasAttrib($oXMLElement, 'expandfolder')) { |
||
| 89 | $this->setExpandFolder(self::getAttribString($oXMLElement, 'expandfolder')); |
||
| 90 | } |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Set the maxlength attribute of the element. |
||
| 95 | * @param int $iMaxLength |
||
| 96 | */ |
||
| 97 | public function setMaxLength(int $iMaxLength) : void |
||
| 98 | { |
||
| 99 | $this->addAttribute('maxlength', (string)$iMaxLength); |
||
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Set placeholder to display on empty input element. |
||
| 104 | * @param string $strPlaceholder |
||
| 105 | */ |
||
| 106 | public function setPlaceholder(string $strPlaceholder) : void |
||
| 107 | { |
||
| 108 | if (strlen($strPlaceholder) > 0) { |
||
| 109 | $this->addAttribute('placeholder', $strPlaceholder); |
||
| 110 | } |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Set image and title for select-button. |
||
| 115 | * The `FormFlag::ADD_SELBTN` flag have to be set with the constructor or with the |
||
| 116 | * `addFlags()` method. |
||
| 117 | * To handle the select button click, define JS function `OnSelect(strField)`. The |
||
| 118 | * handler is called with the name of the element the select-button belongs to. |
||
| 119 | * @see FormFlags::ADD_SELBTN |
||
| 120 | * @param string $strImg image to display (leave blank for default 'search' - button) |
||
| 121 | * @param string $strTitle (default = '') |
||
| 122 | */ |
||
| 123 | public function setSelectImg(string $strImg, string $strTitle = '') : void |
||
| 124 | { |
||
| 125 | $this->strSelectImg = $strImg; |
||
| 126 | $this->strSelectImgTitle = $strTitle; |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Set the folder to expand when call the filemanager. |
||
| 131 | * The `FormFlag::BROWSE_SERVER` flag have to be set with the constructor or with the |
||
| 132 | * `addFlags()` method. |
||
| 133 | * Only available, if the richfilemanager is configured. |
||
| 134 | * @see FormFlags::BROWSE_SERVER |
||
| 135 | * @param string $strExpandFolder |
||
| 136 | */ |
||
| 137 | public function setExpandFolder(string $strExpandFolder) : void |
||
| 138 | { |
||
| 139 | $this->strExpandFolder = $strExpandFolder; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Set a suffix that is outputed after the element. |
||
| 144 | * @param string $strSuffix |
||
| 145 | */ |
||
| 146 | public function setSuffix(string $strSuffix) : void |
||
| 147 | { |
||
| 148 | $this->strSuffix = $strSuffix; |
||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * {@inheritDoc} |
||
| 153 | * @see \SKien\Formgenerator\FormElement::onParentSet() |
||
| 154 | */ |
||
| 155 | protected function onParentSet() : void |
||
| 159 | } |
||
| 160 | } |
||
| 161 | |||
| 162 | /** |
||
| 163 | * Build the HTML-notation for the input element. |
||
| 164 | * {@inheritDoc} |
||
| 165 | * @see \SKien\Formgenerator\FormElement::getHTML() |
||
| 166 | * @internal |
||
| 167 | */ |
||
| 168 | public function getHTML() : string |
||
| 169 | { |
||
| 170 | $this->processFlags(); |
||
| 171 | $this->setSize(); |
||
| 172 | $strHTML = $this->buildContainerDiv(); |
||
| 173 | |||
| 174 | $this->strID = $this->strID ?: $this->strName; |
||
| 175 | |||
| 176 | $strHTML .= '<input'; |
||
| 177 | $strHTML .= ' type="' . $this->strType . '"'; |
||
| 178 | $strHTML .= ' name="' . $this->strName . '"'; |
||
| 179 | $strHTML .= $this->buildClass(); |
||
| 180 | $strHTML .= $this->buildID(); |
||
| 181 | $strHTML .= $this->buildStyle(); |
||
| 182 | $strHTML .= $this->buildTabindex(); |
||
| 183 | $strHTML .= $this->buildValue(); |
||
| 184 | $strHTML .= $this->buildAttributes(); |
||
| 185 | $strHTML .= $this->buildListLink(); |
||
| 186 | $strHTML .= '>'; |
||
| 187 | |||
| 188 | $strHTML .= $this->buildSelectButton(); |
||
| 189 | $strHTML .= $this->buildSuffix(); |
||
| 190 | $strHTML .= $this->buildDatalist(); |
||
| 191 | |||
| 192 | $strHTML .= '</div>' . PHP_EOL; |
||
| 193 | |||
| 194 | return $strHTML; |
||
| 195 | } |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Set the tab index of the element. |
||
| 199 | * Method is called from the PageGenerator after an element is added to the form. |
||
| 200 | * @param int $iTabindex |
||
| 201 | * @return int the number of indexes, the element needs |
||
| 202 | * @internal |
||
| 203 | */ |
||
| 204 | public function setTabindex(int $iTabindex) : int |
||
| 205 | { |
||
| 206 | if ($this->oFlags->isSet(FormFlags::HIDDEN | FormFlags::READ_ONLY | FormFlags::DISABLED)) { |
||
| 207 | return 0; |
||
| 208 | } |
||
| 209 | $this->iTabindex = $iTabindex; |
||
| 210 | return 1; |
||
| 211 | } |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Process the current flags before the HTML is generated. |
||
| 215 | */ |
||
| 216 | protected function processFlags() : void |
||
| 217 | { |
||
| 218 | $this->setTypeFromFlags(); |
||
| 219 | |||
| 220 | if ($this->oFlags->isSet(FormFlags::MANDATORY)) { |
||
| 221 | $this->addAttribute('required'); |
||
| 222 | } |
||
| 223 | if ($this->oFlags->isSet(FormFlags::READ_ONLY)) { |
||
| 224 | $this->addAttribute('readonly'); |
||
| 225 | } else if ($this->oFlags->isSet(FormFlags::DISABLED)) { |
||
| 226 | $this->addAttribute('disabled'); |
||
| 227 | } |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Set the type depending on some flags |
||
| 232 | */ |
||
| 233 | protected function setTypeFromFlags() : void |
||
| 245 | } |
||
| 246 | } |
||
| 247 | } |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Set the size of the element. |
||
| 251 | * If property $size contains numeric value, the HTML attrib 'size' is set, in case of a |
||
| 252 | * string a width information including dimension (px, em, ...) is assumed. |
||
| 253 | */ |
||
| 254 | protected function setSize() : void |
||
| 255 | { |
||
| 256 | if ($this->oFlags->isSet(FormFlags::HIDDEN)) { |
||
| 257 | $this->size = ''; |
||
| 258 | } |
||
| 259 | if ((is_numeric($this->size)) && ($this->size > 0)) { |
||
| 260 | $this->addAttribute('size', (string)$this->size); |
||
| 261 | } else if (!empty($this->size)) { |
||
| 262 | // size given as string including dimension |
||
| 263 | $this->addStyle('width', (string)$this->size); |
||
| 264 | } |
||
| 265 | } |
||
| 266 | |||
| 267 | /** |
||
| 268 | * {@inheritDoc} |
||
| 269 | * @see \SKien\Formgenerator\FormElement::buildClass() |
||
| 270 | */ |
||
| 271 | protected function buildClass() : string |
||
| 272 | { |
||
| 273 | if (!empty($this->strClass)) { |
||
| 274 | $this->strClass .= ' '; |
||
| 275 | } |
||
| 276 | $this->strClass .= ($this->oFlags->isSet(FormFlags::MANDATORY)) ? ' inputMand' : ' inputOK'; |
||
| 277 | if ($this->oFlags->isSet(FormFlags::ALIGN_RIGHT)) { |
||
| 278 | $this->strClass .= '_R'; |
||
| 279 | } |
||
| 280 | return parent::buildClass(); |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Build the markup for a suffix succeeding the input element. |
||
| 285 | * @return string |
||
| 286 | */ |
||
| 287 | protected function buildSuffix() : string |
||
| 288 | { |
||
| 289 | $strHTML = ''; |
||
| 290 | if (!empty($this->strSuffix)) { |
||
| 291 | if ($this->oFlags->isSet(FormFlags::READ_ONLY)) { |
||
| 292 | $strHTML .= ' <span class="readonly">' . $this->strSuffix . '</span>'; |
||
| 293 | } else { |
||
| 294 | $strHTML .= ' ' . $this->strSuffix; |
||
| 295 | } |
||
| 296 | } |
||
| 297 | return $strHTML; |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Build attrib for associated datalist. |
||
| 302 | * If the dataprovider contains a datalist in the selectoptions with the same name |
||
| 303 | * as the element, we add the attrib to conect to this list. |
||
| 304 | * @return string |
||
| 305 | */ |
||
| 306 | protected function buildListLink() : string |
||
| 307 | { |
||
| 308 | $strLink = ''; |
||
| 309 | $aOptions = $this->oFG->getData()->getSelectOptions($this->strName); |
||
| 310 | if (count($aOptions) > 0) { |
||
| 311 | $strLink = ' list="list' . $this->strName . '"'; |
||
| 312 | } |
||
| 313 | return $strLink; |
||
| 314 | } |
||
| 315 | |||
| 316 | /** |
||
| 317 | * Build the markup for associated datalist. |
||
| 318 | * If the dataprovider contains a datalist in the selectoptions with the same name |
||
| 319 | * as the element, we build this datalist. |
||
| 320 | * @return string |
||
| 321 | */ |
||
| 322 | protected function buildDatalist() : string |
||
| 323 | { |
||
| 324 | $strHTML = ''; |
||
| 325 | $aOptions = $this->oFG->getData()->getSelectOptions($this->strName); |
||
| 326 | if (count($aOptions) > 0) { |
||
| 327 | $strHTML .= '<datalist id="list' . $this->strName . '">' . PHP_EOL; |
||
| 328 | foreach ($aOptions as $strValue) { |
||
| 329 | $strHTML .= ' '; |
||
| 330 | $strHTML .= '<option '; |
||
| 331 | $strHTML .= 'value="' . $strValue . '">' . PHP_EOL; |
||
| 332 | } |
||
| 333 | $strHTML .= '</datalist>' . PHP_EOL; |
||
| 334 | } |
||
| 335 | return $strHTML; |
||
| 336 | } |
||
| 337 | |||
| 338 | /** |
||
| 339 | * Build the markup for the select button(s). |
||
| 340 | * If input is set to readonly, an additional 'delete' button is appended. |
||
| 341 | * @param string $strCssClass |
||
| 342 | * @return string |
||
| 343 | */ |
||
| 344 | protected function buildSelectButton(string $strCssClass = 'picker') : string |
||
| 396 | } |
||
| 397 | |||
| 398 | /** |
||
| 399 | * Build the markup for a selectimage. |
||
| 400 | * @param string $strImg |
||
| 401 | * @param string $strTitle |
||
| 402 | * @param string $strOnClick |
||
| 403 | * @param string $strID |
||
| 404 | * @param string $strCssClass |
||
| 405 | * @param string $strFor |
||
| 406 | * @return string |
||
| 407 | */ |
||
| 408 | protected function buildSelectImage(string $strImg, string $strTitle, string $strOnClick, string $strID, string $strCssClass, string $strFor = '') : string |
||
| 431 | } |
||
| 432 | } |
||
| 433 |
