PAYONE-GmbH / magento-2

Model/ConfigProvider.php

<?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 <support@fatchip.de>
 * @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;

use Payone\Core\Model\Methods\BNPL\BNPLBase;
use Payone\Core\Model\Methods\PayoneMethod;
use Payone\Core\Model\PayoneConfig;
use Payone\Core\Model\Methods\OnlineBankTransfer\Eps;
use Payone\Core\Model\Methods\OnlineBankTransfer\Ideal;

/**
 * Extension for config provider to extend the javascript
 * data-array in the checkout
 */
class ConfigProvider extends \Magento\Payment\Model\CcGenericConfigProvider

The type Magento\Payment\Model\CcGenericConfigProvider was not found. Maybe you did not declare it correctly or list all dependencies?

{
    /**
     * Payment helper object
     *
     * @var \Magento\Payment\Helper\Data

The type Magento\Payment\Helper\Data was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $dataHelper;

    /**
     * PAYONE country helper
     *
     * @var \Payone\Core\Helper\Country
     */
    protected $countryHelper;

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

    /**
     * PAYONE payment helper
     *
     * @var \Payone\Core\Helper\Payment
     */
    protected $paymentHelper;

    /**
     * PAYONE hosted iframe helper
     *
     * @var \Payone\Core\Helper\HostedIframe
     */
    protected $hostedIframeHelper;

    /**
     * PAYONE request helper
     *
     * @var \Payone\Core\Helper\Request
     */
    protected $requestHelper;

    /**
     * Escaper object
     *
     * @var \Magento\Framework\Escaper

The type Magento\Framework\Escaper was not found. Maybe you did not declare it correctly or list all dependencies?

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

    /**
     * Privacy declaration object
     *
     * @var \Payone\Core\Model\Api\Payolution\PrivacyDeclaration
     */
    protected $privacyDeclaration;

    /**
     * Checkout session
     *
     * @var \Magento\Checkout\Model\Session

The type Magento\Checkout\Model\Session was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $checkoutSession;

    /**
     * Customer session
     *
     * @var \Magento\Customer\Model\Session

The type Magento\Customer\Model\Session was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $customerSession;

    /**
     * PAYONE shop helper
     *
     * @var \Payone\Core\Helper\Shop
     */
    protected $shopHelper;

    /**
     * Resource model for saved payment data
     *
     * @var \Payone\Core\Model\ResourceModel\SavedPaymentData
     */
    protected $savedPaymentData;

    /**
     * @var \Payone\Core\Model\Methods\Ratepay\Installment\Proxy

The type Payone\Core\Model\Methods\Ratepay\Installment\Proxy was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $ratepayInstallment;

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

    /**
     * PAYONE ratepay helper
     *
     * @var \Payone\Core\Helper\Ratepay
     */
    protected $ratepayHelper;

    /**
     * Constructor
     *
     * @param \Magento\Payment\Model\CcConfig                      $ccConfig
     * @param \Magento\Payment\Helper\Data                         $dataHelper
     * @param \Payone\Core\Helper\Country                          $countryHelper
     * @param \Payone\Core\Helper\Customer                         $customerHelper
     * @param \Payone\Core\Helper\Payment                          $paymentHelper
     * @param \Payone\Core\Helper\HostedIframe                     $hostedIframeHelper
     * @param \Payone\Core\Helper\Request                          $requestHelper
     * @param \Magento\Framework\Escaper                           $escaper
     * @param \Payone\Core\Helper\Consumerscore                    $consumerscoreHelper
     * @param \Payone\Core\Model\Api\Payolution\PrivacyDeclaration $privacyDeclaration
     * @param \Magento\Checkout\Model\Session                      $checkoutSession
     * @param \Magento\Customer\Model\Session                      $customerSession
     * @param \Payone\Core\Helper\Shop                             $shopHelper
     * @param \Payone\Core\Model\ResourceModel\SavedPaymentData    $savedPaymentData
     * @param \Payone\Core\Model\Methods\Ratepay\Installment\Proxy $ratepayInstallment
     * @param \Payone\Core\Helper\Toolkit                          $toolkitHelper
     * @param \Payone\Core\Helper\Ratepay                          $ratepayHelper
     */
    public function __construct(
        \Magento\Payment\Model\CcConfig $ccConfig,

The type Magento\Payment\Model\CcConfig was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Payment\Helper\Data $dataHelper,
        \Payone\Core\Helper\Country $countryHelper,
        \Payone\Core\Helper\Customer $customerHelper,
        \Payone\Core\Helper\Payment $paymentHelper,
        \Payone\Core\Helper\HostedIframe $hostedIframeHelper,
        \Payone\Core\Helper\Request $requestHelper,
        \Magento\Framework\Escaper $escaper,
        \Payone\Core\Helper\Consumerscore $consumerscoreHelper,
        \Payone\Core\Model\Api\Payolution\PrivacyDeclaration $privacyDeclaration,
        \Magento\Checkout\Model\Session $checkoutSession,
        \Magento\Customer\Model\Session $customerSession,
        \Payone\Core\Helper\Shop $shopHelper,
        \Payone\Core\Model\ResourceModel\SavedPaymentData $savedPaymentData,
        \Payone\Core\Model\Methods\Ratepay\Installment\Proxy $ratepayInstallment,
        \Payone\Core\Helper\Toolkit $toolkitHelper,
        \Payone\Core\Helper\Ratepay $ratepayHelper
    ) {
        parent::__construct($ccConfig, $dataHelper);
        $this->dataHelper = $dataHelper;
        $this->countryHelper = $countryHelper;
        $this->customerHelper = $customerHelper;
        $this->paymentHelper = $paymentHelper;
        $this->hostedIframeHelper = $hostedIframeHelper;
        $this->requestHelper = $requestHelper;
        $this->escaper = $escaper;
        $this->consumerscoreHelper = $consumerscoreHelper;
        $this->privacyDeclaration = $privacyDeclaration;
        $this->checkoutSession = $checkoutSession;
        $this->customerSession = $customerSession;
        $this->shopHelper = $shopHelper;
        $this->savedPaymentData = $savedPaymentData;
        $this->ratepayInstallment = $ratepayInstallment;
        $this->toolkitHelper = $toolkitHelper;
        $this->ratepayHelper = $ratepayHelper;
    }

    /**
     * Get the payment description text
     *
     * @param  PayoneMethod $sCode
     * @return string
     */
    protected function getInstructionByMethod($oMethodInstance)
    {
        return nl2br($this->escaper->escapeHtml($oMethodInstance->getInstructions()));
    }

    /**
     * Add payolution parameters to the config array
     *
     * @return array
     */
    protected function getPayolutionConfig()
    {
        return [
            'b2bMode' => [
                'invoice' => $this->requestHelper->getConfigParam('b2b_mode', PayoneConfig::METHOD_PAYOLUTION_INVOICE, 'payone_payment'),
            ],
            'privacyDeclaration' => [
                'invoice' => $this->privacyDeclaration->getPayolutionAcceptanceText(PayoneConfig::METHOD_PAYOLUTION_INVOICE),
                'debit' => $this->privacyDeclaration->getPayolutionAcceptanceText(PayoneConfig::METHOD_PAYOLUTION_DEBIT),
                'installment' => $this->privacyDeclaration->getPayolutionAcceptanceText(PayoneConfig::METHOD_PAYOLUTION_INSTALLMENT),
            ],
        ];
    }

    /**
     * Add payone parameters to the config array
     *
     * @return array
     */
    protected function getPayoneConfig()
    {
        return [
            'locale' => $this->shopHelper->getLocale(),
            'fullLocale' => $this->requestHelper->getConfigParam('code', 'locale', 'general'),
            'availableCardTypes' => $this->paymentHelper->getAvailableCreditcardTypes(),
            'availableApplePayTypes' => $this->paymentHelper->getAvailableApplePayTypes(),
            'fieldConfig' => $this->hostedIframeHelper->getHostedFieldConfig(),
            'sepaCountries' => $this->countryHelper->getEnabledCountries(PayoneConfig::METHOD_DEBIT),
            'hostedRequest' => $this->requestHelper->getHostedIframeRequest(),
            'mandateManagementActive' => $this->paymentHelper->isMandateManagementActive(),
            'checkCvc' => (bool)$this->paymentHelper->isCheckCvcActive(),
            'ccMinValidity' => $this->requestHelper->getConfigParam('min_validity_period', PayoneConfig::METHOD_CREDITCARD, 'payone_payment'),
            'requestBic' => (bool)$this->requestHelper->getConfigParam('request_bic', PayoneConfig::METHOD_DEBIT, 'payone_payment'),
            'validateBankCode' => (bool)$this->requestHelper->getConfigParam('check_bankaccount', PayoneConfig::METHOD_DEBIT, 'payone_payment'),
            'disableSafeInvoice' => (bool)$this->requestHelper->getConfigParam('disable_after_refusal', PayoneConfig::METHOD_SAFE_INVOICE, 'payone_payment'),
            'bankaccountcheckRequest' => $this->requestHelper->getBankaccountCheckRequest(),
            'bankCodeValidatedAndValid' => false,
            'blockedMessage' => $this->paymentHelper->getBankaccountCheckBlockedMessage(),
            'epsBankGroups' => Eps::getBankGroups(),
            'addresscheckEnabled' => (int)$this->requestHelper->getConfigParam('enabled', 'address_check', 'payone_protect'),
            'addresscheckBillingEnabled' => $this->requestHelper->getConfigParam('check_billing', 'address_check', 'payone_protect') == 'NO' ? 0 : 1,
            'addresscheckShippingEnabled' => $this->requestHelper->getConfigParam('check_shipping', 'address_check', 'payone_protect') == 'NO' ? 0 : 1,
            'addresscheckConfirmCorrection' => (int)$this->requestHelper->getConfigParam('confirm_address_correction', 'address_check', 'payone_protect'),
            'canShowPaymentHintText' => $this->consumerscoreHelper->canShowPaymentHintText(),
            'paymentHintText' => $this->requestHelper->getConfigParam('payment_hint_text', 'creditrating', 'payone_protect'),
            'canShowAgreementMessage' => $this->consumerscoreHelper->canShowAgreementMessage(),
            'agreementMessage' => $this->requestHelper->getConfigParam('agreement_message', 'creditrating', 'payone_protect'),
            'consumerScoreEnabledMethods' => $this->consumerscoreHelper->getConsumerscoreEnabledMethods(),
            'payolution' => $this->getPayolutionConfig(),
            'canceledPaymentMethod' => $this->getCanceledPaymentMethod(),
            'isError' => $this->checkoutSession->getPayoneIsError(),
            'orderDeferredExists' => (bool)version_compare($this->shopHelper->getMagentoVersion(), '2.1.0', '>='),
            'saveCCDataEnabled' => (bool)$this->requestHelper->getConfigParam('save_data_enabled', PayoneConfig::METHOD_CREDITCARD, 'payone_payment'),
            'savedPaymentData' => $this->savedPaymentData->getSavedPaymentData($this->checkoutSession->getQuote()->getCustomerId(), PayoneConfig::METHOD_CREDITCARD),
            'currency' => $this->requestHelper->getConfigParam('currency'),
            'klarnaTitles' => $this->paymentHelper->getKlarnaMethodTitles(),
            'storeName' => $this->shopHelper->getStoreName(),
            'ratepay' => $this->getRatepayConfig(),
            'ratepayRefreshed' => false,
            'bnpl' => $this->getBNPLConfig(),
        ];
    }

    /**
     * Returns the extended checkout-data array
     *
     * @return array
     */
    public function getConfig()
    {
        $config = parent::getConfig();
        $config = array_merge_recursive($config, [
            'payment' => [
                'payone' => $this->getPayoneConfig(),
            ],
        ]);
        foreach ($this->paymentHelper->getAvailablePaymentTypes() as $sCode) {
            $oMethodInstance = $this->dataHelper->getMethodInstance($sCode);
            if ($oMethodInstance instanceof PayoneMethod && $oMethodInstance->isAvailable()) {
                $config['payment']['payone'][$sCode] = $oMethodInstance->getFrontendConfig();
                $config['payment']['instructions'][$sCode] = $this->getInstructionByMethod($oMethodInstance);
            }
        }
        return $config;
    }

    /**
     * Get canceled payment method from session
     *
     * @return string|bool
     */
    protected function getCanceledPaymentMethod()
    {
        $sPaymentMethod = $this->checkoutSession->getPayoneCanceledPaymentMethod();
        $this->checkoutSession->unsPayoneCanceledPaymentMethod();
        if ($sPaymentMethod) {
            return $sPaymentMethod;
        }
        return false;
    }

    /**
     * Return ratepay config for all ratepay payment methods
     *
     * @return array
     */
    protected function getRatepayConfig()
    {
        $aReturn = $this->ratepayHelper->getRatepayConfig();

        if (isset($aReturn[PayoneConfig::METHOD_RATEPAY_INSTALLMENT])) {
            $aReturn[PayoneConfig::METHOD_RATEPAY_INSTALLMENT]['allowedMonths'] = $this->ratepayInstallment->getAllowedMonths();
        }
        return $aReturn;
    }

    /**
     * Reads payone UUID from session
     * Generates it if not yet set in session
     *
     * @return string
     * @throws \Exception
     */
    protected function getUUID()
    {
        $sUUID = $this->checkoutSession->getPayoneUUID();
        if (empty($sUUID)) {
            $sUUID = $this->toolkitHelper->generateUUIDv4();
            $this->checkoutSession->setPayoneUUID($sUUID);
        }
        return $sUUID;
    }

    /**
     * Check if at least 1 BNPL method is active
     *
     * @return bool
     */
    protected function isBNPLActive()
    {
        if ($this->paymentHelper->isPaymentMethodActive(PayoneConfig::METHOD_BNPL_INVOICE) === true ||
            $this->paymentHelper->isPaymentMethodActive(PayoneConfig::METHOD_BNPL_DEBIT) === true ||
            $this->paymentHelper->isPaymentMethodActive(PayoneConfig::METHOD_BNPL_INSTALLMENT) === true
        ) {
            return true;
        }
        return false;
    }

    /**
     * Returns config options for BNPL payment methods
     *
     * @return array|false
     */
    protected function getBNPLConfig()
    {
        if ($this->isBNPLActive()) {
            return [
                'environment' => [ // "t" for TEST, "p" for PROD
                    PayoneConfig::METHOD_BNPL_INVOICE => $this->requestHelper->getConfigParam('mode', PayoneConfig::METHOD_BNPL_INVOICE, 'payone_payment') == 'live' ? 'p' : 't',
                    PayoneConfig::METHOD_BNPL_INSTALLMENT => $this->requestHelper->getConfigParam('mode', PayoneConfig::METHOD_BNPL_INSTALLMENT, 'payone_payment') == 'live' ? 'p' : 't',
                    PayoneConfig::METHOD_BNPL_DEBIT => $this->requestHelper->getConfigParam('mode', PayoneConfig::METHOD_BNPL_DEBIT, 'payone_payment') == 'live' ? 'p' : 't',
                ],
                'mid' => [
                    PayoneConfig::METHOD_BNPL_INVOICE => $this->paymentHelper->getCustomConfigParam('mid', PayoneConfig::METHOD_BNPL_INVOICE),
                    PayoneConfig::METHOD_BNPL_INSTALLMENT => $this->paymentHelper->getCustomConfigParam('mid', PayoneConfig::METHOD_BNPL_INSTALLMENT),
                    PayoneConfig::METHOD_BNPL_DEBIT => $this->paymentHelper->getCustomConfigParam('mid', PayoneConfig::METHOD_BNPL_DEBIT),
                ],
                'differentAddressAllowed' => [
                    PayoneConfig::METHOD_BNPL_INVOICE => (bool)$this->requestHelper->getConfigParam('different_address_allowed', PayoneConfig::METHOD_BNPL_INVOICE, 'payment'),
                    PayoneConfig::METHOD_BNPL_INSTALLMENT => (bool)$this->requestHelper->getConfigParam('different_address_allowed', PayoneConfig::METHOD_BNPL_INSTALLMENT, 'payment'),
                    PayoneConfig::METHOD_BNPL_DEBIT => (bool)$this->requestHelper->getConfigParam('different_address_allowed', PayoneConfig::METHOD_BNPL_DEBIT, 'payment'),
                ],
                'payla_partner_id' => BNPLBase::BNPL_PARTNER_ID,
                'uuid' => $this->getUUID(),
            ];
        }
        return false;
    }
}