How is the available payment methods list gathered for the frontend checkout page?

dmitry_fedyuk · February 8, 2016, 5:52am

magento/magento2/blob/6ce74b2/app/code/Magento/Checkout/Block/Onepage.php#L49-L49


\Magento\Checkout\Model\CompositeConfigProvider $configProvider,

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Checkout/etc/frontend/di.xml#L46-L52


<type name="Magento\Checkout\Model\CompositeConfigProvider">
    <arguments>
        <argument name="configProviders" xsi:type="array">
            <item name="checkout_default_config_provider" xsi:type="object">Magento\Checkout\Model\DefaultConfigProvider</item>
        </argument>
    </arguments>
</type>

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Checkout/Model/DefaultConfigProvider.php#L297-L297


$output['paymentMethods'] = $this->getPaymentMethods();

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Checkout/Model/DefaultConfigProvider.php#L609-L626


/**
 * Returns array of payment methods
 * @return array
 */
private function getPaymentMethods()
{
    $paymentMethods = [];
    $quote = $this->checkoutSession->getQuote();
    if ($quote->getIsVirtual()) {
        foreach ($this->paymentMethodManagement->getList($quote->getId()) as $paymentMethod) {
            $paymentMethods[] = [
                'code' => $paymentMethod->getCode(),
                'title' => $paymentMethod->getTitle()
            ];
        }
    }
    return $paymentMethods;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Checkout/Model/DefaultConfigProvider.php#L220-L220


\Magento\Quote\Api\PaymentMethodManagementInterface $paymentMethodManagement,

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Quote/etc/di.xml#L19-L19


<preference for="Magento\Quote\Api\PaymentMethodManagementInterface" type="\Magento\Quote\Model\PaymentMethodManagement" />

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Quote/Model/PaymentMethodManagement.php#L108-L113


public function getList($cartId)
{
    /** @var \Magento\Quote\Model\Quote $quote */
    $quote = $this->quoteRepository->get($cartId);
    return $this->methodList->getAvailableMethods($quote);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodList.php#L35-L51


/**
 * @param \Magento\Quote\Api\Data\CartInterface $quote
 * @return \Magento\Payment\Model\MethodInterface[]
 * @api
 */
public function getAvailableMethods(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    $store = $quote ? $quote->getStoreId() : null;
    $methods = [];
    foreach ($this->paymentHelper->getStoreMethods($store, $quote) as $method) {
        if ($this->_canUseMethod($method, $quote)) {
            $method->setInfoInstance($quote->getPayment());
            $methods[] = $method;
        }
    }
    return $methods;
}

github.com

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


/**
 * Get and sort available payment methods for specified or current store
 *
 * @param null|string|bool|int $store
 * @param Quote|null $quote
 * @return AbstractMethod[]
 */
public function getStoreMethods($store = null, $quote = null)

github.com

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


/**
 * Retrieve all payment methods
 *
 * @return array
 */
public function getPaymentMethods()
{
    return $this->_initialConfig->getData('default')[self::XML_PATH_PAYMENT_METHODS];
}

The standard payment methods declarations

github.com

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


$model = $this->scopeConfig->getValue(
    $this->getMethodModelConfigName($code),
    \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
    $store
);
if (!$model) {
    continue;
}

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/MethodList.php#L45-L48


if ($this->_canUseMethod($method, $quote)) {
    $method->setInfoInstance($quote->getPayment());
    $methods[] = $method;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodList.php#L53-L72


/**
 * Check payment method model
 *
 * @param \Magento\Payment\Model\MethodInterface $method
 * @param \Magento\Quote\Api\Data\CartInterface $quote
 * @return bool
 */
protected function _canUseMethod($method, \Magento\Quote\Api\Data\CartInterface $quote)
{
    return $this->methodSpecificationFactory->create(
        [
            AbstractMethod::CHECK_USE_FOR_COUNTRY,
            AbstractMethod::CHECK_USE_FOR_CURRENCY,
            AbstractMethod::CHECK_ORDER_TOTAL_MIN_MAX,
        ]
    )->isApplicable(
        $method,
        $quote
    );
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodList.php#L29-L29


\Magento\Payment\Model\Checks\SpecificationFactory $specificationFactory

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Checks/SpecificationFactory.php#L35-L46


/**
 * Creates new instances of payment method models
 *
 * @param array $data
 * @return Composite
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function create($data)
{
    $specifications = array_intersect_key($this->mapping, array_flip((array)$data));
    return $this->compositeFactory->create(['list' => $specifications]);
}

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/Payment/Model/Checks/Composite.php#L24-L39


/**
 * Check whether payment method is applicable to quote
 *
 * @param MethodInterface $paymentMethod
 * @param \Magento\Quote\Model\Quote $quote
 * @return bool
 */
public function isApplicable(MethodInterface $paymentMethod, Quote $quote)
{
    foreach ($this->list as $specification) {
        if (!$specification->isApplicable($paymentMethod, $quote)) {
            return false;
        }
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/etc/di.xml#L67-L69


<type name="Magento\Payment\Model\Checks\Composite">
    <plugin name="paypal_specification" type="Magento\Paypal\Model\Method\Checks\SpecificationPlugin"/>
</type>

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Checks/SpecificationPlugin.php#L29-L39


/**
 * Override check for Billing Agreements
 *
 * @param SpecificationInterface $specification
 * @param \Closure $proceed
 * @param MethodInterface $paymentMethod
 * @param Quote $quote
 * @return bool
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function aroundIsApplicable(

dmitry_fedyuk · February 8, 2016, 6:04am