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

dmitry_fedyuk · February 11, 2016, 5:03am

Declaration

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


/**
 * Check method for processing with base currency
 *
 * @param string $currencyCode
 * @return bool
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function canUseForCurrency($currencyCode);

Definition

github.com

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


/**
 * Check method for processing with base currency
 *
 * @param string $currencyCode
 * @return bool
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function canUseForCurrency($currencyCode)
{
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Authorizenet.php#L167-L179


/**
 * Check method for processing with base currency
 *
 * @param string $currencyCode
 * @return bool
 */
public function canUseForCurrency($currencyCode)
{
    if (!in_array($currencyCode, $this->getAcceptedCurrencyCodes())) {
        return false;
    }
    return true;
}

github.com

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


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


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

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L221-L230


/**
 * Whether method is available for specified currency
 *
 * @param string $currencyCode
 * @return bool
 */
public function canUseForCurrency($currencyCode)
{
    return $this->_pro->getConfig()->isCurrencyCodeSupported($currencyCode);
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Checks/CanUseForCurrency.php#L11-L25


class CanUseForCurrency implements SpecificationInterface
{
/**
 * Check whether payment method is applicable to quote
 * Purposed to allow use in controllers some logic that was implemented in blocks only before
 *
 * @param MethodInterface $paymentMethod
 * @param \Magento\Quote\Model\Quote $quote
 * @return bool
 */
public function isApplicable(MethodInterface $paymentMethod, Quote $quote)
{
    return $paymentMethod->canUseForCurrency($quote->getStore()->getBaseCurrencyCode());
}
}

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, 5:07am