PayoneRepository::getFormattedPaymentData() - Code Metrics - Inspection of "SUPESC-781 Fixed duplicated preauthorisation calls..." - spryker-eco/payone - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#88)

by Olha
created 2024-03-18 14:09 UTC
PayoneRepository::getFormattedPaymentData() A

↳ Parent: PayoneRepository
Complexity

Conditions	2
Paths	2
Size

Total Lines	15
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	15
rs	10
cc	2
nc	2
nop	1
<?php

/**
 * MIT License
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace SprykerEco\Zed\Payone\Persistence;

use ArrayObject;
use Generated\Shared\Transfer\OrderTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PaymentDetailTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PaymentPayoneOrderItemTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PayoneApiLogTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PayoneOrderItemFilterTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PayonePaymentLogCollectionTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PayonePaymentLogTransfer;
filter:
    dependency_paths: ["lib/*"]
use Generated\Shared\Transfer\PayonePaymentTransfer;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Payone\Persistence\Map\SpyPaymentPayoneApiLogTableMap;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Payone\Persistence\SpyPaymentPayoneApiLogQuery;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Payone\Persistence\SpyPaymentPayoneOrderItemQuery;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Payone\Persistence\SpyPaymentPayoneQuery;
filter:
    dependency_paths: ["lib/*"]
use Orm\Zed\Payone\Persistence\SpyPaymentPayoneTransactionStatusLogQuery;
filter:
    dependency_paths: ["lib/*"]
use Propel\Runtime\ActiveQuery\Criteria;
use Spryker\Zed\Kernel\Persistence\AbstractRepository;
use SprykerEco\Shared\Payone\PayoneApiConstants;

/**
 * @method \SprykerEco\Zed\Payone\Persistence\PayonePersistenceFactory getFactory()
 */
class PayoneRepository extends AbstractRepository implements PayoneRepositoryInterface
{
    protected const LOG_TYPE_API_LOG = 'SpyPaymentPayoneApiLog';
    protected const LOG_TYPE_TRANSACTION_STATUS_LOG = 'SpyPaymentPayoneTransactionStatusLog';

    /**
     * @var string
     */
    protected const RAW_RESPONSE_COLUMN_NAME = 'rawResponse';

    /**
     * @param \Generated\Shared\Transfer\PayoneOrderItemFilterTransfer $payoneOrderItemFilerTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentPayoneOrderItemTransfer[]
     */
    public function findPaymentPayoneOrderItemByFilter(PayoneOrderItemFilterTransfer $payoneOrderItemFilerTransfer): array
    {
        $paymentPayoneOrderItemQuery = $this->getFactory()->createPaymentPayoneOrderItemQuery();
        $paymentPayoneOrderItemQuery = $this->setPayoneOrderItemFilters(
            $paymentPayoneOrderItemQuery,
            $payoneOrderItemFilerTransfer
        );

        $paymentPayoneOrderItemEntities = $paymentPayoneOrderItemQuery->find();
        $paymentPayoneOrderItemTransfers = [];

        foreach ($paymentPayoneOrderItemEntities as $paymentPayoneOrderItemEntity) {
            $paymentPayoneOrderItemTransfers[] = $this->getFactory()
                ->createPayonePersistenceMapper()
                ->mapEntityToPaymentPayoneOrderItemTransfer($paymentPayoneOrderItemEntity, new PaymentPayoneOrderItemTransfer());
        }

        return $paymentPayoneOrderItemTransfers;
    }

    /**
     * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer
     *
     * @return \Generated\Shared\Transfer\PayonePaymentTransfer
     */
    public function getPayonePaymentByOrder(OrderTransfer $orderTransfer): PayonePaymentTransfer
    {
        $paymentPayoneEntity = $this->createPaymentPayoneQueryByOrderId($orderTransfer->getIdSalesOrder())->findOne();

        return $this
            ->getFactory()
            ->createPayonePersistenceMapper()
            ->mapPaymentPayoneEntityToPayonePaymentTransfer($paymentPayoneEntity, new PayonePaymentTransfer());
    }

    /**
     * @param int $idOrder
     *
     * @return \Generated\Shared\Transfer\PaymentDetailTransfer
     */
    public function getPaymentDetail(int $idOrder): PaymentDetailTransfer
    {
        $paymentPayoneEntity = $this->createPaymentPayoneQueryByOrderId($idOrder)->findOne();
        $paymentPayoneDetailEntity = $paymentPayoneEntity->getSpyPaymentPayoneDetail();

        return $this->getFactory()->createPayonePersistenceMapper()->mapPaymentPayoneDetailToPaymentDetailTransfer($paymentPayoneDetailEntity);
    }

