MethodList::checkKlarnaMethods() - Code Metrics - Inspection of "MAG2-117 New Klarna implementation" - PAYONE-GmbH/magento-2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#315)

unknown
created 2020-05-28 16:00 UTC
MethodList::checkKlarnaMethods() B

↳ Parent: MethodList
Complexity

Conditions	7
Paths	12
Size

Total Lines	25
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
eloc	16
nc	12
nop	1
dl	0
loc	25
rs	8.8333
c	0
b	0
f	0
<?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\Plugins;

use Magento\Payment\Model\MethodList as OrigMethodList;
filter:
    dependency_paths: ["lib/*"]
use Magento\Payment\Model\MethodInterface;
filter:
    dependency_paths: ["lib/*"]
use Magento\Quote\Api\Data\AddressInterface;
filter:
    dependency_paths: ["lib/*"]
use Payone\Core\Model\PayoneConfig;
use Payone\Core\Model\Source\CreditratingIntegrationEvent as Event;
use Magento\Quote\Model\Quote;
filter:
    dependency_paths: ["lib/*"]
use Payone\Core\Model\Source\PersonStatus;

/**
 * Plugin for Magentos MethodList class
 */
class MethodList
{
    /**
     * PAYONE consumerscore request model
     *
     * @var \Payone\Core\Model\Api\Request\Consumerscore
     */
    protected $consumerscore;

    /**
     * Consumerscore helper
     *
     * @var \Payone\Core\Helper\Consumerscore
     */
    protected $consumerscoreHelper;

    /**
     * Checkout session
     *
     * @var \Magento\Checkout\Model\Session
filter:
    dependency_paths: ["lib/*"]
     */
    protected $checkoutSession;

    /**
     * Payment ban entity
     *
     * @var \Payone\Core\Model\ResourceModel\PaymentBan
     */
    protected $paymentBan;

    /**
     * Addresscheck management object
     *
     * @var \Payone\Core\Model\Risk\Addresscheck
     */
    protected $addresscheck;

    /**
     * Constructor
     *
     * @param \Payone\Core\Model\Api\Request\Consumerscore $consumerscore
     * @param \Payone\Core\Helper\Consumerscore            $consumerscoreHelper
     * @param \Magento\Checkout\Model\Session              $checkoutSession
     * @param \Payone\Core\Model\ResourceModel\PaymentBan  $paymentBan
     * @param \Payone\Core\Model\Risk\Addresscheck         $addresscheck
     */
    public function __construct(
        \Payone\Core\Model\Api\Request\Consumerscore $consumerscore,
        \Payone\Core\Helper\Consumerscore $consumerscoreHelper,
        \Magento\Checkout\Model\Session $checkoutSession,
        \Payone\Core\Model\ResourceModel\PaymentBan $paymentBan,
        \Payone\Core\Model\Risk\Addresscheck $addresscheck
    ) {
        $this->consumerscore = $consumerscore;
        $this->consumerscoreHelper = $consumerscoreHelper;
        $this->checkoutSession = $checkoutSession;
        $this->paymentBan = $paymentBan;
        $this->addresscheck = $addresscheck;
    }

    /**
     * Filter methods by the worst score
     *
     * @param  MethodInterface[] $aPaymentMethods
     * @param  string            $sWorstScore
     * @return MethodInterface[]
     */
    protected function filterMethodsByScore($aPaymentMethods, $sWorstScore)
    {
        $aRedMethods = $this->consumerscoreHelper->getAllowedMethodsForScore('R');
        $aYellowMethods = array_merge($aRedMethods, $this->consumerscoreHelper->getAllowedMethodsForScore('Y'));

        $aReturnMethods = [];
        foreach ($aPaymentMethods as $oMethod) {
            if ($sWorstScore == 'Y' && array_search($oMethod->getCode(), $aYellowMethods) !== false) {
                $aReturnMethods[] = $oMethod;
            }

            if ($sWorstScore == 'R' && array_search($oMethod->getCode(), $aRedMethods) !== false) {
                $aReturnMethods[] = $oMethod;
            }
        }
        return $aReturnMethods;
    }

    /**
     * Execute a consumerscore request to PAYONE or load an old score if its lifetime is still active
     *
     * @param  AddressInterface $oShipping
     * @return string
     */
    protected function getScoreByCreditrating(AddressInterface $oShipping)
    {
        $aResponse = $this->consumerscore->sendRequest($oShipping);
        if ($aResponse === true) {// creditrating not executed because of a previous check
            $this->consumerscoreHelper->copyOldStatusToNewAddress($oShipping);
        }

        if (isset($aResponse['score'])) {
            $oShipping->setPayoneProtectScore($aResponse['score'])->save();
        }

        $sScore = $oShipping->getPayoneProtectScore();
        if (isset($aResponse['personstatus']) && $aResponse['personstatus'] !== PersonStatus::NONE) {
            $aMapping = $this->addresscheck->getPersonstatusMapping();
            if (array_key_exists($aResponse['personstatus'], $aMapping)) {
                $sScore = $this->consumerscoreHelper->getWorstScore([$sScore, $aMapping[$aResponse['personstatus']]]);
            }
        }
        return $sScore;
    }

    /**
     * Get parameter from config
     *
     * @param  string $sParam
     * @param  bool   $blIsAddresscheck
     * @return string
     */
    protected function getConfigParam($sParam, $blIsAddresscheck = false)
    {
        $sGroup = 'creditrating';
        if ($blIsAddresscheck === true) {
            $sGroup = 'address_check';
        }
        return $this->consumerscoreHelper->getConfigParam($sParam, $sGroup, 'payone_protect');
    }

