CheckoutSubmitBefore::getPaymentWhitelist() - Code Metrics - PAYONE-GmbH/magento-2 - Measure and Improve Code Quality continuously with Scrutinizer

CheckoutSubmitBefore::getPaymentWhitelist() A
last analyzed 2025-07-01 12:36 UTC

↳ Parent: CheckoutSubmitBefore
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	4
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	7
rs	10
<?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\Observer;

use Magento\Framework\Event\ObserverInterface;
filter:
    dependency_paths: ["lib/*"]
use Magento\Framework\Event\Observer;
filter:
    dependency_paths: ["lib/*"]
use Magento\Framework\Exception\LocalizedException;
filter:
    dependency_paths: ["lib/*"]
use Magento\Quote\Model\Quote;
filter:
    dependency_paths: ["lib/*"]
use Magento\Quote\Api\Data\AddressInterface;
filter:
    dependency_paths: ["lib/*"]
use Payone\Core\Model\Source\CreditratingIntegrationEvent as Event;
use Payone\Core\Model\Source\PersonStatus;
use Payone\Core\Model\Exception\FilterMethodListException;

/**
 * Event class to set the orderstatus to new and pending
 */
class CheckoutSubmitBefore implements ObserverInterface
{
    /**
     * PAYONE consumerscore request model
     *
     * @var \Payone\Core\Model\Api\Request\Consumerscore
     */
    protected $consumerscore;

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

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

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

    /**
     * Payone customer helper
     *
     * @var \Payone\Core\Helper\Customer
     */
    protected $customerHelper;

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

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

    /**
     * Check if given payment methods was enabled for bonicheck in the configuration
     *
     * @param  string $sPaymentCode
     * @return bool
     */
    protected function isPaymentMethodEnabledForCheck($sPaymentCode)
    {
        $aPaymentTypesToCheck = $this->consumerscoreHelper->getConsumerscoreEnabledMethods();
        if (array_search($sPaymentCode, $aPaymentTypesToCheck) !== false) {
            return true;
        }
        return false;
    }

    /**
     * Determine if creditrating is needed
     *
     * @param  Quote $oQuote
     * @return bool
     */
    public function isCreditratingNeeded(Quote $oQuote)
    {
        if (!$this->consumerscoreHelper->isCreditratingNeeded(Event::AFTER_PAYMENT, $oQuote->getGrandTotal())) {
            return false;
        }

        if ($this->isPaymentMethodEnabledForCheck($oQuote->getPayment()->getMethodInstance()->getCode()) === false) {
            return false;
        }

        if ($oQuote->getPayment()->getMethodInstance()->getInfoInstance()->getAdditionalInformation('payone_boni_agreement') === false) { // getAdditionalInformation() returns null if field not existing
            return false; // agreement checkbox was not checked by the customer
        }

        return true;
    }

    /**
     * @param Quote $oQuote
     */
    protected function isBonicheckAgreementActiveAndNotConfirmedByCustomer($oQuote)
    {
        if (!$this->consumerscoreHelper->canShowAgreementMessage() || // check if agreement is configured
            !$this->isPaymentMethodEnabledForCheck($oQuote->getPayment()->getMethodInstance()->getCode()) || // check if selected payment methods is enabled for bonicheck
            $oQuote->getPayment()->getMethodInstance()->getInfoInstance()->getAdditionalInformation('payone_boni_agreement') !== false // check if agreement was not confirmed
        ) {
            return false;
        }
        return true;
    }

    /**
     * Determine if the payment type can be used with this score
     *
     * @param  Quote $oQuote
     * @param  string $sScore
     * @return bool
     */
    public function isPaymentApplicableForScore(Quote $oQuote, $sScore)
    {
        if ($sScore == 'G') {
            return true;
        }

        $sPaymentCode = $oQuote->getPayment()->getMethodInstance()->getCode();

        $aYellowMethods = $this->consumerscoreHelper->getAllowedMethodsForScore('Y');
        $aRedMethods = $this->consumerscoreHelper->getAllowedMethodsForScore('R');

        if ($sScore == 'Y' && (array_search($sPaymentCode, $aYellowMethods) !== false ||
                array_search($sPaymentCode, $aRedMethods) !== false)) {
            return true;
        } elseif ($sScore == 'R' && array_search($sPaymentCode, $aRedMethods) !== false) {
            return true;
        }
        return false;
    }

