starweb /
starlit-db
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 AbstractDbEntity 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 AbstractDbEntity, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | abstract class AbstractDbEntity implements \Serializable |
||
| 20 | { |
||
| 21 | /** |
||
| 22 | * The database table name (meant to be overridden). |
||
| 23 | * |
||
| 24 | * @var string |
||
| 25 | */ |
||
| 26 | protected static $dbTableName; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Entity's database properties and their attributes (meant to be overridden). |
||
| 30 | * Example format: |
||
| 31 | * |
||
| 32 | * $dbProperties = [ |
||
| 33 | * 'productId' => ['type' => 'int'], |
||
| 34 | * 'otherId' => ['type' => 'int', 'required' => true,], |
||
| 35 | * 'name' => ['type' => 'string', 'maxLength' => 10, 'required' => true, 'default' => 'Some name'], |
||
| 36 | * ]; |
||
| 37 | * |
||
| 38 | * 'type' => 'int' Corresponding PHP type (required). |
||
| 39 | * 'required' => true The value have to be set (not '', null, false) |
||
| 40 | * 'nonEmpty' => true The value should not be empty ('', 0, null) |
||
| 41 | * |
||
| 42 | * Properties correspond to database table's columns but words are |
||
| 43 | * camel cased instead of separated with underscore (_) as in the database. |
||
| 44 | * |
||
| 45 | * @var array |
||
| 46 | */ |
||
| 47 | protected static $dbProperties = []; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Object database field name that is used for primary key (meant to be overridden). |
||
| 51 | * Should be camel cased as it maps to the dbFields array. |
||
| 52 | * |
||
| 53 | * @var string|array |
||
| 54 | */ |
||
| 55 | protected static $primaryDbPropertyKey; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * @var array |
||
| 59 | */ |
||
| 60 | private static $cachedDefaultDbData = []; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * @var array |
||
| 64 | */ |
||
| 65 | private static $cachedDbPropertyNames; |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @var array |
||
| 69 | */ |
||
| 70 | private static $cachedDbFieldNames; |
||
| 71 | |||
| 72 | /** |
||
| 73 | * @var array |
||
| 74 | */ |
||
| 75 | private static $typeDefaults = [ |
||
| 76 | 'string' => '', |
||
| 77 | 'int' => 0, |
||
| 78 | 'float' => 0.0, |
||
| 79 | 'bool' => false, |
||
| 80 | 'dateTime' => null, |
||
| 81 | ]; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Database row data with field names and their values. |
||
| 85 | * |
||
| 86 | * @var array |
||
| 87 | */ |
||
| 88 | private $dbData = []; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * The primary key value currently set in database. This |
||
| 92 | * can be different from the value in $dbData if the primary value |
||
| 93 | * is changed. |
||
| 94 | * |
||
| 95 | * @var mixed |
||
| 96 | */ |
||
| 97 | private $primaryDbValue; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Database fields that has had their value modified since init/load. |
||
| 101 | * |
||
| 102 | * @var array |
||
| 103 | */ |
||
| 104 | private $modifiedDbProperties = []; |
||
| 105 | |||
| 106 | /** |
||
| 107 | * @var bool |
||
| 108 | */ |
||
| 109 | private $deleteFromDbOnSave = false; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * @var bool |
||
| 113 | */ |
||
| 114 | private $deleted = false; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * @var bool |
||
| 118 | */ |
||
| 119 | private $forceDbInsertOnSave = false; |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Constructor. |
||
| 123 | * |
||
| 124 | * @param mixed $primaryDbValueOrRowData |
||
| 125 | */ |
||
| 126 | 73 | public function __construct($primaryDbValueOrRowData = null) |
|
| 138 | |||
| 139 | /** |
||
| 140 | * Make sure that class has all necessary static properties set. |
||
| 141 | */ |
||
| 142 | 73 | private static function checkStaticProperties() |
|
| 159 | |||
| 160 | /** |
||
| 161 | * @param mixed $primaryDbValueOrRowData |
||
| 162 | */ |
||
| 163 | 13 | public function setPrimaryDbValueOrRowData($primaryDbValueOrRowData = null) |
|
| 173 | |||
| 174 | /** |
||
| 175 | * Get all default database values. |
||
| 176 | * |
||
| 177 | * @return array |
||
| 178 | */ |
||
| 179 | 72 | public function getDefaultDbData() |
|
| 191 | |||
| 192 | /** |
||
| 193 | * Get default db value (can be overridden if non static default values need to be used). |
||
| 194 | * |
||
| 195 | * @param string $propertyName |
||
| 196 | * @return mixed |
||
| 197 | */ |
||
| 198 | 17 | public function getDefaultDbPropertyValue($propertyName) |
|
| 210 | |||
| 211 | /** |
||
| 212 | * The primary key value currently set in database. |
||
| 213 | * |
||
| 214 | * This can be different from the value/values in $dbData |
||
| 215 | * if a primary value is changed. |
||
| 216 | * |
||
| 217 | * @return mixed |
||
| 218 | */ |
||
| 219 | 26 | public function getPrimaryDbValue() |
|
| 223 | |||
| 224 | /** |
||
| 225 | * @param mixed $primaryDbValue |
||
| 226 | */ |
||
| 227 | 24 | public function setPrimaryDbValue($primaryDbValue) |
|
| 234 | |||
| 235 | /** |
||
| 236 | * @param mixed $primaryDbValue |
||
| 237 | */ |
||
| 238 | 23 | protected function setDbDataPrimaryValue($primaryDbValue) |
|
| 250 | |||
| 251 | /** |
||
| 252 | * Update primary database value with data from set database data. |
||
| 253 | */ |
||
| 254 | 12 | public function updatePrimaryDbValueFromDbData() |
|
| 262 | |||
| 263 | /** |
||
| 264 | * @return mixed|array |
||
| 265 | */ |
||
| 266 | 12 | View Code Duplication | protected function getDbDataPrimaryValue() |
| 279 | |||
| 280 | /** |
||
| 281 | * @return mixed|array |
||
| 282 | */ |
||
| 283 | 12 | View Code Duplication | private function getDbDataPrimaryDefaultValue() |
| 296 | |||
| 297 | /** |
||
| 298 | * @return bool |
||
| 299 | */ |
||
| 300 | 10 | public function isNewDbEntity() |
|
| 311 | |||
| 312 | /** |
||
| 313 | * @return bool |
||
| 314 | */ |
||
| 315 | 9 | public function shouldInsertOnDbSave() |
|
| 320 | |||
| 321 | /** |
||
| 322 | * Set a row field value. |
||
| 323 | * |
||
| 324 | * @param string $property |
||
| 325 | * @param mixed $value |
||
| 326 | * @param bool $setAsModified |
||
| 327 | * @param bool $force |
||
| 328 | */ |
||
| 329 | 32 | protected function setDbValue($property, $value, $setAsModified = true, $force = false) |
|
| 341 | |||
| 342 | /** |
||
| 343 | * @param string $property |
||
| 344 | * @param mixed $value |
||
| 345 | * @return mixed |
||
| 346 | */ |
||
| 347 | 44 | private function getValueWithPropertyType(string $property, $value) { |
|
| 371 | |||
| 372 | /** |
||
| 373 | * @param string $property |
||
| 374 | * @param mixed $value |
||
| 375 | * @return mixed |
||
| 376 | */ |
||
| 377 | 24 | private function getPrimaryDbValueWithPropertyType($primaryDbValue) { |
|
| 404 | |||
| 405 | /** |
||
| 406 | * @param string $value |
||
| 407 | * @return \DateTime|\Carbon\Carbon|null |
||
| 408 | */ |
||
| 409 | 1 | protected function createDateTimeDbValue($value) |
|
| 420 | |||
| 421 | /** |
||
| 422 | * Get a database field value. |
||
| 423 | * |
||
| 424 | * @param string $property |
||
| 425 | * @return mixed |
||
| 426 | */ |
||
| 427 | 19 | protected function getDbValue($property) |
|
| 431 | |||
| 432 | /** |
||
| 433 | * Get raw (with underscore as word separator as it is formatted in database) |
||
| 434 | * field name from a object field property name (camelcased). |
||
| 435 | * |
||
| 436 | * @param string $propertyName |
||
| 437 | * @return string |
||
| 438 | */ |
||
| 439 | 24 | public static function getDbFieldName($propertyName) |
|
| 447 | |||
| 448 | /** |
||
| 449 | * Get object field property name (camelCased) from database field name (underscore separated). |
||
| 450 | * |
||
| 451 | * @param string $dbFieldName |
||
| 452 | * @return string |
||
| 453 | */ |
||
| 454 | 9 | public static function getDbPropertyName($dbFieldName) |
|
| 462 | |||
| 463 | /** |
||
| 464 | * @return bool |
||
| 465 | */ |
||
| 466 | 6 | public function hasModifiedDbProperties() |
|
| 470 | |||
| 471 | /** |
||
| 472 | * @param string $property |
||
| 473 | * @return bool |
||
| 474 | */ |
||
| 475 | 19 | public function isDbPropertyModified($property) |
|
| 479 | |||
| 480 | /** |
||
| 481 | * @return array |
||
| 482 | */ |
||
| 483 | 6 | public function getModifiedDbData() |
|
| 487 | |||
| 488 | /** |
||
| 489 | * @return array |
||
| 490 | */ |
||
| 491 | 1 | public function getModifiedDbProperties() |
|
| 492 | { |
||
| 493 | 1 | return $this->modifiedDbProperties; |
|
| 494 | } |
||
| 495 | |||
| 496 | /** |
||
| 497 | * @param string $property |
||
| 498 | */ |
||
| 499 | 1 | public function clearModifiedDbProperty($property) |
|
| 500 | { |
||
| 501 | 1 | if (($key = array_search($property, $this->modifiedDbProperties)) !== false) { |
|
| 502 | 1 | unset($this->modifiedDbProperties[$key]); |
|
| 503 | } |
||
| 504 | 1 | } |
|
| 505 | |||
| 506 | 4 | public function clearModifiedDbProperties() |
|
| 510 | |||
| 511 | 1 | public function setAllDbPropertiesAsModified() |
|
| 515 | |||
| 516 | /** |
||
| 517 | * Magic method used to automate getters & setters for row data. |
||
| 518 | * |
||
| 519 | * @param string $name |
||
| 520 | * @param array $arguments |
||
| 521 | * @return mixed |
||
| 522 | */ |
||
| 523 | 24 | public function __call($name, array $arguments = []) |
|
| 540 | |||
| 541 | /** |
||
| 542 | * Set database fields' data. |
||
| 543 | * |
||
| 544 | * @param array $data |
||
| 545 | */ |
||
| 546 | 3 | public function setDbData(array $data) |
|
| 554 | |||
| 555 | /** |
||
| 556 | * Set db data from raw database row data with field names in database format. |
||
| 557 | * |
||
| 558 | * @param array $rowData |
||
| 559 | */ |
||
| 560 | 9 | public function setDbDataFromRow(array $rowData) |
|
| 582 | |||
| 583 | /** |
||
| 584 | * @return mixed |
||
| 585 | */ |
||
| 586 | protected function getPrimaryDbValueFromRow(array $rowData) |
||
| 602 | |||
| 603 | /** |
||
| 604 | * @return array |
||
| 605 | */ |
||
| 606 | 11 | public function getDbData() |
|
| 610 | |||
| 611 | /** |
||
| 612 | * @return array |
||
| 613 | */ |
||
| 614 | 1 | public function getDbRowData() |
|
| 624 | |||
| 625 | /** |
||
| 626 | * @return array |
||
| 627 | */ |
||
| 628 | 2 | public function getDbDataWithoutPrimary() |
|
| 642 | |||
| 643 | /** |
||
| 644 | * @param bool $deleteFromDbOnSave |
||
| 645 | */ |
||
| 646 | 3 | public function setDeleteFromDbOnSave($deleteFromDbOnSave = true) |
|
| 650 | |||
| 651 | /** |
||
| 652 | * @return bool |
||
| 653 | */ |
||
| 654 | 11 | public function shouldBeDeletedFromDbOnSave() |
|
| 658 | |||
| 659 | /** |
||
| 660 | * @return bool |
||
| 661 | */ |
||
| 662 | 1 | public function isDeleted() |
|
| 666 | |||
| 667 | /** |
||
| 668 | * @param bool $deleted |
||
| 669 | */ |
||
| 670 | 3 | public function setDeleted($deleted = true) |
|
| 674 | |||
| 675 | /** |
||
| 676 | * @param bool $forceDbInsertOnSave |
||
| 677 | */ |
||
| 678 | 5 | public function setForceDbInsertOnSave($forceDbInsertOnSave) |
|
| 682 | |||
| 683 | /** |
||
| 684 | * @return bool |
||
| 685 | */ |
||
| 686 | 5 | public function shouldForceDbInsertOnSave() |
|
| 690 | |||
| 691 | /** |
||
| 692 | * @return array |
||
| 693 | */ |
||
| 694 | 1 | public static function getDbProperties() |
|
| 698 | |||
| 699 | /** |
||
| 700 | * @param string $propertyName |
||
| 701 | * @return int|null |
||
| 702 | */ |
||
| 703 | 6 | public static function getDbPropertyMaxLength($propertyName) |
|
| 709 | |||
| 710 | /** |
||
| 711 | * @param string $propertyName |
||
| 712 | * @return bool |
||
| 713 | */ |
||
| 714 | 3 | public static function getDbPropertyRequired($propertyName) |
|
| 720 | |||
| 721 | /** |
||
| 722 | * @param string $propertyName |
||
| 723 | * @return bool |
||
| 724 | */ |
||
| 725 | 6 | public static function getDbPropertyNonEmpty($propertyName) |
|
| 731 | |||
| 732 | /** |
||
| 733 | * @return string|array |
||
| 734 | */ |
||
| 735 | 16 | public static function getPrimaryDbPropertyKey() |
|
| 739 | |||
| 740 | /** |
||
| 741 | * @return string|array |
||
| 742 | */ |
||
| 743 | 12 | public static function getPrimaryDbFieldKey() |
|
| 758 | |||
| 759 | /** |
||
| 760 | * Return array with db property names. |
||
| 761 | * |
||
| 762 | * @param array $exclude |
||
| 763 | * @return array |
||
| 764 | */ |
||
| 765 | 1 | public static function getDbPropertyNames(array $exclude = []) |
|
| 771 | |||
| 772 | /** |
||
| 773 | * Return array with raw db field names. |
||
| 774 | * |
||
| 775 | * @param array $exclude |
||
| 776 | * @return array |
||
| 777 | */ |
||
| 778 | 3 | public static function getDbFieldNames(array $exclude = []) |
|
| 787 | |||
| 788 | |||
| 789 | /** |
||
| 790 | * Get raw database field names prefixed (id, name becomes t.id, t.name etc.). |
||
| 791 | * |
||
| 792 | * @param string $dbTableAlias |
||
| 793 | * @param array $exclude |
||
| 794 | * @return array |
||
| 795 | */ |
||
| 796 | 1 | public static function getPrefixedDbFieldNames($dbTableAlias, array $exclude = []) |
|
| 800 | |||
| 801 | /** |
||
| 802 | * Get database columns transformed from e.g. "productId, date" to "p.product_id AS p_product_id, p.date AS p_date". |
||
| 803 | * |
||
| 804 | * @param string $dbTableAlias |
||
| 805 | * @param array $exclude |
||
| 806 | * @return array |
||
| 807 | */ |
||
| 808 | 1 | public static function getAliasedDbFieldNames($dbTableAlias, array $exclude = []) |
|
| 819 | |||
| 820 | /** |
||
| 821 | * Filters a full db item array by it's table alias and the strips the table alias. |
||
| 822 | * |
||
| 823 | * @param array $rowData |
||
| 824 | * @param string $dbTableAlias |
||
| 825 | * @param bool $skipStrip For cases when you want to filter only (no stripping) |
||
| 826 | * @return array |
||
| 827 | */ |
||
| 828 | 1 | public static function filterStripDbRowData(array $rowData, $dbTableAlias, $skipStrip = false) |
|
| 842 | |||
| 843 | /** |
||
| 844 | * @return string |
||
| 845 | */ |
||
| 846 | 8 | public static function getDbTableName() |
|
| 850 | |||
| 851 | /** |
||
| 852 | * Method to handle the serialization of this object. |
||
| 853 | * |
||
| 854 | * Implementation of Serializable interface. If descendant private properties |
||
| 855 | * should be serialized, they need to be visible to this parent (i.e. not private). |
||
| 856 | * |
||
| 857 | * @return string |
||
| 858 | */ |
||
| 859 | 2 | public function serialize() |
|
| 863 | |||
| 864 | /** |
||
| 865 | * Method to handle the unserialization of this object. |
||
| 866 | * |
||
| 867 | * Implementation of Serializable interface. If descendant private properties |
||
| 868 | * should be unserialized, they need to be visible to this parent (i.e. not private). |
||
| 869 | * |
||
| 870 | * @param string $serializedObject |
||
| 871 | */ |
||
| 872 | 1 | public function unserialize($serializedObject) |
|
| 880 | |||
| 881 | /** |
||
| 882 | * Merges other object's modified database data into this object. |
||
| 883 | * |
||
| 884 | * @param AbstractDbEntity $otherEntity |
||
| 885 | */ |
||
| 886 | 1 | public function mergeWith(AbstractDbEntity $otherEntity) |
|
| 891 | } |
||
| 892 |
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.