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 ShoppingService 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 ShoppingService, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
69 | class ShoppingService |
||
70 | { |
||
71 | /** |
||
72 | * @var MailTemplateRepository |
||
73 | */ |
||
74 | protected $mailTemplateRepository; |
||
75 | |||
76 | /** |
||
77 | * @var MailService |
||
78 | */ |
||
79 | protected $mailService; |
||
80 | |||
81 | /** |
||
82 | * @var EventDispatcher |
||
83 | */ |
||
84 | protected $eventDispatcher; |
||
85 | |||
86 | /** |
||
87 | * @var FormFactory |
||
88 | */ |
||
89 | protected $formFactory; |
||
90 | |||
91 | /** |
||
92 | * @var DeliveryFeeRepository |
||
93 | */ |
||
94 | protected $deliveryFeeRepository; |
||
95 | |||
96 | /** |
||
97 | * @var TaxRuleRepository |
||
98 | */ |
||
99 | protected $taxRuleRepository; |
||
100 | |||
101 | /** |
||
102 | * @var CustomerAddressRepository |
||
103 | */ |
||
104 | protected $customerAddressRepository; |
||
105 | |||
106 | /** |
||
107 | * @var DeliveryRepository |
||
108 | */ |
||
109 | protected $deliveryRepository; |
||
110 | |||
111 | /** |
||
112 | * @var DeliveryTimeRepository |
||
113 | */ |
||
114 | protected $deliveryTimeRepository; |
||
115 | |||
116 | /** |
||
117 | * @var OrderStatusRepository |
||
118 | */ |
||
119 | protected $orderStatusRepository; |
||
120 | |||
121 | /** |
||
122 | * @var PaymentRepository |
||
123 | */ |
||
124 | protected $paymentRepository; |
||
125 | |||
126 | /** |
||
127 | * @var DeviceTypeRepository |
||
128 | */ |
||
129 | protected $deviceTypeRepository; |
||
130 | |||
131 | /** |
||
132 | * @var EntityManager |
||
133 | */ |
||
134 | protected $entityManager; |
||
135 | |||
136 | /** |
||
137 | * @var EccubeConfig |
||
138 | */ |
||
139 | protected $eccubeConfig; |
||
140 | |||
141 | /** |
||
142 | * @var PrefRepository |
||
143 | */ |
||
144 | protected $prefRepository; |
||
145 | |||
146 | /** |
||
147 | * @var Session |
||
148 | */ |
||
149 | protected $session; |
||
150 | |||
151 | /** |
||
152 | * @var OrderRepository |
||
153 | */ |
||
154 | protected $orderRepository; |
||
155 | |||
156 | /** |
||
157 | * @var BaseInfo |
||
158 | */ |
||
159 | protected $BaseInfo; |
||
160 | |||
161 | /** |
||
162 | * @var \Eccube\Service\CartService |
||
163 | */ |
||
164 | protected $cartService; |
||
165 | |||
166 | /** |
||
167 | * @var \Eccube\Service\OrderService |
||
168 | * |
||
169 | * @deprecated |
||
170 | */ |
||
171 | protected $orderService; |
||
172 | |||
173 | /** |
||
174 | * @var AuthorizationCheckerInterface |
||
175 | */ |
||
176 | protected $authorizationChecker; |
||
177 | |||
178 | /** |
||
179 | * ShoppingService constructor. |
||
180 | * |
||
181 | * @param MailTemplateRepository $mailTemplateRepository |
||
|
|||
182 | * @param MailService $mailService |
||
183 | * @param EventDispatcher $eventDispatcher |
||
184 | * @param FormFactory $formFactory |
||
185 | * @param DeliveryFeeRepository $deliveryFeeRepository |
||
186 | * @param TaxRuleRepository $taxRuleRepository |
||
187 | * @param CustomerAddressRepository $customerAddressRepository |
||
188 | * @param DeliveryRepository $deliveryRepository |
||
189 | * @param DeliveryTimeRepository $deliveryTimeRepository |
||
190 | * @param OrderStatusRepository $orderStatusRepository |
||
191 | * @param PaymentRepository $paymentRepository |
||
192 | * @param DeviceTypeRepository $deviceTypeRepository |
||
193 | * @param EntityManager $entityManager |
||
194 | * @param EccubeConfig $eccubeConfig |
||
195 | * @param PrefRepository $prefRepository |
||
196 | * @param Session $session |
||
197 | * @param OrderRepository $orderRepository |
||
198 | * @param CartService $cartService |
||
199 | * @param OrderService $orderService |
||
200 | * @param BaseInfo $BaseInfo |
||
201 | * @param AuthorizationCheckerInterface $authorizationChecker |
||
202 | */ |
||
203 | 36 | public function __construct( |
|
248 | |||
249 | /** |
||
250 | * セッションにセットされた受注情報を取得 |
||
251 | * |
||
252 | * @param null $status |
||
253 | * |
||
254 | * @return null|object |
||
255 | */ |
||
256 | 26 | public function getOrder($status = null) |
|
278 | |||
279 | /** |
||
280 | * 非会員情報を取得 |
||
281 | * |
||
282 | * @param $sesisonKey |
||
283 | * |
||
284 | * @return $Customer|null |
||
285 | */ |
||
286 | public function getNonMember($sesisonKey) |
||
309 | |||
310 | /** |
||
311 | * 受注情報を作成 |
||
312 | * |
||
313 | * @param $Customer |
||
314 | * |
||
315 | * @return \Eccube\Entity\Order |
||
316 | */ |
||
317 | public function createOrder($Customer) |
||
338 | |||
339 | /** |
||
340 | * 仮受注情報作成 |
||
341 | * |
||
342 | * @param $Customer |
||
343 | * @param $preOrderId |
||
344 | * |
||
345 | * @return mixed |
||
346 | * |
||
347 | * @throws \Doctrine\ORM\NoResultException |
||
348 | * @throws \Doctrine\ORM\NonUniqueResultException |
||
349 | */ |
||
350 | public function registerPreOrder(Customer $Customer, $preOrderId) |
||
414 | |||
415 | /** |
||
416 | * 受注情報を作成 |
||
417 | * |
||
418 | * @param $Customer |
||
419 | * |
||
420 | * @return \Eccube\Entity\Order |
||
421 | */ |
||
422 | public function getNewOrder(Customer $Customer) |
||
429 | |||
430 | /** |
||
431 | * 受注情報を作成 |
||
432 | * |
||
433 | * @return \Eccube\Entity\Order |
||
434 | */ |
||
435 | public function newOrder() |
||
442 | |||
443 | /** |
||
444 | * 受注情報を作成 |
||
445 | * |
||
446 | * @param \Eccube\Entity\Order $Order |
||
447 | * @param \Eccube\Entity\Customer|null $Customer |
||
448 | * |
||
449 | * @return \Eccube\Entity\Order |
||
450 | */ |
||
451 | public function copyToOrderFromCustomer(Order $Order, Customer $Customer = null) |
||
485 | |||
486 | /** |
||
487 | * 配送業者情報を取得 |
||
488 | * |
||
489 | * @return array |
||
490 | */ |
||
491 | public function getDeliveriesCart() |
||
498 | |||
499 | /** |
||
500 | * 配送業者情報を取得 |
||
501 | * |
||
502 | * @param Order $Order |
||
503 | * |
||
504 | * @return array |
||
505 | */ |
||
506 | public function getDeliveriesOrder(Order $Order) |
||
513 | |||
514 | /** |
||
515 | * 配送業者情報を取得 |
||
516 | * |
||
517 | * @param $saleTypes |
||
518 | * |
||
519 | * @return array |
||
520 | */ |
||
521 | public function getDeliveries($saleTypes) |
||
540 | |||
541 | /** |
||
542 | * お届け先情報を作成 |
||
543 | * |
||
544 | * @param Order $Order |
||
545 | * @param Customer $Customer |
||
546 | * @param $deliveries |
||
547 | * |
||
548 | * @return Order |
||
549 | */ |
||
550 | public function getNewShipping(Order $Order, Customer $Customer, $deliveries) |
||
573 | |||
574 | /** |
||
575 | * お届け先情報を作成 |
||
576 | * |
||
577 | * @param \Eccube\Entity\Shipping $Shipping |
||
578 | * @param \Eccube\Entity\Customer|null $Customer |
||
579 | * |
||
580 | * @return \Eccube\Entity\Shipping |
||
581 | */ |
||
582 | public function copyToShippingFromCustomer(Shipping $Shipping, Customer $Customer = null) |
||
635 | |||
636 | /** |
||
637 | * 受注明細情報、配送商品情報を作成 |
||
638 | * |
||
639 | * @param Order $Order |
||
640 | * |
||
641 | * @return Order |
||
642 | */ |
||
643 | public function getNewDetails(Order $Order) |
||
660 | |||
661 | /** |
||
662 | * 配送商品情報を作成 |
||
663 | * |
||
664 | * @param Order $Order |
||
665 | * @param Product $Product |
||
666 | * @param ProductClass $ProductClass |
||
667 | * @param $quantity |
||
668 | * |
||
669 | * @return \Eccube\Entity\OrderItem |
||
670 | */ |
||
671 | public function getNewOrderItem(Order $Order, Product $Product, ProductClass $ProductClass, $quantity) |
||
723 | |||
724 | /** |
||
725 | * お届け先ごとの送料合計を取得 |
||
726 | * |
||
727 | * @param $shippings |
||
728 | * |
||
729 | * @return int |
||
730 | */ |
||
731 | public function getShippingDeliveryFeeTotal($shippings) |
||
740 | |||
741 | /** |
||
742 | * 商品ごとの配送料を取得 |
||
743 | * |
||
744 | * @param Shipping $Shipping |
||
745 | * |
||
746 | * @return int |
||
747 | */ |
||
748 | public function getProductDeliveryFee(Shipping $Shipping) |
||
758 | |||
759 | /** |
||
760 | * 住所などの情報が変更された時に金額の再計算を行う |
||
761 | * |
||
762 | * @deprecated PurchaseFlowで行う |
||
763 | * |
||
764 | * @param Order $Order |
||
765 | * |
||
766 | * @return Order |
||
767 | */ |
||
768 | public function getAmount(Order $Order) |
||
788 | |||
789 | /** |
||
790 | * 配送料金の設定 |
||
791 | * |
||
792 | * @param Shipping $Shipping |
||
793 | * @param Delivery|null $Delivery |
||
794 | */ |
||
795 | public function setShippingDeliveryFee(Shipping $Shipping, Delivery $Delivery = null) |
||
816 | |||
817 | /** |
||
818 | * 配送料無料条件(合計金額)の条件を満たしていれば配送料金を0に設定 |
||
819 | * |
||
820 | * @param Order $Order |
||
821 | */ |
||
822 | 2 | View Code Duplication | public function setDeliveryFreeAmount(Order $Order) |
823 | { |
||
824 | // 配送料無料条件(合計金額) |
||
825 | 2 | $deliveryFreeAmount = $this->BaseInfo->getDeliveryFreeAmount(); |
|
826 | 2 | if (!is_null($deliveryFreeAmount)) { |
|
827 | // 合計金額が設定金額以上であれば送料無料 |
||
828 | if ($Order->getSubTotal() >= $deliveryFreeAmount) { |
||
829 | $Order->setDeliveryFeeTotal(0); |
||
830 | // お届け先情報の配送料も0にセット |
||
831 | $shippings = $Order->getShippings(); |
||
832 | foreach ($shippings as $Shipping) { |
||
833 | $Shipping->setShippingDeliveryFee(0); |
||
834 | } |
||
835 | } |
||
836 | } |
||
837 | } |
||
838 | |||
839 | /** |
||
840 | * 配送料無料条件(合計数量)の条件を満たしていれば配送料金を0に設定 |
||
841 | * |
||
842 | * @param Order $Order |
||
843 | */ |
||
844 | 2 | View Code Duplication | public function setDeliveryFreeQuantity(Order $Order) |
845 | { |
||
846 | // 配送料無料条件(合計数量) |
||
847 | 2 | $deliveryFreeQuantity = $this->BaseInfo->getDeliveryFreeQuantity(); |
|
848 | 2 | if (!is_null($deliveryFreeQuantity)) { |
|
849 | // 合計数量が設定数量以上であれば送料無料 |
||
850 | if ($this->orderService->getTotalQuantity($Order) >= $deliveryFreeQuantity) { |
||
851 | $Order->setDeliveryFeeTotal(0); |
||
852 | // お届け先情報の配送料も0にセット |
||
853 | $shippings = $Order->getShippings(); |
||
854 | foreach ($shippings as $Shipping) { |
||
855 | $Shipping->setShippingDeliveryFee(0); |
||
856 | } |
||
857 | } |
||
858 | } |
||
859 | } |
||
860 | |||
861 | /** |
||
862 | * 受注情報、お届け先情報の更新 |
||
863 | * |
||
864 | * @param Order $Order 受注情報 |
||
865 | * @param $data フォームデータ |
||
866 | * |
||
867 | * @deprecated since 3.0.5, to be removed in 3.1 |
||
868 | */ |
||
869 | public function setOrderUpdate(Order $Order, $data) |
||
902 | |||
903 | /** |
||
904 | * 受注情報の更新 |
||
905 | * |
||
906 | * @param Order $Order 受注情報 |
||
907 | */ |
||
908 | 2 | public function setOrderUpdateData(Order $Order) |
|
909 | { |
||
910 | // 受注情報を更新 |
||
911 | 2 | $Order->setOrderDate(new \DateTime()); // XXX 後続の setOrderStatus でも時刻を更新している |
|
912 | 2 | $OrderStatus = $this->orderStatusRepository->find(OrderStatus::NEW); |
|
913 | 2 | $this->setOrderStatus($Order, $OrderStatus); |
|
914 | } |
||
915 | |||
916 | /** |
||
917 | * 会員情報の更新 |
||
918 | * |
||
919 | * @param Order $Order 受注情報 |
||
920 | * @param Customer $user ログインユーザ |
||
921 | */ |
||
922 | 1 | public function setCustomerUpdate(Order $Order, Customer $user) |
|
923 | { |
||
924 | // 顧客情報を更新 |
||
925 | 1 | $now = new \DateTime(); |
|
926 | 1 | $firstBuyDate = $user->getFirstBuyDate(); |
|
927 | 1 | if (empty($firstBuyDate)) { |
|
928 | 1 | $user->setFirstBuyDate($now); |
|
929 | } |
||
930 | 1 | $user->setLastBuyDate($now); |
|
931 | |||
932 | 1 | $user->setBuyTimes($user->getBuyTimes() + 1); |
|
933 | 1 | $user->setBuyTotal($user->getBuyTotal() + $Order->getTotal()); |
|
934 | } |
||
935 | |||
936 | /** |
||
937 | * 支払方法選択の表示設定 |
||
938 | * |
||
939 | * @param $payments 支払選択肢情報 |
||
940 | * @param $subTotal 小計 |
||
941 | * |
||
942 | * @return array |
||
943 | */ |
||
944 | public function getPayments($payments, $subTotal) |
||
961 | |||
962 | /** |
||
963 | * お届け日を取得 |
||
964 | * |
||
965 | * @param Order $Order |
||
966 | * |
||
967 | * @return array |
||
968 | */ |
||
969 | public function getFormDeliveryDurations(Order $Order) |
||
1015 | |||
1016 | /** |
||
1017 | * 支払方法を取得 |
||
1018 | * |
||
1019 | * @param $deliveries |
||
1020 | * @param Order $Order |
||
1021 | * |
||
1022 | * @return array |
||
1023 | */ |
||
1024 | public function getFormPayments($deliveries, Order $Order) |
||
1041 | |||
1042 | /** |
||
1043 | * お届け先ごとにFormを作成 |
||
1044 | * |
||
1045 | * @param Order $Order |
||
1046 | * |
||
1047 | * @return \Symfony\Component\Form\Form |
||
1048 | * |
||
1049 | * @deprecated since 3.0, to be removed in 3.1 |
||
1050 | */ |
||
1051 | View Code Duplication | public function getShippingForm(Order $Order) |
|
1076 | |||
1077 | /** |
||
1078 | * お届け先ごとにFormBuilderを作成 |
||
1079 | * |
||
1080 | * @param Order $Order |
||
1081 | * |
||
1082 | * @return \Symfony\Component\Form\FormBuilderInterface |
||
1083 | * |
||
1084 | * @deprecated 利用している箇所なし |
||
1085 | */ |
||
1086 | View Code Duplication | public function getShippingFormBuilder(Order $Order) |
|
1109 | |||
1110 | /** |
||
1111 | * フォームデータを更新 |
||
1112 | * |
||
1113 | * @param Order $Order |
||
1114 | * @param array $data |
||
1115 | * |
||
1116 | * @deprecated |
||
1117 | */ |
||
1118 | public function setFormData(Order $Order, array $data) |
||
1137 | |||
1138 | /** |
||
1139 | * 配送料の合計金額を計算 |
||
1140 | * |
||
1141 | * @param Order $Order |
||
1142 | * |
||
1143 | * @return Order |
||
1144 | */ |
||
1145 | 2 | public function calculateDeliveryFee(Order $Order) |
|
1146 | { |
||
1147 | // 配送業者を取得 |
||
1148 | 2 | $shippings = $Order->getShippings(); |
|
1149 | |||
1150 | // 配送料合計金額 |
||
1151 | // TODO CalculateDeliveryFeeStrategy でセットする |
||
1152 | // $Order->setDeliveryFeeTotal($this->getShippingDeliveryFeeTotal($shippings)); |
||
1153 | |||
1154 | // 配送料無料条件(合計金額) |
||
1155 | 2 | $this->setDeliveryFreeAmount($Order); |
|
1156 | |||
1157 | // 配送料無料条件(合計数量) |
||
1158 | 2 | $this->setDeliveryFreeQuantity($Order); |
|
1159 | |||
1160 | 2 | return $Order; |
|
1161 | } |
||
1162 | |||
1163 | /** |
||
1164 | * 購入処理を行う |
||
1165 | * |
||
1166 | * @param Order $Order |
||
1167 | * |
||
1168 | * @deprecated PurchaseFlow::purchase() を使用してください |
||
1169 | */ |
||
1170 | 2 | public function processPurchase(Order $Order) |
|
1171 | { |
||
1172 | // 受注情報、配送情報を更新 |
||
1173 | 2 | $Order = $this->calculateDeliveryFee($Order); |
|
1174 | 2 | $this->setOrderUpdateData($Order); |
|
1175 | |||
1176 | 2 | if ($this->authorizationChecker->isGranted('ROLE_USER')) { |
|
1177 | 1 | $this->setCustomerUpdate($Order, $Order->getCustomer()); |
|
1178 | } |
||
1179 | } |
||
1180 | |||
1181 | /** |
||
1182 | * 値引き可能かチェック |
||
1183 | * |
||
1184 | * @param Order $Order |
||
1185 | * @param $discount |
||
1186 | * |
||
1187 | * @return bool |
||
1188 | */ |
||
1189 | public function isDiscount(Order $Order, $discount) |
||
1197 | |||
1198 | /** |
||
1199 | * 値引き金額をセット |
||
1200 | * |
||
1201 | * @param Order $Order |
||
1202 | * @param $discount |
||
1203 | */ |
||
1204 | public function setDiscount(Order $Order, $discount) |
||
1208 | |||
1209 | /** |
||
1210 | * 合計金額を計算 |
||
1211 | * |
||
1212 | * @param Order $Order |
||
1213 | * |
||
1214 | * @return Order |
||
1215 | */ |
||
1216 | public function calculatePrice(Order $Order) |
||
1230 | |||
1231 | /** |
||
1232 | * 受注ステータスをセット |
||
1233 | * |
||
1234 | * @param Order $Order |
||
1235 | * @param $status |
||
1236 | * |
||
1237 | * @return Order |
||
1238 | */ |
||
1239 | 2 | public function setOrderStatus(Order $Order, $status) |
|
1240 | { |
||
1241 | 2 | $Order->setOrderDate(new \DateTime()); |
|
1242 | 2 | $Order->setOrderStatus($this->orderStatusRepository->find($status)); |
|
1243 | |||
1244 | 2 | $event = new EventArgs( |
|
1245 | [ |
||
1246 | 2 | 'Order' => $Order, |
|
1247 | ], |
||
1248 | 2 | null |
|
1249 | ); |
||
1250 | 2 | $this->eventDispatcher->dispatch(EccubeEvents::SERVICE_SHOPPING_ORDER_STATUS, $event); |
|
1251 | |||
1252 | 2 | return $Order; |
|
1253 | } |
||
1254 | |||
1255 | /** |
||
1256 | * 受注メール送信を行う |
||
1257 | * |
||
1258 | * @param Order $Order |
||
1259 | * |
||
1260 | * @return MailHistory |
||
1261 | */ |
||
1262 | 2 | public function sendOrderMail(Order $Order) |
|
1263 | { |
||
1264 | // メール送信 |
||
1265 | 2 | $message = $this->mailService->sendOrderMail($Order); |
|
1266 | |||
1267 | // 送信履歴を保存. |
||
1268 | 2 | $MailHistory = new MailHistory(); |
|
1269 | $MailHistory |
||
1270 | 2 | ->setMailSubject($message->getSubject()) |
|
1271 | 2 | ->setMailBody($message->getBody()) |
|
1272 | 2 | ->setSendDate(new \DateTime()) |
|
1273 | 2 | ->setOrder($Order); |
|
1274 | |||
1275 | 2 | $this->entityManager->persist($MailHistory); |
|
1276 | 2 | $this->entityManager->flush($MailHistory); |
|
1277 | |||
1278 | 2 | return $MailHistory; |
|
1279 | } |
||
1280 | |||
1281 | /** |
||
1282 | * 受注処理完了通知 |
||
1283 | * |
||
1284 | * @param Order $Order |
||
1285 | */ |
||
1286 | public function notifyComplete(Order $Order) |
||
1296 | } |
||
1297 |