Cart Class Reference

Inheritance diagram for Cart:

Public Member Functions
	getAmounts ()
	hasNegativeItemAmount ()
Public Member Functions inherited from Cart
	__construct (\Magento\Payment\Model\Cart\SalesModel\Factory $salesModelFactory, \Magento\Framework\Event\ManagerInterface $eventManager, $salesModel)
	getSalesModel ()
	addTax ($taxAmount)
	setTax ($taxAmount)
	getTax ()
	addDiscount ($discountAmount)
	setDiscount ($discountAmount)
	getDiscount ()
	addShipping ($shippingAmount)
	setShipping ($shippingAmount)
	getShipping ()
	addSubtotal ($subtotalAmount)
	getSubtotal ()
	addCustomItem ($name, $qty, $amount, $identifier=null)
	getAllItems ()
	getAmounts ()
	setTransferShippingAsItem ()
	setTransferDiscountAsItem ()

Protected Member Functions
	_calculateCustomItemsSubtotal ()
	_validate ()
	_importItemsFromSalesModel ()
	_applyDiscountTaxCompensationWorkaround (\Magento\Payment\Model\Cart\SalesModel\SalesModelInterface $salesEntity)
Protected Member Functions inherited from Cart
	_collectItemsAndAmounts ()
	_importItemsFromSalesModel ()
	_calculateCustomItemsSubtotal ()
	_setTransferFlag ($flagType, $value)
	_setAmount ($amountType, $amount)
	_addAmount ($amountType, $amount)
	_getAmount ($amountType)
	_createItemFromData ($name, $qty, $amount, $identifier=null)
	_resetAmounts ()

Protected Attributes
	$_areAmountsValid = false
Protected Attributes inherited from Cart
	$_salesModel
	$_eventManager
	$_amounts
	$_customItems = []
	$_salesModelItems = []
	$_transferFlags = []
	$_itemsCollectingRequired = true

Additional Inherited Members
Data Fields inherited from Cart
const	AMOUNT_TAX = 'tax'
const	AMOUNT_SHIPPING = 'shipping'
const	AMOUNT_DISCOUNT = 'discount'
const	AMOUNT_SUBTOTAL = 'subtotal'

Detailed Description

PayPal-specific model for shopping cart items and totals The main idea is to accommodate all possible totals into PayPal-compatible 4 totals and line items

Definition at line 14 of file Cart.php.

Member Function Documentation

_applyDiscountTaxCompensationWorkaround()

_applyDiscountTaxCompensationWorkaround ( \Magento\Payment\Model\Cart\SalesModel\SalesModelInterface  $salesEntity )

protected

Add "hidden" discount and shipping tax

Go ahead, try to understand ]:->

Tax settings for getting "discount tax":

• Catalog Prices = Including Tax
• Apply Customer Tax = After Discount
• Apply Discount on Prices = Including Tax

Test case for getting "hidden shipping tax":

• Make sure shipping is taxable (set shipping tax class)
• Catalog Prices = Including Tax
• Shipping Prices = Including Tax
• Apply Customer Tax = After Discount
• Create a cart price rule with % discount applied to the Shipping Amount
• run shopping cart and estimate shipping
• go to PayPal

Parameters

\Magento\Payment\Model\Cart\SalesModel\SalesModelInterface

$salesEntity

Returns

void

Definition at line 177 of file Cart.php.

      {
        $dataContainer = $salesEntity->getTaxContainer();
        $this->addTax((double)$dataContainer->getBaseDiscountTaxCompensationAmount());
        $this->addTax((double)$dataContainer->getBaseShippingDiscountTaxCompensationAmount());
    }

_calculateCustomItemsSubtotal()

_calculateCustomItemsSubtotal ( )

protected

Calculate subtotal from custom items

Returns

void

Definition at line 52 of file Cart.php.

    {
        parent::_calculateCustomItemsSubtotal();
        $this->_applyDiscountTaxCompensationWorkaround($this->_salesModel);

        $this->_validate();
    }

_importItemsFromSalesModel()

_importItemsFromSalesModel ( )

protected

Import items from sales model with workarounds for PayPal

