CartViewFactory::create() - Code Metrics - Inspection of "Changing plugin to the right naming convention" - Sylius/SyliusShopApiPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#290)

unknown

created 2018-08-20 12:49 UTC

CartViewFactory::create() B

↳ Parent: CartViewFactory

Complexity

Conditions	8
Paths	96

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	46
rs	7.9337
c	0
b	0
f	0
cc	8
nc	96
nop	2

<?php

declare(strict_types=1);

namespace Sylius\SyliusShopApiPlugin\Factory;

use Sylius\Component\Core\Model\AdjustmentInterface;
use Sylius\Component\Core\Model\OrderInterface;
use Sylius\Component\Core\Model\OrderItemInterface;
use Sylius\ShopApiPlugin\View\AdjustmentView;
use Sylius\ShopApiPlugin\View\CartSummaryView;

final class CartViewFactory implements CartViewFactoryInterface
{
    /** @var CartItemViewFactoryInterface */
    private $cartItemFactory;

    /** @var AddressViewFactoryInterface */
    private $addressViewFactory;

    /** @var TotalViewFactoryInterface */
    private $totalViewFactory;

    /** @var ShipmentViewFactoryInterface */
    private $shipmentViewFactory;

    /** @var PaymentViewFactoryInterface */
    private $paymentViewFactory;

    /** @var AdjustmentViewFactoryInterface */
    private $adjustmentViewFactory;

    /** @var string */
    private $cartSummaryViewClass;

    public function __construct(
        CartItemViewFactoryInterface $cartItemFactory,
        AddressViewFactoryInterface $addressViewFactory,
        TotalViewFactoryInterface $totalViewFactory,
        ShipmentViewFactoryInterface $shipmentViewFactory,
        PaymentViewFactoryInterface $paymentViewFactory,
        AdjustmentViewFactoryInterface $adjustmentViewFactory,
        string $cartSummaryViewClass
    ) {
        $this->cartItemFactory = $cartItemFactory;
        $this->addressViewFactory = $addressViewFactory;
        $this->totalViewFactory = $totalViewFactory;
        $this->shipmentViewFactory = $shipmentViewFactory;
        $this->paymentViewFactory = $paymentViewFactory;
        $this->adjustmentViewFactory = $adjustmentViewFactory;
        $this->cartSummaryViewClass = $cartSummaryViewClass;
    }

