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 BunchSubject 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 BunchSubject, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
38 | class BunchSubject extends AbstractProductSubject |
||
39 | { |
||
40 | |||
41 | /** |
||
42 | * The mapping for the supported backend types (for the product entity) => persist methods. |
||
43 | * |
||
44 | * @var array |
||
45 | */ |
||
46 | protected $backendTypes = array( |
||
47 | 'datetime' => array('persistProductDatetimeAttribute', 'loadProductDatetimeAttribute'), |
||
48 | 'decimal' => array('persistProductDecimalAttribute', 'loadProductDecimalAttribute'), |
||
49 | 'int' => array('persistProductIntAttribute', 'loadProductIntAttribute'), |
||
50 | 'text' => array('persistProductTextAttribute', 'loadProductTextAttribute'), |
||
51 | 'varchar' => array('persistProductVarcharAttribute', 'loadProductVarcharAttribute') |
||
52 | ); |
||
53 | |||
54 | /** |
||
55 | * Mappings for attribute code => CSV column header. |
||
56 | * |
||
57 | * @var array |
||
58 | */ |
||
59 | protected $headerMappings = array( |
||
60 | 'status' => 'product_online', |
||
61 | 'tax_class_id' => 'tax_class_name', |
||
62 | 'price_type' => 'bundle_price_type', |
||
63 | 'sku_type' => 'bundle_sku_type', |
||
64 | 'price_view' => 'bundle_price_view', |
||
65 | 'weight_type' => 'bundle_weight_type', |
||
66 | 'image' => 'base_image', |
||
67 | 'image_label' => 'base_image_label', |
||
68 | 'thumbnail' => 'thumbnail_image', |
||
69 | 'thumbnail_label' => 'thumbnail_image_label', |
||
70 | 'shipment_type' => 'bundle_shipment_type' |
||
71 | ); |
||
72 | |||
73 | /** |
||
74 | * Mappings for the table column => CSV column header. |
||
75 | * |
||
76 | * @var array |
||
77 | */ |
||
78 | protected $headerStockMappings = array( |
||
79 | 'qty' => array('qty', 'float'), |
||
80 | 'min_qty' => array('out_of_stock_qty', 'float'), |
||
81 | 'use_config_min_qty' => array('use_config_min_qty', 'int'), |
||
82 | 'is_qty_decimal' => array('is_qty_decimal', 'int'), |
||
83 | 'backorders' => array('allow_backorders', 'int'), |
||
84 | 'use_config_backorders' => array('use_config_backorders', 'int'), |
||
85 | 'min_sale_qty' => array('min_cart_qty', 'float'), |
||
86 | 'use_config_min_sale_qty' => array('use_config_min_sale_qty', 'int'), |
||
87 | 'max_sale_qty' => array('max_cart_qty', 'float'), |
||
88 | 'use_config_max_sale_qty' => array('use_config_max_sale_qty', 'int'), |
||
89 | 'is_in_stock' => array('is_in_stock', 'int'), |
||
90 | 'notify_stock_qty' => array('notify_on_stock_below', 'float'), |
||
91 | 'use_config_notify_stock_qty' => array('use_config_notify_stock_qty', 'int'), |
||
92 | 'manage_stock' => array('manage_stock', 'int'), |
||
93 | 'use_config_manage_stock' => array('use_config_manage_stock', 'int'), |
||
94 | 'use_config_qty_increments' => array('use_config_qty_increments', 'int'), |
||
95 | 'qty_increments' => array('qty_increments', 'float'), |
||
96 | 'use_config_enable_qty_inc' => array('use_config_enable_qty_inc', 'int'), |
||
97 | 'enable_qty_increments' => array('enable_qty_increments', 'int'), |
||
98 | 'is_decimal_divided' => array('is_decimal_divided', 'int'), |
||
99 | ); |
||
100 | |||
101 | /** |
||
102 | * The array with the available visibility keys. |
||
103 | * |
||
104 | * @var array |
||
105 | */ |
||
106 | protected $availableVisibilities = array( |
||
107 | 'Not Visible Individually' => VisibilityKeys::VISIBILITY_NOT_VISIBLE, |
||
108 | 'Catalog' => VisibilityKeys::VISIBILITY_IN_CATALOG, |
||
109 | 'Search' => VisibilityKeys::VISIBILITY_IN_SEARCH, |
||
110 | 'Catalog, Search' => VisibilityKeys::VISIBILITY_BOTH |
||
111 | ); |
||
112 | |||
113 | /** |
||
114 | * The attribute set of the product that has to be created. |
||
115 | * |
||
116 | * @var array |
||
117 | */ |
||
118 | protected $attributeSet = array(); |
||
119 | |||
120 | /** |
||
121 | * The array containing the data for product type configuration (configurables, bundles, etc). |
||
122 | * |
||
123 | * @var array |
||
124 | */ |
||
125 | protected $artefacs = array(); |
||
126 | |||
127 | /** |
||
128 | * The mapping for the SKUs to the created entity IDs. |
||
129 | * |
||
130 | * @var array |
||
131 | */ |
||
132 | protected $skuEntityIdMapping = array(); |
||
133 | |||
134 | /** |
||
135 | * The category IDs the product is related with. |
||
136 | * |
||
137 | * @var array |
||
138 | */ |
||
139 | protected $productCategoryIds = array(); |
||
140 | |||
141 | /** |
||
142 | * Set's the attribute set of the product that has to be created. |
||
143 | * |
||
144 | * @param array $attributeSet The attribute set |
||
145 | * |
||
146 | * @return void |
||
147 | */ |
||
148 | 1 | public function setAttributeSet(array $attributeSet) |
|
152 | |||
153 | /** |
||
154 | * Return's the attribute set of the product that has to be created. |
||
155 | * |
||
156 | * @return array The attribute set |
||
157 | */ |
||
158 | public function getAttributeSet() |
||
162 | |||
163 | /** |
||
164 | * Clean up the global data after importing the bunch. |
||
165 | * |
||
166 | * @return void |
||
167 | */ |
||
168 | public function tearDown() |
||
186 | |||
187 | /** |
||
188 | * Export's the artefacts to CSV files. |
||
189 | * |
||
190 | * @return void |
||
191 | */ |
||
192 | protected function exportArtefacts() |
||
224 | |||
225 | /** |
||
226 | * Return's the target directory for the artefact export. |
||
227 | * |
||
228 | * @return string The target directory for the artefact export |
||
229 | */ |
||
230 | protected function getTargetDir() |
||
234 | |||
235 | /** |
||
236 | * Initialize and return the exporter configuration. |
||
237 | * |
||
238 | * @return \Goodby\CSV\Export\Standard\ExporterConfig The exporter configuration |
||
239 | */ |
||
240 | protected function getExportConfig() |
||
279 | |||
280 | /** |
||
281 | * Cast's the passed value based on the backend type information. |
||
282 | * |
||
283 | * @param string $backendType The backend type to cast to |
||
284 | * @param mixed $value The value to be casted |
||
285 | * |
||
286 | * @return mixed The casted value |
||
287 | */ |
||
288 | 1 | public function castValueByBackendType($backendType, $value) |
|
309 | |||
310 | /** |
||
311 | * Return's the mappings for the table column => CSV column header. |
||
312 | * |
||
313 | * @return array The header stock mappings |
||
314 | */ |
||
315 | 1 | public function getHeaderStockMappings() |
|
319 | |||
320 | /** |
||
321 | * Return's mapping for the supported backend types (for the product entity) => persist methods. |
||
322 | * |
||
323 | * @return array The mapping for the supported backend types |
||
324 | */ |
||
325 | public function getBackendTypes() |
||
329 | |||
330 | /** |
||
331 | * Return's the artefacts for post-processing. |
||
332 | * |
||
333 | * @return array The artefacts |
||
334 | */ |
||
335 | public function getArtefacts() |
||
339 | |||
340 | /** |
||
341 | * Return's the visibility key for the passed visibility string. |
||
342 | * |
||
343 | * @param string $visibility The visibility string to return the key for |
||
344 | * |
||
345 | * @return integer The requested visibility key |
||
346 | * @throws \Exception Is thrown, if the requested visibility is not available |
||
347 | */ |
||
348 | View Code Duplication | public function getVisibilityIdByValue($visibility) |
|
366 | |||
367 | /** |
||
368 | * Map the passed attribute code, if a header mapping exists and return the |
||
369 | * mapped mapping. |
||
370 | * |
||
371 | * @param string $attributeCode The attribute code to map |
||
372 | * |
||
373 | * @return string The mapped attribute code, or the original one |
||
374 | */ |
||
375 | public function mapAttributeCodeByHeaderMapping($attributeCode) |
||
386 | |||
387 | /** |
||
388 | * Add the passed product type artefacts to the product with the |
||
389 | * last entity ID. |
||
390 | * |
||
391 | * @param string $type The artefact type, e. g. configurable |
||
392 | * @param array $artefacts The product type artefacts |
||
393 | * |
||
394 | * @return void |
||
395 | * @uses \TechDivision\Import\Product\Subjects\BunchSubject::getLastEntityId() |
||
396 | */ |
||
397 | public function addArtefacts($type, array $artefacts) |
||
408 | |||
409 | /** |
||
410 | * Add the passed SKU => entity ID mapping. |
||
411 | * |
||
412 | * @param string $sku The SKU |
||
413 | * |
||
414 | * @return void |
||
415 | * @uses \Import\Csv\Actions\ProductImportBunchAction::getLastEntityId() |
||
416 | */ |
||
417 | public function addSkuEntityIdMapping($sku) |
||
421 | |||
422 | /** |
||
423 | * Add the passed category ID to the product's category list. |
||
424 | * |
||
425 | * @param integer $categoryId The category ID to add |
||
426 | * |
||
427 | * @return void |
||
428 | */ |
||
429 | public function addProductCategoryId($categoryId) |
||
433 | |||
434 | /** |
||
435 | * Return's the list with category IDs the product is related with. |
||
436 | * |
||
437 | * @return array The product's category IDs |
||
438 | */ |
||
439 | public function getProductCategoryIds() |
||
453 | |||
454 | /** |
||
455 | * Return's the attribute option value with the passed value and store ID. |
||
456 | * |
||
457 | * @param mixed $value The option value |
||
458 | * @param integer $storeId The ID of the store |
||
459 | * |
||
460 | * @return array|boolean The attribute option value instance |
||
461 | */ |
||
462 | public function getEavAttributeOptionValueByOptionValueAndStoreId($value, $storeId) |
||
466 | |||
467 | /** |
||
468 | * Return's the URL rewrites for the passed URL entity type and ID. |
||
469 | * |
||
470 | * @param string $entityType The entity type to load the URL rewrites for |
||
471 | * @param integer $entityId The entity ID to laod the rewrites for |
||
472 | * |
||
473 | * @return array The URL rewrites |
||
474 | */ |
||
475 | 1 | public function getUrlRewritesByEntityTypeAndEntityId($entityType, $entityId) |
|
479 | |||
480 | /** |
||
481 | * Load's and return's the product with the passed SKU. |
||
482 | * |
||
483 | * @param string $sku The SKU of the product to load |
||
484 | * |
||
485 | * @return array The product |
||
486 | */ |
||
487 | public function loadProduct($sku) |
||
491 | |||
492 | /** |
||
493 | * Load's and return's the product website relation with the passed product and website ID. |
||
494 | * |
||
495 | * @param string $productId The product ID of the relation |
||
496 | * @param string $websiteId The website ID of the relation |
||
497 | * |
||
498 | * @return array The product website |
||
499 | */ |
||
500 | public function loadProductWebsite($productId, $websiteId) |
||
504 | |||
505 | /** |
||
506 | * Return's the category product relation with the passed category/product ID. |
||
507 | * |
||
508 | * @param integer $categoryId The category ID of the category product relation to return |
||
509 | * @param integer $productId The product ID of the category product relation to return |
||
510 | * |
||
511 | * @return array The category product relation |
||
512 | */ |
||
513 | public function loadCategoryProduct($categoryId, $productId) |
||
517 | |||
518 | /** |
||
519 | * Load's and return's the stock status with the passed product/website/stock ID. |
||
520 | * |
||
521 | * @param integer $productId The product ID of the stock status to load |
||
522 | * @param integer $websiteId The website ID of the stock status to load |
||
523 | * @param integer $stockId The stock ID of the stock status to load |
||
524 | * |
||
525 | * @return array The stock status |
||
526 | */ |
||
527 | public function loadStockStatus($productId, $websiteId, $stockId) |
||
531 | |||
532 | /** |
||
533 | * Load's and return's the stock status with the passed product/website/stock ID. |
||
534 | * |
||
535 | * @param integer $productId The product ID of the stock item to load |
||
536 | * @param integer $websiteId The website ID of the stock item to load |
||
537 | * @param integer $stockId The stock ID of the stock item to load |
||
538 | * |
||
539 | * @return array The stock item |
||
540 | */ |
||
541 | public function loadStockItem($productId, $websiteId, $stockId) |
||
545 | |||
546 | /** |
||
547 | * Load's and return's the datetime attribute with the passed entity/attribute/store ID. |
||
548 | * |
||
549 | * @param integer $entityId The entity ID of the attribute |
||
550 | * @param integer $attributeId The attribute ID of the attribute |
||
551 | * @param integer $storeId The store ID of the attribute |
||
552 | * |
||
553 | * @return array|null The datetime attribute |
||
554 | */ |
||
555 | public function loadProductDatetimeAttribute($entityId, $attributeId, $storeId) |
||
559 | |||
560 | /** |
||
561 | * Load's and return's the decimal attribute with the passed entity/attribute/store ID. |
||
562 | * |
||
563 | * @param integer $entityId The entity ID of the attribute |
||
564 | * @param integer $attributeId The attribute ID of the attribute |
||
565 | * @param integer $storeId The store ID of the attribute |
||
566 | * |
||
567 | * @return array|null The decimal attribute |
||
568 | */ |
||
569 | public function loadProductDecimalAttribute($entityId, $attributeId, $storeId) |
||
573 | |||
574 | /** |
||
575 | * Load's and return's the integer attribute with the passed entity/attribute/store ID. |
||
576 | * |
||
577 | * @param integer $entityId The entity ID of the attribute |
||
578 | * @param integer $attributeId The attribute ID of the attribute |
||
579 | * @param integer $storeId The store ID of the attribute |
||
580 | * |
||
581 | * @return array|null The integer attribute |
||
582 | */ |
||
583 | public function loadProductIntAttribute($entityId, $attributeId, $storeId) |
||
587 | |||
588 | /** |
||
589 | * Load's and return's the text attribute with the passed entity/attribute/store ID. |
||
590 | * |
||
591 | * @param integer $entityId The entity ID of the attribute |
||
592 | * @param integer $attributeId The attribute ID of the attribute |
||
593 | * @param integer $storeId The store ID of the attribute |
||
594 | * |
||
595 | * @return array|null The text attribute |
||
596 | */ |
||
597 | public function loadProductTextAttribute($entityId, $attributeId, $storeId) |
||
601 | |||
602 | /** |
||
603 | * Load's and return's the varchar attribute with the passed entity/attribute/store ID. |
||
604 | * |
||
605 | * @param integer $entityId The entity ID of the attribute |
||
606 | * @param integer $attributeId The attribute ID of the attribute |
||
607 | * @param integer $storeId The store ID of the attribute |
||
608 | * |
||
609 | * @return array|null The varchar attribute |
||
610 | */ |
||
611 | public function loadProductVarcharAttribute($entityId, $attributeId, $storeId) |
||
615 | |||
616 | /** |
||
617 | * Persist's the passed product data and return's the ID. |
||
618 | * |
||
619 | * @param array $product The product data to persist |
||
620 | * |
||
621 | * @return string The ID of the persisted entity |
||
622 | */ |
||
623 | public function persistProduct($product) |
||
627 | |||
628 | /** |
||
629 | * Persist's the passed product varchar attribute. |
||
630 | * |
||
631 | * @param array $attribute The attribute to persist |
||
632 | * |
||
633 | * @return void |
||
634 | */ |
||
635 | public function persistProductVarcharAttribute($attribute) |
||
639 | |||
640 | /** |
||
641 | * Persist's the passed product integer attribute. |
||
642 | * |
||
643 | * @param array $attribute The attribute to persist |
||
644 | * |
||
645 | * @return void |
||
646 | */ |
||
647 | public function persistProductIntAttribute($attribute) |
||
651 | |||
652 | /** |
||
653 | * Persist's the passed product decimal attribute. |
||
654 | * |
||
655 | * @param array $attribute The attribute to persist |
||
656 | * |
||
657 | * @return void |
||
658 | */ |
||
659 | public function persistProductDecimalAttribute($attribute) |
||
663 | |||
664 | /** |
||
665 | * Persist's the passed product datetime attribute. |
||
666 | * |
||
667 | * @param array $attribute The attribute to persist |
||
668 | * |
||
669 | * @return void |
||
670 | */ |
||
671 | public function persistProductDatetimeAttribute($attribute) |
||
675 | |||
676 | /** |
||
677 | * Persist's the passed product text attribute. |
||
678 | * |
||
679 | * @param array $attribute The attribute to persist |
||
680 | * |
||
681 | * @return void |
||
682 | */ |
||
683 | public function persistProductTextAttribute($attribute) |
||
687 | |||
688 | /** |
||
689 | * Persist's the passed product website data and return's the ID. |
||
690 | * |
||
691 | * @param array $productWebsite The product website data to persist |
||
692 | * |
||
693 | * @return void |
||
694 | */ |
||
695 | public function persistProductWebsite($productWebsite) |
||
699 | |||
700 | /** |
||
701 | * Persist's the passed category product relation. |
||
702 | * |
||
703 | * @param array $categoryProduct The category product relation to persist |
||
704 | * |
||
705 | * @return void |
||
706 | */ |
||
707 | public function persistCategoryProduct($categoryProduct) |
||
711 | |||
712 | /** |
||
713 | * Persist's the passed stock item data and return's the ID. |
||
714 | * |
||
715 | * @param array $stockItem The stock item data to persist |
||
716 | * |
||
717 | * @return void |
||
718 | */ |
||
719 | public function persistStockItem($stockItem) |
||
723 | |||
724 | /** |
||
725 | * Persist's the passed stock status data and return's the ID. |
||
726 | * |
||
727 | * @param array $stockStatus The stock status data to persist |
||
728 | * |
||
729 | * @return void |
||
730 | */ |
||
731 | public function persistStockStatus($stockStatus) |
||
735 | |||
736 | /** |
||
737 | * Persist's the URL write with the passed data. |
||
738 | * |
||
739 | * @param array $row The URL rewrite to persist |
||
740 | * |
||
741 | * @return void |
||
742 | */ |
||
743 | 1 | public function persistUrlRewrite($row) |
|
747 | |||
748 | /** |
||
749 | * Delete's the entity with the passed attributes. |
||
750 | * |
||
751 | * @param array $row The attributes of the entity to delete |
||
752 | * @param string|null $name The name of the prepared statement that has to be executed |
||
753 | * |
||
754 | * @return void |
||
755 | */ |
||
756 | public function deleteProduct($row, $name = null) |
||
760 | |||
761 | /** |
||
762 | * Delete's the URL rewrite(s) with the passed attributes. |
||
763 | * |
||
764 | * @param array $row The attributes of the entity to delete |
||
765 | * @param string|null $name The name of the prepared statement that has to be executed |
||
766 | * |
||
767 | * @return void |
||
768 | */ |
||
769 | 1 | public function deleteUrlRewrite($row, $name = null) |
|
773 | |||
774 | /** |
||
775 | * Delete's the stock item(s) with the passed attributes. |
||
776 | * |
||
777 | * @param array $row The attributes of the entity to delete |
||
778 | * @param string|null $name The name of the prepared statement that has to be executed |
||
779 | * |
||
780 | * @return void |
||
781 | */ |
||
782 | public function deleteStockItem($row, $name = null) |
||
786 | |||
787 | /** |
||
788 | * Delete's the stock status with the passed attributes. |
||
789 | * |
||
790 | * @param array $row The attributes of the entity to delete |
||
791 | * @param string|null $name The name of the prepared statement that has to be executed |
||
792 | * |
||
793 | * @return void |
||
794 | */ |
||
795 | public function deleteStockStatus($row, $name = null) |
||
799 | |||
800 | /** |
||
801 | * Delete's the product website relations with the passed attributes. |
||
802 | * |
||
803 | * @param array $row The attributes of the entity to delete |
||
804 | * @param string|null $name The name of the prepared statement that has to be executed |
||
805 | * |
||
806 | * @return void |
||
807 | */ |
||
808 | public function deleteProductWebsite($row, $name = null) |
||
812 | |||
813 | /** |
||
814 | * Delete's the category product relations with the passed attributes. |
||
815 | * |
||
816 | * @param array $row The attributes of the entity to delete |
||
817 | * @param string|null $name The name of the prepared statement that has to be executed |
||
818 | * |
||
819 | * @return void |
||
820 | */ |
||
821 | public function deleteCategoryProduct($row, $name = null) |
||
825 | } |
||
826 |
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.