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

dmitry_fedyuk · February 12, 2016, 4:32am

Declaration

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


/**
 * Retrieve payment information model object
 *
 * @return InfoInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 * 
 * @deprecated
 */
public function getInfoInstance();

Definition

github.com

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


/**
 * Retrieve payment information model object
 *
 * @return InfoInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 */
public function getInfoInstance()
{
    $instance = $this->getData('info_instance');
    if (!$instance instanceof InfoInterface) {
        throw new \Magento\Framework\Exception\LocalizedException(__('We cannot retrieve the payment information object instance.'));
    }
    return $instance;
}

github.com

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


public function getInfoInstance()
{
    return $this->infoInstance;
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Directpost.php#L471-L486


public function initialize($paymentAction, $stateObject)
{
    $requestType = null;
    switch ($paymentAction) {
        case self::ACTION_AUTHORIZE:
            $requestType = self::REQUEST_TYPE_AUTH_ONLY;
            //intentional
        case self::ACTION_AUTHORIZE_CAPTURE:
            $requestType = $requestType ?: self::REQUEST_TYPE_AUTH_CAPTURE;
            $payment = $this->getInfoInstance();
            $order = $payment->getOrder();
            $order->setCanSendNewEmailFlag(false);
            $payment->setBaseAmountAuthorized($order->getBaseTotalDue());
            $payment->setAmountAuthorized($order->getTotalDue());
            $payment->setAnetTransType($requestType);
            break;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Directpost.php#L859-L867


/**
 * Get whether it is possible to capture
 *
 * @return bool
 */
public function canCapture()
{
    return !$this->isGatewayActionsLocked($this->getInfoInstance());
}

github.com

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


/**
 * Assign corresponding data
 *
 * @param \Magento\Framework\DataObject|mixed $data
 * @return $this
 * @throws LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    parent::assignData($data);
    $infoInstance = $this->getInfoInstance();
    if ($this->getConfigData('fraudprotection') > 0) {
        $infoInstance->setAdditionalInformation('device_data', $data->getData('device_data'));
    }
    $infoInstance->setAdditionalInformation('cc_last4', $data->getData('cc_last4'));
    $infoInstance->setAdditionalInformation('cc_token', $data->getCcToken());
    $infoInstance->setAdditionalInformation('payment_method_nonce', $data->getPaymentMethodNonce());
    $infoInstance->setAdditionalInformation('store_in_vault', $data->getStoreInVault());
    return $this;
}

github.com

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


public function validate()
{
    $info = $this->getInfoInstance();
    if ($info instanceof \Magento\Sales\Model\Order\Payment) {
        $billingCountry = $info->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $info->getQuote()->getBillingAddress()->getCountryId();
    }


    if (!$this->config->canUseForCountry($billingCountry)) {
        throw new LocalizedException(__('Selected payment type is not allowed for billing country.'));
    }

github.com

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


$ccType = $info->getCcType();
if (!$ccType) {
    $token = $this->getInfoInstance()->getAdditionalInformation('cc_token');
    if ($token) {
        $ccType = $this->vault->getSavedCardType($token);
    }
}

github.com

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


if (!$this->isTokenAllowed()) {
    $token = null;
} elseif (!$token) {
    $token = $this->getInfoInstance()->getAdditionalInformation('cc_token');
}

github.com

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


} elseif ($this->getInfoInstance()->getAdditionalInformation('payment_method_nonce')) {
    $transactionParams['paymentMethodNonce'] =
        $this->getInfoInstance()->getAdditionalInformation('payment_method_nonce');

github.com

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


if ($this->getInfoInstance()->getAdditionalInformation('store_in_vault')) {
    $last4 = $this->getInfoInstance()->getAdditionalInformation('cc_last4');
    if ($this->shouldSaveCard($last4)) {
        $transactionParams['options']['storeInVaultOnSuccess'] = true;
    }
} else {
    $transactionParams['options']['storeInVault'] = false;
}

github.com

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


if ($token && $this->getInfoInstance()->getAdditionalInformation('payment_method_nonce')) {
    $transactionParams['paymentMethodNonce'] =
        $this->getInfoInstance()->getAdditionalInformation('payment_method_nonce');
    unset($transactionParams['paymentMethodToken']);
}

github.com

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


if ($this->config->isFraudProtectionEnabled() &&
    strlen($this->getInfoInstance()->getAdditionalInformation('device_data')) > 0) {
    $transactionParams['deviceData'] = $this->getInfoInstance()->getAdditionalInformation('device_data');
}

github.com

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


/**
 * Assign corresponding data
 *
 * @param \Magento\Framework\DataObject|mixed $data
 * @return $this
 * @throws LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    $infoInstance = $this->getInfoInstance();
    $infoInstance->setAdditionalInformation('payment_method_nonce', $data->getPaymentMethodNonce());
    return $this;
}

github.com

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


public function validate()
{
    $info = $this->getInfoInstance();
    if ($info instanceof \Magento\Sales\Model\Order\Payment) {
        $billingCountry = $info->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $info->getQuote()->getBillingAddress()->getCountryId();
    }


    if (!$this->payPalConfig->canUseForCountry($billingCountry)) {
        throw new LocalizedException(__('Selected payment type is not allowed for billing country.'));
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/OfflinePayments/Model/Purchaseorder.php#L41-L56


/**
 * Assign data to info model instance
 *
 * @param \Magento\Framework\DataObject|mixed $data
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    if (!$data instanceof \Magento\Framework\DataObject) {
        $data = new \Magento\Framework\DataObject($data);
    }


    $this->getInfoInstance()->setPoNumber($data->getPoNumber());
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Form.php#L55-L64


/**
 * Retrieve field value data from payment info object
 *
 * @param   string $field
 * @return  mixed
 */
public function getInfoData($field)
{
    return $this->escapeHtml($this->getMethod()->getInfoInstance()->getData($field));
}

github.com

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


public function validate()
{
    /**
     * to validate payment method is allowed for billing country or not
     */
    $paymentInfo = $this->getInfoInstance();
    if ($paymentInfo instanceof Payment) {
        $billingCountry = $paymentInfo->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $paymentInfo->getQuote()->getBillingAddress()->getCountryId();
    }
    if (!$this->canUseForCountry($billingCountry)) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('You can\'t use the payment type you selected to make payments to the billing country.')
        );
    }
    return $this;
}

github.com

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


/**
 * Assign data to info model instance
 *
 * @param array|\Magento\Framework\DataObject $data
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    if (is_array($data)) {
        $this->getInfoInstance()->addData($data);
    } elseif ($data instanceof \Magento\Framework\DataObject) {
        $this->getInfoInstance()->addData($data->getData());
    }

github.com

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


$this->_eventManager->dispatch(
    'payment_method_assign_data_' . $this->getCode(),
    [
        AbstractDataAssignObserver::METHOD_CODE => $this,
        AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
        AbstractDataAssignObserver::DATA_CODE => $data
    ]
);


$this->_eventManager->dispatch(
    'payment_method_assign_data',
    [
        AbstractDataAssignObserver::METHOD_CODE => $this,
        AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
        AbstractDataAssignObserver::DATA_CODE => $data
    ]
);

github.com

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


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
    }

github.com

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


private function getConfiguredValue($field, $storeId = null)
{
    $handler = $this->valueHandlerPool->get($field);
    $subject = [
        'field' => $field
    ];


    if ($this->getInfoInstance()) {
        $subject['payment'] = $this->paymentDataObjectFactory->create($this->getInfoInstance());
    }


    return $handler->handle($subject, $storeId ?: $this->getStore());
}

github.com

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


public function validate()
{
    try {
        $validator = $this->getValidatorPool()->get('global');
    } catch (\Exception $e) {
        return $this;
    }


    $result = $validator->validate(
        ['payment' => $this->getInfoInstance(), 'storeId' => $this->getStore()]
    );


    if (!$result->isValid()) {
        throw new LocalizedException(
            __(implode("\n", $result->getFailsDescription()))
        );
    }


    return $this;
}

github.com

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


public function assignData(\Magento\Framework\DataObject $data)
{
    $this->eventManager->dispatch(
        'payment_method_assign_data_' . $this->getCode(),
        [
            AbstractDataAssignObserver::METHOD_CODE => $this,
            AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
            AbstractDataAssignObserver::DATA_CODE => $data
        ]
    );


    $this->eventManager->dispatch(
        'payment_method_assign_data',
        [
            AbstractDataAssignObserver::METHOD_CODE => $this,
            AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
            AbstractDataAssignObserver::DATA_CODE => $data
        ]
    );


    return $this;

github.com

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


public function initialize($paymentAction, $stateObject)
{
    $this->executeCommand(
        'initialize',
        [
            'payment' => $this->getInfoInstance(),
            'paymentAction' => $paymentAction,
            'stateObject' => $stateObject
        ]
    );
    return $this;
}

github.com

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


public function validate()
{
    /*
     * calling parent validate function
     */
    parent::validate();


    $info = $this->getInfoInstance();
    $errorMsg = false;
    $availableTypes = explode(',', $this->getConfigData('cctypes'));


    $ccNumber = $info->getCcNumber();


    // remove credit card number delimiters such as "-" and space
    $ccNumber = preg_replace('/[\-\s]+/', '', $ccNumber);
    $info->setCcNumber($ccNumber);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Substitution.php#L36-L44


/**
 * Retrieve payment method title
 *
 * @return string
 */
public function getTitle()
{
    return $this->getInfoInstance()->getAdditionalInformation(self::INFO_KEY_TITLE);
}

github.com

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


/**
 * Whether payment can be reviewed
 * @return bool
 */
public function canReviewPayment()
{
    return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
}

github.com

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


/**
 * Whether payment can be reviewed
 * @return bool
 */
public function canReviewPayment()
{
    return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
}

github.com

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


/**
 * Assign data to info model instance
 *
 * @param array|\Magento\Framework\DataObject $data
 * @return \Magento\Payment\Model\Info
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)
{
    $result = parent::assignData($data);
    $key = ExpressCheckout::PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT;
    if (is_array($data)) {
        $this->getInfoInstance()->setAdditionalInformation($key, isset($data[$key]) ? $data[$key] : null);
    } elseif ($data instanceof \Magento\Framework\DataObject) {
        $this->getInfoInstance()->setAdditionalInformation($key, $data->getData($key));
    }
    return $result;
}

github.com

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


/**
 * Check void availability
 * @return bool
 * @throws \Magento\Framework\Exception\LocalizedException
 * @internal param \Magento\Framework\DataObject $payment
 */
public function canVoid()
{
    $info = $this->getInfoInstance();
    if ($info->getAdditionalInformation($this->_isOrderPaymentActionKey)) {
        $orderTransaction = $this->getOrderTransaction($info);
        if ($orderTransaction) {
            $info->setParentTransactionId($orderTransaction->getTxnId());
        }
    }


    return $this->_canVoid;
}

github.com

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


/**
 * Check capture availability
 *
 * @return bool
 */
public function canCapture()
{
    $payment = $this->getInfoInstance();
    $this->_pro->getConfig()->setStoreId($payment->getOrder()->getStore()->getId());


    if ($payment->getAdditionalInformation($this->_isOrderPaymentActionKey)) {
        $orderTransaction = $this->getOrderTransaction($payment);
        if ($orderTransaction->getIsClosed()) {
            return false;
        }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Hostedpro.php#L180-L197


public function initialize($paymentAction, $stateObject)
{
    switch ($paymentAction) {
        case Config::PAYMENT_ACTION_AUTH:
        case Config::PAYMENT_ACTION_SALE:
            $payment = $this->getInfoInstance();
            /** @var \Magento\Sales\Model\Order $order */
            $order = $payment->getOrder();
            $order->setCanSendNewEmailFlag(false);
            $payment->setAmountAuthorized($order->getTotalDue());
            $payment->setBaseAmountAuthorized($order->getBaseTotalDue());


            $this->setPaymentFormUrl($payment);


            $stateObject->setState(Order::STATE_PENDING_PAYMENT);
            $stateObject->setStatus(Order::STATE_PENDING_PAYMENT);
            $stateObject->setIsNotified(false);
            break;

github.com

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


/**
 * Check refund availability.
 * The main factor is that the last capture transaction exists and has an Payflow\Pro::TRANSPORT_PAYFLOW_TXN_ID in
 * additional information(needed to perform online refund. Requirement of the Payflow gateway)
 *
 * @return bool
 */
public function canRefund()
{
    /** @var \Magento\Sales\Model\Order\Payment $payment */
    $payment = $this->getInfoInstance();
    // we need the last capture transaction was made
    $captureTransaction = $this->transactionRepository->getByTransactionType(
        Transaction::TYPE_CAPTURE,
        $payment->getId(),
        $payment->getOrder()->getId()
    );
    return $captureTransaction && $captureTransaction->getAdditionalInformation(
        Payflow\Pro::TRANSPORT_PAYFLOW_TXN_ID
    ) && $this->_canRefund;
}

github.com

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


public function initialize($paymentAction, $stateObject)
{
    switch ($paymentAction) {
        case \Magento\Paypal\Model\Config::PAYMENT_ACTION_AUTH:
        case \Magento\Paypal\Model\Config::PAYMENT_ACTION_SALE:
            $payment = $this->getInfoInstance();
            $order = $payment->getOrder();
            $order->setCanSendNewEmailFlag(false);
            $payment->setAmountAuthorized($order->getTotalDue());
            $payment->setBaseAmountAuthorized($order->getBaseTotalDue());
            $this->_generateSecureSilentPostHash($payment);
            $request = $this->_buildTokenRequest($payment);
            $response = $this->postRequest($request, $this->getConfig());
            $this->_processTokenErrors($response, $payment);

github.com

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


/**
 * Get capture amount
 *
 * @param float $amount
 * @return float
 */
protected function _getCaptureAmount($amount)
{
    $infoInstance = $this->getInfoInstance();
    $amountToPay = round($amount, 2);
    $authorizedAmount = round($infoInstance->getAmountAuthorized(), 2);
    return $amountToPay != $authorizedAmount ? $amountToPay : 0;
}

github.com

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


$trxType = $this->getInfoInstance()->hasAmountPaid() ? self::TRXTYPE_SALE : self::TRXTYPE_DELAYED_CAPTURE;
$request->setTrxtype($trxType);

github.com

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


/**
 * Check void availability
 * @return bool
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function canVoid()
{
    if ($this->getInfoInstance()->getAmountPaid()) {
        $this->_canVoid = false;
    }


    return $this->_canVoid;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Agreement.php#L344-L352


/**
 * Whether payment can be reviewed
 * @return bool
 * @internal param InfoInterface|Payment $payment
 */
public function canReviewPayment()
{
    return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
}

github.com

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


$info = $this->getInfoInstance();
$ba = $this->_agreementFactory->create()->load($id);
if ($ba->getId() && $ba->getCustomerId() == $info->getQuote()->getCustomerId()) {
    $info->setAdditionalInformation(
        $key,
        $id
    )->setAdditionalInformation(
        self::PAYMENT_INFO_REFERENCE_ID,
        $ba->getReferenceId()
    );
}

dmitry_fedyuk · February 12, 2016, 4:36am