Eccube\Controller\Admin\Shipping\EditController

Complexity

Total Complexity

27

Size/Duplication

Total Lines	260
Duplicated Lines	9.62 %

Coupling/Cohesion

Components	2
Dependencies	17

Test Coverage

Coverage

68.04%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	19	19	1
F	edit()	6	123	21
A	searchProduct()	0	27	2
A	searchItem()	0	18	3

<?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 Doctrine\Common\Collections\ArrayCollection;
use Eccube\Controller\AbstractController;
use Eccube\Entity\Master\ShippingStatus;
use Eccube\Entity\OrderItem;
use Eccube\Entity\Shipping;
use Eccube\Form\Type\Admin\ShippingType;
use Eccube\Repository\CategoryRepository;
use Eccube\Repository\DeliveryRepository;
use Eccube\Repository\Master\ShippingStatusRepository;
use Eccube\Repository\OrderItemRepository;
use Eccube\Repository\ShippingRepository;
use Eccube\Service\TaxRuleService;
use Knp\Component\Pager\PaginatorInterface;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Serializer\SerializerInterface;
use Eccube\Service\MailService;

class EditController extends AbstractController

Missing class doc comment

{
    /**
     * @var OrderItemRepository
     */
    protected $orderItemRepository;

    /**
     * @var CategoryRepository
     */
    protected $categoryRepository;

    /**
     * @var DeliveryRepository
     */
    protected $deliveryRepository;

    /**
     * @var TaxRuleService
     */
    protected $taxRuleService;

    /**
     * @var ShippingRepository
     */
    protected $shippingRepository;

    /**
     * @var SerializerInterface
     */
    protected $serializer;

    /**
     * @var ShippingStatusRepository
     */
    protected $shippingStatusRepository;

    /**
     * @var \Eccube\Service\MailService
     */
    protected $mailService;

    /**
     * EditController constructor.
     *
     * @param MailService $mailService

Expected 14 spaces after parameter type; 1 found

     * @param OrderItemRepository $orderItemRepository

Expected 6 spaces after parameter type; 1 found

     * @param CategoryRepository $categoryRepository

Expected 7 spaces after parameter type; 1 found

     * @param DeliveryRepository $deliveryRepository

Expected 7 spaces after parameter type; 1 found

     * @param TaxRuleService $taxRuleService

Expected 11 spaces after parameter type; 1 found

     * @param ShippingRepository $shippingRepository

Expected 7 spaces after parameter type; 1 found

     * @param ShippingStatusRepository $shippingStatusRepository
     * @param SerializerInterface $serializer

Expected 6 spaces after parameter type; 1 found

     */
    public function __construct(

This method seems to be duplicated in your project.

        MailService $mailService,
        OrderItemRepository $orderItemRepository,
        CategoryRepository $categoryRepository,
        DeliveryRepository $deliveryRepository,
        TaxRuleService $taxRuleService,
        ShippingRepository $shippingRepository,
        ShippingStatusRepository $shippingStatusRepository,
        SerializerInterface $serializer
    ) {
        $this->mailService = $mailService;
        $this->orderItemRepository = $orderItemRepository;
        $this->categoryRepository = $categoryRepository;
        $this->deliveryRepository = $deliveryRepository;
        $this->taxRuleService = $taxRuleService;
        $this->shippingRepository = $shippingRepository;
        $this->shippingStatusRepository = $shippingStatusRepository;
        $this->serializer = $serializer;
    }

    /**

Doc comment for parameter "$request" missing

Doc comment for parameter "$id" missing

     * 出荷登録/編集画面.
     *
     * @Route("/%eccube_admin_route%/shipping/new", name="admin_shipping_new")
     * @Route("/%eccube_admin_route%/shipping/{id}/edit", requirements={"id" = "\d+"}, name="admin_shipping_edit")
     * @Template("@admin/Shipping/edit.twig")
     */

Missing @return tag in function comment

    public function edit(Request $request, $id = null)
    {
        $TargetShipping = null;

$TargetShipping is not used, you could remove the assignment.

        $OriginShipping = null;

$OriginShipping is not used, you could remove the assignment.

        if (null === $id) {
            // 空のエンティティを作成.
            $TargetShipping = new Shipping();
        } else {
            $TargetShipping = $this->shippingRepository->find($id);
            if (null === $TargetShipping) {
                throw new NotFoundHttpException();
            }
        }

        // 編集前の受注情報を保持
        $OriginShipping = clone $TargetShipping;
        // 編集前のお届け先のアイテム情報を保持
        $OriginalOrderItems = new ArrayCollection();

        foreach ($TargetShipping->getOrderItems() as $OrderItem) {
            $OriginalOrderItems->add($OrderItem);
        }

        $builder = $this->formFactory
            ->createBuilder(ShippingType::class, $TargetShipping);

        $form = $builder->getForm();
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            // TODO: Should move logic out of controller such as service, modal

            // FIXME 税額計算は CalculateService で処理する. ここはテストを通すための暫定処理
            // see EditControllerTest::testOrderProcessingWithTax
            $OrderItems = $TargetShipping->getOrderItems();
            $taxtotal = 0;
            foreach ($OrderItems as $OrderItem) {
                $tax = $this->taxRuleService
                    ->calcTax($OrderItem->getPrice(), $OrderItem->getTaxRate(), $OrderItem->getTaxRule());
                $OrderItem->setPriceIncTax($OrderItem->getPrice() + $tax);

                $taxtotal += $tax * $OrderItem->getQuantity();
            }

            log_info('出荷登録開始', [$TargetShipping->getId()]);
            // TODO 在庫の有無や販売制限数のチェックなども行う必要があるため、完了処理もcaluclatorのように抽象化できないか検討する.
            // TODO 後続にある会員情報の更新のように、完了処理もcaluclatorのように抽象化できないか検討する.
            // 画面上で削除された明細をremove
            foreach ($OriginalOrderItems as $OrderItem) {
                if (false === $TargetShipping->getOrderItems()->contains($OrderItem)) {
                    $OrderItem->setShipping(null);
                }
            }

            foreach ($TargetShipping->getOrderItems() as $OrderItem) {
                $OrderItem->setShipping($TargetShipping);
            }

            $OriginShippingStatus = $OriginShipping->getShippingStatus();
            $TargetShippingStatus = $TargetShipping->getShippingStatus();

            // 出荷ステータス変更時の処理
            if ($TargetShippingStatus !== null
             && $TargetShippingStatus->getId() == ShippingStatus::SHIPPED) {
                // 「出荷済み」にステータスが変更された場合
                if ($OriginShippingStatus === null
                 || $OriginShippingStatus->getId() != $TargetShippingStatus->getId()) {
                    // 出荷日時を更新
                    $TargetShipping->setShippingDate(new \DateTime());
                    // 出荷メールを送信
                    if ($form->get('notify_email')->getData()) {
                        try {
                            $this->mailService->sendShippingNotifyMail(
                              $TargetShipping
                            );
                        } catch (\Exception $e) {
                            log_error('メール通知エラー', [$TargetShipping->getId(), $e]);
                            $this->addError(
                              'admin.shipping.edit.shipped_mail_failed',
                              'admin'
                            );
                        }
                    }
                }
            } else {
                // 「出荷済み」以外に変更した場合は、出荷日時をクリアする
                $TargetShipping->setShippingDate(null);
            }

            try {
                $this->entityManager->persist($TargetShipping);
                $this->entityManager->flush();

                $this->addSuccess('admin.shipping.edit.save.complete', 'admin');
                $this->addInfo('admin.shipping.edit.save.info', 'admin');
                log_info('出荷登録完了', [$TargetShipping->getId()]);

                return $this->redirectToRoute('admin_shipping_edit', ['id' => $TargetShipping->getId()]);
            } catch (\Exception $e) {
                log_error('出荷登録エラー', [$TargetShipping->getId(), $e]);
                $this->addError('admin.flash.register_failed', 'admin');
            }
        } elseif ($form->isSubmitted() && $form->getErrors(true)) {
            $this->addError('admin.flash.register_failed', 'admin');
        }

        // 配送業者のお届け時間
        $times = [];
        $deliveries = $this->deliveryRepository->findAll();
        foreach ($deliveries as $Delivery) {
            $deliveryTiems = $Delivery->getDeliveryTimes();
            foreach ($deliveryTiems as $DeliveryTime) {
                $times[$Delivery->getId()][$DeliveryTime->getId()] = $DeliveryTime->getDeliveryTime();
            }
        }

        return [
            'form' => $form->createView(),
            'Shipping' => $TargetShipping,
            'shippingDeliveryTimes' => $this->serializer->serialize($times, 'json'),
        ];
    }

    /**

Doc comment for parameter "$request" missing

Doc comment for parameter "$paginator" missing

     * @Route("/%eccube_admin_route%/shipping/search/product", name="admin_shipping_search_product")
     * @Template("@admin/Shipping/search_product.twig")
     */

