EC-CUBE / ec-cube

src/Eccube/Controller/Admin/Shipping/CsvImportController.php

<?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\Shipping;

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

class CsvImportController extends AbstractCsvImportController

Missing class doc comment

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

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

    /**

Doc comment for parameter "$request" missing

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

Missing @return tag in function comment

    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);

It seems like $csv defined by $this->getImportData($formFile) on line 57 can also be of type false; however, Eccube\Controller\Admin\Shipping\CsvImportController::loadCsv() does only seem to accept object<Eccube\Service\CsvImportService>, did you maybe forget to handle an error condition?

                        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) {

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 8.

            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;
                }

                $Shipping->setShippingDate($shippingDate);
            }
        }
    }

    /**

Doc comment for parameter "$request" missing

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

Missing @return tag in function comment

    public function csvTemplate(Request $request)

Declare public methods first, then protected ones and finally private ones

    {
        $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,
            ],
        ];
    }
}