    /**
     * Gets payment logs (both api and transaction status) for specific orders in chronological order.
     *
     * @param \ArrayObject|\Generated\Shared\Transfer\OrderTransfer[] $orderTransfers
     *
     * @return \Generated\Shared\Transfer\PayonePaymentLogCollectionTransfer
     */
    public function getPaymentLogs(ArrayObject $orderTransfers): PayonePaymentLogCollectionTransfer
    {
        $paymentPayoneApiLogEntityCollection = $this->createPaymentPayoneApiLogQueryByOrderIds($orderTransfers)->find()->getData();

        $paymentPayoneTransactionStatusLogEntityCollection = $this->createPaymentPayoneTransactionStatusLogQueryByOrderIds($orderTransfers)->find()->getData();

        $payonePaymentLogTransferList = [];
        /** @var \Orm\Zed\Payone\Persistence\SpyPaymentPayoneApiLog $paymentPayoneApiLogEntity */
        foreach ($paymentPayoneApiLogEntityCollection as $paymentPayoneApiLogEntity) {
            /** @var \DateTime $apiLogCreatedAtDateTime */
            $apiLogCreatedAtDateTime = $paymentPayoneApiLogEntity->getCreatedAt();
            $key = $apiLogCreatedAtDateTime->format('Y-m-d\TH:i:s\Z') . 'a' . $paymentPayoneApiLogEntity->getIdPaymentPayoneApiLog();
            $payonePaymentLogTransfer = new PayonePaymentLogTransfer();
            $payonePaymentLogTransfer->fromArray($paymentPayoneApiLogEntity->toArray(), true);
            $payonePaymentLogTransfer->setLogType(static::LOG_TYPE_API_LOG);
            $payonePaymentLogTransferList[$key] = $payonePaymentLogTransfer;
        }
        /** @var \Orm\Zed\Payone\Persistence\SpyPaymentPayoneTransactionStatusLog $paymentPayoneTransactionStatusLogEntity */
        foreach ($paymentPayoneTransactionStatusLogEntityCollection as $paymentPayoneTransactionStatusLogEntity) {
            /** @var \DateTime $transactionStatusLogDateTime */
            $transactionStatusLogDateTime = $paymentPayoneTransactionStatusLogEntity->getCreatedAt();
            $key = $transactionStatusLogDateTime->format('Y-m-d\TH:i:s\Z') . 't' . $paymentPayoneTransactionStatusLogEntity->getIdPaymentPayoneTransactionStatusLog();
            $payonePaymentLogTransfer = new PayonePaymentLogTransfer();
            $payonePaymentLogTransfer->fromArray($paymentPayoneTransactionStatusLogEntity->toArray(), true);
            $payonePaymentLogTransfer->setLogType(static::LOG_TYPE_TRANSACTION_STATUS_LOG);
            $payonePaymentLogTransferList[$key] = $payonePaymentLogTransfer;
        }

        ksort($payonePaymentLogTransferList);

        $payonePaymentLogCollectionTransfer = new PayonePaymentLogCollectionTransfer();

        foreach ($payonePaymentLogTransferList as $payonePaymentLogTransfer) {
            $payonePaymentLogCollectionTransfer->addPaymentLog($payonePaymentLogTransfer);
        }

        return $payonePaymentLogCollectionTransfer;
    }

    /**
     * @param int $idSalesOrder
     *
     * @return \Generated\Shared\Transfer\PayoneApiLogTransfer|null
     */
    public function findLastApiLogByOrderId(int $idSalesOrder): ?PayoneApiLogTransfer
    {
        $paymentPayoneApiLogEntity = $this->getFactory()->createPaymentPayoneApiLogQuery()
            ->useSpyPaymentPayoneQuery()
                ->filterByFkSalesOrder($idSalesOrder)
            ->endUse()
            ->orderByCreatedAt(Criteria::DESC)
            ->orderByIdPaymentPayoneApiLog(Criteria::DESC)
            ->findOne();

        if (!$paymentPayoneApiLogEntity) {
            return null;
        }

        $apiLogTransfer = new PayoneApiLogTransfer();
        $apiLogTransfer->fromArray($paymentPayoneApiLogEntity->toArray(), true);

        return $apiLogTransfer;
    }

    /**
     * @param int $idOrder
     *
     * @return \Orm\Zed\Payone\Persistence\SpyPaymentPayoneQuery
     */
    public function createPaymentPayoneQueryByOrderId(int $idOrder): SpyPaymentPayoneQuery
    {
        $query = $this->getFactory()->createPaymentPayoneQuery();
        $query->findByFkSalesOrder($idOrder);

        return $query;
    }

