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

dmitry_fedyuk · February 10, 2016, 7:12am

Purpose

The same as canUseInternal(), but it is used for the frontend only.

Declaration

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


/**
 * Can be used in regular checkout
 *
 * @return bool
 */
public function canUseCheckout();

Definition

github.com

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


/**
 * Payment Method feature
 *
 * @var bool
 */
protected $_canUseCheckout = true;

github.com

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


/**
 * Can be used in regular checkout
 *
 * @return bool
 */
public function canUseCheckout()
{
    return $this->_canUseCheckout;
}

Usages

github.com

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


class CanUseCheckout implements SpecificationInterface
{
/**
 * 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->canUseCheckout();
}
}

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>

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L279-L282


public function canUseCheckout()
{
    return $this->getVaultProvider()->canUseCheckout();
}

dmitry_fedyuk · February 10, 2016, 7:13am