CartOrderRoute::fetchCustomer() - Code Metrics - Inspection of "Merge branch 'next-11126/allow-create-order-with-c..." - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( dd6e64...a763da )

by Christian

created 2020-11-13 08:12 UTC

CartOrderRoute::fetchCustomer() A

↳ Parent: CartOrderRoute

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	10
rs	10

<?php declare(strict_types=1);

namespace Shopware\Core\Checkout\Cart\SalesChannel;

use OpenApi\Annotations as OA;
use Shopware\Core\Checkout\Cart\Cart;
use Shopware\Core\Checkout\Cart\CartCalculator;
use Shopware\Core\Checkout\Cart\CartPersisterInterface;
use Shopware\Core\Checkout\Cart\Event\CheckoutOrderPlacedEvent;
use Shopware\Core\Checkout\Cart\Order\OrderPersisterInterface;
use Shopware\Core\Checkout\Order\Aggregate\OrderCustomer\OrderCustomerEntity;
use Shopware\Core\Checkout\Order\OrderEntity;
use Shopware\Core\Checkout\Order\SalesChannel\OrderService;
use Shopware\Core\Checkout\Payment\Exception\InvalidOrderException;
use Shopware\Core\Framework\Context;
use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
use Shopware\Core\Framework\Routing\Annotation\RouteScope;
use Shopware\Core\Framework\Routing\Annotation\Since;
use Shopware\Core\Framework\Validation\DataBag\DataBag;
use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
use Shopware\Core\System\SalesChannel\SalesChannelContext;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;

/**
 * @RouteScope(scopes={"store-api"})
 */
class CartOrderRoute extends AbstractCartOrderRoute
{
    /**
     * @var CartCalculator
     */
    private $cartCalculator;

    /**
     * @var EntityRepositoryInterface
     */
    private $orderRepository;

    /**
     * @var OrderPersisterInterface
     */
    private $orderPersister;

    /**
     * @var CartPersisterInterface
     */
    private $cartPersister;

    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    /**
     * @var EntityRepositoryInterface
     */
    private $orderCustomerRepository;

    public function __construct(
        CartCalculator $cartCalculator,
        EntityRepositoryInterface $orderRepository,
        EntityRepositoryInterface $orderCustomerRepository,
        OrderPersisterInterface $orderPersister,
        CartPersisterInterface $cartPersister,
        EventDispatcherInterface $eventDispatcher
    ) {
        $this->cartCalculator = $cartCalculator;
        $this->orderRepository = $orderRepository;
        $this->orderPersister = $orderPersister;
        $this->cartPersister = $cartPersister;
        $this->eventDispatcher = $eventDispatcher;
        $this->orderCustomerRepository = $orderCustomerRepository;
    }

    public function getDecorated(): AbstractCartOrderRoute
    {
        throw new DecorationPatternException(self::class);
    }

    /**
     * @Since("6.3.0.0")
     * @OA\Post(
     *      path="/checkout/order",
     *      summary="Create a new order from cart",
     *      operationId="createOrder",
     *      tags={"Store API", "Cart"},
     *      @OA\Response(
     *          response="200",
     *          description="Order",
     *          @OA\JsonContent(ref="#/components/schemas/order_flat")
     *     )
     * )
     * @Route("/store-api/v{version}/checkout/order", name="store-api.checkout.cart.order", methods={"POST"})
     */
    public function order(Cart $cart, SalesChannelContext $context, ?RequestDataBag $data = null): CartOrderRouteResponse
    {
        $calculatedCart = $this->cartCalculator->calculate($cart, $context);

        // @deprecated tag:v6.4.0 - Parameter $data will be mandatory in future implementation
        if ($data !== null) {
            $this->addCustomerComment($calculatedCart, $data);
            $this->addAffiliateTracking($calculatedCart, $data);
        }

        $orderId = $this->orderPersister->persist($calculatedCart, $context);

        $criteria = new Criteria([$orderId]);
        $criteria
            ->addAssociation('deliveries.shippingMethod')
            ->addAssociation('deliveries.shippingOrderAddress.country')
            ->addAssociation('transactions.paymentMethod')
            ->addAssociation('lineItems')
            ->addAssociation('currency')
            ->addAssociation('addresses.country');

        /** @var OrderEntity|null $orderEntity */
        $orderEntity = $this->orderRepository->search($criteria, $context->getContext())->first();

        if (!$orderEntity) {
            throw new InvalidOrderException($orderId);
        }

        // todo@dr: can be merged with above criteria after NEXT-4466
        $orderEntity->setOrderCustomer(
            $this->fetchCustomer($orderEntity->getId(), $context->getContext())
        );

        $orderPlacedEvent = new CheckoutOrderPlacedEvent(
            $context->getContext(),
            $orderEntity,
            $context->getSalesChannel()->getId()
        );

        $this->eventDispatcher->dispatch($orderPlacedEvent);

        $this->cartPersister->delete($context->getToken(), $context);

        return new CartOrderRouteResponse($orderEntity);
    }

