CsvImportController::__construct() - Code Metrics - Inspection of "OrderStatusMachineでOrderStatusのidが変更される問題の対応" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — experimental/sf (#3402)

by Kiyotaka

created 2018-07-25 08:25 UTC

CsvImportController::__construct() A

↳ Parent: CsvImportController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	7
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Controller\Admin\Order;

use Eccube\Controller\Admin\AbstractCsvImportController;
use Eccube\Entity\Shipping;
use Eccube\Entity\Master\OrderStatus;
use Eccube\Form\Type\Admin\CsvImportType;
use Eccube\Repository\ShippingRepository;
use Eccube\Service\CsvImportService;
use Eccube\Service\OrderStateMachine;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\HttpFoundation\Request;

class CsvImportController extends AbstractCsvImportController

{
    /**
     * @var ShippingRepository
     */
    private $shippingRepository;

    /**
     * @var OrderStateMachine
     */
    protected $orderStateMachine;

    public function __construct(
        ShippingRepository $shippingRepository,
        OrderStateMachine $orderStateMachine
    ) {
        $this->shippingRepository = $shippingRepository;
        $this->orderStateMachine = $orderStateMachine;
    }

    /**

     * 出荷CSVアップロード
     *
     * @Route("/%eccube_admin_route%/order/shipping_csv_upload", name="admin_shipping_csv_import")
     * @Template("@admin/Order/csv_shipping.twig")
     *
     * @throws \Doctrine\DBAL\ConnectionException
     */

    public function csvShipping(Request $request)
    {
        $form = $this->formFactory->createBuilder(CsvImportType::class)->getForm();
        $columnConfig = $this->getColumnConfig();
        $errors = [];

        if ($request->getMethod() === 'POST') {
            $form->handleRequest($request);
            if ($form->isValid()) {
                $formFile = $form['import_file']->getData();

                if (!empty($formFile)) {
                    $csv = $this->getImportData($formFile);

                    try {
                        $this->entityManager->getConfiguration()->setSQLLogger(null);
                        $this->entityManager->getConnection()->beginTransaction();

                        $this->loadCsv($csv, $errors);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

                        if ($errors) {
                            $this->entityManager->getConnection()->rollBack();
                        } else {
                            $this->entityManager->flush();
                            $this->entityManager->getConnection()->commit();

                            $this->addInfo('admin.shipping.csv_import.save.complete', 'admin');
                        }
                    } finally {
                        $this->removeUploadedFile();
                    }
                }
            }
        }

        return [
            'form' => $form->createView(),
            'headers' => $columnConfig,
            'errors' => $errors,
        ];
    }

    protected function loadCsv(CsvImportService $csv, &$errors)
    {
        $columnConfig = $this->getColumnConfig();

        if ($csv === false) {
            $errors[] = trans('csvimport.text.error.format_invalid');
        }

        // 必須カラムの確認
        $requiredColumns = array_map(function ($value) {
            return $value['name'];
        }, array_filter($columnConfig, function ($value) {

            return $value['required'];
        }));
        $csvColumns = $csv->getColumnHeaders();
        if (count(array_diff($requiredColumns, $csvColumns)) > 0) {
            $errors[] = trans('csvimport.text.error.format_invalid');
        }

        // 行数の確認
        $size = count($csv);
        if ($size < 1) {
            $errors[] = trans('csvimport.text.error.format_invalid');
        }

        $columnNames = array_combine(array_keys($columnConfig), array_column($columnConfig, 'name'));

        foreach ($csv as $line => $row) {
            // 出荷IDがなければエラー
            if (!isset($row[$columnNames['id']])) {
                $errors[] = trans('csvimportcontroller.require', ['%line%' => $line, '%name%' => $columnNames['id']]);
                continue;
            }

            /* @var Shipping $Shipping */
            $Shipping = is_numeric($row[$columnNames['id']]) ? $this->shippingRepository->find($row[$columnNames['id']]) : null;

            // 存在しない出荷IDはエラー
            if (is_null($Shipping)) {
                $errors[] = trans('csvimportcontroller.notfound', ['%line%' => $line, '%name%' => $columnNames['id']]);
                continue;
            }

            if (isset($row[$columnNames['tracking_number']])) {
                $Shipping->setTrackingNumber($row[$columnNames['tracking_number']]);
            }

            if (isset($row[$columnNames['shipping_date']])) {
                // 日付フォーマットが異なる場合はエラー
                $shippingDate = \DateTime::createFromFormat('Y-m-d', $row[$columnNames['shipping_date']]);
                if ($shippingDate === false) {
                    $errors[] = trans('csvimportcontroller.invalid_date_format', ['%line%' => $line, '%name%' => $columnNames['id']]);
                    continue;
                }

                $shippingDate->setTime(0, 0, 0);
                $Shipping->setShippingDate($shippingDate);
            }

            $Order = $Shipping->getOrder();
            $RelateShippings = $Order->getShippings();
            $allShipped = true;
            foreach ($RelateShippings as $RelateShipping) {
                if (!$RelateShipping->getShippingDate()) {
                    $allShipped = false;
                    break;
                }
            }
            $OrderStatus = $this->entityManager->find(OrderStatus::class, OrderStatus::DELIVERED);
            if ($allShipped) {
                if ($this->orderStateMachine->can($Order, $OrderStatus)) {
                    $this->orderStateMachine->apply($Order, $OrderStatus);
                } else {
                    $from = $Order->getOrderStatus()->getName();
                    $to = $OrderStatus->getName();
                    $errors[] = sprintf('%s: %s から %s へステータス変更できませんでした', $Shipping->getId(), $from, $to);
                }
            }
        }
    }

    /**

     * アップロード用CSV雛形ファイルダウンロード
     *
     * @Route("/%eccube_admin_route%/order/csv_template", name="admin_shipping_csv_template")
     */

    public function csvTemplate(Request $request)

    {
        $columns = array_column($this->getColumnConfig(), 'name');

        return $this->sendTemplateResponse($request, $columns, 'shipping.csv');
    }

    protected function getColumnConfig()
    {
        return [
            'id' => [
                'name' => trans('admin.shipping.csv_shipping.id'),
                'description' => trans('admin.shipping.csv_shipping.id.description'),
                'required' => true,
            ],
            'tracking_number' => [
                'name' => trans('admin.shipping.csv_shipping.tracking_number'),
                'description' => trans('admin.shipping.csv_shipping.tracking_number.description'),
                'required' => false,
            ],
            'shipping_date' => [
                'name' => trans('admin.shipping.csv_shipping.shipping_date'),
                'description' => trans('admin.shipping.csv_shipping.shipping_date.description'),
                'required' => false,
            ],
        ];
    }
}


1		<?php
2
3		/*
4		* This file is part of EC-CUBE
5		*
6		* Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
7		*
8		* http://www.lockon.co.jp/
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Eccube\Controller\Admin\Order;
15
16		use Eccube\Controller\Admin\AbstractCsvImportController;
17		use Eccube\Entity\Shipping;
18		use Eccube\Entity\Master\OrderStatus;
19		use Eccube\Form\Type\Admin\CsvImportType;
20		use Eccube\Repository\ShippingRepository;
21		use Eccube\Service\CsvImportService;
22		use Eccube\Service\OrderStateMachine;
23		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
24		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
25		use Symfony\Component\HttpFoundation\Request;
26
27		class CsvImportController extends AbstractCsvImportController
		0 ignored issues – show introduced 2018-07-05 09:47 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
28		{
29		/**
30		* @var ShippingRepository
31		*/
32		private $shippingRepository;
33
34		/**
35		* @var OrderStateMachine
36		*/
37		protected $orderStateMachine;
38
39	8	public function __construct(
40		ShippingRepository $shippingRepository,
41		OrderStateMachine $orderStateMachine
42		) {
43	8	$this->shippingRepository = $shippingRepository;
44	8	$this->orderStateMachine = $orderStateMachine;
45		}
46
47		/**
		0 ignored issues – show introduced 2018-07-20 11:17 UTC by Report Bug Copy Issue Report Doc comment for parameter "$request" missing Loading history...
48		* 出荷CSVアップロード
49		*
50		* @Route("/%eccube_admin_route%/order/shipping_csv_upload", name="admin_shipping_csv_import")
51		* @Template("@admin/Order/csv_shipping.twig")
52		*
53		* @throws \Doctrine\DBAL\ConnectionException
54		*/
		0 ignored issues – show introduced 2018-07-05 09:47 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
55	1	public function csvShipping(Request $request)
56		{
57	1	$form = $this->formFactory->createBuilder(CsvImportType::class)->getForm();
58	1	$columnConfig = $this->getColumnConfig();
59	1	$errors = [];
60
61	1	if ($request->getMethod() === 'POST') {
62	1	$form->handleRequest($request);
63	1	if ($form->isValid()) {
64	1	$formFile = $form['import_file']->getData();
65
66	1	if (!empty($formFile)) {
67	1	$csv = $this->getImportData($formFile);
68
69		try {
70	1	$this->entityManager->getConfiguration()->setSQLLogger(null);
71	1	$this->entityManager->getConnection()->beginTransaction();
72
73	1	$this->loadCsv($csv, $errors);
		0 ignored issues – show Security Bug introduced 2018-07-23 14:25 UTC by Report Bug Copy Issue Report It seems like `$csv` defined by `$this->getImportData($formFile)` on line `67` can also be of type `false`; however, `Eccube\Controller\Admin\...rtController::loadCsv()` does only seem to accept `object<Eccube\Service\CsvImportService>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
74
75	1	if ($errors) {
76		$this->entityManager->getConnection()->rollBack();
77		} else {
78	1	$this->entityManager->flush();
79	1	$this->entityManager->getConnection()->commit();
80
81	1	$this->addInfo('admin.shipping.csv_import.save.complete', 'admin');
82		}
83	1	} finally {
84	1	$this->removeUploadedFile();
85		}
86		}
87		}
88		}
89
90		return [
91	1	'form' => $form->createView(),
92	1	'headers' => $columnConfig,
93	1	'errors' => $errors,
94		];
95		}
96
97	8	protected function loadCsv(CsvImportService $csv, &$errors)
98		{
99	8	$columnConfig = $this->getColumnConfig();
100
101	8	if ($csv === false) {
102		$errors[] = trans('csvimport.text.error.format_invalid');
103		}
104
105		// 必須カラムの確認
106	8	$requiredColumns = array_map(function ($value) {
107	8	return $value['name'];
108		}, array_filter($columnConfig, function ($value) {
		0 ignored issues – show Coding Style introduced 2018-07-05 09:47 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `12` spaces, but found `8`. Loading history...
109	8	return $value['required'];
110	8	}));
111	8	$csvColumns = $csv->getColumnHeaders();
112	8	if (count(array_diff($requiredColumns, $csvColumns)) > 0) {
113	2	$errors[] = trans('csvimport.text.error.format_invalid');
114		}
115
116		// 行数の確認
117	8	$size = count($csv);
118	8	if ($size < 1) {
119		$errors[] = trans('csvimport.text.error.format_invalid');
120		}
121
122	8	$columnNames = array_combine(array_keys($columnConfig), array_column($columnConfig, 'name'));
123
124	8	foreach ($csv as $line => $row) {
125		// 出荷IDがなければエラー
126	8	if (!isset($row[$columnNames['id']])) {
127	2	$errors[] = trans('csvimportcontroller.require', ['%line%' => $line, '%name%' => $columnNames['id']]);
128	2	continue;
129		}
130
131		/* @var Shipping $Shipping */
132	6	$Shipping = is_numeric($row[$columnNames['id']]) ? $this->shippingRepository->find($row[$columnNames['id']]) : null;
133
134		// 存在しない出荷IDはエラー
135	6	if (is_null($Shipping)) {
136	2	$errors[] = trans('csvimportcontroller.notfound', ['%line%' => $line, '%name%' => $columnNames['id']]);
137	2	continue;
138		}
139
140	4	if (isset($row[$columnNames['tracking_number']])) {
141	4	$Shipping->setTrackingNumber($row[$columnNames['tracking_number']]);
142		}
143
144	4	if (isset($row[$columnNames['shipping_date']])) {
145		// 日付フォーマットが異なる場合はエラー
146	4	$shippingDate = \DateTime::createFromFormat('Y-m-d', $row[$columnNames['shipping_date']]);
147	4	if ($shippingDate === false) {
148	1	$errors[] = trans('csvimportcontroller.invalid_date_format', ['%line%' => $line, '%name%' => $columnNames['id']]);
149	1	continue;
150		}
151
152	3	$shippingDate->setTime(0, 0, 0);
153	3	$Shipping->setShippingDate($shippingDate);
154		}
155
156	3	$Order = $Shipping->getOrder();
157	3	$RelateShippings = $Order->getShippings();
158	3	$allShipped = true;
159	3	foreach ($RelateShippings as $RelateShipping) {
160	3	if (!$RelateShipping->getShippingDate()) {
161		$allShipped = false;
162	3	break;
163		}
164		}
165	3	$OrderStatus = $this->entityManager->find(OrderStatus::class, OrderStatus::DELIVERED);
166	3	if ($allShipped) {
167	3	if ($this->orderStateMachine->can($Order, $OrderStatus)) {
168	1	$this->orderStateMachine->apply($Order, $OrderStatus);
169		} else {
170	2	$from = $Order->getOrderStatus()->getName();
171	2	$to = $OrderStatus->getName();
172	3	$errors[] = sprintf('%s: %s から %s へステータス変更できませんでした', $Shipping->getId(), $from, $to);
173		}
174		}
175		}
176		}
177
178		/**
		0 ignored issues – show introduced 2018-07-20 11:17 UTC by Report Bug Copy Issue Report Doc comment for parameter "$request" missing Loading history...
179		* アップロード用CSV雛形ファイルダウンロード
180		*
181		* @Route("/%eccube_admin_route%/order/csv_template", name="admin_shipping_csv_template")
182		*/
		0 ignored issues – show introduced 2018-07-05 09:47 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
183		public function csvTemplate(Request $request)
		0 ignored issues – show introduced 2018-07-05 09:47 UTC by Report Bug Copy Issue Report Declare public methods first, then protected ones and finally private ones Loading history...
184		{
185		$columns = array_column($this->getColumnConfig(), 'name');
186
187		return $this->sendTemplateResponse($request, $columns, 'shipping.csv');
188		}
189
190	8	protected function getColumnConfig()
191		{
192		return [
193	8	'id' => [
194	8	'name' => trans('admin.shipping.csv_shipping.id'),
195	8	'description' => trans('admin.shipping.csv_shipping.id.description'),
196		'required' => true,
197		],
198		'tracking_number' => [
199	8	'name' => trans('admin.shipping.csv_shipping.tracking_number'),
200	8	'description' => trans('admin.shipping.csv_shipping.tracking_number.description'),
201		'required' => false,
202		],
203		'shipping_date' => [
204	8	'name' => trans('admin.shipping.csv_shipping.shipping_date'),
205	8	'description' => trans('admin.shipping.csv_shipping.shipping_date.description'),
206		'required' => false,
207		],
208		];
209		}
210		}
211

EC-CUBE / ec-cube

Pull Request — experimental/sf (#3402)

CsvImportController::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like