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

dmitrii_fediuk · February 10, 2016, 6:47am

Purpose

Place in your custom canUseInternal() method a custom logic to decide whether the payment method need to be shown to a customer on the checkout screen. By default there is no custom login and the method just returns true.

Declaration

github.com

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


/**
 * Using internal pages for input payment data
 * Can be used in admin
 *
 * @return bool
 */
public function canUseInternal();

Definition

github.com

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


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

github.com

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


/**
 * Using internal pages for input payment data
 * Can be used in admin
 *
 * @return bool
 */
public function canUseInternal()
{
    return $this->_canUseInternal;
}

Usages

github.com

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


class CanUseInternal 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->canUseInternal();
}
}

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/Sales/Block/Adminhtml/Order/Create/Billing/Method/Form.php#L40-L49


/**
 * Check payment method model
 *
 * @param \Magento\Payment\Model\MethodInterface|null $method
 * @return bool
 */
protected function _canUseMethod($method)
{
    return $method && $method->canUseInternal() && parent::_canUseMethod($method);
}

github.com

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


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

dmitrii_fediuk · February 10, 2016, 6:55am