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

dmitry_fedyuk · February 15, 2016, 10:55am

Declaration

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


/**
 * Check whether payment method can be used
 *
 * @param CartInterface|null $quote
 * @return bool
 * 
 */
public function isAvailable(CartInterface $quote = null);

Definition

github.com

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


public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    if (!$this->isActive($quote ? $quote->getStoreId() : null)) {
        return false;
    }


    $checkResult = new DataObject();
    $checkResult->setData('is_available', true);


    // for future use in observers
    $this->_eventManager->dispatch(
        'payment_method_is_active',
        [
            'result' => $checkResult,
            'method_instance' => $this,
            'quote' => $quote
        ]
    );


    return $checkResult->getData('is_available');
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L829-L849


/**
 * Check whether payment method is applicable to quote
 * Purposed to allow use in controllers some logic that was implemented in blocks only before
 *
 * @param \Magento\Quote\Api\Data\CartInterface|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    if (parent::isAvailable($quote)) {
        if ($quote != null) {
            $availableCcTypes = $this->config->getApplicableCardTypes($quote->getBillingAddress()->getCountryId());
            if (!$availableCcTypes) {
                return false;
            }
        }
    } else {
        return false;
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod/PayPal.php#L181-L190


/**
 * Check whether payment method can be used with the quote
 *
 * @param \Magento\Quote\Api\Data\CartInterface|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return $this->isActive($quote ? $quote->getStoreId() : null);
}

github.com

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


public function isAvailable(CartInterface $quote = null)
{
    if (!$this->isActive($quote ? $quote->getStoreId() : null)) {
        return false;
    }


    $checkResult = new DataObject();
    $checkResult->setData('is_available', true);
    try {
        $validator = $this->getValidatorPool()->get('availability');
        $result = $validator->validate(
            [
                'payment' => $this->paymentDataObjectFactory->create($this->getInfoInstance())
            ]
        );


        $checkResult->setData('is_available', $result->isValid());
    } catch (\Exception $e) {
        // pass
    }


    // for future use in observers
    $this->eventManager->dispatch(
        'payment_method_is_active',
        [
            'result' => $checkResult,
            'method_instance' => $this,
            'quote' => $quote
        ]
    );


    return $checkResult->getData('is_available');
}

github.com

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


/**
 * Check whether there are CC types set in configuration
 *
 * @param \Magento\Quote\Api\Data\CartInterface|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return $this->getConfigData('cctypes', $quote ? $quote->getStoreId() : null) && parent::isAvailable($quote);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Free.php#L88-L101


/**
 * Check whether method is available
 *
 * @param \Magento\Quote\Api\Data\CartInterface|\Magento\Quote\Model\Quote|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return parent::isAvailable(
        $quote
    ) && null !== $quote && $this->priceCurrency->round(
        $quote->getGrandTotal()
    ) == 0;
}

github.com

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


/**
 * Check whether payment method can be used
 *
 * @param \Magento\Quote\Api\Data\CartInterface|\Magento\Quote\Model\Quote|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return parent::isAvailable($quote) && $this->_pro->getConfig()->isMethodAvailable();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L332-L340


/**
 * Check whether payment method can be used
 * @param \Magento\Quote\Api\Data\CartInterface|Quote|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return parent::isAvailable($quote) && $this->_pro->getConfig()->isMethodAvailable();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/PayflowExpress.php#L118-L138


/**
 * EC PE won't be available if the EC is available
 *
 * @param \Magento\Quote\Api\Data\CartInterface|\Magento\Quote\Model\Quote|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    if (!parent::isAvailable($quote)) {
        return false;
    }
    if (!$this->_ecInstance) {
        $this->_ecInstance = $this->_paymentData->getMethodInstance(
            Config::METHOD_WPP_EXPRESS
        );
    }
    if ($quote) {
        $this->_ecInstance->setStore($quote->getStoreId());
    }
    return !$this->_ecInstance->isAvailable();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowlink.php#L207-L217


/**
 * Check whether payment method can be used
 *
 * @param \Magento\Quote\Api\Data\CartInterface|\Magento\Quote\Model\Quote|null $quote
 * @return bool
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return AbstractMethod::isAvailable($quote) && $this->getConfig()->isMethodAvailable($this->getCode());
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowpro.php#L322-L332


/**
 * Check whether payment method can be used
 *
 * @param \Magento\Quote\Api\Data\CartInterface|Quote|null $quote
 * @return bool
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return parent::isAvailable($quote) && $this->getConfig()->isMethodAvailable($this->getCode());
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payment/Method/Billing/AbstractAgreement.php#L88-L102


/**
 * Check whether method is available
 *
 * @param \Magento\Paypal\Model\Quote|\Magento\Quote\Api\Data\CartInterface|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    if ($this->_isAvailable === null) {
        $this->_isAvailable = parent::isAvailable($quote) && $this->_isAvailable($quote);
        $this->_canUseCheckout = $this->_isAvailable && $this->_canUseCheckout;
        $this->_canUseInternal = $this->_isAvailable && $this->_canUseInternal;
    }
    return $this->_isAvailable;
}

github.com

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


public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return $this->getVaultProvider()->isAvailable($quote);
}

Usage

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Helper/Data.php#L137-L144


/** @var AbstractMethod $methodInstance */
$methodInstance = $this->_methodFactory->create($model);
$methodInstance->setStore($store);
if (!$methodInstance->isAvailable($quote)) {
    /* if the payment method cannot be used at this time */
    continue;
}
$res[] = $methodInstance;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/CcGenericConfigProvider.php#L42-L62