    private function fetchCustomer(string $orderId, Context $context): OrderCustomerEntity
    {
        $criteria = new Criteria();
        $criteria->addFilter(new EqualsFilter('orderId', $orderId));
        $criteria->addAssociation('customer');
        $criteria->addAssociation('salutation');

        return $this->orderCustomerRepository

            ->search($criteria, $context)
            ->first();
    }

    private function addCustomerComment(Cart $cart, DataBag $data): void
    {
        $customerComment = ltrim(rtrim((string) $data->get(OrderService::CUSTOMER_COMMENT_KEY, '')));

        if ($customerComment === '') {
            return;
        }

        $cart->setCustomerComment($customerComment);
    }

    private function addAffiliateTracking(Cart $cart, DataBag $data): void
    {
        $affiliateCode = $data->get(OrderService::AFFILIATE_CODE_KEY);
        $campaignCode = $data->get(OrderService::CAMPAIGN_CODE_KEY);
        if ($affiliateCode !== null && $campaignCode !== null) {
            $cart->setAffiliateCode($affiliateCode);
            $cart->setCampaignCode($campaignCode);
        }
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Core\Checkout\Cart\SalesChannel;
4
5			use OpenApi\Annotations as OA;
6			use Shopware\Core\Checkout\Cart\Cart;
7			use Shopware\Core\Checkout\Cart\CartCalculator;
8			use Shopware\Core\Checkout\Cart\CartPersisterInterface;
9			use Shopware\Core\Checkout\Cart\Event\CheckoutOrderPlacedEvent;
10			use Shopware\Core\Checkout\Cart\Order\OrderPersisterInterface;
11			use Shopware\Core\Checkout\Order\Aggregate\OrderCustomer\OrderCustomerEntity;
12			use Shopware\Core\Checkout\Order\OrderEntity;
13			use Shopware\Core\Checkout\Order\SalesChannel\OrderService;
14			use Shopware\Core\Checkout\Payment\Exception\InvalidOrderException;
15			use Shopware\Core\Framework\Context;
16			use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
17			use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
18			use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
19			use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
20			use Shopware\Core\Framework\Routing\Annotation\RouteScope;
21			use Shopware\Core\Framework\Routing\Annotation\Since;
22			use Shopware\Core\Framework\Validation\DataBag\DataBag;
23			use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
24			use Shopware\Core\System\SalesChannel\SalesChannelContext;
25			use Symfony\Component\Routing\Annotation\Route;
26			use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
27
28			/**
29			* @RouteScope(scopes={"store-api"})
30			*/
31			class CartOrderRoute extends AbstractCartOrderRoute
32			{
33			/**
34			* @var CartCalculator
35			*/
36			private $cartCalculator;
37
38			/**
39			* @var EntityRepositoryInterface
40			*/
41			private $orderRepository;
42
43			/**
44			* @var OrderPersisterInterface
45			*/
46			private $orderPersister;
47
48			/**
49			* @var CartPersisterInterface
50			*/
51			private $cartPersister;
52
53			/**
54			* @var EventDispatcherInterface
55			*/
56			private $eventDispatcher;
57
58			/**
59			* @var EntityRepositoryInterface
60			*/
61			private $orderCustomerRepository;
62
63			public function __construct(
64			CartCalculator $cartCalculator,
65			EntityRepositoryInterface $orderRepository,
66			EntityRepositoryInterface $orderCustomerRepository,
67			OrderPersisterInterface $orderPersister,
68			CartPersisterInterface $cartPersister,
69			EventDispatcherInterface $eventDispatcher
70			) {
71			$this->cartCalculator = $cartCalculator;
72			$this->orderRepository = $orderRepository;
73			$this->orderPersister = $orderPersister;
74			$this->cartPersister = $cartPersister;
75			$this->eventDispatcher = $eventDispatcher;
76			$this->orderCustomerRepository = $orderCustomerRepository;
77			}
78
79			public function getDecorated(): AbstractCartOrderRoute
80			{
81			throw new DecorationPatternException(self::class);
82			}
83
84			/**
85			* @Since("6.3.0.0")
86			* @OA\Post(
87			* path="/checkout/order",
88			* summary="Create a new order from cart",
89			* operationId="createOrder",
90			* tags={"Store API", "Cart"},
91			* @OA\Response(
92			* response="200",
93			* description="Order",
94			* @OA\JsonContent(ref="#/components/schemas/order_flat")
95			* )
96			* )
97			* @Route("/store-api/v{version}/checkout/order", name="store-api.checkout.cart.order", methods={"POST"})
98			*/
99			public function order(Cart $cart, SalesChannelContext $context, ?RequestDataBag $data = null): CartOrderRouteResponse
100			{
101			$calculatedCart = $this->cartCalculator->calculate($cart, $context);
102
103			// @deprecated tag:v6.4.0 - Parameter $data will be mandatory in future implementation
104			if ($data !== null) {
105			$this->addCustomerComment($calculatedCart, $data);
106			$this->addAffiliateTracking($calculatedCart, $data);
107			}
108
109			$orderId = $this->orderPersister->persist($calculatedCart, $context);
110
111			$criteria = new Criteria([$orderId]);
112			$criteria
113			->addAssociation('deliveries.shippingMethod')
114			->addAssociation('deliveries.shippingOrderAddress.country')
115			->addAssociation('transactions.paymentMethod')
116			->addAssociation('lineItems')
117			->addAssociation('currency')
118			->addAssociation('addresses.country');
119
120			/** @var OrderEntity\|null $orderEntity */
121			$orderEntity = $this->orderRepository->search($criteria, $context->getContext())->first();
122
123			if (!$orderEntity) {
124			throw new InvalidOrderException($orderId);
125			}
126
127			// todo@dr: can be merged with above criteria after NEXT-4466
128			$orderEntity->setOrderCustomer(
129			$this->fetchCustomer($orderEntity->getId(), $context->getContext())
130			);
131
132			$orderPlacedEvent = new CheckoutOrderPlacedEvent(
133			$context->getContext(),
134			$orderEntity,
135			$context->getSalesChannel()->getId()
136			);
137
138			$this->eventDispatcher->dispatch($orderPlacedEvent);
139
140			$this->cartPersister->delete($context->getToken(), $context);
141
142			return new CartOrderRouteResponse($orderEntity);
143			}
144
145			private function fetchCustomer(string $orderId, Context $context): OrderCustomerEntity
146			{
147			$criteria = new Criteria();
148			$criteria->addFilter(new EqualsFilter('orderId', $orderId));
149			$criteria->addAssociation('customer');
150			$criteria->addAssociation('salutation');
151
152			return $this->orderCustomerRepository
			0 ignored issues – show Bug Best Practice introduced 2019-05-06 21:03 UTC by Report Bug Copy Issue Report The expression `return $this->orderCusto...ria, $context)->first()` could return the type `null` which is incompatible with the type-hinted return `Shopware\Core\Checkout\O...mer\OrderCustomerEntity`. Consider adding an additional type-check to rule them out. Loading history...
153			->search($criteria, $context)
154			->first();
155			}
156
157			private function addCustomerComment(Cart $cart, DataBag $data): void
158			{
159			$customerComment = ltrim(rtrim((string) $data->get(OrderService::CUSTOMER_COMMENT_KEY, '')));
160
161			if ($customerComment === '') {
162			return;
163			}
164
165			$cart->setCustomerComment($customerComment);
166			}
167
168			private function addAffiliateTracking(Cart $cart, DataBag $data): void
169			{
170			$affiliateCode = $data->get(OrderService::AFFILIATE_CODE_KEY);
171			$campaignCode = $data->get(OrderService::CAMPAIGN_CODE_KEY);
172			if ($affiliateCode !== null && $campaignCode !== null) {
173			$cart->setAffiliateCode($affiliateCode);
174			$cart->setCampaignCode($campaignCode);
175			}
176			}
177			}
178

shopware / platform

Push — master ( dd6e64...a763da )

CartOrderRoute::fetchCustomer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like