Eccube\Service\OrderStateMachine

Complexity

Total Complexity

20

Size/Duplication

Total Lines	228
Duplicated Lines	7.89 %

Coupling/Cohesion

Components	4
Dependencies	9

Test Coverage

Coverage

98.33%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	apply()	0	9	2
A	can()	0	4	1
A	getTransition()	0	11	3
A	getSubscribedEvents()	0	13	1
A	updatePaymentDate()	0	6	1
A	commitUsePoint()	0	6	1
A	rollbackUsePoint()	0	6	1
A	commitStock()	0	6	1
A	rollbackStock()	0	6	1
A	commitAddPoint()	9	9	2
A	rollbackAddPoint()	9	9	2
A	onCompleted()	0	13	1
A	guardShip()	0	11	2

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

use Doctrine\ORM\EntityManagerInterface;
use Eccube\Entity\Master\OrderStatus;
use Eccube\Entity\Order;
use Eccube\Entity\Shipping;
use Eccube\Repository\Master\OrderStatusRepository;
use Eccube\Service\PurchaseFlow\Processor\PointProcessor;
use Eccube\Service\PurchaseFlow\Processor\StockReduceProcessor;
use Eccube\Service\PurchaseFlow\PurchaseContext;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Workflow\Event\Event;
use Symfony\Component\Workflow\Event\GuardEvent;
use Symfony\Component\Workflow\StateMachine;

class OrderStateMachine implements EventSubscriberInterface

Missing class doc comment

{
    /**
     * @var StateMachine
     */
    private $machine;

    /**
     * @var OrderStatusRepository
     */
    private $orderStatusRepository;

    /**
     * @var PointProcessor
     */
    private $pointProcessor;
    /**
     * @var StockReduceProcessor
     */
    private $stockReduceProcessor;

    /**
     * @var EntityManagerInterface
     */
    private $entityManager;

    public function __construct(StateMachine $_orderStateMachine, OrderStatusRepository $orderStatusRepository, PointProcessor $pointProcessor, StockReduceProcessor $stockReduceProcessor, EntityManagerInterface $entityManager)
    {
        $this->machine = $_orderStateMachine;
        $this->orderStatusRepository = $orderStatusRepository;
        $this->pointProcessor = $pointProcessor;
        $this->stockReduceProcessor = $stockReduceProcessor;
        $this->entityManager = $entityManager;
    }

    /**
     * 指定ステータスに遷移.
     *
     * @param Order $Order 受注

Expected 7 spaces after parameter type; 1 found

Expected 7 spaces after parameter name; 1 found

     * @param OrderStatus $OrderStatus 遷移先ステータス
     */
    public function apply(Order $Order, OrderStatus $OrderStatus)
    {
        $transition = $this->getTransition($Order, $OrderStatus);
        if ($transition) {
            $this->machine->apply($Order, $transition->getName());
        } else {
            throw new \InvalidArgumentException();
        }
    }

    /**
     * 指定ステータスに遷移できるかどうかを判定.
     *
     * @param Order $Order 受注

Expected 7 spaces after parameter type; 1 found

Expected 7 spaces after parameter name; 1 found

     * @param OrderStatus $OrderStatus 遷移先ステータス
     *
     * @return boolean 指定ステータスに遷移できる場合はtrue
     */
    public function can(Order $Order, OrderStatus $OrderStatus)
    {
        return !is_null($this->getTransition($Order, $OrderStatus));
    }

    private function getTransition(Order $Order, OrderStatus $OrderStatus)
    {
        $transitions = $this->machine->getEnabledTransitions($Order);
        foreach ($transitions as $t) {
            if (in_array($OrderStatus->getId(), $t->getTos())) {
                return $t;
            }
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()

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

    {
        return [
            'workflow.order.completed' => ['onCompleted'],
            'workflow.order.transition.pay' => ['updatePaymentDate'],
            'workflow.order.transition.cancel' => [['rollbackStock'], ['rollbackUsePoint']],
            'workflow.order.transition.back_to_in_progress' => [['commitStock'], ['commitUsePoint']],
            'workflow.order.transition.ship' => ['commitAddPoint'],
            'workflow.order.transition.return' => [['rollbackUsePoint'], ['rollbackAddPoint']],
            'workflow.order.transition.cancel_return' => [['commitUsePoint'], ['commitAddPoint']],
            'workflow.order.guard.ship' => ['guardShip'],
        ];
    }

    /*
     * Event handlers.
     */

    /**
     * 購入日を更新する.
     *
     * @param Event $event
     */
    public function updatePaymentDate(Event $event)
    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $Order->setPaymentDate(new \DateTime());
    }

    /**
     * 会員の保有ポイントを減らす.
     *
     * @param Event $event
     *
     * @throws PurchaseFlow\PurchaseException
     */
    public function commitUsePoint(Event $event)
    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $this->pointProcessor->prepare($Order, new PurchaseContext());
    }

    /**
     * 利用ポイントを会員に戻す.
     *
     * @param Event $event
     */
    public function rollbackUsePoint(Event $event)
    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $this->pointProcessor->rollback($Order, new PurchaseContext());
    }

    /**
     * 在庫を減らす.
     *
     * @param Event $event
     *
     * @throws PurchaseFlow\PurchaseException
     */
    public function commitStock(Event $event)
    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $this->stockReduceProcessor->prepare($Order, new PurchaseContext());
    }

    /**
     * 在庫を戻す.
     *
     * @param Event $event
     */
    public function rollbackStock(Event $event)
    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $this->stockReduceProcessor->rollback($Order, new PurchaseContext());
    }

    /**
     * 会員に加算ポイントを付与する.
     *
     * @param Event $event
     */
    public function commitAddPoint(Event $event)

This method seems to be duplicated in your project.

    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $Customer = $Order->getCustomer();
        if ($Customer) {
            $Customer->setPoint(intval($Customer->getPoint()) + intval($Order->getAddPoint()));
        }
    }

    /**
     * 会員に付与した加算ポイントを取り消す.
     *
     * @param Event $event
     */
    public function rollbackAddPoint(Event $event)

This method seems to be duplicated in your project.

    {
        /* @var Order $Order */
        $Order = $event->getSubject();
        $Customer = $Order->getCustomer();
        if ($Customer) {
            $Customer->setPoint(intval($Customer->getPoint()) - intval($Order->getAddPoint()));
        }
    }

    /**
     * 受注ステータスを再設定.
     * {@link StateMachine}によって遷移が終了したときには{@link Order#OrderStatus}のidが変更されるだけなのでOrderStatusを設定し直す.
     *
     * @param Event $event
     */
    public function onCompleted(Event $event)
    {
        /** @var Order $Order */
        $Order = $event->getSubject();
        $OrderStatusId = $Order->getOrderStatus()->getId();

        // XXX このまま EntityManager::flush() をコールすると、 OrderStatus::id が更新されてしまうため元に戻す
        $TransitionlStatus = $Order->getOrderStatus();
        $this->entityManager->detach($TransitionlStatus);

        $CompletedOrderStatus = $this->orderStatusRepository->find($OrderStatusId);
        $Order->setOrderStatus($CompletedOrderStatus);
    }

    /**
     * すべての出荷が発送済みなら、受注も発送済みに遷移できる.
     *
     * @param GuardEvent $event
     */
    public function guardShip(GuardEvent $event)
    {
        /** @var Order $Order */
        $Order = $event->getSubject();
        $UnShipped = $Order->getShippings()->filter(function (Shipping $Shipping) {
            return $Shipping->getShippingDate() == null;
        });
        if (!$UnShipped->isEmpty()) {
            $event->setBlocked(true);
        }
    }
}