| Current File : /var/www/prestashop/modules/ps_checkout/src/PayPal/PayPalConfiguration.php |
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License version 3.0
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/AFL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
*/
namespace PrestaShop\Module\PrestashopCheckout\PayPal;
use PrestaShop\Module\PrestashopCheckout\Configuration\PrestaShopConfiguration;
use PrestaShop\Module\PrestashopCheckout\Exception\PsCheckoutException;
use PrestaShop\Module\PrestashopCheckout\Repository\PayPalCodeRepository;
use PrestaShop\Module\PrestashopCheckout\Settings\RoundingSettings;
class PayPalConfiguration
{
const INTENT = 'PS_CHECKOUT_INTENT';
const PAYMENT_MODE = 'PS_CHECKOUT_MODE';
const CARD_PAYMENT_ENABLED = 'PS_CHECKOUT_CARD_PAYMENT_ENABLED';
const PS_ROUND_TYPE = 'PS_ROUND_TYPE';
const PS_PRICE_ROUND_MODE = 'PS_PRICE_ROUND_MODE';
const INTEGRATION_DATE = 'PS_CHECKOUT_INTEGRATION_DATE';
const HOSTED_FIELDS_CONTINGENCIES = 'PS_CHECKOUT_HOSTED_FIELDS_CONTINGENCIES';
const CSP_NONCE = 'PS_CHECKOUT_CSP_NONCE';
const PS_CHECKOUT_PAYPAL_CB_INLINE = 'PS_CHECKOUT_PAYPAL_CB_INLINE';
const PS_CHECKOUT_PAYPAL_BUTTON = 'PS_CHECKOUT_PAYPAL_BUTTON';
const PS_CHECKOUT_PAYPAL_ID_MERCHANT = 'PS_CHECKOUT_PAYPAL_ID_MERCHANT';
const PS_CHECKOUT_PAYPAL_EMAIL_MERCHANT = 'PS_CHECKOUT_PAYPAL_EMAIL_MERCHANT';
const PS_CHECKOUT_PAYPAL_COUNTRY_MERCHANT = 'PS_CHECKOUT_PAYPAL_COUNTRY_MERCHANT';
const PS_CHECKOUT_PAYPAL_EMAIL_STATUS = 'PS_CHECKOUT_PAYPAL_EMAIL_STATUS';
const PS_CHECKOUT_PAYPAL_PAYMENT_STATUS = 'PS_CHECKOUT_PAYPAL_PAYMENT_STATUS';
const PS_CHECKOUT_CARD_HOSTED_FIELDS_STATUS = 'PS_CHECKOUT_CARD_PAYMENT_STATUS';
const PS_CHECKOUT_CARD_HOSTED_FIELDS_ENABLED = 'PS_CHECKOUT_CARD_PAYMENT_ENABLED';
const PS_CHECKOUT_DISPLAY_LOGO_PRODUCT = 'PS_CHECKOUT_DISPLAY_LOGO_PRODUCT';
const PS_CHECKOUT_DISPLAY_LOGO_CART = 'PS_CHECKOUT_DISPLAY_LOGO_CART';
const PS_CHECKOUT_VAULTING = 'PS_CHECKOUT_VAULTING';
const PS_CHECKOUT_GOOGLE_PAY = 'PS_CHECKOUT_GOOGLE_PAY';
/**
* @var PrestaShopConfiguration
*/
private $configuration;
/**
* @var PayPalCodeRepository
*/
private $codeRepository;
public function __construct(PrestaShopConfiguration $configuration, PayPalCodeRepository $codeRepository)
{
$this->configuration = $configuration;
$this->codeRepository = $codeRepository;
}
/**
* Used to return the PS_CHECKOUT_INTENT from the Configuration
*
* @return string
*/
public function getIntent()
{
return Intent::AUTHORIZE === $this->configuration->get(self::INTENT) ? Intent::AUTHORIZE : Intent::CAPTURE;
}
/**
* Used to set the PS_CHECKOUT_INTENT in the Configuration
*
* @param string $captureMode
*
* @throws PsCheckoutException
*/
public function setIntent($captureMode)
{
if (!in_array($captureMode, [Intent::CAPTURE, Intent::AUTHORIZE])) {
throw new \UnexpectedValueException(sprintf('The value should be an Intent constant, %s value sent', $captureMode));
}
$this->configuration->set(self::INTENT, $captureMode);
}
/**
* Used to return the PS_CHECKOUT_MODE from the Configuration
*
* @return string
*/
public function getPaymentMode()
{
return Mode::LIVE === $this->configuration->get(self::PAYMENT_MODE) ? Mode::LIVE : Mode::SANDBOX;
}
/**
* Used to set the PS_CHECKOUT_MODE in the Configuration
*
* @param string $paymentMode
*
* @throws PsCheckoutException
*/
public function setPaymentMode($paymentMode)
{
if (!in_array($paymentMode, [Mode::LIVE, Mode::SANDBOX])) {
throw new \UnexpectedValueException(sprintf('The value should be a Mode constant, %s value sent', $paymentMode));
}
$this->configuration->set(self::PAYMENT_MODE, $paymentMode);
}
/**
* @param bool $status
*
* @throws PsCheckoutException
*/
public function setCardPaymentEnabled($status)
{
$this->configuration->set(self::CARD_PAYMENT_ENABLED, (int) $status);
}
/**
* @return bool
*/
public function isCardPaymentEnabled()
{
return (bool) $this->configuration->get(self::CARD_PAYMENT_ENABLED);
}
/**
* @param bool $status
*
* @throws PsCheckoutException
*/
public function setCardInlinePaypalEnabled($status)
{
$this->configuration->set(self::PS_CHECKOUT_PAYPAL_CB_INLINE, (int) $status);
}
/**
* @return bool
*/
public function isCardInlinePaypalIsEnabled()
{
return (bool) $this->configuration->get(self::PS_CHECKOUT_PAYPAL_CB_INLINE);
}
/**
* @param string $roundType
*
* @throws PsCheckoutException
*/
public function setRoundType($roundType)
{
if (!in_array($roundType, [RoundingSettings::ROUND_ON_EACH_ITEM])) {
throw new \UnexpectedValueException(sprintf('The value should be a RoundingSettings constant, %s value sent', $roundType));
}
$this->configuration->set(self::PS_ROUND_TYPE, $roundType);
}
/**
* @param string $priceRoundMode
*
* @throws PsCheckoutException
*/
public function setPriceRoundMode($priceRoundMode)
{
if (!in_array($priceRoundMode, [RoundingSettings::ROUND_UP_AWAY_FROM_ZERO])) {
throw new \UnexpectedValueException(sprintf('The value should be a RoundingSettings constant, %s value sent', $priceRoundMode));
}
$this->configuration->set(self::PS_PRICE_ROUND_MODE, $priceRoundMode);
}
/**
* Check if the rounding configuration if correctly set
*
* PS_ROUND_TYPE need to be set to 1 (Round on each item)
* PS_PRICE_ROUND_MODE need to be set to 2 (Round up away from zero, when it is half way there)
*
* @return bool
*/
public function IsRoundingSettingsCorrect()
{
return $this->configuration->get(self::PS_ROUND_TYPE) === RoundingSettings::ROUND_ON_EACH_ITEM
&& $this->configuration->get(self::PS_PRICE_ROUND_MODE) === RoundingSettings::ROUND_UP_AWAY_FROM_ZERO;
}
/**
* Used to return the PS_ROUND_TYPE from the Configuration
*
* @return string
*/
public function getRoundType()
{
return $this->configuration->get(self::PS_ROUND_TYPE);
}
/**
* Used to return the PS_PRICE_ROUND_MODE from the Configuration
*
* @return string
*/
public function getPriceRoundMode()
{
return $this->configuration->get(self::PS_PRICE_ROUND_MODE);
}
/**
* @return string
*/
public function getIntegrationDate()
{
return $this->configuration->get(static::INTEGRATION_DATE, ['default' => \Ps_checkout::INTEGRATION_DATE]);
}
/**
* @return string
*/
public function getCSPNonce()
{
return $this->configuration->get(static::CSP_NONCE, ['default' => '']);
}
/**
* @return bool
*/
public function is3dSecureEnabled()
{
return $this->getHostedFieldsContingencies() !== 'NONE';
}
/**
* Get the incompatible ISO country codes with PayPal.
*
* @param bool $onlyEnabledShopCountries
*
* @return array
*/
public function getIncompatibleCountryCodes($onlyEnabledShopCountries = true)
{
$active = $onlyEnabledShopCountries ? ' AND c.active = 1' : null;
$db = \Db::getInstance();
$shopCodes = $db->executeS('
SELECT c.iso_code
FROM ' . _DB_PREFIX_ . 'country c
JOIN ' . _DB_PREFIX_ . 'module_country mc ON mc.id_country = c.id_country
JOIN ' . _DB_PREFIX_ . 'module m ON m.id_module = mc.id_module
WHERE m.name = "ps_checkout"
AND mc.id_shop = ' . \Context::getContext()->shop->id
. $active
);
$paypalCodes = $this->codeRepository->getCountryCodes();
if (!is_array($shopCodes)) {
$shopCodes = [];
}
return $this->checkCodesCompatibility($shopCodes, $paypalCodes);
}
/**
* Get the incompatible ISO currency codes with PayPal.
*
* @param bool $onlyEnabledShopCurrencies
*
* @return array
*/
public function getIncompatibleCurrencyCodes($onlyEnabledShopCurrencies = true)
{
$active = $onlyEnabledShopCurrencies ? ' AND c.active = 1' : null;
$db = \Db::getInstance();
$shopCodes = $db->executeS('
SELECT c.iso_code
FROM ' . _DB_PREFIX_ . 'currency c
JOIN ' . _DB_PREFIX_ . 'module_currency mc ON mc.id_currency = c.id_currency
JOIN ' . _DB_PREFIX_ . 'module m ON m.id_module = mc.id_module
WHERE m.name = "ps_checkout"
AND mc.id_shop = ' . \Context::getContext()->shop->id
. $active
);
$paypalCodes = $this->codeRepository->getCurrencyCodes();
if (!is_array($shopCodes)) {
$shopCodes = [];
}
return $this->checkCodesCompatibility($shopCodes, $paypalCodes);
}
/**
* Check shop codes compatibility with PayPal
*
* @param array $shopCodes
* @param array $paypalCodes
*
* @return array
*/
private function checkCodesCompatibility(array $shopCodes, array $paypalCodes)
{
$incompatibleCodes = [];
foreach ($shopCodes as $shopCode) {
if (!in_array(strtoupper($shopCode['iso_code']), array_keys($paypalCodes))) {
$incompatibleCodes[] = $shopCode['iso_code'];
}
}
return $incompatibleCodes;
}
/**
* @return array
*/
public function getButtonConfiguration()
{
return json_decode($this->configuration->get(self::PS_CHECKOUT_PAYPAL_BUTTON));
}
/**
* @param object $configuration
*
* @throws PsCheckoutException
*/
public function setButtonConfiguration($configuration)
{
$this->configuration->set(self::PS_CHECKOUT_PAYPAL_BUTTON, json_encode($configuration));
}
/**
* @return string
*/
public function getHostedFieldsContingencies()
{
switch ($this->configuration->get(self::HOSTED_FIELDS_CONTINGENCIES)) {
case 'SCA_ALWAYS':
return 'SCA_ALWAYS';
case 'NONE':
return 'NONE';
default:
return 'SCA_WHEN_REQUIRED';
}
}
/**
* Get the merchant id for the current onboarded merchant
*
* @return string|false
*/
public function getMerchantId()
{
return $this->configuration->get(static::PS_CHECKOUT_PAYPAL_ID_MERCHANT);
}
/**
* Get the merchant email
*
* @return string|false
*/
public function getMerchantEmail()
{
return $this->configuration->get(static::PS_CHECKOUT_PAYPAL_EMAIL_MERCHANT);
}
/**
* Get the merchant country ISO code
*
* @return string|false
*/
public function getMerchantCountry()
{
return $this->configuration->get(static::PS_CHECKOUT_PAYPAL_COUNTRY_MERCHANT);
}
/**
* Get the merchant email status
*
* @return bool
*/
public function isMerchantEmailConfirmed()
{
return (bool) $this->configuration->get(static::PS_CHECKOUT_PAYPAL_EMAIL_STATUS);
}
/**
* Get the PayPal payment method status for the current merchant
*
* @return bool
*/
public function isPayPalPaymentsReceivable()
{
return (bool) $this->configuration->get(static::PS_CHECKOUT_PAYPAL_PAYMENT_STATUS);
}
/**
* Get the card payment status for the current merchant
*
* @return string|false SUBSCRIBED|LIMITED|NEED_MORE_DATA|IN_REVIEW|SUSPENDED|REVOKED|DENIED
*/
public function getCardHostedFieldsStatus()
{
return $this->configuration->get(static::PS_CHECKOUT_CARD_HOSTED_FIELDS_STATUS);
}
/**
* Merchant can disable hosted fields in module configuration
*
* @return bool
*/
public function isHostedFieldsEnabled()
{
return (bool) $this->configuration->get(static::PS_CHECKOUT_CARD_HOSTED_FIELDS_ENABLED);
}
/**
* @return string
*/
public function getTimeZone()
{
return $this->configuration->get('PS_TIMEZONE', [
'default' => date_default_timezone_get(),
]);
}
/**
* Merchant can disable vaulting in module configuration
*
* @return bool
*/
public function isVaultingEnabled()
{
return (bool) $this->configuration->get(static::PS_CHECKOUT_VAULTING);
}
public function isGooglePayEligible()
{
return (bool) $this->configuration->get(static::PS_CHECKOUT_GOOGLE_PAY);
}
}