    /**
     * Get quote object from session
     *
     * @return Quote
     */
    protected function getQuote()
    {
        return $this->checkoutSession->getQuote();
    }

    /**
     * Return banned payment methods for the current user
     *
     * @param  Quote $oQuote
     * @return array
     */
    protected function getBannedPaymentMethods(Quote $oQuote)
    {
        $aBans = [];
        if (!empty($oQuote->getCustomerId())) {
            $aBans = $this->paymentBan->getPaymentBans($oQuote->getCustomerId());
        } else { // guest checkout
            $aSessionBans = $this->checkoutSession->getPayonePaymentBans();
            if (!empty($aSessionBans)) {
                $aBans = $aSessionBans;
            }
        }
        return $aBans;
    }

    /**
     * Remove banned paymenttypes
     *
     * @param  array $aPaymentMethods
     * @param  Quote $oQuote
     * @return array
     */
    protected function removeBannedPaymentMethods($aPaymentMethods, Quote $oQuote)
    {
        $aBannedMethos = $this->getBannedPaymentMethods($oQuote);
        for($i = 0; $i < count($aPaymentMethods); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $sCode = $aPaymentMethods[$i]->getCode();
            if (array_key_exists($sCode, $aBannedMethos) !== false) {
                $iBannedUntil = strtotime($aBannedMethos[$sCode]);
                if ($iBannedUntil > time()) {
                    unset($aPaymentMethods[$i]);
                }
            }
        }
        return $aPaymentMethods;
    }

    /**
     * Remove paymenttypes not on the session whitelist
     *
     * @param  array $aPaymentMethods
     * @return array
     */
    protected function removeNotWhitelistedPaymentMethods($aPaymentMethods)
    {
        $aWhitelist = $this->checkoutSession->getPayonePaymentWhitelist();
        if (!empty($aWhitelist)) {
            $iCount = count($aPaymentMethods);
            for($i = 0; $i < $iCount; $i++) {
                if (array_search($aPaymentMethods[$i]->getCode(), $aWhitelist) === false) {
                    unset($aPaymentMethods[$i]);
                }
            }
        }
        return $aPaymentMethods;
    }

    /**
     * Remove Amazon Pay from payment method array
     *
     * @param  array $aPaymentMethods
     * @return array
     */
    public function removeAmazonPay($aPaymentMethods)
    {
        for($i = 0; $i < count($aPaymentMethods); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            if (isset($aPaymentMethods[$i]) && $aPaymentMethods[$i]->getCode() == PayoneConfig::METHOD_AMAZONPAY) {
                unset($aPaymentMethods[$i]);
            }
        }
        return $aPaymentMethods;
    }

    /**
     * Removes Klarna base methode if there are no Klarna sub-types available
     *
     * @param  array $aPaymentMethods
     * @return array
     */
    public function checkKlarnaMethods($aPaymentMethods)
    {
        $iKeyKlarna = false;
        $blHasKlarnaSubtypes = false;
        $aKlarnaSubtypes = [
            PayoneConfig::METHOD_KLARNA_INVOICE,
            PayoneConfig::METHOD_KLARNA_DEBIT,
            PayoneConfig::METHOD_KLARNA_INSTALLMENT
        ];
        for($i = 0; $i < count($aPaymentMethods); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            if (isset($aPaymentMethods[$i])) {
                if ($aPaymentMethods[$i]->getCode() == PayoneConfig::METHOD_KLARNA_BASE) {
                    $iKeyKlarna = $i;
                }
                if (in_array($aPaymentMethods[$i]->getCode(), $aKlarnaSubtypes) === true) {
                    $blHasKlarnaSubtypes = true;
                    break;
                }
            }
        }

        if ($iKeyKlarna !== false && $blHasKlarnaSubtypes === false) {
            unset($aPaymentMethods[$iKeyKlarna]);
        }
        return $aPaymentMethods;
    }

    /**
     *
     * @param  OrigMethodList    $subject
     * @param  MethodInterface[] $aPaymentMethods
     * @return MethodInterface[]
     */
    public function afterGetAvailableMethods(OrigMethodList $subject, $aPaymentMethods)
    public function afterGetAvailableMethods(/** @scrutinizer ignore-unused */ OrigMethodList $subject, $aPaymentMethods)
    {
        $oQuote = $this->getQuote();
        $oShipping = $oQuote->getShippingAddress();

        $aScores = [];
        if ($this->getConfigParam('enabled', true)) {// is addresscheck active
            $aScores[] = $oShipping->getPayoneAddresscheckScore();
        }

        $dTotal = $oQuote->getGrandTotal();
        if ($this->consumerscoreHelper->isCreditratingNeeded(Event::BEFORE_PAYMENT, $dTotal) === true) {
            $aScores[] = $this->getScoreByCreditrating($oShipping);
        }

        $sScore = $this->consumerscoreHelper->getWorstScore($aScores);
        if ($sScore != 'G') { // no need to filter
            $aPaymentMethods = $this->filterMethodsByScore($aPaymentMethods, $sScore);
        }

        $aPaymentMethods = $this->removeBannedPaymentMethods($aPaymentMethods, $oQuote);
        $aPaymentMethods = $this->removeNotWhitelistedPaymentMethods($aPaymentMethods);
        $aPaymentMethods = $this->removeAmazonPay($aPaymentMethods);
        $aPaymentMethods = $this->checkKlarnaMethods($aPaymentMethods);

        return $aPaymentMethods;
    }
}

PAYONE-GmbH / magento-2

Pull Request — master (#315)

MethodList::checkKlarnaMethods() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
