How is the «Transfer Cart Line Items» PayPal option implemented?

dmitry_fedyuk · April 1, 2016, 6:10am

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/etc/adminhtml/system/paypal_payflowpro_with_express_checkout.xml#L218-L223


<field id="line_items_enabled" translate="label" type="select" sortOrder="40" showInDefault="1" showInWebsite="1">
    <label>Transfer Cart Line Items</label>
    <config_path>payment/payflow_express/line_items_enabled</config_path>
    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
    <attribute type="shared">1</attribute>
</field>

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/etc/adminhtml/system/express_checkout.xml#L393-L398


<field id="line_items_enabled" translate="label" type="select" sortOrder="40" showInDefault="1" showInWebsite="1">
    <label>Transfer Cart Line Items</label>
    <config_path>payment/paypal_express/line_items_enabled</config_path>
    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
    <attribute type="shared">1</attribute>
</field>

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/Model/Api/PayflowNvp.php#L759-L769


/**
 * Checking negative line items
 *
 * @param array $request
 * @param int $i
 * @return null|true
 */
protected function _exportLineItems(array &$request, $i = 0)
{
    $requestBefore = $request;
    $result = parent::_exportLineItems($request, $i);

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/Model/Api/PayflowNvp.php#L770-L790


if ($this->getIsLineItemsEnabled() && $this->_cart->hasNegativeItemAmount()) {
    $this->_lineItemTotalExportMap = [
        Cart::AMOUNT_TAX      => 'TAXAMT',
        Cart::AMOUNT_SHIPPING => 'FREIGHTAMT',
        'amount'              => 'PAYMENTREQUEST_0_ITEMAMT',
    ];
    $this->_lineItemExportItemsFormat = [
        'name'   => 'L_PAYMENTREQUEST_0_NAME%d',
        'qty'    => 'L_PAYMENTREQUEST_0_QTY%d',
        'amount' => 'L_PAYMENTREQUEST_0_AMT%d',
    ];
    $request = $requestBefore;
    $result = parent::_exportLineItems($request, $i);
    /** @var Nvp $paypalNvp */
    $paypalNvp = $this->nvpFactory->create();
    $this->_doCaptureResponse = $paypalNvp->_doCaptureResponse;
    $this->_refundTransactionResponse = $paypalNvp->_refundTransactionResponse;
    $this->_getTransactionDetailsResponse = $paypalNvp->_getTransactionDetailsResponse;
    $this->_paymentInformationResponse = $paypalNvp->_paymentInformationResponse;
    $this->_headers[] = 'PAYPAL-NVP: Y';
    $this->_setSpecificForNegativeLineItems();

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/Model/Api/AbstractApi.php#L406-L416


/**
 * Prepare line items request
 *
 * Returns true if there were line items added
 *
 * @param array &$request
 * @param int $i
 * @return true|null
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
protected function _exportLineItems(array &$request, $i = 0)

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/Model/Api/AbstractApi.php#L422-L431


// always add cart totals, even if line items are not requested
if ($this->_lineItemTotalExportMap) {
    foreach ($this->_cart->getAmounts() as $key => $total) {
        if (isset($this->_lineItemTotalExportMap[$key])) {
            // !empty($total)
            $privateKey = $this->_lineItemTotalExportMap[$key];
            $request[$privateKey] = $this->formatPrice($total);
        }
    }
}

github.com

magento/magento2/blob/6ea7d2d/app/code/Magento/Paypal/Model/Api/AbstractApi.php#L433-L453


// add cart line items
$items = $this->_cart->getAllItems();
if (empty($items) || !$this->getIsLineItemsEnabled()) {
    return;
}
$result = null;
foreach ($items as $item) {
    foreach ($this->_lineItemExportItemsFormat as $publicKey => $privateFormat) {
        $result = true;
        $value = $item->getDataUsingMethod($publicKey);
        if (isset($this->_lineItemExportItemsFilters[$publicKey])) {
            $callback = $this->_lineItemExportItemsFilters[$publicKey];
            $value = call_user_func([$this, $callback], $value);
        }
        if (is_float($value)) {
            $value = $this->formatPrice($value);
        }
        $request[sprintf($privateFormat, $i)] = $value;
    }
    $i++;
}