    /**
     * @param string $reference
     *
     * @return array<string, mixed>
     */
    public function getPreauthorizedPaymentByReference(string $reference): array
    {
        $paymentPayoneQuery = $this->getFactory()->createPaymentPayoneQuery();
        $paymentPayoneQuery->filterByReference($reference)
            ->joinSpyPaymentPayoneApiLog()
            ->useSpyPaymentPayoneApiLogQuery()
                ->filterByRequest(PayoneApiConstants::REQUEST_TYPE_PREAUTHORIZATION)
                ->filterByStatus(PayoneApiConstants::RESPONSE_TYPE_APPROVED)
            ->endUse()
            ->withColumn(SpyPaymentPayoneApiLogTableMap::COL_RAW_RESPONSE, static::RAW_RESPONSE_COLUMN_NAME);
        $paymentData = $paymentPayoneQuery->findOne();

        if ($paymentData === null) {
            return [];
        }

        return $this->getFormattedPaymentData($paymentData);
    }

    /**
     * @param \Orm\Zed\Payone\Persistence\SpyPaymentPayoneOrderItemQuery $paymentPayoneOrderItemQuery
     * @param \Generated\Shared\Transfer\PayoneOrderItemFilterTransfer $payoneOrderItemFilerTransfer
     *
     * @return \Orm\Zed\Payone\Persistence\SpyPaymentPayoneOrderItemQuery
     */
    protected function setPayoneOrderItemFilters(
        SpyPaymentPayoneOrderItemQuery $paymentPayoneOrderItemQuery,
        PayoneOrderItemFilterTransfer $payoneOrderItemFilerTransfer
    ): SpyPaymentPayoneOrderItemQuery {
        if ($payoneOrderItemFilerTransfer->getIdSalesOrder()) {
            $paymentPayoneOrderItemQuery
                ->useSpyPaymentPayoneQuery()
                    ->filterByFkSalesOrder($payoneOrderItemFilerTransfer->getIdSalesOrder())
                ->endUse();
        }

        if (count($payoneOrderItemFilerTransfer->getSalesOrderItemIds())) {
            $paymentPayoneOrderItemQuery->filterByFkSalesOrderItem_In(
                $payoneOrderItemFilerTransfer->getSalesOrderItemIds()
            );
        }

        return $paymentPayoneOrderItemQuery;
    }

    /**
     * @param \ArrayObject|\Generated\Shared\Transfer\OrderTransfer[] $orderTransfers
     *
     * @return \Orm\Zed\Payone\Persistence\SpyPaymentPayoneApiLogQuery
     */
    protected function createPaymentPayoneApiLogQueryByOrderIds($orderTransfers): SpyPaymentPayoneApiLogQuery
    {
        $ids = [];
        foreach ($orderTransfers as $orderTransfer) {
            $ids[] = $orderTransfer->getIdSalesOrder();
        }

        $query = $this->getFactory()->createPaymentPayoneApiLogQuery()
            ->useSpyPaymentPayoneQuery()
                ->filterByFkSalesOrder($ids, Criteria::IN)
            ->endUse()
            ->orderByCreatedAt();

        return $query;
    }

    /**
     * @param \ArrayObject|\Generated\Shared\Transfer\OrderTransfer[] $orderTransfers
     *
     * @return \Orm\Zed\Payone\Persistence\SpyPaymentPayoneTransactionStatusLogQuery
     */
    protected function createPaymentPayoneTransactionStatusLogQueryByOrderIds(ArrayObject $orderTransfers): SpyPaymentPayoneTransactionStatusLogQuery
    {
        $ids = [];
        foreach ($orderTransfers as $orderTransfer) {
            $ids[] = $orderTransfer->getIdSalesOrder();
        }

        $query = $this->getFactory()->createPaymentPayoneTransactionStatusLogQuery()
            ->useSpyPaymentPayoneQuery()
                ->filterByFkSalesOrder($ids, Criteria::IN)
            ->endUse()
            ->orderByCreatedAt();

        return $query;
    }

    /**
     * @param array<string, mixed> $paymentData
     *
     * @return array<string, mixed>
     */
    protected function getFormattedPaymentData(array $paymentData): array
    {
        $paymentResponseData = $this->getFactory()->getServiceUtilEncoding()->decodeJson($paymentData[static::RAW_RESPONSE_COLUMN_NAME], true);

        if ($paymentResponseData === null) {
            return [];
        }

        $formattedPaymentData = array_merge(
            $paymentData,
            $paymentResponseData,
            /** @scrutinizer ignore-type */ $paymentResponseData,
        );
        unset($formattedPaymentData[static::RAW_RESPONSE_COLUMN_NAME]);

        return $formattedPaymentData;
    }
}

spryker-eco / payone

Pull Request — master (#88)

PayoneRepository::getFormattedPaymentData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
