Debit::__construct() - Code Metrics - Inspection of "Fix creditmemo to be correctly sent to Payone API..." - PAYONE-GmbH/magento-2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#395)

unknown
created 2021-09-30 10:00 UTC
Debit::__construct() A

↳ Parent: Debit
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	1
eloc	5
c	2
b	0
f	0
nc	1
nop	8
dl	0
loc	15
rs	10
How to fix Many Parameters

<?php

/**
 * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
 *
 * PHP version 5
 *
 * @category  Payone
 * @package   Payone_Magento2_Plugin
 * @author    FATCHIP GmbH <[email protected]>
 * @copyright 2003 - 2016 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\Core\Model\Api\Request;

use Magento\Framework\Exception\LocalizedException;
filter:
    dependency_paths: ["lib/*"]
use Magento\Sales\Model\Order;
filter:
    dependency_paths: ["lib/*"]
use Magento\Sales\Model\Order\Creditmemo;
filter:
    dependency_paths: ["lib/*"]
use Payone\Core\Model\Methods\PayoneMethod;
use Magento\Payment\Model\InfoInterface;
filter:
    dependency_paths: ["lib/*"]

/**
 * Class for the PAYONE Server API request "debit"
 */
class Debit extends Base
{
    /**
     * @var \Payone\Core\Model\Api\Invoice $invoiceGenerator
     */
    protected $invoiceGenerator;

    /**
     * PAYONE database helper
     *
     * @var \Payone\Core\Helper\Database
     */
    protected $databaseHelper;

    /**
     * PAYONE toolkit helper
     *
     * @var \Payone\Core\Helper\Toolkit
     */
    protected $toolkitHelper;


    const AREA_CODE = \Magento\Framework\App\Area::AREA_ADMINHTML;
filter:
    dependency_paths: ["lib/*"]

    /**
     * State resolving
     *
     * @var \Magento\Framework\App\State
filter:
    dependency_paths: ["lib/*"]
     */
    protected $state;

    /**
     * Constructor
     *
     * @param \Payone\Core\Helper\Shop                $shopHelper
     * @param \Payone\Core\Helper\Environment         $environmentHelper
     * @param \Payone\Core\Helper\Api                 $apiHelper
     * @param \Payone\Core\Model\ResourceModel\ApiLog $apiLog
     * @param \Payone\Core\Model\Api\Invoice          $invoiceGenerator
     * @param \Payone\Core\Helper\Database            $databaseHelper
     * @param \Payone\Core\Helper\Toolkit             $toolkitHelper
     * @param \Magento\Framework\App\State            $state
     */
    public function __construct(
        \Payone\Core\Helper\Shop $shopHelper,
        \Payone\Core\Helper\Environment $environmentHelper,
        \Payone\Core\Helper\Api $apiHelper,
        \Payone\Core\Model\ResourceModel\ApiLog $apiLog,
        \Payone\Core\Model\Api\Invoice $invoiceGenerator,
        \Payone\Core\Helper\Database $databaseHelper,
        \Payone\Core\Helper\Toolkit $toolkitHelper,
        \Magento\Framework\App\State $state
    ) {
        parent::__construct($shopHelper, $environmentHelper, $apiHelper, $apiLog);
        $this->invoiceGenerator = $invoiceGenerator;
        $this->databaseHelper = $databaseHelper;
        $this->toolkitHelper = $toolkitHelper;
        $this->state = $state;
    }

    /**
     * Get creditmemo array from request parameters
     *
     * @return mixed
     */
    protected function getCreditmemoRequestParams()
    {
        return $this->shopHelper->getRequestParameter('creditmemo');
    }

