How is a payment method's canUseForCountry() used?

dmitry_fedyuk · February 11, 2016, 2:04am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L184-L190


/**
 * To check billing country is allowed for the payment method
 *
 * @param string $country
 * @return bool
 */
public function canUseForCountry($country);

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L464-L482


/**
 * To check billing country is allowed for the payment method
 *
 * @param string $country
 * @return bool
 */
public function canUseForCountry($country)
{
    /*
    for specific country, the flag will set up as 1
    */
    if ($this->getConfigData('allowspecific') == 1) {
        $availableCountries = explode(',', $this->getConfigData('specificcountry'));
        if (!in_array($country, $availableCountries)) {
            return false;
        }
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/Config.php#L177-L197


/**
 * To check billing country is allowed for the payment method
 *
 * @param string $country
 * @return bool
 */
public function canUseForCountry($country)
{
    /*
    for specific country, the flag will set up as 1
    */
    if ($this->getConfigData(self::KEY_ALLOW_SPECIFIC) == 1) {
        $availableCountries = explode(',', $this->getConfigData(self::KEY_SPECIFIC_COUNTRY));
        if (!in_array($country, $availableCountries)) {
            return false;
        }
    } elseif ($this->sourceCountry->isCountryRestricted($country)) {
        return false;
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Adapter.php#L307-L317


public function canUseForCountry($country)
{
    try {
        $validator = $this->getValidatorPool()->get('country');
    } catch (\Exception $e) {
        return true;
    }


    $result = $validator->validate(['country' => $country, 'storeId' => $this->getStore()]);
    return $result->isValid();
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L566-L583


public function validate()
{
    /**
     * to validate payment method is allowed for billing country or not
     */
    $paymentInfo = $this->getInfoInstance();
    if ($paymentInfo instanceof Payment) {
        $billingCountry = $paymentInfo->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $paymentInfo->getQuote()->getBillingAddress()->getCountryId();
    }
    if (!$this->canUseForCountry($billingCountry)) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('You can\'t use the payment type you selected to make payments to the billing country.')
        );
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Checks/CanUseForCountry.php#L27-L36


/**
 * Check whether payment method is applicable to quote
 * @param MethodInterface $paymentMethod
 * @param Quote $quote
 * @return bool
 */
public function isApplicable(MethodInterface $paymentMethod, Quote $quote)
{
    return $paymentMethod->canUseForCountry($this->countryProvider->getCountry($quote));
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/etc/di.xml#L106-L117


<type name="Magento\Payment\Model\Checks\SpecificationFactory">
    <arguments>
        <argument name="mapping" xsi:type="array">
            <item name="country" xsi:type="object">Magento\Payment\Model\Checks\CanUseForCountry</item>
            <item name="currency" xsi:type="object">Magento\Payment\Model\Checks\CanUseForCurrency</item>
            <item name="checkout" xsi:type="object">Magento\Payment\Model\Checks\CanUseCheckout</item>
            <item name="internal" xsi:type="object">Magento\Payment\Model\Checks\CanUseInternal</item>
            <item name="total" xsi:type="object">Magento\Payment\Model\Checks\TotalMinMax</item>
            <item name="zero_total" xsi:type="object">Magento\Payment\Model\Checks\ZeroTotal</item>
        </argument>
    </arguments>
</type>

dmitry_fedyuk · February 11, 2016, 2:07am