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

dmitry_fedyuk · February 12, 2016, 4:47am

Declaration

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


/**
 * Retrieve payment information model object
 *
 * @param InfoInterface $info
 * @return void
 * 
 * @deprecated
 */
public function setInfoInstance(InfoInterface $info);

Definition

github.com

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


/**
 * Retrieve payment information model object
 *
 * @param InfoInterface $info
 * @return void
 * @api
 */
public function setInfoInstance(InfoInterface $info)
{
    $this->setData('info_instance', $info);
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Form/Container.php#L84-L96


/**
 * Check and prepare payment method model
 *
 * Redeclare this method in child classes for declaring method info instance
 *
 * @param \Magento\Payment\Model\MethodInterface $method
 * @return $this
 */
protected function _assignMethod($method)
{
    $method->setInfoInstance($this->getQuote()->getPayment());
    return $this;
}

github.com

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


public function getMethodInstance()
{
    if (!$this->hasMethodInstance()) {
        if (!$this->getMethod()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('The payment method you requested is not available.')
            );
        }


        try {
            $instance = $this->_paymentData->getMethodInstance($this->getMethod());
        } catch (\UnexpectedValueException $e) {
            $instance = $this->_paymentData->getMethodInstance(Method\Substitution::CODE);
        }


        $instance->setInfoInstance($this);
        $this->setMethodInstance($instance);
    }


    return $this->_getData('method_instance');
}

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/Sales/Model/Order/Payment/Info.php#L105-L122


public function getMethodInstance()
{
    if (!$this->hasMethodInstance()) {
        if (!$this->getMethod()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('The payment method you requested is not available.')
            );
        }
        try {
            $instance = $this->paymentData->getMethodInstance($this->getMethod());
        } catch (\UnexpectedValueException $e) {
            $instance = $this->paymentData->getMethodInstance(Substitution::CODE);
        }
        $instance->setInfoInstance($this);
        $this->setMethodInstance($instance);
    }
    return $this->getData('method_instance');
}

dmitry_fedyuk · February 12, 2016, 4:57am