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 |
||
| 36 | View Code Duplication | class LastEntityIdObserver extends AbstractProductImportObserver |
|
|
|
|||
| 37 | { |
||
| 38 | |||
| 39 | /** |
||
| 40 | * The product bunch processor instance. |
||
| 41 | * |
||
| 42 | * @var \TechDivision\Import\Product\Services\ProductBunchProcessorInterface |
||
| 43 | */ |
||
| 44 | protected $productBunchProcessor; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Initialize the observer with the passed product bunch processor instance. |
||
| 48 | * |
||
| 49 | * @param \TechDivision\Import\Product\Services\ProductBunchProcessorInterface $productBunchProcessor The product bunch processor instance |
||
| 50 | */ |
||
| 51 | public function __construct(ProductBunchProcessorInterface $productBunchProcessor) |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Return's the product bunch processor instance. |
||
| 58 | * |
||
| 59 | * @return \TechDivision\Import\Product\Services\ProductBunchProcessorInterface The product bunch processor instance |
||
| 60 | */ |
||
| 61 | protected function getProductBunchProcessor() |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Process the observer's business logic. |
||
| 68 | * |
||
| 69 | * @return array The processed row |
||
| 70 | * @throws \Exception Is thrown, if the product with the SKU can not be loaded |
||
| 71 | */ |
||
| 72 | protected function process() |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Temporarily persist's the IDs of the passed product. |
||
| 99 | * |
||
| 100 | * @param array $product The product to temporarily persist the IDs for |
||
| 101 | */ |
||
| 102 | protected function setIds(array $product) |
||
| 106 | |||
| 107 | /** |
||
| 108 | * Set's the ID of the product that has been created recently. |
||
| 109 | * |
||
| 110 | * @param string $lastEntityId The entity ID |
||
| 111 | * |
||
| 112 | * @return void |
||
| 113 | */ |
||
| 114 | protected function setLastEntityId($lastEntityId) |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Load's and return's the product with the passed SKU. |
||
| 121 | * |
||
| 122 | * @param string $sku The SKU of the product to load |
||
| 123 | * |
||
| 124 | * @return array The product |
||
| 125 | */ |
||
| 126 | protected function loadProduct($sku) |
||
| 130 | } |
||
| 131 |
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.