techdivision /
import
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:
| 1 | <?php |
||
| 39 | trait AttributeObserverTrait |
||
| 40 | { |
||
| 41 | |||
| 42 | /** |
||
| 43 | * The ID of the attribute to create the values for. |
||
| 44 | * |
||
| 45 | * @var integer |
||
| 46 | */ |
||
| 47 | protected $attributeId; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * The attribute code of the attribute to create the values for. |
||
| 51 | * |
||
| 52 | * @var string |
||
| 53 | */ |
||
| 54 | protected $attributeCode; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * The backend type of the attribute to create the values for. |
||
| 58 | * |
||
| 59 | * @var string |
||
| 60 | */ |
||
| 61 | protected $backendType; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * The attribute value to process. |
||
| 65 | * |
||
| 66 | * @var mixed |
||
| 67 | */ |
||
| 68 | protected $attributeValue; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * The array with the column keys that has to be cleaned up when their values are empty. |
||
| 72 | * |
||
| 73 | * @var array |
||
| 74 | * @deprecated Will be removed up from version 17.0.0 |
||
| 75 | */ |
||
| 76 | protected $cleanUpEmptyColumnKeys; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * The entity's existing attribues. |
||
| 80 | * |
||
| 81 | * @var array |
||
| 82 | */ |
||
| 83 | protected $attributes; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * The attribute code that has to be processed. |
||
| 87 | * |
||
| 88 | * @return string The attribute code |
||
| 89 | */ |
||
| 90 | 1 | public function getAttributeCode() |
|
| 94 | |||
| 95 | /** |
||
| 96 | * The attribute value that has to be processed. |
||
| 97 | * |
||
| 98 | * @return string The attribute value |
||
| 99 | */ |
||
| 100 | 1 | public function getAttributeValue() |
|
| 104 | |||
| 105 | /** |
||
| 106 | * Remove all the empty values from the row and return the cleared row. |
||
| 107 | * |
||
| 108 | * @return array The cleared row |
||
| 109 | * @todo Move initialization of $this->cleanUpEmptyColumnKeys to createObserver() method and implement ObserverFactoryInterface |
||
| 110 | */ |
||
| 111 | 7 | protected function clearRow() |
|
| 112 | { |
||
| 113 | |||
| 114 | // initialize the array with the column keys that has to be cleaned-up |
||
| 115 | 7 | $this->cleanUpEmptyColumnKeys = array(); |
|
|
|
|||
| 116 | |||
| 117 | // query whether or not column names that has to be cleaned up have been configured |
||
| 118 | 7 | View Code Duplication | if ($this->getSubject()->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)) { |
| 119 | // if yes, load the column names |
||
| 120 | $cleanUpEmptyColumns = $this->getSubject()->getCleanUpColumns(); |
||
| 121 | |||
| 122 | // translate the column names into column keys |
||
| 123 | foreach ($cleanUpEmptyColumns as $cleanUpEmptyColumn) { |
||
| 124 | if ($this->hasHeader($cleanUpEmptyColumn)) { |
||
| 125 | $this->cleanUpEmptyColumnKeys[] = $this->getHeader($cleanUpEmptyColumn); |
||
| 126 | } |
||
| 127 | } |
||
| 128 | } |
||
| 129 | |||
| 130 | // remove all the empty values from the row, expected the columns has to be cleaned-up |
||
| 131 | 7 | View Code Duplication | foreach ($this->row as $key => $value) { |
| 132 | // query whether or not the value is empty AND the column has NOT to be cleaned-up |
||
| 133 | 7 | if (($value === null || $value === '') && in_array($key, $this->cleanUpEmptyColumnKeys) === false) { |
|
| 134 | 7 | unset($this->row[$key]); |
|
| 135 | } |
||
| 136 | } |
||
| 137 | |||
| 138 | // finally return the clean row |
||
| 139 | 7 | return $this->row; |
|
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Returns the value(s) of the primary key column(s). As the primary key column can |
||
| 144 | * also consist of two columns, the return value can be an array also. |
||
| 145 | * |
||
| 146 | * @return mixed The primary key value(s) |
||
| 147 | */ |
||
| 148 | 7 | protected function getPrimaryKeyValue() |
|
| 152 | |||
| 153 | /** |
||
| 154 | * Process the observer's business logic. |
||
| 155 | * |
||
| 156 | * @return void |
||
| 157 | */ |
||
| 158 | 7 | protected function process() |
|
| 313 | |||
| 314 | /** |
||
| 315 | * Prepare the attributes of the entity that has to be persisted. |
||
| 316 | * |
||
| 317 | * @return array|null The prepared attributes |
||
| 318 | */ |
||
| 319 | 2 | protected function prepareAttributes() |
|
| 349 | |||
| 350 | /** |
||
| 351 | * Initialize the category product with the passed attributes and returns an instance. |
||
| 352 | * |
||
| 353 | * @param array $attr The category product attributes |
||
| 354 | * |
||
| 355 | * @return array The initialized category product |
||
| 356 | */ |
||
| 357 | 2 | protected function initializeAttribute(array $attr) |
|
| 361 | |||
| 362 | /** |
||
| 363 | * Return's the array with callbacks for the passed type. |
||
| 364 | * |
||
| 365 | * @param string $type The type of the callbacks to return |
||
| 366 | * |
||
| 367 | * @return array The callbacks |
||
| 368 | */ |
||
| 369 | 2 | protected function getCallbacksByType($type) |
|
| 373 | |||
| 374 | /** |
||
| 375 | * Return's mapping for the supported backend types (for the product entity) => persist methods. |
||
| 376 | * |
||
| 377 | * @return array The mapping for the supported backend types |
||
| 378 | */ |
||
| 379 | 7 | protected function getBackendTypes() |
|
| 383 | |||
| 384 | /** |
||
| 385 | * Return's the attributes for the attribute set of the product that has to be created. |
||
| 386 | * |
||
| 387 | * @return array The attributes |
||
| 388 | * @throws \Exception |
||
| 389 | */ |
||
| 390 | 7 | protected function getAttributes() |
|
| 394 | |||
| 395 | /** |
||
| 396 | * Intializes the existing attributes for the entity with the passed primary key. |
||
| 397 | * |
||
| 398 | * @param string $pk The primary key of the entity to load the attributes for |
||
| 399 | * @param integer $storeId The ID of the store view to load the attributes for |
||
| 400 | * |
||
| 401 | * @return array The entity attributes |
||
| 402 | */ |
||
| 403 | abstract protected function getAttributesByPrimaryKeyAndStoreId($pk, $storeId); |
||
| 404 | |||
| 405 | /** |
||
| 406 | * Return's the logger with the passed name, by default the system logger. |
||
| 407 | * |
||
| 408 | * @param string $name The name of the requested system logger |
||
| 409 | * |
||
| 410 | * @return \Psr\Log\LoggerInterface The logger instance |
||
| 411 | * @throws \Exception Is thrown, if the requested logger is NOT available |
||
| 412 | */ |
||
| 413 | abstract protected function getSystemLogger($name = LoggerKeys::SYSTEM); |
||
| 414 | |||
| 415 | /** |
||
| 416 | * Return's the PK to create the product => attribute relation. |
||
| 417 | * |
||
| 418 | * @return integer The PK to create the relation with |
||
| 419 | */ |
||
| 420 | abstract protected function getPrimaryKey(); |
||
| 421 | |||
| 422 | /** |
||
| 423 | * Return's the PK column name to create the product => attribute relation. |
||
| 424 | * |
||
| 425 | * @return string The PK column name |
||
| 426 | */ |
||
| 427 | abstract protected function getPrimaryKeyMemberName(); |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Return's the column name that contains the primary key. |
||
| 431 | * |
||
| 432 | * @return string the column name that contains the primary key |
||
| 433 | */ |
||
| 434 | abstract protected function getPrimaryKeyColumnName(); |
||
| 435 | |||
| 436 | /** |
||
| 437 | * Queries whether or not the passed PK and store view code has already been processed. |
||
| 438 | * |
||
| 439 | * @param string $pk The PK to check been processed |
||
| 440 | * @param string $storeViewCode The store view code to check been processed |
||
| 441 | * |
||
| 442 | * @return boolean TRUE if the PK and store view code has been processed, else FALSE |
||
| 443 | */ |
||
| 444 | abstract protected function storeViewHasBeenProcessed($pk, $storeViewCode); |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Persist's the passed varchar attribute. |
||
| 448 | * |
||
| 449 | * @param array $attribute The attribute to persist |
||
| 450 | * |
||
| 451 | * @return void |
||
| 452 | */ |
||
| 453 | abstract protected function persistVarcharAttribute($attribute); |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Persist's the passed integer attribute. |
||
| 457 | * |
||
| 458 | * @param array $attribute The attribute to persist |
||
| 459 | * |
||
| 460 | * @return void |
||
| 461 | */ |
||
| 462 | abstract protected function persistIntAttribute($attribute); |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Persist's the passed decimal attribute. |
||
| 466 | * |
||
| 467 | * @param array $attribute The attribute to persist |
||
| 468 | * |
||
| 469 | * @return void |
||
| 470 | */ |
||
| 471 | abstract protected function persistDecimalAttribute($attribute); |
||
| 472 | |||
| 473 | /** |
||
| 474 | * Persist's the passed datetime attribute. |
||
| 475 | * |
||
| 476 | * @param array $attribute The attribute to persist |
||
| 477 | * |
||
| 478 | * @return void |
||
| 479 | */ |
||
| 480 | abstract protected function persistDatetimeAttribute($attribute); |
||
| 481 | |||
| 482 | /** |
||
| 483 | * Persist's the passed text attribute. |
||
| 484 | * |
||
| 485 | * @param array $attribute The attribute to persist |
||
| 486 | * |
||
| 487 | * @return void |
||
| 488 | */ |
||
| 489 | abstract protected function persistTextAttribute($attribute); |
||
| 490 | |||
| 491 | /** |
||
| 492 | * Delete's the datetime attribute with the passed value ID. |
||
| 493 | * |
||
| 494 | * @param array $row The attributes of the entity to delete |
||
| 495 | * @param string|null $name The name of the prepared statement that has to be executed |
||
| 496 | * |
||
| 497 | * @return void |
||
| 498 | */ |
||
| 499 | abstract protected function deleteDatetimeAttribute(array $row, $name = null); |
||
| 500 | |||
| 501 | /** |
||
| 502 | * Delete's the decimal attribute with the passed value ID. |
||
| 503 | * |
||
| 504 | * @param array $row The attributes of the entity to delete |
||
| 505 | * @param string|null $name The name of the prepared statement that has to be executed |
||
| 506 | * |
||
| 507 | * @return void |
||
| 508 | */ |
||
| 509 | abstract protected function deleteDecimalAttribute(array $row, $name = null); |
||
| 510 | |||
| 511 | /** |
||
| 512 | * Delete's the integer attribute with the passed value ID. |
||
| 513 | * |
||
| 514 | * @param array $row The attributes of the entity to delete |
||
| 515 | * @param string|null $name The name of the prepared statement that has to be executed |
||
| 516 | * |
||
| 517 | * @return void |
||
| 518 | */ |
||
| 519 | abstract protected function deleteIntAttribute(array $row, $name = null); |
||
| 520 | |||
| 521 | /** |
||
| 522 | * Delete's the text attribute with the passed value ID. |
||
| 523 | * |
||
| 524 | * @param array $row The attributes of the entity to delete |
||
| 525 | * @param string|null $name The name of the prepared statement that has to be executed |
||
| 526 | * |
||
| 527 | * @return void |
||
| 528 | */ |
||
| 529 | abstract protected function deleteTextAttribute(array $row, $name = null); |
||
| 530 | |||
| 531 | /** |
||
| 532 | * Delete's the varchar attribute with the passed value ID. |
||
| 533 | * |
||
| 534 | * @param array $row The attributes of the entity to delete |
||
| 535 | * @param string|null $name The name of the prepared statement that has to be executed |
||
| 536 | * |
||
| 537 | * @return void |
||
| 538 | */ |
||
| 539 | abstract protected function deleteVarcharAttribute(array $row, $name = null); |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Query whether or not the entity has to be processed. |
||
| 543 | * |
||
| 544 | * @param array $entity The entity to query for |
||
| 545 | * |
||
| 546 | * @return boolean TRUE if the entity has to be processed, else FALSE |
||
| 547 | */ |
||
| 548 | abstract protected function hasChanges(array $entity); |
||
| 549 | } |
||
| 550 |
Loading history...
This property has been deprecated. The supplier of the class has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.