    /**
     * Generate position list for invoice data transmission
     *
     * @param  Order      $oOrder
     * @param  Creditmemo $oCreditmemo
     * @return array|false
     */
    protected function getInvoiceList(Order $oOrder, Creditmemo $oCreditmemo)
    {
        $aCreditmemo = $this->getCreditmemoRequestParams();

        if (empty($aCreditmemo) && $this->state->getAreaCode() != self::AREA_CODE) {
            $aCreditmemo = $this->getCreditMemoData($oCreditmemo);
        }

        $aPositions = [];
        $blFull = true;
        if ($aCreditmemo && array_key_exists('items', $aCreditmemo) !== false) {
            foreach ($oOrder->getAllItems() as $oItem) {
                if (isset($aCreditmemo['items'][$oItem->getItemId()]) && $aCreditmemo['items'][$oItem->getItemId()]['qty'] > 0) {
                    $aPositions[$oItem->getProductId().$oItem->getSku()] = $aCreditmemo['items'][$oItem->getItemId()]['qty'];
                    if ($aCreditmemo['items'][$oItem->getItemId()]['qty'] != $oItem->getQtyOrdered()) {
                        $blFull = false;
                    }
                } elseif (!$oItem->getParentItemId()) { // dont set invoice list to not full on variant dummy items
                    $blFull = false;
                }
            }
        }
        if (isset($aCreditmemo['shipping_amount']) && $aCreditmemo['shipping_amount'] != 0) {
            $aPositions['delcost'] = $oCreditmemo->getBaseShippingInclTax();
            if ($this->shopHelper->getConfigParam('currency', 'global', 'payone_general', $this->storeCode) == 'display') {
                $aPositions['delcost'] = $oCreditmemo->getShippingInclTax();
            }
        }
        if ($blFull !== true && $oCreditmemo->getBaseDiscountAmount() != 0) {
            $aPositions['discount'] = $oCreditmemo->getBaseDiscountAmount();
            if ($this->shopHelper->getConfigParam('currency', 'global', 'payone_general', $this->storeCode) == 'display') {
                $aPositions['discount'] = $oCreditmemo->getDiscountAmount();
            }
        }
        if ($blFull === true && (!isset($aCreditmemo['shipping_amount']) || $aCreditmemo['shipping_amount'] == $oOrder->getBaseShippingInclTax())) {
            $aPositions = false; // false = full debit
        }
        return $aPositions;
    }