    /**
     *
     * @param  array $aResponse
     * @return bool
     */
    public function checkoutNeedsToBeStopped($aResponse)
    {
        if (!$aResponse || (isset($aResponse['status']) && $aResponse['status'] == 'ERROR'

                && $this->getConfigParam('handle_response_error') == 'stop_checkout')) {
            return true;
        }
        return false;
    }

    /**
     * Filter payment methods by the creditrating result if applicable
     *
     * @param  AddressInterface $oBilling
     * @return string
     * @throws LocalizedException
     */
    public function getScoreByCreditrating(AddressInterface $oBilling)
    {
        $aResponse = $this->consumerscore->sendRequest($oBilling, $this->customerHelper->getCustomerGender(), $this->customerHelper->getCustomerBirthday());
        if ($aResponse === true) { // creditrating not executed because of a previous check
            $this->consumerscoreHelper->copyOldStatusToNewAddress($oBilling);
        }

        if ($this->checkoutNeedsToBeStopped($aResponse)) {
        if ($this->checkoutNeedsToBeStopped(/** @scrutinizer ignore-type */ $aResponse)) {
            $sErrorMsg = $this->getConfigParam('stop_checkout_message');
            if (empty($sErrorMsg)) {
                $sErrorMsg = 'An error occured during the credit check.';
            }
            throw new LocalizedException(__($sErrorMsg));
            throw new LocalizedException(/** @scrutinizer ignore-call */ __($sErrorMsg));
        }

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

        $sScore = $oBilling->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 error message for when the creditrating failed because the score is insufficient
     *
     * @return string
     */
    public function getInsufficientScoreMessage()
    {
        $sErrorMsg = $this->getConfigParam('insufficient_score_message');
        if (empty($sErrorMsg)) {
            $sErrorMsg = 'An error occured during the credit check.';
        }
        return $sErrorMsg;
    }

    /**
     * Returns allowed payment methods for the given score
     *
     * @param  string $sScore
     * @return array
     */
    protected function getPaymentWhitelist($sScore)
    {
        $aWhitelist = $this->consumerscoreHelper->getAllowedMethodsForScore('R');
        if ($sScore == "Y") {
            $aWhitelist = array_merge($aWhitelist, $this->consumerscoreHelper->getAllowedMethodsForScore('Y'));
        }
        return $aWhitelist;
    }

    /**
     * Execute certain tasks after the payment is placed and thus the order is placed
     *
     * @param  Observer $observer
     * @return void
     * @throws LocalizedException
     */
    public function execute(Observer $observer)
    {
        /** @var Quote $oQuote */
        $oQuote = $observer->getQuote();
        if (!$oQuote) {

            return;
        }

        $oBilling = $oQuote->getBillingAddress();
        $oShipping = $oQuote->getShippingAddress();

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

        if ($this->isCreditratingNeeded($oQuote) === true) {
            $aScores[] = $this->getScoreByCreditrating($oBilling);
        }

        if ($this->isBonicheckAgreementActiveAndNotConfirmedByCustomer($oQuote) === true) {
            $aScores[] = 'R';
        }

        $sScore = $this->consumerscoreHelper->getWorstScore($aScores);
        $blSuccess = $this->isPaymentApplicableForScore($oQuote, $sScore);
        if ($blSuccess === false) {
            $aWhitelist = $this->getPaymentWhitelist($sScore);
            $this->checkoutSession->setPayonePaymentWhitelist($aWhitelist);
            throw new FilterMethodListException(__($this->getInsufficientScoreMessage()), $aWhitelist);
            throw new FilterMethodListException(/** @scrutinizer ignore-call */ __($this->getInsufficientScoreMessage()), $aWhitelist);
        }
    }
}

PAYONE-GmbH / magento-2

CheckoutSubmitBefore::getPaymentWhitelist() A last analyzed 2025-07-01 12:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CheckoutSubmitBefore::getPaymentWhitelist() A
last analyzed 2025-07-01 12:36 UTC