    /**
     * {@inheritdoc}
     */
    public function create(OrderInterface $cart, string $localeCode): CartSummaryView
    {
        /** @var CartSummaryView $cartView */
        $cartView = new $this->cartSummaryViewClass();
        $cartView->channel = $cart->getChannel()->getCode();
        $cartView->currency = $cart->getCurrencyCode();
        $cartView->locale = $localeCode;
        $cartView->checkoutState = $cart->getCheckoutState();
        $cartView->tokenValue = $cart->getTokenValue();
        $cartView->totals = $this->totalViewFactory->create($cart);

        /** @var OrderItemInterface $item */
        foreach ($cart->getItems() as $item) {
            $cartView->items[] = $this->cartItemFactory->create($item, $cart->getChannel(), $localeCode);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        foreach ($cart->getShipments() as $shipment) {
            $cartView->shipments[] = $this->shipmentViewFactory->create($shipment, $localeCode);
        }

        foreach ($cart->getPayments() as $payment) {
            $cartView->payments[] = $this->paymentViewFactory->create($payment, $localeCode);
        }

        /** @var AdjustmentView[] $cartDiscounts */
        $cartDiscounts = [];
        /** @var AdjustmentInterface $adjustment */
        foreach ($cart->getAdjustmentsRecursively(AdjustmentInterface::ORDER_PROMOTION_ADJUSTMENT) as $adjustment) {
            $originCode = $adjustment->getOriginCode();
            $additionalAmount = isset($cartDiscounts[$originCode]) ? $cartDiscounts[$originCode]->amount->current : 0;

            $cartDiscounts[$originCode] = $this->adjustmentViewFactory->create($adjustment, $additionalAmount, $cart->getCurrencyCode());
        }

        $cartView->cartDiscounts = $cartDiscounts;

        if (null !== $cart->getShippingAddress()) {
            $cartView->shippingAddress = $this->addressViewFactory->create($cart->getShippingAddress());
        }

        if (null !== $cart->getBillingAddress()) {
            $cartView->billingAddress = $this->addressViewFactory->create($cart->getBillingAddress());
        }

        return $cartView;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Sylius\SyliusShopApiPlugin\Factory;
6
7			use Sylius\Component\Core\Model\AdjustmentInterface;
8			use Sylius\Component\Core\Model\OrderInterface;
9			use Sylius\Component\Core\Model\OrderItemInterface;
10			use Sylius\ShopApiPlugin\View\AdjustmentView;
11			use Sylius\ShopApiPlugin\View\CartSummaryView;
12
13			final class CartViewFactory implements CartViewFactoryInterface
14			{
15			/** @var CartItemViewFactoryInterface */
16			private $cartItemFactory;
17
18			/** @var AddressViewFactoryInterface */
19			private $addressViewFactory;
20
21			/** @var TotalViewFactoryInterface */
22			private $totalViewFactory;
23
24			/** @var ShipmentViewFactoryInterface */
25			private $shipmentViewFactory;
26
27			/** @var PaymentViewFactoryInterface */
28			private $paymentViewFactory;
29
30			/** @var AdjustmentViewFactoryInterface */
31			private $adjustmentViewFactory;
32
33			/** @var string */
34			private $cartSummaryViewClass;
35
36			public function __construct(
37			CartItemViewFactoryInterface $cartItemFactory,
38			AddressViewFactoryInterface $addressViewFactory,
39			TotalViewFactoryInterface $totalViewFactory,
40			ShipmentViewFactoryInterface $shipmentViewFactory,
41			PaymentViewFactoryInterface $paymentViewFactory,
42			AdjustmentViewFactoryInterface $adjustmentViewFactory,
43			string $cartSummaryViewClass
44			) {
45			$this->cartItemFactory = $cartItemFactory;
46			$this->addressViewFactory = $addressViewFactory;
47			$this->totalViewFactory = $totalViewFactory;
48			$this->shipmentViewFactory = $shipmentViewFactory;
49			$this->paymentViewFactory = $paymentViewFactory;
50			$this->adjustmentViewFactory = $adjustmentViewFactory;
51			$this->cartSummaryViewClass = $cartSummaryViewClass;
52			}
53
54			/**
55			* {@inheritdoc}
56			*/
57			public function create(OrderInterface $cart, string $localeCode): CartSummaryView
58			{
59			/** @var CartSummaryView $cartView */
60			$cartView = new $this->cartSummaryViewClass();
61			$cartView->channel = $cart->getChannel()->getCode();
62			$cartView->currency = $cart->getCurrencyCode();
63			$cartView->locale = $localeCode;
64			$cartView->checkoutState = $cart->getCheckoutState();
65			$cartView->tokenValue = $cart->getTokenValue();
66			$cartView->totals = $this->totalViewFactory->create($cart);
67
68			/** @var OrderItemInterface $item */
69			foreach ($cart->getItems() as $item) {
70			$cartView->items[] = $this->cartItemFactory->create($item, $cart->getChannel(), $localeCode);
			0 ignored issues – show Bug introduced 2018-08-20 13:31 UTC by Report Bug Copy Issue Report It seems like `$cart->getChannel()` can be `null`; however, `create()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
71			}
72
73			foreach ($cart->getShipments() as $shipment) {
74			$cartView->shipments[] = $this->shipmentViewFactory->create($shipment, $localeCode);
75			}
76
77			foreach ($cart->getPayments() as $payment) {
78			$cartView->payments[] = $this->paymentViewFactory->create($payment, $localeCode);
79			}
80
81			/** @var AdjustmentView[] $cartDiscounts */
82			$cartDiscounts = [];
83			/** @var AdjustmentInterface $adjustment */
84			foreach ($cart->getAdjustmentsRecursively(AdjustmentInterface::ORDER_PROMOTION_ADJUSTMENT) as $adjustment) {
85			$originCode = $adjustment->getOriginCode();
86			$additionalAmount = isset($cartDiscounts[$originCode]) ? $cartDiscounts[$originCode]->amount->current : 0;
87
88			$cartDiscounts[$originCode] = $this->adjustmentViewFactory->create($adjustment, $additionalAmount, $cart->getCurrencyCode());
89			}
90
91			$cartView->cartDiscounts = $cartDiscounts;
92
93			if (null !== $cart->getShippingAddress()) {
94			$cartView->shippingAddress = $this->addressViewFactory->create($cart->getShippingAddress());
95			}
96
97			if (null !== $cart->getBillingAddress()) {
98			$cartView->billingAddress = $this->addressViewFactory->create($cart->getBillingAddress());
99			}
100
101			return $cartView;
102			}
103			}
104

Sylius / SyliusShopApiPlugin

Pull Request — master (#290)

CartViewFactory::create() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like