XoopsModules25x /
suico
| Total Complexity | 94 |
| Total Lines | 359 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Field 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 Field, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 31 | class Field extends \XoopsObject |
||
| 32 | { |
||
| 33 | public $field_id; |
||
| 34 | public $cat_id; |
||
| 35 | public $field_type; |
||
| 36 | public $field_valuetype; |
||
| 37 | public $field_name; |
||
| 38 | public $field_title; |
||
| 39 | public $field_description; |
||
| 40 | public $field_required; |
||
| 41 | public $field_maxlength; |
||
| 42 | public $field_weight; |
||
| 43 | public $field_default; |
||
| 44 | public $field_notnull; |
||
| 45 | public $field_edit; |
||
| 46 | public $field_show; |
||
| 47 | public $field_config; |
||
| 48 | public $field_options; |
||
| 49 | public $step_id; |
||
| 50 | |||
| 51 | public function __construct() |
||
| 52 | { |
||
| 53 | $this->initVar('field_id', \XOBJ_DTYPE_INT, null); |
||
| 54 | $this->initVar('cat_id', \XOBJ_DTYPE_INT, null, true); |
||
| 55 | $this->initVar('field_type', \XOBJ_DTYPE_TXTBOX); |
||
| 56 | $this->initVar('field_valuetype', \XOBJ_DTYPE_INT, null, true); |
||
| 57 | $this->initVar('field_name', \XOBJ_DTYPE_TXTBOX, null, true); |
||
| 58 | $this->initVar('field_title', \XOBJ_DTYPE_TXTBOX); |
||
| 59 | $this->initVar('field_description', \XOBJ_DTYPE_TXTAREA); |
||
| 60 | $this->initVar('field_required', \XOBJ_DTYPE_INT, 0); //0 = no, 1 = yes |
||
| 61 | $this->initVar('field_maxlength', \XOBJ_DTYPE_INT, 0); |
||
| 62 | $this->initVar('field_weight', \XOBJ_DTYPE_INT, 0); |
||
| 63 | $this->initVar('field_default', \XOBJ_DTYPE_TXTAREA, ''); |
||
| 64 | $this->initVar('field_notnull', \XOBJ_DTYPE_INT, 1); |
||
| 65 | $this->initVar('field_edit', \XOBJ_DTYPE_INT, 0); |
||
| 66 | $this->initVar('field_show', \XOBJ_DTYPE_INT, 0); |
||
| 67 | $this->initVar('field_config', \XOBJ_DTYPE_INT, 0); |
||
| 68 | $this->initVar('field_options', \XOBJ_DTYPE_ARRAY, []); |
||
| 69 | $this->initVar('step_id', \XOBJ_DTYPE_INT, 0); |
||
| 70 | } |
||
| 71 | |||
| 72 | /** |
||
| 73 | * Extra treatment dealing with non latin encoding |
||
| 74 | * Tricky solution |
||
| 75 | * @param string $key |
||
| 76 | * @param mixed $value |
||
| 77 | * @param bool $not_gpc |
||
| 78 | */ |
||
| 79 | public function setVar($key, $value, $not_gpc = false): void |
||
| 80 | { |
||
| 81 | if ('field_options' === $key && \is_array($value)) { |
||
| 82 | foreach (\array_keys($value) as $idx) { |
||
| 83 | $value[$idx] = \base64_encode($value[$idx]); |
||
| 84 | } |
||
| 85 | } |
||
| 86 | parent::setVar($key, $value, $not_gpc); |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @param string $key |
||
| 91 | * @param string $format |
||
| 92 | * |
||
| 93 | * @return mixed |
||
| 94 | */ |
||
| 95 | public function getVar($key, $format = 's') |
||
| 96 | { |
||
| 97 | $value = parent::getVar($key, $format); |
||
| 98 | if ('field_options' === $key && !empty($value)) { |
||
| 99 | foreach (\array_keys($value) as $idx) { |
||
|
Bug
introduced
by
|
|||
| 100 | $value[$idx] = \base64_decode($value[$idx], true); |
||
| 101 | } |
||
| 102 | } |
||
| 103 | |||
| 104 | return $value; |
||
| 105 | } |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Returns a {@link XoopsFormElement} for editing the value of this field |
||
| 109 | * |
||
| 110 | * @param \XoopsUser $user {@link \XoopsUser} object to edit the value of |
||
| 111 | * @param Profile $profile {@link Profile} object to edit the value of |
||
| 112 | * |
||
| 113 | * @return \XoopsFormCheckBox|\XoopsFormDatetime|\XoopsFormDhtmlTextArea|\XoopsFormLabel|\XoopsFormRadio|\XoopsFormRadioYN|\XoopsFormSelect|\XoopsFormSelectGroup|\XoopsFormSelectLang|\XoopsFormSelectTheme|\XoopsFormSelectTimezone|\XoopsFormText|\XoopsFormTextArea|\XoopsFormTextDateSelect |
||
| 114 | */ |
||
| 115 | public function getEditElement($user, $profile) |
||
| 116 | { |
||
| 117 | $value = \in_array($this->getVar('field_name'), $this->getUserVars(), true) ? $user->getVar($this->getVar('field_name'), 'e') : $profile->getVar($this->getVar('field_name'), 'e'); |
||
| 118 | $caption = $this->getVar('field_title'); |
||
| 119 | $caption = \defined($caption) ? \constant($caption) : $caption; |
||
| 120 | $name = $this->getVar('field_name', 'e'); |
||
| 121 | $options = $this->getVar('field_options'); |
||
| 122 | if (\is_array($options)) { |
||
| 123 | //asort($options); |
||
| 124 | foreach (\array_keys($options) as $key) { |
||
| 125 | $optval = \defined($options[$key]) ? \constant($options[$key]) : $options[$key]; |
||
| 126 | $optkey = \defined((string)$key) ? \constant($key) : $key; |
||
| 127 | unset($options[$key]); |
||
| 128 | $options[$optkey] = $optval; |
||
| 129 | } |
||
| 130 | } |
||
| 131 | require_once $GLOBALS['xoops']->path('class/xoopsformloader.php'); |
||
| 132 | switch ($this->getVar('field_type')) { |
||
| 133 | default: |
||
| 134 | case 'autotext': |
||
| 135 | //autotext is not for editing |
||
| 136 | $element = new \XoopsFormLabel($caption, $this->getOutputValue($user, $profile)); |
||
| 137 | break; |
||
| 138 | case 'textbox': |
||
| 139 | $element = new \XoopsFormText($caption, $name, 35, $this->getVar('field_maxlength'), $value); |
||
| 140 | break; |
||
| 141 | case 'textarea': |
||
| 142 | $element = new \XoopsFormTextArea($caption, $name, $value, 4, 30); |
||
| 143 | break; |
||
| 144 | case 'dhtml': |
||
| 145 | $element = new \XoopsFormDhtmlTextArea($caption, $name, $value, 10, 30); |
||
| 146 | break; |
||
| 147 | case 'select': |
||
| 148 | $element = new \XoopsFormSelect($caption, $name, $value); |
||
| 149 | // If options do not include an empty element, then add a blank option to prevent any default selection |
||
| 150 | // if (!in_array('', array_keys($options))) { |
||
| 151 | if (!\array_key_exists('', $options)) { |
||
| 152 | $element->addOption('', \_NONE); |
||
| 153 | $eltmsg = empty($caption) ? \sprintf(\_FORM_ENTER, $name) : \sprintf(\_FORM_ENTER, $caption); |
||
| 154 | $eltmsg = \str_replace('"', '\"', \stripslashes($eltmsg)); |
||
| 155 | $element->customValidationCode[] = "\nvar hasSelected = false; var selectBox = myform.{$name};" |
||
| 156 | . "for (i = 0; i < selectBox.options.length; i++) { if (selectBox.options[i].selected === true && selectBox.options[i].value != '') { hasSelected = true; break; } }" |
||
| 157 | . "if (!hasSelected) { window.alert(\"{$eltmsg}\"); selectBox.focus(); return false; }"; |
||
| 158 | } |
||
| 159 | $element->addOptionArray($options); |
||
| 160 | break; |
||
| 161 | case 'select_multi': |
||
| 162 | $element = new \XoopsFormSelect($caption, $name, $value, 5, true); |
||
| 163 | $element->addOptionArray($options); |
||
| 164 | break; |
||
| 165 | case 'radio': |
||
| 166 | $element = new \XoopsFormRadio($caption, $name, $value); |
||
| 167 | $element->addOptionArray($options); |
||
| 168 | break; |
||
| 169 | case 'checkbox': |
||
| 170 | $element = new \XoopsFormCheckBox($caption, $name, $value); |
||
| 171 | $element->addOptionArray($options); |
||
| 172 | break; |
||
| 173 | case 'yesno': |
||
| 174 | $element = new \XoopsFormRadioYN($caption, $name, $value); |
||
| 175 | break; |
||
| 176 | case 'group': |
||
| 177 | $element = new \XoopsFormSelectGroup($caption, $name, true, $value); |
||
| 178 | break; |
||
| 179 | case 'group_multi': |
||
| 180 | $element = new \XoopsFormSelectGroup($caption, $name, true, $value, 5, true); |
||
| 181 | break; |
||
| 182 | case 'language': |
||
| 183 | $element = new \XoopsFormSelectLang($caption, $name, $value); |
||
| 184 | break; |
||
| 185 | case 'date': |
||
| 186 | $element = new \XoopsFormTextDateSelect($caption, $name, 15, $value); |
||
| 187 | break; |
||
| 188 | case 'longdate': |
||
| 189 | $element = new \XoopsFormTextDateSelect($caption, $name, 15, \str_replace('-', '/', $value)); |
||
| 190 | break; |
||
| 191 | case 'datetime': |
||
| 192 | $element = new \XoopsFormDatetime($caption, $name, 15, $value); |
||
| 193 | break; |
||
| 194 | case 'timezone': |
||
| 195 | $element = new \XoopsFormSelectTimezone($caption, $name, $value); |
||
| 196 | $element->setExtra("style='width: 280px;'"); |
||
| 197 | break; |
||
| 198 | case 'rank': |
||
| 199 | $element = new \XoopsFormSelect($caption, $name, $value); |
||
| 200 | require_once $GLOBALS['xoops']->path('class/xoopslists.php'); |
||
| 201 | $ranks = \XoopsLists::getUserRankList(); |
||
| 202 | $element->addOption(0, '--------------'); |
||
| 203 | $element->addOptionArray($ranks); |
||
| 204 | break; |
||
| 205 | case 'theme': |
||
| 206 | $element = new \XoopsFormSelectTheme($caption, $name, $value, 1, true); |
||
| 207 | break; |
||
| 208 | } |
||
| 209 | if ('' != $this->getVar('field_description')) { |
||
| 210 | $element->setDescription($this->getVar('field_description')); |
||
| 211 | } |
||
| 212 | |||
| 213 | return $element; |
||
| 214 | } |
||
| 215 | |||
| 216 | /** |
||
| 217 | * Returns a value for output of this field |
||
| 218 | * |
||
| 219 | * @param \XoopsUser $user {@link XoopsUser} object to get the value of |
||
| 220 | * @param Profile $profile object to get the value of |
||
| 221 | * |
||
| 222 | * @return mixed |
||
| 223 | **/ |
||
| 224 | public function getOutputValue($user, $profile) |
||
| 331 | } |
||
| 332 | } |
||
| 333 | |||
| 334 | /** |
||
| 335 | * Returns a value ready to be saved in the database |
||
| 336 | * |
||
| 337 | * @param mixed $value Value to format |
||
| 338 | * |
||
| 339 | * @return mixed |
||
| 340 | */ |
||
| 341 | public function getValueForSave($value) |
||
| 342 | { |
||
| 343 | switch ($this->getVar('field_type')) { |
||
| 344 | default: |
||
| 345 | case 'textbox': |
||
| 346 | case 'textarea': |
||
| 347 | case 'dhtml': |
||
| 348 | case 'yesno': |
||
| 349 | case 'timezone': |
||
| 350 | case 'theme': |
||
| 351 | case 'language': |
||
| 352 | case 'select': |
||
| 353 | case 'radio': |
||
| 354 | case 'select_multi': |
||
| 355 | case 'group': |
||
| 356 | case 'group_multi': |
||
| 357 | case 'longdate': |
||
| 358 | return $value; |
||
| 359 | case 'checkbox': |
||
| 360 | return (array)$value; |
||
| 361 | case 'date': |
||
| 362 | if ('' !== $value) { |
||
| 363 | return \strtotime($value); |
||
| 364 | } |
||
| 365 | |||
| 366 | return $value; |
||
| 367 | break; |
||
| 368 | case 'datetime': |
||
| 369 | if (!empty($value)) { |
||
| 370 | return \strtotime($value['date']) + (int)$value['time']; |
||
| 371 | } |
||
| 372 | |||
| 373 | return $value; |
||
| 374 | break; |
||
| 375 | } |
||
| 376 | } |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Get names of user variables |
||
| 380 | * |
||
| 381 | * @return array |
||
| 382 | */ |
||
| 383 | public function getUserVars() |
||
| 390 | } |
||
| 391 | } |
||
| 392 |
Loading history...
