mambax7 /
smartfaq
| Total Complexity | 52 |
| Total Lines | 467 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like SmartDbTable 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 SmartDbTable, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 76 | class SmartDbTable |
||
| 77 | { |
||
| 78 | /** |
||
| 79 | * @var string $_name name of the table |
||
| 80 | */ |
||
| 81 | private $_name; |
||
| 82 | /** |
||
| 83 | * @var string|null $_structure structure of the table |
||
| 84 | */ |
||
| 85 | private $_structure; |
||
| 86 | /** |
||
| 87 | * @var array $_data containing valued of each records to be added |
||
| 88 | */ |
||
| 89 | private $_data; |
||
| 90 | /** |
||
| 91 | * @var array|null $_alteredFields containing fields to be altered |
||
| 92 | */ |
||
| 93 | private $_alteredFields; |
||
| 94 | /** |
||
| 95 | * @var array|null $_newFields containing new fields to be added |
||
| 96 | */ |
||
| 97 | private $_newFields; |
||
| 98 | /** |
||
| 99 | * @var array|null $_droppedFields containing fields to be dropped |
||
| 100 | */ |
||
| 101 | private $_droppedFields; |
||
| 102 | /** |
||
| 103 | * @var array $_flagForDrop flag table to drop it |
||
| 104 | */ |
||
| 105 | private $_flagForDrop = false; |
||
| 106 | /** |
||
| 107 | * @var array|null $_updatedFields containing fields which values will be updated |
||
| 108 | */ |
||
| 109 | private $_updatedFields; |
||
| 110 | /** |
||
| 111 | * @var array|null $_updatedFields containing fields which values will be updated |
||
| 112 | */ //felix |
||
| 113 | private $_updatedWhere; |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Constructor |
||
| 117 | * |
||
| 118 | * @param string $name name of the table |
||
| 119 | */ |
||
| 120 | public function __construct($name) |
||
| 121 | { |
||
| 122 | $this->_name = $name; |
||
| 123 | $this->_data = []; |
||
| 124 | } |
||
| 125 | |||
| 126 | /** |
||
| 127 | * Return the table name, prefixed with site table prefix |
||
| 128 | * |
||
| 129 | * @return string table name |
||
| 130 | */ |
||
| 131 | public function name() |
||
| 132 | { |
||
| 133 | global $xoopsDB; |
||
| 134 | |||
| 135 | return $xoopsDB->prefix($this->_name); |
||
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * Checks if the table already exists in the database |
||
| 140 | * |
||
| 141 | * @return bool TRUE if it exists, FALSE if not |
||
| 142 | */ |
||
| 143 | public function exists() |
||
| 144 | { |
||
| 145 | return smart_TableExists($this->_name); |
||
| 146 | } |
||
| 147 | |||
| 148 | /** |
||
| 149 | * @return mixed |
||
| 150 | */ |
||
| 151 | public function getExistingFieldsArray() |
||
| 152 | { |
||
| 153 | global $xoopsDB; |
||
| 154 | $result = $xoopsDB->queryF('SHOW COLUMNS FROM ' . $this->name()); |
||
| 155 | while (false !== ($existing_field = $xoopsDB->fetchArray($result))) { |
||
| 156 | $fields[$existing_field['Field']] = $existing_field['Type']; |
||
| 157 | if ('YES' !== $existing_field['Null']) { |
||
| 158 | $fields[$existing_field['Field']] .= ' NOT NULL'; |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 159 | } |
||
| 160 | if ($existing_field['Extra']) { |
||
| 161 | $fields[$existing_field['Field']] .= ' ' . $existing_field['Extra']; |
||
| 162 | } |
||
| 163 | } |
||
| 164 | |||
| 165 | return $fields; |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * @param $field |
||
| 170 | * @return bool |
||
| 171 | */ |
||
| 172 | public function fieldExists($field) |
||
| 173 | { |
||
| 174 | $existingFields = $this->getExistingFieldsArray(); |
||
| 175 | |||
| 176 | return isset($existingFields[$field]); |
||
| 177 | } |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Set the table structure |
||
| 181 | * |
||
| 182 | * @param string $structure table structure |
||
| 183 | */ |
||
| 184 | public function setStructure($structure): void |
||
| 185 | { |
||
| 186 | $this->_structure = $structure; |
||
| 187 | } |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Return the table structure |
||
| 191 | * |
||
| 192 | * @return string table structure |
||
| 193 | */ |
||
| 194 | public function getStructure() |
||
| 195 | { |
||
| 196 | return \sprintf($this->_structure, $this->name()); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Add values of a record to be added |
||
| 201 | * |
||
| 202 | * @param string $data values of a record |
||
| 203 | */ |
||
| 204 | public function setData($data): void |
||
| 205 | { |
||
| 206 | $this->_data[] = $data; |
||
| 207 | } |
||
| 208 | |||
| 209 | /** |
||
| 210 | * Get the data array |
||
| 211 | * |
||
| 212 | * @return array containing the records values to be added |
||
| 213 | */ |
||
| 214 | public function getData() |
||
| 215 | { |
||
| 216 | return $this->_data; |
||
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Use to insert data in a table |
||
| 221 | * |
||
| 222 | * @return bool true if success, false if an error occurred |
||
| 223 | */ |
||
| 224 | public function addData() |
||
| 225 | { |
||
| 226 | global $xoopsDB; |
||
| 227 | |||
| 228 | foreach ($this->getData() as $data) { |
||
| 229 | $query = \sprintf('INSERT INTO `%s` VALUES ("%s")', $this->name(), $data); |
||
| 230 | $ret = $xoopsDB->queryF($query); |
||
| 231 | if ($ret) { |
||
| 232 | echo ' ' . \sprintf(_SDU_MSG_ADD_DATA, $this->name()) . '<br>'; |
||
| 233 | } else { |
||
| 234 | echo ' ' . \sprintf(_SDU_MSG_ADD_DATA_ERR, $this->name()) . '<br>'; |
||
| 235 | } |
||
| 236 | } |
||
| 237 | |||
| 238 | return $ret; |
||
| 239 | } |
||
| 240 | |||
| 241 | /** |
||
| 242 | * Add a field to be added |
||
| 243 | * |
||
| 244 | * @param string $name name of the field |
||
| 245 | * @param string $properties properties of the field |
||
| 246 | * @param bool $showerror |
||
| 247 | */ |
||
| 248 | public function addAlteredField($name, $properties, $showerror = true): void |
||
| 249 | { |
||
| 250 | $field['name'] = $name; |
||
| 251 | $field['properties'] = $properties; |
||
| 252 | $field['showerror'] = $showerror; |
||
| 253 | $this->_alteredFields[] = $field; |
||
| 254 | } |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Invert values 0 to 1 and 1 to 0 |
||
| 258 | * |
||
| 259 | * @param string $name name of the field |
||
| 260 | * @param $newValue |
||
| 261 | * @param $oldValue |
||
| 262 | * @internal param string $old old propertie |
||
| 263 | * @internal param string $new new propertie |
||
| 264 | */ //felix |
||
| 265 | |||
| 266 | public function addUpdatedWhere($name, $newValue, $oldValue): void |
||
| 267 | { |
||
| 268 | $field['name'] = $name; |
||
| 269 | $field['value'] = $newValue; |
||
| 270 | $field['where'] = $oldValue; |
||
| 271 | $this->_updatedWhere[] = $field; |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Add new field of a record to be added |
||
| 276 | * |
||
| 277 | * @param string $name name of the field |
||
| 278 | * @param string $properties properties of the field |
||
| 279 | */ |
||
| 280 | public function addNewField($name, $properties): void |
||
| 281 | { |
||
| 282 | $field['name'] = $name; |
||
| 283 | $field['properties'] = $properties; |
||
| 284 | $this->_newFields[] = $field; |
||
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * Get fields that need to be altered |
||
| 289 | * |
||
| 290 | * @return array fields that need to be altered |
||
| 291 | */ |
||
| 292 | public function getAlteredFields() |
||
| 293 | { |
||
| 294 | return $this->_alteredFields; |
||
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * Add field for which the value will be updated |
||
| 299 | * |
||
| 300 | * @param string $name name of the field |
||
| 301 | * @param string $value value to be set |
||
| 302 | */ |
||
| 303 | public function addUpdatedField($name, $value): void |
||
| 304 | { |
||
| 305 | $field['name'] = $name; |
||
| 306 | $field['value'] = $value; |
||
| 307 | $this->_updatedFields[] = $field; |
||
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * Get new fields to be added |
||
| 312 | * |
||
| 313 | * @return array fields to be added |
||
| 314 | */ |
||
| 315 | public function getNewFields() |
||
| 316 | { |
||
| 317 | return $this->_newFields; |
||
| 318 | } |
||
| 319 | |||
| 320 | /** |
||
| 321 | * Get fields which values need to be updated |
||
| 322 | * |
||
| 323 | * @return array fields which values need to be updated |
||
| 324 | */ |
||
| 325 | public function getUpdatedFields() |
||
| 326 | { |
||
| 327 | return $this->_updatedFields; |
||
| 328 | } |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Get fields which values need to be updated |
||
| 332 | * |
||
| 333 | * @return array fields which values need to be updated |
||
| 334 | */ //felix |
||
| 335 | |||
| 336 | public function getUpdatedWhere() |
||
| 337 | { |
||
| 338 | return $this->_updatedWhere; |
||
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Add values of a record to be added |
||
| 343 | * |
||
| 344 | * @param string $name name of the field |
||
| 345 | */ |
||
| 346 | public function addDroppedField($name): void |
||
| 347 | { |
||
| 348 | $this->_droppedFields[] = $name; |
||
| 349 | } |
||
| 350 | |||
| 351 | /** |
||
| 352 | * Get fields that need to be dropped |
||
| 353 | * |
||
| 354 | * @return array fields that need to be dropped |
||
| 355 | */ |
||
| 356 | public function getDroppedFields() |
||
| 357 | { |
||
| 358 | return $this->_droppedFields; |
||
| 359 | } |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Set the flag to drop the table |
||
| 363 | */ |
||
| 364 | public function setFlagForDrop(): void |
||
| 365 | { |
||
| 366 | $this->_flagForDrop = true; |
||
| 367 | } |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Get the flag to drop the table |
||
| 371 | */ |
||
| 372 | public function getFlagForDrop() |
||
| 373 | { |
||
| 374 | return $this->_flagForDrop; |
||
| 375 | } |
||
| 376 | |||
| 377 | /** |
||
| 378 | * Use to create a table |
||
| 379 | * |
||
| 380 | * @return bool true if success, false if an error occurred |
||
| 381 | */ |
||
| 382 | public function createTable() |
||
| 383 | { |
||
| 384 | global $xoopsDB; |
||
| 385 | |||
| 386 | $query = $this->getStructure(); |
||
| 387 | |||
| 388 | $ret = $xoopsDB->queryF($query); |
||
| 389 | if ($ret) { |
||
| 390 | echo ' ' . \sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . '<br>'; |
||
| 391 | } else { |
||
| 392 | echo ' ' . \sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . '<br>'; |
||
| 393 | } |
||
| 394 | |||
| 395 | return $ret; |
||
| 396 | } |
||
| 397 | |||
| 398 | /** |
||
| 399 | * Use to drop a table |
||
| 400 | * |
||
| 401 | * @return bool true if success, false if an error occurred |
||
| 402 | */ |
||
| 403 | public function dropTable() |
||
| 404 | { |
||
| 405 | global $xoopsDB; |
||
| 406 | |||
| 407 | $query = \sprintf('DROP TABLE `%s`', $this->name()); |
||
| 408 | $ret = $xoopsDB->queryF($query); |
||
| 409 | if (!$ret) { |
||
| 410 | echo ' ' . \sprintf(\_SDU_MSG_DROP_TABLE_ERR, $this->name()) . '<br>'; |
||
| 411 | |||
| 412 | return false; |
||
| 413 | } |
||
| 414 | echo ' ' . \sprintf(\_SDU_MSG_DROP_TABLE, $this->name()) . '<br>'; |
||
| 415 | |||
| 416 | return true; |
||
| 417 | } |
||
| 418 | |||
| 419 | /** |
||
| 420 | * Use to alter a table |
||
| 421 | * |
||
| 422 | * @return bool true if success, false if an error occurred |
||
| 423 | */ |
||
| 424 | public function alterTable() |
||
| 425 | { |
||
| 426 | global $xoopsDB; |
||
| 427 | |||
| 428 | $ret = true; |
||
| 429 | |||
| 430 | foreach ($this->getAlteredFields() as $alteredField) { |
||
| 431 | $query = \sprintf('ALTER TABLE `%s` CHANGE %s %s', $this->name(), $alteredField['name'], $alteredField['properties']); |
||
| 432 | //echo $query; |
||
| 433 | $ret = $ret && $xoopsDB->queryF($query); |
||
| 434 | if ($alteredField['showerror']) { |
||
| 435 | if ($ret) { |
||
| 436 | echo ' ' . \sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . '<br>'; |
||
| 437 | } else { |
||
| 438 | echo ' ' . \sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . '<br>'; |
||
| 439 | } |
||
| 440 | } |
||
| 441 | } |
||
| 442 | |||
| 443 | return $ret; |
||
| 444 | } |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Use to add new fileds in the table |
||
| 448 | * |
||
| 449 | * @return bool true if success, false if an error occurred |
||
| 450 | */ |
||
| 451 | public function addNewFields() |
||
| 452 | { |
||
| 453 | global $xoopsDB; |
||
| 454 | |||
| 455 | $ret = true; |
||
| 456 | foreach ($this->getNewFields() as $newField) { |
||
| 457 | $query = \sprintf('ALTER TABLE `%s` ADD %s %s', $this->name(), $newField['name'], $newField['properties']); |
||
| 458 | //echo $query; |
||
| 459 | $ret = $ret && $xoopsDB->queryF($query); |
||
| 460 | if ($ret) { |
||
| 461 | echo ' ' . \sprintf(_SDU_MSG_NEWFIELD, $newField['name'], $this->name()) . '<br>'; |
||
| 462 | } else { |
||
| 463 | echo ' ' . \sprintf(_SDU_MSG_NEWFIELD_ERR, $newField['name'], $this->name()) . '<br>'; |
||
| 464 | } |
||
| 465 | } |
||
| 466 | |||
| 467 | return $ret; |
||
| 468 | } |
||
| 469 | |||
| 470 | /** |
||
| 471 | * Use to update fields values |
||
| 472 | * |
||
| 473 | * @return bool true if success, false if an error occurred |
||
| 474 | */ |
||
| 475 | public function updateFieldsValues() |
||
| 476 | { |
||
| 477 | global $xoopsDB; |
||
| 478 | |||
| 479 | $ret = true; |
||
| 480 | |||
| 481 | foreach ($this->getUpdatedFields() as $updatedField) { |
||
| 482 | $query = \sprintf('UPDATE `%s` SET %s = %s', $this->name(), $updatedField['name'], $updatedField['value']); |
||
| 483 | $ret = $ret && $xoopsDB->queryF($query); |
||
| 484 | if ($ret) { |
||
| 485 | echo ' ' . \sprintf(\_SDU_MSG_UPDATE_TABLE, $this->name()) . '<br>'; |
||
| 486 | } else { |
||
| 487 | echo ' ' . \sprintf(\_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . '<br>'; |
||
| 488 | } |
||
| 489 | } |
||
| 490 | |||
| 491 | return $ret; |
||
| 492 | } |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Use to update fields values |
||
| 496 | * |
||
| 497 | * @return bool true if success, false if an error occurred |
||
| 498 | */ //felix |
||
| 499 | |||
| 500 | public function updateWhereValues() |
||
| 518 | } |
||
| 519 | |||
| 520 | /** |
||
| 521 | * Use to drop fields |
||
| 522 | * |
||
| 523 | * @return bool true if success, false if an error occurred |
||
| 524 | */ |
||
| 525 | public function dropFields() |
||
| 526 | { |
||
| 527 | global $xoopsDB; |
||
| 528 | |||
| 529 | $ret = true; |
||
| 530 | |||
| 531 | foreach ($this->getDroppedFields() as $droppedField) { |
||
| 532 | $query = \sprintf('ALTER TABLE `%s` DROP %s', $this->name(), $droppedField); |
||
| 543 | } |
||
| 544 | } |
||
| 545 |
Loading history...