Eccube\Controller\Admin\Shipping\ShippingController

Complexity

Total Complexity

16

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	16

Test Coverage

Coverage

32.53%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
C	index()	0	116	9
A	previewShippingNotifyMail()	0	4	1
A	notifyMail()	0	15	1
A	bulkDelete()	0	24	4

<?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\Common\Constant;
use Eccube\Controller\AbstractController;
use Eccube\Entity\Shipping;
use Eccube\Entity\OrderItem;
use Eccube\Event\EccubeEvents;
use Eccube\Event\EventArgs;
use Eccube\Form\Type\Admin\SearchShippingType;
use Eccube\Repository\Master\PageMaxRepository;
use Eccube\Repository\ShippingRepository;
use Eccube\Service\MailService;
use Eccube\Service\OrderStateMachine;
use Eccube\Util\FormUtil;
use Knp\Component\Pager\PaginatorInterface;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class ShippingController extends AbstractController

Missing class doc comment

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

    /**
     * @var PageMaxRepository
     */
    protected $pageMaxRepository;

    /**
     * @var MailService
     */
    protected $mailService;

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

    /**

Doc comment for parameter "$orderStateMachine" missing

     * ShippingController constructor.
     *
     * @param ShippingRepository $shippingRepository
     * @param PageMaxRepository $pageMaxRepository

Expected 2 spaces after parameter type; 1 found

     * @param MailService $mailService

Expected 8 spaces after parameter type; 1 found

     * @param OrderStateMachine $orderStateMachine;

There is no parameter named $orderStateMachine;. Did you maybe mean $orderStateMachine?

Expected 2 spaces after parameter type; 1 found

Doc comment for parameter $orderStateMachine; does not match actual variable name $orderStateMachine

     */
    public function __construct(
        ShippingRepository $shippingRepository,
        PageMaxRepository $pageMaxRepository,
        MailService $mailService,
        OrderStateMachine $orderStateMachine
    ) {
        $this->shippingRepository = $shippingRepository;
        $this->pageMaxRepository = $pageMaxRepository;
        $this->mailService = $mailService;
        $this->orderStateMachine = $orderStateMachine;
    }

    /**

Doc comment for parameter "$request" missing

Doc comment for parameter "$page_no" missing

Doc comment for parameter "$paginator" missing

     * @Route("/%eccube_admin_route%/shipping", name="admin_shipping")
     * @Route("/%eccube_admin_route%/shipping/page/{page_no}", name="admin_shipping_page")
     * @Template("@admin/Shipping/index.twig")
     */

Missing @return tag in function comment

    public function index(Request $request, $page_no = null, PaginatorInterface $paginator)