Returns

void

Definition at line 113 of file Cart.php.

    {
        $this->_salesModelItems = [];

        foreach ($this->_salesModel->getAllItems() as $item) {
            if ($item->getParentItem()) {
                continue;
            }

            $amount = $item->getPrice();
            $qty = $item->getQty();

            $subAggregatedLabel = '';

            // workaround in case if item subtotal precision is not compatible with PayPal (.2)
            if ($amount - round($amount, 2)) {
                $amount = $amount * $qty;
                $subAggregatedLabel = ' x' . $qty;
                $qty = 1;
            }

            // aggregate item price if item qty * price does not match row total
            $itemBaseRowTotal = $item->getOriginalItem()->getBaseRowTotal();
            if ($amount * $qty != $itemBaseRowTotal) {
                $amount = (double)$itemBaseRowTotal;
                $subAggregatedLabel = ' x' . $qty;
                $qty = 1;
            }

            $this->_salesModelItems[] = $this->_createItemFromData(
                $item->getName() . $subAggregatedLabel,
                $qty,
                $amount
            );
        }

        $this->addSubtotal($this->_salesModel->getBaseSubtotal());
        $this->addTax($this->_salesModel->getBaseTaxAmount());
        $this->addShipping($this->_salesModel->getBaseShippingAmount());
        $this->addDiscount(abs($this->_salesModel->getBaseDiscountAmount()));
    }

_validate()

_validate ( )

protected

Check the line items and totals according to PayPal business logic limitations

Returns

void

numbers are intentionally converted to strings because of possible comparison error see http://php.net/float

Definition at line 65 of file Cart.php.

    {
        $areItemsValid = false;
        $this->_areAmountsValid = false;

        $referenceAmount = $this->_salesModel->getDataUsingMethod('base_grand_total');

        $itemsSubtotal = 0;
        foreach ($this->getAllItems() as $i) {
            $itemsSubtotal = $itemsSubtotal + $i->getQty() * $i->getAmount();
        }

        $sum = $itemsSubtotal + $this->getTax();

        if (empty($this->_transferFlags[self::AMOUNT_SHIPPING])) {
            $sum += $this->getShipping();
        }

        if (empty($this->_transferFlags[self::AMOUNT_DISCOUNT])) {
            $sum -= $this->getDiscount();
            // PayPal requires to have discount less than items subtotal
            $this->_areAmountsValid = round($this->getDiscount(), 4) < round($itemsSubtotal, 4);
        } else {
            $this->_areAmountsValid = $itemsSubtotal > 0.00001;
        }

        // match sum of all the items and totals to the reference amount
        if (sprintf('%.4F', $sum) == sprintf('%.4F', $referenceAmount)) {
            $areItemsValid = true;
        }

        $areItemsValid = $areItemsValid && $this->_areAmountsValid;

        if (!$areItemsValid) {
            $this->_salesModelItems = [];
            $this->_customItems = [];
        }
    }

getAmounts()

getAmounts

(

)

Get shipping, tax, subtotal and discount amounts all together

Returns

array

Definition at line 26 of file Cart.php.

    {
        $this->_collectItemsAndAmounts();

        if (!$this->_areAmountsValid) {
            $subtotal = $this->getSubtotal() + $this->getTax();

            if (empty($this->_transferFlags[self::AMOUNT_SHIPPING])) {
                $subtotal += $this->getShipping();
            }

            if (empty($this->_transferFlags[self::AMOUNT_DISCOUNT])) {
                $subtotal -= $this->getDiscount();
            }

            return [self::AMOUNT_SUBTOTAL => $subtotal];
        }

        return $this->_amounts;
    }

hasNegativeItemAmount()

hasNegativeItemAmount

(

)

Check whether any item has negative amount

Returns

bool

Definition at line 190 of file Cart.php.

    {
        foreach ($this->_customItems as $item) {
            if ($item->getAmount() < 0) {
                return true;
            }
        }
        return false;
    }

Field Documentation

$_areAmountsValid

$_areAmountsValid = false

protected

Definition at line 19 of file Cart.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-paypal/Model/Cart.php