Missing @return tag in function comment

    public function searchProduct(Request $request, PaginatorInterface $paginator)
    {
        if (!$request->isXmlHttpRequest()) {
            throw new BadRequestHttpException();
        }

        // FIXME: should use consistent param for pageno ? Other controller use page_no, but here use pageno, then I change from pageno to page_no
        $page_no = (int) $request->get('page_no', 1);
        $page_count = $this->eccubeConfig['eccube_default_page_count'];

        // TODO OrderItemRepository に移動
        $qb = $this->orderItemRepository->createQueryBuilder('s')
            ->where('s.Shipping is null AND s.Order is not null')
            ->andWhere('s.OrderItemType in (1, 2)');

        /** @var \Knp\Component\Pager\Pagination\SlidingPagination $pagination */
        $pagination = $paginator->paginate(
            $qb,
            $page_no,
            $page_count,
            ['wrap-queries' => true]
        );

        return [
            'pagination' => $pagination,
        ];
    }

    /**

Doc comment for parameter "$request" missing

     * @Route("/%eccube_admin_route%/shipping/search/item", name="admin_shipping_search_item")
     * @Template("@admin/Shipping/order_item_prototype.twig")
     */

Missing @return tag in function comment

    public function searchItem(Request $request)
    {
        if (!$request->isXmlHttpRequest()) {
            throw new BadRequestHttpException();
        }

        $id = (int) $request->get('order-item-id');
        /** @var OrderItem $OrderItem */
        $OrderItem = $this->orderItemRepository->find($id);
        if (null === $OrderItem) {
            // not found.
            return $this->json([], 404);
        }

        return [
            'OrderItem' => $OrderItem,
        ];
    }
}