Parameters which have default values should be placed at the end.

    {
        $builder = $this->formFactory
            ->createBuilder(SearchShippingType::class);

        $event = new EventArgs(
            [
                'builder' => $builder,
            ],
            $request
        );
        $this->eventDispatcher->dispatch(EccubeEvents::ADMIN_SHIPPING_INDEX_INITIALIZE, $event);

        $searchForm = $builder->getForm();

        /**
         * ページの表示件数は, 以下の順に優先される.
         * - リクエストパラメータ
         * - セッション
         * - デフォルト値
         * また, セッションに保存する際は mtb_page_maxと照合し, 一致した場合のみ保存する.
         **/
        $page_count = $this->session->get('eccube.admin.shipping.search.page_count',
            $this->eccubeConfig->get('eccube_default_page_count'));

        $page_count_param = (int) $request->get('page_count');
        $pageMaxis = $this->pageMaxRepository->findAll();

        if ($page_count_param) {
            foreach ($pageMaxis as $pageMax) {
                if ($page_count_param == $pageMax->getName()) {
                    $page_count = $pageMax->getName();
                    $this->session->set('eccube.admin.shipping.search.page_count', $page_count);
                    break;
                }
            }
        }

        if ('POST' === $request->getMethod()) {
            $searchForm->handleRequest($request);

            if ($searchForm->isValid()) {
                /**
                 * 検索が実行された場合は, セッションに検索条件を保存する.
                 * ページ番号は最初のページ番号に初期化する.
                 */
                $page_no = 1;
                $searchData = $searchForm->getData();

                // 検索条件, ページ番号をセッションに保持.
                $this->session->set('eccube.admin.shipping.search', FormUtil::getViewData($searchForm));
                $this->session->set('eccube.admin.shipping.search.page_no', $page_no);
            } else {
                return [
                    'searchForm' => $searchForm->createView(),
                    'pagination' => [],
                    'pageMaxis' => $pageMaxis,
                    'page_no' => $page_no,
                    'page_count' => $page_count,
                    'has_errors' => true,
                ];
            }
        } else {
            if (null !== $page_no || $request->get('resume')) {
                /*
                 * ページ送りの場合または、他画面から戻ってきた場合は, セッションから検索条件を復旧する.
                 */
                if ($page_no) {
                    // ページ送りで遷移した場合.
                    $this->session->set('eccube.admin.shipping.search.page_no', (int) $page_no);
                } else {
                    // 他画面から遷移した場合.
                    $page_no = $this->session->get('eccube.admin.shipping.search.page_no', 1);
                }
                $viewData = $this->session->get('eccube.admin.shipping.search', []);
                $searchData = FormUtil::submitAndGetData($searchForm, $viewData);
            } else {
                /**
                 * 初期表示の場合.
                 */
                $page_no = 1;
                $searchData = [];

                // セッション中の検索条件, ページ番号を初期化.
                $this->session->set('eccube.admin.shipping.search', $searchData);
                $this->session->set('eccube.admin.shipping.search.page_no', $page_no);
            }
        }

        $qb = $this->shippingRepository->getQueryBuilderBySearchDataForAdmin($searchData);

        $event = new EventArgs(
            [
                'qb' => $qb,
                'searchData' => $searchData,
            ],
            $request
        );

        $this->eventDispatcher->dispatch(EccubeEvents::ADMIN_SHIPPING_INDEX_SEARCH, $event);

        $pagination = $paginator->paginate(
            $qb,
            $page_no,
            $page_count
        );

        return [
            'searchForm' => $searchForm->createView(),
            'pagination' => $pagination,
            'pageMaxis' => $pageMaxis,
            'page_no' => $page_no,
            'page_count' => $page_count,
            'has_errors' => false,
        ];
    }

    /**
     * @Route("/%eccube_admin_route%/shipping/preview_notify_mail/{id}", requirements={"id" = "\d+"}, name="admin_shipping_preview_notify_mail")
     *
     * @param Shipping $Shipping
     *
     * @return Response
     *
     * @throws \Twig_Error
     */
    public function previewShippingNotifyMail(Shipping $Shipping)
    {
        return new Response($this->mailService->getShippingNotifyMailBody($Shipping, $Shipping->getOrder()));
    }

    /**
     * @Method("PUT")
     * @Route("/%eccube_admin_route%/shipping/notify_mail/{id}", requirements={"id" = "\d+"}, name="admin_shipping_notify_mail")
     *
     * @param Shipping $Shipping
     *
     * @return JsonResponse
     *
     * @throws \Twig_Error
     */
    public function notifyMail(Shipping $Shipping)
    {
        $this->isTokenValid();

        $this->mailService->sendShippingNotifyMail($Shipping);

        $Shipping->setMailSendDate(new \DateTime());
        $this->shippingRepository->save($Shipping);
        $this->entityManager->flush();

        return $this->json([
            'mail' => true,
            'shipped' => false,
        ]);
    }

    /**

Doc comment for parameter "$request" missing

     * @Method("POST")
     * @Route("/%eccube_admin_route%/shipping/bulk_delete", name="admin_shipping_bulk_delete")
     */

Missing @return tag in function comment

    public function bulkDelete(Request $request)
    {
        $this->isTokenValid();
        $ids = $request->get('ids');

        foreach ($ids as $shipping_id) {
            /** @var Shipping $Shipping */
            $Shipping = $this->shippingRepository->find($shipping_id);

Are you sure the assignment to $Shipping is correct as $this->shippingRepository->find($shipping_id) (which targets Doctrine\ORM\EntityRepository::find()) seems to always return null.

            if ($Shipping) {
                $OrderItems = $Shipping->getOrderItems();
                /** @var OrderItem $OrderItem */
                foreach ($OrderItems as $OrderItem) {
                    $OrderItem->setShipping(null);
                }
                $this->entityManager->remove($Shipping);
                log_info('出荷削除', [$Shipping->getId()]);
            }
        }
        $this->entityManager->flush();

        $this->addSuccess('admin.shipping.delete.complete', 'admin');

        return $this->redirect($this->generateUrl('admin_shipping', ['resume' => Constant::ENABLED]));
    }
}