SprykerEco\Yves\Braintree\Form\DataProvider\CheckoutShipmentFormDataProvider

Complexity

Total Complexity

21

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Importance

Changes	6
Bugs	1	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	getData()	0	8	2
A	getOptions()	0	5	1
A	appendDeliveryTime()	0	15	2
A	getAvailableShipmentMethods()	0	3	1
A	createAvailableShipmentChoiceList()	0	14	3
A	getTranslatedDayName()	0	7	2
A	getShipmentDescription()	0	8	1
A	appendShipmentPrice()	0	6	1
A	getDeliveryTime()	0	7	2
A	getSelectedShipmentMethodId()	0	9	3
A	translate()	0	3	1
A	getFormattedShipmentPrice()	0	6	1

<?php

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace SprykerEco\Yves\Braintree\Form\DataProvider;

use Generated\Shared\Transfer\QuoteTransfer;

The type Generated\Shared\Transfer\QuoteTransfer was not found. Maybe you did not declare it correctly or list all dependencies?

use Generated\Shared\Transfer\ShipmentMethodsCollectionTransfer;

The type Generated\Shared\Transfer\ShipmentMethodsCollectionTransfer was not found. Maybe you did not declare it correctly or list all dependencies?

use Generated\Shared\Transfer\ShipmentMethodsTransfer;

The type Generated\Shared\Transfer\ShipmentMethodsTransfer was not found. Maybe you did not declare it correctly or list all dependencies?

use Generated\Shared\Transfer\ShipmentMethodTransfer;

The type Generated\Shared\Transfer\ShipmentMethodTransfer was not found. Maybe you did not declare it correctly or list all dependencies?

use Generated\Shared\Transfer\ShipmentTransfer;

The type Generated\Shared\Transfer\ShipmentTransfer was not found. Maybe you did not declare it correctly or list all dependencies?

use Spryker\Shared\Kernel\Store;
use Spryker\Shared\Kernel\Transfer\AbstractTransfer;
use Spryker\Shared\Money\Dependency\Plugin\MoneyPluginInterface;
use Spryker\Yves\StepEngine\Dependency\Form\StepEngineFormDataProviderInterface;
use SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToGlossaryClientInterface;
use SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToShipmentClientInterface;
use SprykerEco\Yves\Braintree\Form\CheckoutShipmentForm;

class CheckoutShipmentFormDataProvider implements StepEngineFormDataProviderInterface
{
    public const FIELD_ID_SHIPMENT_METHOD = 'idShipmentMethod';

    public const TRANSLATION_KEY_DELIVERY_TIME = 'page.checkout.shipping.delivery_time';
    public const TRANSLATION_KEY_DAY = 'page.checkout.shipping.day';
    public const TRANSLATION_KEY_DAYS = 'page.checkout.shipping.days';

    protected const SECONDS_IN_A_DAY = 86400;

    /**
     * @var \SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToShipmentClientInterface
     */
    protected $shipmentClient;

    /**
     * @var \SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToGlossaryClientInterface
     */
    protected $glossaryClient;

    /**
     * @var \Spryker\Shared\Kernel\Store
     */
    protected $store;

    /**
     * @var \Spryker\Shared\Money\Dependency\Plugin\MoneyPluginInterface
     */
    protected $moneyPlugin;

    /**
     * @param \SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToShipmentClientInterface $shipmentClient
     * @param \SprykerEco\Yves\Braintree\Dependency\Client\BraintreeToGlossaryClientInterface $glossaryClient
     * @param \Spryker\Shared\Kernel\Store $store
     * @param \Spryker\Shared\Money\Dependency\Plugin\MoneyPluginInterface $moneyPlugin
     */
    public function __construct(
        BraintreeToShipmentClientInterface $shipmentClient,
        BraintreeToGlossaryClientInterface $glossaryClient,
        Store $store,
        MoneyPluginInterface $moneyPlugin
    ) {
        $this->shipmentClient = $shipmentClient;
        $this->glossaryClient = $glossaryClient;
        $this->store = $store;
        $this->moneyPlugin = $moneyPlugin;
    }

    /**
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return \Generated\Shared\Transfer\QuoteTransfer
     */
    public function getData(AbstractTransfer $quoteTransfer): QuoteTransfer
    {
        if ($quoteTransfer->getShipment() === null) {

The method getShipment() does not exist on Spryker\Shared\Kernel\Transfer\AbstractTransfer.

            $shipmentTransfer = new ShipmentTransfer();
            $quoteTransfer->setShipment($shipmentTransfer);

The method setShipment() does not exist on Spryker\Shared\Kernel\Transfer\AbstractTransfer.

        }

        return $quoteTransfer;

The expression return $quoteTransfer returns the type Spryker\Shared\Kernel\Transfer\AbstractTransfer which is incompatible with the type-hinted return Generated\Shared\Transfer\QuoteTransfer.

    }

