How is a payment method's assignData() implemented and used?

dmitry_fedyuk · February 15, 2016, 10:02am

Declaration

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


/**
 * Assign data to info model instance
 *
 * @param DataObject $data
 * @return $this
 * 
 */
public function assignData(DataObject $data);

Definition

github.com

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


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


    $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/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/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/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/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/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/Payment/Method/Billing/AbstractAgreement.php#L104-L111


/**
 * Assign data to info model instance
 *
 * @param \Magento\Framework\DataObject $data
 * @return \Magento\Payment\Model\Info
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function assignData(\Magento\Framework\DataObject $data)

github.com

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


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


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


    return $this->getVaultProvider()->assignData($data);

Usage

Context: How does a payment information saving work when a registered customer places an order?

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Quote/Model/Quote/Payment.php#L169-L173


$method->assignData($data);
/*
 * validating the payment data
 */
$method->validate();

github.com

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


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


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


    return $this->getVaultProvider()->assignData($data);

dmitry_fedyuk · February 15, 2016, 10:18am