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 |
||
| 51 | class OrderController extends AbstractController |
||
|
|
|||
| 52 | { |
||
| 53 | /** |
||
| 54 | * @var PurchaseFlow |
||
| 55 | */ |
||
| 56 | protected $purchaseFlow; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var CsvExportService |
||
| 60 | */ |
||
| 61 | protected $csvExportService; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var CustomerRepository |
||
| 65 | */ |
||
| 66 | protected $customerRepository; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var PaymentRepository |
||
| 70 | */ |
||
| 71 | protected $paymentRepository; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @var SexRepository |
||
| 75 | */ |
||
| 76 | protected $sexRepository; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @var OrderStatusRepository |
||
| 80 | */ |
||
| 81 | protected $orderStatusRepository; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * @var PageMaxRepository |
||
| 85 | */ |
||
| 86 | protected $pageMaxRepository; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * @var ProductStatusRepository |
||
| 90 | */ |
||
| 91 | protected $productStatusRepository; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * @var OrderRepository |
||
| 95 | */ |
||
| 96 | protected $orderRepository; |
||
| 97 | |||
| 98 | /** |
||
| 99 | * @var ValidatorInterface |
||
| 100 | */ |
||
| 101 | protected $validator; |
||
| 102 | |||
| 103 | /** |
||
| 104 | * OrderController constructor. |
||
| 105 | * |
||
| 106 | * @param PurchaseFlow $orderPurchaseFlow |
||
| 107 | * @param CsvExportService $csvExportService |
||
| 108 | * @param CustomerRepository $customerRepository |
||
| 109 | * @param PaymentRepository $paymentRepository |
||
| 110 | * @param SexRepository $sexRepository |
||
| 111 | * @param OrderStatusRepository $orderStatusRepository |
||
| 112 | * @param PageMaxRepository $pageMaxRepository |
||
| 113 | * @param ProductStatusRepository $productStatusRepository |
||
| 114 | * @param OrderRepository $orderRepository |
||
| 115 | */ |
||
| 116 | 14 | public function __construct( |
|
| 139 | |||
| 140 | /** |
||
| 141 | * 受注一覧画面. |
||
| 142 | * |
||
| 143 | * - 検索条件, ページ番号, 表示件数はセッションに保持されます. |
||
| 144 | * - クエリパラメータでresume=1が指定された場合、検索条件, ページ番号, 表示件数をセッションから復旧します. |
||
| 145 | * - 各データの, セッションに保持するアクションは以下の通りです. |
||
| 146 | * - 検索ボタン押下時 |
||
| 147 | * - 検索条件をセッションに保存します |
||
| 148 | * - ページ番号は1で初期化し、セッションに保存します。 |
||
| 149 | * - 表示件数変更時 |
||
| 150 | * - クエリパラメータpage_countをセッションに保存します。 |
||
| 151 | * - ただし, mtb_page_maxと一致しない場合, eccube_default_page_countが保存されます. |
||
| 152 | * - ページング時 |
||
| 153 | * - URLパラメータpage_noをセッションに保存します. |
||
| 154 | * - 初期表示 |
||
| 155 | * - 検索条件は空配列, ページ番号は1で初期化し, セッションに保存します. |
||
| 156 | * |
||
| 157 | * @Route("/%eccube_admin_route%/order", name="admin_order") |
||
| 158 | * @Route("/%eccube_admin_route%/order/page/{page_no}", requirements={"page_no" = "\d+"}, name="admin_order_page") |
||
| 159 | * @Template("@admin/Order/index.twig") |
||
| 160 | */ |
||
| 161 | 8 | public function index(Request $request, $page_no = null, PaginatorInterface $paginator) |
|
| 285 | |||
| 286 | /** |
||
| 287 | * @Method("POST") |
||
| 288 | * @Route("/%eccube_admin_route%/order/bulk_delete", name="admin_order_bulk_delete") |
||
| 289 | */ |
||
| 290 | 1 | public function bulkDelete(Request $request) |
|
| 309 | |||
| 310 | /** |
||
| 311 | * 受注CSVの出力. |
||
| 312 | * |
||
| 313 | * @Route("/%eccube_admin_route%/order/export/order", name="admin_order_export_order") |
||
| 314 | * |
||
| 315 | * @param Request $request |
||
| 316 | * |
||
| 317 | * @return StreamedResponse |
||
| 318 | */ |
||
| 319 | 1 | View Code Duplication | public function exportOrder(Request $request) |
| 320 | { |
||
| 321 | 1 | $filename = 'order_'.(new \DateTime())->format('YmdHis').'.csv'; |
|
| 322 | 1 | $response = $this->exportCsv($request, CsvType::CSV_TYPE_ORDER, $filename); |
|
| 323 | 1 | log_info('受注CSV出力ファイル名', [$filename]); |
|
| 324 | |||
| 325 | 1 | return $response; |
|
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * 配送CSVの出力. |
||
| 330 | * |
||
| 331 | * @Route("/%eccube_admin_route%/order/export/shipping", name="admin_order_export_shipping") |
||
| 332 | * |
||
| 333 | * @param Request $request |
||
| 334 | * |
||
| 335 | * @return StreamedResponse |
||
| 336 | */ |
||
| 337 | View Code Duplication | public function exportShipping(Request $request) |
|
| 345 | |||
| 346 | /** |
||
| 347 | * @param Request $request |
||
| 348 | * @param $csvTypeId |
||
| 349 | * @param $fileName |
||
| 350 | * |
||
| 351 | * @return StreamedResponse |
||
| 352 | */ |
||
| 353 | 1 | private function exportCsv(Request $request, $csvTypeId, $fileName) |
|
| 354 | { |
||
| 355 | // タイムアウトを無効にする. |
||
| 356 | 1 | set_time_limit(0); |
|
| 357 | |||
| 358 | // sql loggerを無効にする. |
||
| 359 | 1 | $em = $this->entityManager; |
|
| 360 | 1 | $em->getConfiguration()->setSQLLogger(null); |
|
| 361 | |||
| 362 | 1 | $response = new StreamedResponse(); |
|
| 363 | 1 | $response->setCallback(function () use ($request, $csvTypeId) { |
|
| 364 | // CSV種別を元に初期化. |
||
| 365 | 1 | $this->csvExportService->initCsvType($csvTypeId); |
|
| 366 | |||
| 367 | // ヘッダ行の出力. |
||
| 368 | 1 | $this->csvExportService->exportHeader(); |
|
| 369 | |||
| 370 | // 受注データ検索用のクエリビルダを取得. |
||
| 371 | 1 | $qb = $this->csvExportService |
|
| 372 | 1 | ->getOrderQueryBuilder($request); |
|
| 373 | |||
| 374 | // データ行の出力. |
||
| 375 | 1 | $this->csvExportService->setExportQueryBuilder($qb); |
|
| 376 | 1 | $this->csvExportService->exportData(function ($entity, $csvService) use ($request) { |
|
| 377 | 1 | $Csvs = $csvService->getCsvs(); |
|
| 378 | |||
| 379 | 1 | $Order = $entity; |
|
| 380 | 1 | $OrderItems = $Order->getOrderItems(); |
|
| 381 | |||
| 382 | 1 | foreach ($OrderItems as $OrderItem) { |
|
| 383 | 1 | $ExportCsvRow = new ExportCsvRow(); |
|
| 384 | |||
| 385 | // CSV出力項目と合致するデータを取得. |
||
| 386 | 1 | foreach ($Csvs as $Csv) { |
|
| 387 | // 受注データを検索. |
||
| 388 | 1 | $ExportCsvRow->setData($csvService->getData($Csv, $Order)); |
|
| 389 | 1 | if ($ExportCsvRow->isDataNull()) { |
|
| 390 | // 受注データにない場合は, 受注明細を検索. |
||
| 391 | 1 | $ExportCsvRow->setData($csvService->getData($Csv, $OrderItem)); |
|
| 392 | } |
||
| 393 | 1 | if ($ExportCsvRow->isDataNull() && $Shipping = $OrderItem->getShipping()) { |
|
| 394 | // 受注明細データにない場合は, 出荷を検索. |
||
| 395 | 1 | $ExportCsvRow->setData($csvService->getData($Csv, $Shipping)); |
|
| 396 | } |
||
| 397 | |||
| 398 | 1 | $event = new EventArgs( |
|
| 399 | [ |
||
| 400 | 1 | 'csvService' => $csvService, |
|
| 401 | 1 | 'Csv' => $Csv, |
|
| 402 | 1 | 'OrderItem' => $OrderItem, |
|
| 403 | 1 | 'ExportCsvRow' => $ExportCsvRow, |
|
| 404 | ], |
||
| 405 | 1 | $request |
|
| 406 | ); |
||
| 407 | 1 | $this->eventDispatcher->dispatch(EccubeEvents::ADMIN_ORDER_CSV_EXPORT_ORDER, $event); |
|
| 408 | |||
| 409 | 1 | $ExportCsvRow->pushData(); |
|
| 410 | } |
||
| 411 | |||
| 412 | //$row[] = number_format(memory_get_usage(true)); |
||
| 413 | // 出力. |
||
| 414 | 1 | $csvService->fputcsv($ExportCsvRow->getRow()); |
|
| 415 | } |
||
| 416 | 1 | }); |
|
| 417 | 1 | }); |
|
| 418 | |||
| 419 | 1 | $response->headers->set('Content-Type', 'application/octet-stream'); |
|
| 420 | 1 | $response->headers->set('Content-Disposition', 'attachment; filename='.$fileName); |
|
| 421 | 1 | $response->send(); |
|
| 422 | |||
| 423 | 1 | return $response; |
|
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Bulk action to order status |
||
| 428 | * |
||
| 429 | * @Method("POST") |
||
| 430 | * @Route("/%eccube_admin_route%/order/bulk/order-status/{id}", requirements={"id" = "\d+"}, name="admin_order_bulk_order_status") |
||
| 431 | * |
||
| 432 | * @param Request $request |
||
| 433 | * @param OrderStatus $OrderStatus |
||
| 434 | * |
||
| 435 | * @return RedirectResponse |
||
| 436 | */ |
||
| 437 | 2 | public function bulkOrderStatus(Request $request, OrderStatus $OrderStatus) |
|
| 511 | |||
| 512 | /** |
||
| 513 | * Update to Tracking number. |
||
| 514 | * |
||
| 515 | * @Method("PUT") |
||
| 516 | * @Route("/%eccube_admin_route%/shipping/{id}/tracking_number", requirements={"id" = "\d+"}, name="admin_shipping_update_tracking_number") |
||
| 517 | * |
||
| 518 | * @param Request $request |
||
| 519 | * @param Shipping $shipping |
||
| 520 | * |
||
| 521 | * @return Response |
||
| 522 | */ |
||
| 523 | 2 | public function updateTrackingNumber(Request $request, Shipping $shipping) |
|
| 565 | } |
||
| 566 |