public function getConfig()
{
    $config = [];
    foreach ($this->methods as $methodCode => $method) {
        if ($method->isAvailable()) {
            $config = array_merge_recursive($config, [
                'payment' => [
                    'ccform' => [
                        'availableTypes' => [$methodCode => $this->getCcAvailableTypes($methodCode)],
                        'months' => [$methodCode => $this->getCcMonths()],
                        'years' => [$methodCode => $this->getCcYears()],
                        'hasVerification' => [$methodCode => $this->hasVerification($methodCode)],
                        'hasSsCardType' => [$methodCode => $this->hasSsCardType($methodCode)],
                        'ssStartYears' => [$methodCode => $this->getSsStartYears()],
                        'cvvImageUrl' => [$methodCode => $this->getCvvImageUrl()]
                    ]
                ]
            ]);
        }
    }
    return $config;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/IframeConfigProvider.php#L117-L133


/**
 * Get delimiter for date
 *
 * @return string
 */
protected function getDateDelim()
{
    $result = '';
    if ($this->method->isAvailable()) {
        $configData = $this->getMethodConfigData('date_delim');
        if ($configData !== null) {
            $result = $configData;
        }
    }


    return  $result;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/IframeConfigProvider.php#L145-L161


/**
 * Get map of cc_code, cc_num, cc_expdate for gateway
 * Returns json formatted string
 *
 * @return string
 */
protected function getCardFieldsMap()
{
    $result = [];
    if ($this->method->isAvailable()) {
        $configData = $this->getMethodConfigData('ccfields');
        $keys = ['cccvv', 'ccexpdate', 'ccnum'];
        $result = array_combine($keys, explode(',', $configData));
    }


    return $result;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/AdminOrder/Create.php#L1926-L1939


if (!$this->getQuote()->getPayment()->getMethod()) {
    $this->_errors[] = __('Please specify a payment method.');
} else {
    $method = $this->getQuote()->getPayment()->getMethodInstance();
    if (!$method->isAvailable($this->getQuote())) {
        $this->_errors[] = __('This payment method is not available.');
    } else {
        try {
            $method->validate();
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->_errors[] = $e->getMessage();
        }
    }
}

github.com

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


public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return $this->getVaultProvider()->isAvailable($quote);
}

dmitry_fedyuk · February 15, 2016, 11:16am