    /**
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return array
     */
    public function getOptions(AbstractTransfer $quoteTransfer): array
    {
        return [
            CheckoutShipmentForm::OPTION_SHIPMENT_METHODS => $this->createAvailableShipmentChoiceList($quoteTransfer),
            CheckoutShipmentForm::OPTION_ID_SELECTED_SHIPMENT_METHOD => $this->getSelectedShipmentMethodId($quoteTransfer),
        ];
    }

    /**
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return array
     */
    protected function createAvailableShipmentChoiceList(QuoteTransfer $quoteTransfer): array
    {
        $shipmentMethods = [];
        $shipmentMethodsTransfer = $this->getAvailableShipmentMethods($quoteTransfer);
        foreach ($shipmentMethodsTransfer->getMethods() as $shipmentMethodTransfer) {
            if (!isset($shipmentMethods[$shipmentMethodTransfer->getCarrierName()])) {
                $shipmentMethods[$shipmentMethodTransfer->getCarrierName()] = [];
            }
            $description = $this->getShipmentDescription(
                $shipmentMethodTransfer
            );
            $shipmentMethods[$shipmentMethodTransfer->getCarrierName()][$description] = $shipmentMethodTransfer->getIdShipmentMethod();
        }
        return $shipmentMethods;
    }

    /**
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return \Generated\Shared\Transfer\ShipmentMethodsTransfer
     */
    protected function getAvailableShipmentMethods(QuoteTransfer $quoteTransfer): ShipmentMethodsTransfer
    {
        return $this->shipmentClient->getAvailableMethods($quoteTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentMethodTransfer $shipmentMethodTransfer
     *
     * @return string
     */
    protected function getShipmentDescription(ShipmentMethodTransfer $shipmentMethodTransfer): string
    {
        $shipmentDescription = $this->translate($shipmentMethodTransfer->getName());

        $shipmentDescription = $this->appendDeliveryTime($shipmentMethodTransfer, $shipmentDescription);
        $shipmentDescription = $this->appendShipmentPrice($shipmentMethodTransfer, $shipmentDescription);

        return $shipmentDescription;
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentMethodTransfer $shipmentMethodTransfer
     * @param string $shipmentDescription
     *
     * @return string
     */
    protected function appendDeliveryTime(ShipmentMethodTransfer $shipmentMethodTransfer, $shipmentDescription): string
    {
        $deliveryTime = $this->getDeliveryTime($shipmentMethodTransfer);

        if ($deliveryTime !== 0) {
            $shipmentDescription = sprintf(
                '%s (%s %d %s)',
                $shipmentDescription,
                $this->translate(static::TRANSLATION_KEY_DELIVERY_TIME),
                $deliveryTime,
                $this->getTranslatedDayName($deliveryTime)
            );
        }

        return $shipmentDescription;
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentMethodTransfer $shipmentMethodTransfer
     * @param string $shipmentDescription
     *
     * @return string
     */
    protected function appendShipmentPrice(ShipmentMethodTransfer $shipmentMethodTransfer, $shipmentDescription): string
    {
        $shipmentPrice = $this->getFormattedShipmentPrice($shipmentMethodTransfer);
        $shipmentDescription .= ': ' . $shipmentPrice;

        return $shipmentDescription;
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentMethodTransfer $method
     *
     * @return int
     */
    protected function getDeliveryTime(ShipmentMethodTransfer $method): int
    {
        if (!$method->getDeliveryTime()) {
            return 0;
        }

        return (int)ceil($method->getDeliveryTime() / static::SECONDS_IN_A_DAY);
    }

    /**
     * @param \Generated\Shared\Transfer\ShipmentMethodTransfer $shipmentMethodTransfer
     *
     * @return string
     */
    protected function getFormattedShipmentPrice(ShipmentMethodTransfer $shipmentMethodTransfer): string
    {
        $moneyTransfer = $this->moneyPlugin
            ->fromInteger($shipmentMethodTransfer->getStoreCurrencyPrice());

        return $this->moneyPlugin->formatWithSymbol($moneyTransfer);
    }

    /**
     * @param string $translationKey
     *
     * @return string
     */
    protected function translate($translationKey): string
    {
        return $this->glossaryClient->translate($translationKey, $this->store->getCurrentLocale());
    }

    /**
     * @param \Generated\Shared\Transfer\QuoteTransfer $quoteTransfer
     *
     * @return int|null
     */
    protected function getSelectedShipmentMethodId(QuoteTransfer $quoteTransfer): ?int
    {
        $shipment = $quoteTransfer->getShipment();

        if (!$shipment) {
            return null;
        }

        return $shipment->getMethod() ? $shipment->getMethod()->getIdShipmentMethod() : null;
    }

    /**
     * @param int $deliveryTime
     *
     * @return string
     */
    protected function getTranslatedDayName(int $deliveryTime): string
    {
        if ($deliveryTime === 1) {
            return $this->translate(static::TRANSLATION_KEY_DAY);
        }

        return $this->translate(static::TRANSLATION_KEY_DAYS);
    }
}