    /**
     * Send request "debit" to PAYONE server API
     *
     * @param  PayoneMethod  $oPayment
     * @param  InfoInterface $oPaymentInfo
     * @param  float         $dAmount
     * @return array
     */
    public function sendRequest(PayoneMethod $oPayment, InfoInterface $oPaymentInfo, $dAmount)
    {
        $oOrder = $oPaymentInfo->getOrder();

        $this->setStoreCode($oOrder->getStore()->getCode());

        $oCreditmemo = $oPaymentInfo->getCreditmemo();
        $aPositions = $this->getInvoiceList($oOrder, $oCreditmemo);

        $iTxid = $oPaymentInfo->getParentTransactionId();
        if (strpos($iTxid, '-') !== false) {
            $iTxid = substr($iTxid, 0, strpos($iTxid, '-')); // clean the txid from the magento-suffixes
        }

        $this->setOrderId($oOrder->getRealOrderId());

        $this->addParameter('request', 'debit'); // Request method
        $this->addParameter('mode', $oPayment->getOperationMode()); // PayOne Portal Operation Mode (live or test)
        $this->addParameter('txid', $iTxid); // PayOne Transaction ID
        $this->addParameter('sequencenumber', $this->databaseHelper->getSequenceNumber($iTxid));

        // Total order sum in smallest currency unit
        $this->addParameter('amount', number_format((-1 * $dAmount), 2, '.', '') * 100); // add price to request
        $this->addParameter('currency', $this->apiHelper->getCurrencyFromOrder($oOrder)); // add currency to request

        $this->addParameter('transactiontype', 'GT');

        $sRefundAppendix = $this->getRefundAppendix($oOrder, $oPayment);
        if (!empty($sRefundAppendix)) {
            $this->addParameter('invoiceappendix', $sRefundAppendix);
        }

        if ($this->apiHelper->isInvoiceDataNeeded($oPayment, $aPositions)) {
        if ($this->apiHelper->isInvoiceDataNeeded($oPayment, /** @scrutinizer ignore-type */ $aPositions)) {
            $this->invoiceGenerator->addProductInfo($this, $oOrder, $aPositions, true); // add invoice parameters
            $this->invoiceGenerator->addProductInfo($this, $oOrder, /** @scrutinizer ignore-type */ $aPositions, true); // add invoice parameters
        }

        $aCreditmemo = $this->getCreditmemoRequestParams();
        $sIban = false;
        $sBic = false;
        if (!empty($oOrder->getPayoneRefundIban()) && !empty($oOrder->getPayoneRefundBic())) {
            $sIban = $oOrder->getPayoneRefundIban();
            $sBic = $oOrder->getPayoneRefundBic();
        } elseif (isset($aCreditmemo['payone_iban']) && isset($aCreditmemo['payone_bic'])) {
            $sIban = $aCreditmemo['payone_iban'];
            $sBic = $aCreditmemo['payone_bic'];
        }

        if ($sIban !== false && $sBic !== false && $this->isSepaDataValid($sIban, $sBic)) {
            $this->addParameter('iban', $sIban);
            $this->addParameter('bic', $sBic);
        }

        $this->aParameters = array_merge($this->aParameters, $oPayment->getPaymentSpecificDebitParameters($oOrder));

        $aResponse = $this->send($oPayment);

        return $aResponse;
    }

    /**
     * Get substituted refund appendix text
     *
     * @param  Order        $oOrder
     * @param  PayoneMethod $oPayment
     * @return string
     */
    protected function getRefundAppendix(Order $oOrder, PayoneMethod $oPayment)
    {
        $sText = $this->shopHelper->getConfigParam('invoice_appendix_refund', 'invoicing', 'payone_general', $this->storeCode);
        $sCreditMemoIncrId = '';
        $sInvoiceIncrementId = '';
        $sInvoiceId = '';

        $oCreditmemo = $oPayment->getCreditmemo();
        if ($oCreditmemo) {
            $sCreditMemoIncrId = $oCreditmemo->getIncrementId();
            $oInvoice = $oCreditmemo->getInvoice();
            if ($oInvoice) {
                $sInvoiceIncrementId = $oInvoice->getIncrementId();
                $sInvoiceId = $oInvoice->getId();
            }
        }

        $aSubstitutionArray = [
            '{{order_increment_id}}' => $oOrder->getIncrementId(),
            '{{order_id}}' => $oOrder->getId(),
            '{{customer_id}}' => $oOrder->getCustomerId(),
            '{{creditmemo_increment_id}}' => $sCreditMemoIncrId,
            '{{invoice_increment_id}}' => $sInvoiceIncrementId,
            '{{invoice_id}}' => $sInvoiceId,
        ];
        $sRefundAppendix = $this->toolkitHelper->handleSubstituteReplacement($sText, $aSubstitutionArray, 255);
        $sRefundAppendix = $this->toolkitHelper->handleSubstituteReplacement($sText, /** @scrutinizer ignore-type */ $aSubstitutionArray, 255);
        return $sRefundAppendix;
    }

    /**
     * Validate IBAN
     *
     * @param  string $sIban
     * @return bool
     */
    protected function isIbanValid($sIban)
    {
        $sRegex = '/^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}(?:[a-zA-Z0-9]?){0,16}$/';
        return $this->checkRegex($sRegex, $sIban);
    }

    /**
     * Check if the regex validates correctly
     *
     * @param  string $sRegex
     * @param  string $sValue
     * @return bool
     */
    protected function checkRegex($sRegex, $sValue)
    {
        preg_match($sRegex, str_replace(' ', '', $sValue), $aMatches);
        if (empty($aMatches)) {
            return false;
        }
        return true;
    }

    /**
     * Validate IBAN
     *
     * @param  string $sBic
     * @return bool
     */
    protected function isBicValid($sBic)
    {
        $sRegex = '/^([a-zA-Z]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?)$/';
        return $this->checkRegex($sRegex, $sBic);
    }

    /**
     * Check IBAN and BIC fields
     *
     * @param  string $sIban
     * @param  string $sBic
     * @return bool
     * @throws LocalizedException
     */
    public function isSepaDataValid($sIban, $sBic)
    {
        if (!$this->isIbanValid($sIban)) {
            throw new LocalizedException(__('The given IBAN is invalid!'));
            throw new LocalizedException(/** @scrutinizer ignore-call */ __('The given IBAN is invalid!'));
        }
        if (!$this->isBicValid($sBic)) {
            throw new LocalizedException(__('The given BIC is invalid!'));
        }
        return true;
    }

    /**
     * Emulate the getCreditmemoRequestParams method for creditmemos that are not created via adminhtml
     *
     * @param $oCreditmemo
     * @return array
     */
    protected function getCreditMemoData($oCreditmemo)
    {
        $data = [];
        foreach ($oCreditmemo->getItems() as $item) {
            if ($item->getQty() <= 0 || $item->getOrderItem()->isDummy()){
                continue;
            }
            $data['items'][$item->getOrderItemId()]['qty'] = $item->getQty();
        }
        $data['do_offline'] = 0;
        $data['comment_text'] = '';
        $data['shipping_amount'] = 0;
        if ($oCreditmemo->getAdjustment() > 0) {
            $data['adjustment_positive'] = $oCreditmemo->getAdjustment();
        } else if ($oCreditmemo->getAdjustment() < 0) {
            $data['adjustment_negative'] = $oCreditmemo->getAdjustment() * -1;
        }

        return $data;
    }
}

PAYONE-GmbH / magento-2

Pull Request — master (#395)

Debit::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
