Kerox\Messenger\Model\Common\Button\Payment\PaymentSummary

Complexity

Total Complexity

11

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

95.45%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	isTestPayment()	0	6	1
A	addPriceList()	0	6	1
A	isValidPaymentType()	0	9	2
A	getAllowedPaymentType()	0	7	1
A	isValidRequestedUserInfo()	0	11	3
A	getAllowedUserInfo()	0	9	1
A	jsonSerialize()	0	13	1

<?php

declare(strict_types=1);

namespace Kerox\Messenger\Model\Common\Button\Payment;

class PaymentSummary implements \JsonSerializable
{
    public const PAYMENT_TYPE_FIXED_AMOUNT = 'FIXED_AMOUNT';
    public const PAYMENT_TYPE_FLEXIBLE_AMOUNT = 'FLEXIBLE_AMOUNT';

    public const USER_INFO_SHIPPING_ADDRESS = 'shipping_address';
    public const USER_INFO_CONTACT_NAME = 'contact_name';
    public const USER_INFO_CONTACT_PHONE = 'contact_phone';
    public const USER_INFO_CONTACT_EMAIL = 'contact_email';

    /**
     * @var string
     */
    protected $currency;

    /**
     * @var null|bool
     */
    protected $isTestPayment;

    /**
     * @var string
     */
    protected $paymentType;

    /**
     * @var string
     */
    protected $merchantName;

    /**
     * @var array
     */
    protected $requestedUserInfo = [];

    /**
     * @var array
     */
    protected $priceList = [];

    /**
     * PaymentSummary constructor.
     *
     * @param string      $currency
     * @param string      $paymentType
     * @param string      $merchantName
     * @param array       $requestedUserInfo
     * @param PriceList[] $priceList
     */
    public function __construct(
        string $currency,
        string $paymentType,
        string $merchantName,
        array $requestedUserInfo,
        array $priceList
    ) {
        $this->isValidPaymentType($paymentType);
        $this->isValidRequestedUserInfo($requestedUserInfo);

        $this->currency = $currency;
        $this->paymentType = $paymentType;
        $this->merchantName = $merchantName;
        $this->requestedUserInfo = $requestedUserInfo;
        $this->priceList = $priceList;
    }

    /**
     * @param bool $isTestPayment
     *
     * @return PaymentSummary
     */
    public function isTestPayment(bool $isTestPayment): self
    {
        $this->isTestPayment = $isTestPayment;

        return $this;
    }

    /**
     * @param string $label
     * @param string $amount
     *
     * @return PaymentSummary
     */
    public function addPriceList(string $label, string $amount): self
    {
        $this->priceList[] = new PriceList($label, $amount);

        return $this;
    }

    /**
     * @param string $paymentType
     *
     * @throws \InvalidArgumentException
     */
    private function isValidPaymentType(string $paymentType): void
    {
        $allowedPaymentType = $this->getAllowedPaymentType();
        if (!in_array($paymentType, $allowedPaymentType, true)) {
            throw new \InvalidArgumentException(
                '$paymentType must be either ' . implode(', ', $allowedPaymentType)
            );
        }
    }

    /**
     * @return array
     */
    private function getAllowedPaymentType(): array
    {
        return [
            self::PAYMENT_TYPE_FIXED_AMOUNT,
            self::PAYMENT_TYPE_FLEXIBLE_AMOUNT,
        ];
    }

    /**
     * @param array $requestedUserInfo
     *
     * @throws \InvalidArgumentException
     */
    private function isValidRequestedUserInfo(array $requestedUserInfo): void
    {
        $allowedUserInfo = $this->getAllowedUserInfo();
        foreach ($requestedUserInfo as $userInfo) {
            if (!in_array($userInfo, $allowedUserInfo, true)) {
                throw new \InvalidArgumentException(
                    "$userInfo is not a valid value. Valid values are " . implode(',', $allowedUserInfo)
                );
            }
        }
    }

    /**
     * @return array
     */
    private function getAllowedUserInfo(): array
    {
        return [
            self::USER_INFO_SHIPPING_ADDRESS,
            self::USER_INFO_CONTACT_NAME,
            self::USER_INFO_CONTACT_PHONE,
            self::USER_INFO_CONTACT_EMAIL,
        ];
    }

    /**
     * @return array
     */
    public function jsonSerialize(): array
    {
        $json = [
            'currency'            => $this->currency,
            'payment_type'        => $this->paymentType,
            'is_test_payment'     => $this->isTestPayment,
            'merchant_name'       => $this->merchantName,
            'requested_user_info' => $this->requestedUserInfo,
            'price_list'          => $this->priceList,
        ];

        return array_filter($json);
    }
}