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 |
||
| 22 | abstract class AbstractDbEntity implements \Serializable |
||
| 23 | { |
||
| 24 | /** |
||
| 25 | * The database table name (meant to be overridden). |
||
| 26 | * |
||
| 27 | * @var string |
||
| 28 | */ |
||
| 29 | protected static $dbTableName; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Entity's database properties and their attributes (meant to be overridden). |
||
| 33 | * Example format: |
||
| 34 | * |
||
| 35 | * $dbProperties = [ |
||
| 36 | * 'productId' => ['type' => 'int'], |
||
| 37 | * 'otherId' => ['type' => 'int', 'required' => true, 'validate' => false], |
||
| 38 | * 'name' => ['type' => 'string', 'maxLength' => 10, 'required' => true, 'default' => 'Some name'], |
||
| 39 | * ]; |
||
| 40 | * |
||
| 41 | * 'type' => 'int' Corresponding PHP type (required). |
||
| 42 | * 'validate' => false Turn off data validation, for example on required key fields that are set internally. |
||
| 43 | * 'required' => true The value have to be set (not '', null, false) |
||
| 44 | * 'nonEmpty' => true The value should not be empty ('', 0, null) |
||
| 45 | * |
||
| 46 | * Properties correspond to database table's columns but words are |
||
| 47 | * camel cased instead of separated with underscore (_) as in the database. |
||
| 48 | * |
||
| 49 | * @var array |
||
| 50 | */ |
||
| 51 | protected static $dbProperties = []; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Object database field name that is used for primary key (meant to be overridden). |
||
| 55 | * Should be camel cased as it maps to the dbFields array. |
||
| 56 | * |
||
| 57 | * @var string|array |
||
| 58 | */ |
||
| 59 | protected static $primaryDbPropertyKey; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * @var array |
||
| 63 | */ |
||
| 64 | private static $cachedDefaultDbData = []; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @var array |
||
| 68 | */ |
||
| 69 | private static $cachedDbPropertyNames; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * @var array |
||
| 73 | */ |
||
| 74 | private static $cachedDbFieldNames; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * @var array |
||
| 78 | */ |
||
| 79 | private static $typeDefaults = [ |
||
| 80 | 'string' => '', |
||
| 81 | 'int' => 0, |
||
| 82 | 'float' => 0.0, |
||
| 83 | 'bool' => false, |
||
| 84 | ]; |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Database row data with field names and their values. |
||
| 88 | * |
||
| 89 | * @var array |
||
| 90 | */ |
||
| 91 | private $dbData = []; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Database fields that has had their value modified since init/load. |
||
| 95 | * |
||
| 96 | * @var array |
||
| 97 | */ |
||
| 98 | private $modifiedDbProperties = []; |
||
| 99 | |||
| 100 | /** |
||
| 101 | * @var bool |
||
| 102 | */ |
||
| 103 | private $deleteFromDbOnSave = false; |
||
| 104 | |||
| 105 | /** |
||
| 106 | * @var bool |
||
| 107 | */ |
||
| 108 | private $deleted = false; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * @var bool |
||
| 112 | */ |
||
| 113 | private $forceDbInsertOnSave = false; |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Constructor. |
||
| 117 | * |
||
| 118 | * @param mixed $primaryDbValueOrRowData |
||
| 119 | */ |
||
| 120 | 64 | public function __construct($primaryDbValueOrRowData = null) |
|
| 121 | { |
||
| 122 | 64 | self::checkStaticProperties(); |
|
| 123 | |||
| 124 | // Set default values |
||
| 125 | 63 | $this->dbData = $this->getDefaultDbData(); |
|
| 126 | |||
| 127 | // Override default values with provided values |
||
| 128 | 63 | if ($primaryDbValueOrRowData !== null) { |
|
| 129 | 13 | $this->setPrimaryDbValueOrRowData($primaryDbValueOrRowData); |
|
| 130 | } |
||
| 131 | 63 | } |
|
| 132 | |||
| 133 | /** |
||
| 134 | * Make sure that class has all necessary static properties set. |
||
| 135 | */ |
||
| 136 | 64 | private static function checkStaticProperties() |
|
| 137 | { |
||
| 138 | 64 | static $checkedClasses = []; |
|
| 139 | 64 | if (!in_array(static::class, $checkedClasses)) { |
|
| 140 | 7 | if (!static::$dbTableName |
|
| 141 | 6 | || !static::$dbProperties |
|
|
|
|||
| 142 | 6 | || !static::$primaryDbPropertyKey |
|
| 143 | 6 | || (is_scalar(static::$primaryDbPropertyKey) |
|
| 144 | 6 | && !isset(static::$dbProperties[static::$primaryDbPropertyKey]['type'])) |
|
| 145 | 6 | || (is_array(static::$primaryDbPropertyKey) |
|
| 146 | 7 | && !Arr::allIn(static::$primaryDbPropertyKey, array_keys(static::$dbProperties))) |
|
| 147 | ) { |
||
| 148 | 1 | throw new \LogicException("All db entity's static properties not set"); |
|
| 149 | } |
||
| 150 | 6 | $checkedClasses[] = static::class; |
|
| 151 | } |
||
| 152 | 63 | } |
|
| 153 | |||
| 154 | /** |
||
| 155 | * @param mixed $primaryDbValueOrRowData |
||
| 156 | */ |
||
| 157 | 13 | public function setPrimaryDbValueOrRowData($primaryDbValueOrRowData = null) |
|
| 158 | { |
||
| 159 | // Row data would ba an associative array (not sequential, that would indicate a multi column primary key) |
||
| 160 | 13 | if (is_array($primaryDbValueOrRowData) && !isset($primaryDbValueOrRowData[0])) { |
|
| 161 | 1 | $this->setDbDataFromRow($primaryDbValueOrRowData); |
|
| 162 | } else { |
||
| 163 | 12 | $this->setPrimaryDbValue($primaryDbValueOrRowData); |
|
| 164 | } |
||
| 165 | 13 | } |
|
| 166 | |||
| 167 | /** |
||
| 168 | * Get all default database values. |
||
| 169 | * |
||
| 170 | * @return array |
||
| 171 | */ |
||
| 172 | 63 | public function getDefaultDbData() |
|
| 173 | { |
||
| 174 | 63 | $class = get_called_class(); |
|
| 175 | 63 | if (!isset(self::$cachedDefaultDbData[$class])) { |
|
| 176 | 6 | self::$cachedDefaultDbData[$class] = []; |
|
| 177 | 6 | foreach (array_keys(static::$dbProperties) as $propertyName) { |
|
| 178 | 6 | self::$cachedDefaultDbData[$class][$propertyName] = $this->getDefaultDbPropertyValue($propertyName); |
|
| 179 | } |
||
| 180 | } |
||
| 181 | |||
| 182 | 63 | return self::$cachedDefaultDbData[$class]; |
|
| 183 | } |
||
| 184 | |||
| 185 | /** |
||
| 186 | * Get default db value (can be overridden if non static default values need to be used). |
||
| 187 | * |
||
| 188 | * @param string $propertyName |
||
| 189 | * @return mixed |
||
| 190 | */ |
||
| 191 | 6 | public function getDefaultDbPropertyValue($propertyName) |
|
| 192 | { |
||
| 193 | // A default value is set |
||
| 194 | 6 | if (array_key_exists('default', static::$dbProperties[$propertyName])) { |
|
| 195 | 4 | $defaultValue = static::$dbProperties[$propertyName]['default']; |
|
| 196 | // No default value set, use default for type |
||
| 197 | } else { |
||
| 198 | 6 | $defaultValue = self::$typeDefaults[static::$dbProperties[$propertyName]['type']]; |
|
| 199 | } |
||
| 200 | |||
| 201 | 6 | return $defaultValue; |
|
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * @return mixed |
||
| 206 | */ |
||
| 207 | 21 | public function getPrimaryDbValue() |
|
| 208 | { |
||
| 209 | 21 | if (is_array(static::$primaryDbPropertyKey)) { |
|
| 210 | 3 | $primaryValues = []; |
|
| 211 | 3 | foreach (static::$primaryDbPropertyKey as $keyPart) { |
|
| 212 | 3 | $primaryValues[] = $this->dbData[$keyPart]; |
|
| 213 | } |
||
| 214 | |||
| 215 | 3 | return $primaryValues; |
|
| 216 | } |
||
| 217 | |||
| 218 | 18 | return $this->dbData[static::$primaryDbPropertyKey]; |
|
| 219 | } |
||
| 220 | |||
| 221 | /** |
||
| 222 | * @param mixed $primaryDbValue |
||
| 223 | */ |
||
| 224 | 17 | public function setPrimaryDbValue($primaryDbValue) |
|
| 225 | { |
||
| 226 | 17 | if (is_array(static::$primaryDbPropertyKey)) { |
|
| 227 | 3 | if (!is_array($primaryDbValue)) { |
|
| 228 | 1 | throw new \InvalidArgumentException("Primary db value should be an array"); |
|
| 229 | } |
||
| 230 | |||
| 231 | 2 | reset($primaryDbValue); |
|
| 232 | 2 | foreach (static::$primaryDbPropertyKey as $keyPart) { |
|
| 233 | 2 | $this->dbData[$keyPart] = current($primaryDbValue); |
|
| 234 | 2 | next($primaryDbValue); |
|
| 235 | } |
||
| 236 | } else { |
||
| 237 | 14 | $this->dbData[static::$primaryDbPropertyKey] = $primaryDbValue; |
|
| 238 | } |
||
| 239 | 16 | } |
|
| 240 | |||
| 241 | /** |
||
| 242 | * @return bool |
||
| 243 | */ |
||
| 244 | 9 | public function isNewDbEntity() |
|
| 255 | |||
| 256 | /** |
||
| 257 | * @return bool |
||
| 258 | */ |
||
| 259 | 8 | public function shouldInsertOnDbSave() |
|
| 264 | |||
| 265 | /** |
||
| 266 | * Set a row field value. |
||
| 267 | * |
||
| 268 | * @param string $property |
||
| 269 | * @param mixed $value |
||
| 270 | * @param bool $setAsModified |
||
| 271 | */ |
||
| 272 | 23 | protected function setDbValue($property, $value, $setAsModified = true) |
|
| 299 | |||
| 300 | /** |
||
| 301 | * Get a database field value. |
||
| 302 | * |
||
| 303 | * @param string $property |
||
| 304 | * @return mixed |
||
| 305 | */ |
||
| 306 | 8 | protected function getDbValue($property) |
|
| 310 | |||
| 311 | /** |
||
| 312 | * Get raw (with underscore as word separator as it is formatted in database) |
||
| 313 | * field name from a object field property name (camelcased). |
||
| 314 | * |
||
| 315 | * @param string $propertyName |
||
| 316 | * @return string |
||
| 317 | */ |
||
| 318 | 18 | public static function getDbFieldName($propertyName) |
|
| 326 | |||
| 327 | /** |
||
| 328 | * Get object field property name (camelCased) from database field name (underscore separated). |
||
| 329 | * |
||
| 330 | * @param string $dbFieldName |
||
| 331 | * @return string |
||
| 332 | */ |
||
| 333 | 7 | public static function getDbPropertyName($dbFieldName) |
|
| 341 | |||
| 342 | /** |
||
| 343 | * @return bool |
||
| 344 | */ |
||
| 345 | 5 | public function hasModifiedDbProperties() |
|
| 349 | |||
| 350 | /** |
||
| 351 | * @param string $property |
||
| 352 | * @return bool |
||
| 353 | */ |
||
| 354 | 14 | public function isDbPropertyModified($property) |
|
| 358 | |||
| 359 | /** |
||
| 360 | * @return array |
||
| 361 | */ |
||
| 362 | 5 | public function getModifiedDbData() |
|
| 366 | |||
| 367 | /** |
||
| 368 | * @param string $property |
||
| 369 | */ |
||
| 370 | public function clearModifiedDbProperty($property) |
||
| 376 | |||
| 377 | /** |
||
| 378 | */ |
||
| 379 | 4 | public function clearModifiedDbProperties() |
|
| 383 | |||
| 384 | /** |
||
| 385 | * Magic method used to automate getters & setters for row data. |
||
| 386 | * |
||
| 387 | * @param string $name |
||
| 388 | * @param array $arguments |
||
| 389 | * @return mixed |
||
| 390 | */ |
||
| 391 | 17 | public function __call($name, array $arguments = []) |
|
| 408 | |||
| 409 | /** |
||
| 410 | * Set database fields' data. |
||
| 411 | * |
||
| 412 | * @param array $data |
||
| 413 | */ |
||
| 414 | 3 | public function setDbData(array $data) |
|
| 422 | |||
| 423 | /** |
||
| 424 | * Set db data from raw database row data with field names in database format. |
||
| 425 | * |
||
| 426 | * @param array $rowData |
||
| 427 | */ |
||
| 428 | 7 | public function setDbDataFromRow(array $rowData) |
|
| 448 | |||
| 449 | /** |
||
| 450 | * @return array |
||
| 451 | */ |
||
| 452 | 8 | public function getDbData() |
|
| 456 | |||
| 457 | /** |
||
| 458 | * @return array |
||
| 459 | */ |
||
| 460 | 2 | public function getDbDataWithoutPrimary() |
|
| 474 | |||
| 475 | /** |
||
| 476 | * @param bool $deleteFromDbOnSave |
||
| 477 | */ |
||
| 478 | 3 | public function setDeleteFromDbOnSave($deleteFromDbOnSave = true) |
|
| 482 | |||
| 483 | /** |
||
| 484 | * @return bool |
||
| 485 | */ |
||
| 486 | 10 | public function shouldBeDeletedFromDbOnSave() |
|
| 490 | |||
| 491 | /** |
||
| 492 | * @return bool; |
||
| 493 | */ |
||
| 494 | 1 | public function isDeleted() |
|
| 498 | |||
| 499 | /** |
||
| 500 | * @param bool $deleted |
||
| 501 | */ |
||
| 502 | 3 | public function setDeleted($deleted = true) |
|
| 506 | |||
| 507 | /** |
||
| 508 | * @param bool $forceDbInsertOnSave |
||
| 509 | */ |
||
| 510 | 5 | public function setForceDbInsertOnSave($forceDbInsertOnSave) |
|
| 514 | |||
| 515 | /** |
||
| 516 | * @return bool |
||
| 517 | */ |
||
| 518 | 9 | public function shouldForceDbInsertOnSave() |
|
| 522 | |||
| 523 | /** |
||
| 524 | * @param string $propertyName |
||
| 525 | * @return int|null |
||
| 526 | */ |
||
| 527 | 6 | public static function getDbPropertyMaxLength($propertyName) |
|
| 533 | |||
| 534 | /** |
||
| 535 | * @param string $propertyName |
||
| 536 | * @return bool |
||
| 537 | */ |
||
| 538 | 2 | public static function getDbPropertyRequired($propertyName) |
|
| 544 | |||
| 545 | /** |
||
| 546 | * @param string $propertyName |
||
| 547 | * @return bool |
||
| 548 | */ |
||
| 549 | 3 | public static function getDbPropertyNonEmpty($propertyName) |
|
| 555 | |||
| 556 | /** |
||
| 557 | * Get validator for object's database data. |
||
| 558 | * |
||
| 559 | * @param ValidatorTranslatorInterface|SymfonyTranslatorInterface|null $translator |
||
| 560 | * @return Validator |
||
| 561 | */ |
||
| 562 | 3 | public function getDbDataValidator($translator = null) |
|
| 582 | |||
| 583 | /** |
||
| 584 | * Validate and (if no error messages) set database data. |
||
| 585 | * |
||
| 586 | * @param array $data The data (e.g. from a form post) to be validated and set |
||
| 587 | * @param ValidatorTranslatorInterface|SymfonyTranslatorInterface|null $translator |
||
| 588 | * @return array An array with all (if any) of error messages |
||
| 589 | */ |
||
| 590 | 2 | public function validateAndSetDbData(array $data, $translator = null) |
|
| 605 | |||
| 606 | /** |
||
| 607 | * @return string|array |
||
| 608 | */ |
||
| 609 | 17 | public static function getPrimaryDbPropertyKey() |
|
| 613 | |||
| 614 | /** |
||
| 615 | * @return string|array |
||
| 616 | */ |
||
| 617 | 9 | public static function getPrimaryDbFieldKey() |
|
| 632 | |||
| 633 | /** |
||
| 634 | * Return array with db property names. |
||
| 635 | * |
||
| 636 | * @param array $exclude |
||
| 637 | * @return array |
||
| 638 | */ |
||
| 639 | 1 | public static function getDbPropertyNames(array $exclude = []) |
|
| 645 | |||
| 646 | /** |
||
| 647 | * Return array with raw db field names. |
||
| 648 | * |
||
| 649 | * @param array $exclude |
||
| 650 | * @return array |
||
| 651 | */ |
||
| 652 | 3 | public static function getDbFieldNames(array $exclude = []) |
|
| 661 | |||
| 662 | |||
| 663 | /** |
||
| 664 | * Get raw database field names prefixed (id, name becomes t.id, t.name etc.). |
||
| 665 | * |
||
| 666 | * @param string $dbTableAlias |
||
| 667 | * @param array $exclude |
||
| 668 | * @return array |
||
| 669 | */ |
||
| 670 | 1 | public static function getPrefixedDbFieldNames($dbTableAlias, array $exclude = []) |
|
| 674 | |||
| 675 | /** |
||
| 676 | * Get database columns transformed from e.g. "productId, date" to "p.product_id AS p_product_id, p.date AS p_date". |
||
| 677 | * |
||
| 678 | * @param string $dbTableAlias |
||
| 679 | * @param array $exclude |
||
| 680 | * @return array |
||
| 681 | */ |
||
| 682 | 1 | public static function getAliasedDbFieldNames($dbTableAlias, array $exclude = []) |
|
| 693 | |||
| 694 | /** |
||
| 695 | * Filters a full db item array by it's table alias and the strips the table alias. |
||
| 696 | * |
||
| 697 | * @param array $rowData |
||
| 698 | * @param string $dbTableAlias |
||
| 699 | * @param bool $skipStrip For cases when you want to filter only (no stripping) |
||
| 700 | * @return array |
||
| 701 | */ |
||
| 702 | 1 | public static function filterStripDbRowData(array $rowData, $dbTableAlias, $skipStrip = false) |
|
| 716 | |||
| 717 | /** |
||
| 718 | * @return string |
||
| 719 | */ |
||
| 720 | 8 | public static function getDbTableName() |
|
| 724 | |||
| 725 | /** |
||
| 726 | * Method to handle the serialization of this object. |
||
| 727 | * |
||
| 728 | * Implementation of Serializable interface. If descendant private properties |
||
| 729 | * should be serialized, they need to be visible to this parent (i.e. not private). |
||
| 730 | * |
||
| 731 | * @return string |
||
| 732 | */ |
||
| 733 | 2 | public function serialize() |
|
| 737 | |||
| 738 | /** |
||
| 739 | * Method to handle the unserialization of this object. |
||
| 740 | * |
||
| 741 | * Implementation of Serializable interface. If descendant private properties |
||
| 742 | * should be unserialized, they need to be visible to this parent (i.e. not private). |
||
| 743 | * |
||
| 744 | * @param string $serializedObject |
||
| 745 | */ |
||
| 746 | 1 | public function unserialize($serializedObject) |
|
| 754 | |||
| 755 | /** |
||
| 756 | * Merges other object's modified database data into this object. |
||
| 757 | * |
||
| 758 | * @param AbstractDbEntity $otherEntity |
||
| 759 | */ |
||
| 760 | 1 | public function mergeWith(AbstractDbEntity $otherEntity) |
|
| 765 | } |
||
| 766 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.