Cart Class Reference

Inheritance diagram for Cart:

Public Member Functions
	__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 ()

Data Fields
const	AMOUNT_TAX = 'tax'
const	AMOUNT_SHIPPING = 'shipping'
const	AMOUNT_DISCOUNT = 'discount'
const	AMOUNT_SUBTOTAL = 'subtotal'

Protected Member Functions
	_collectItemsAndAmounts ()
	_importItemsFromSalesModel ()
	_calculateCustomItemsSubtotal ()
	_setTransferFlag ($flagType, $value)
	_setAmount ($amountType, $amount)
	_addAmount ($amountType, $amount)
	_getAmount ($amountType)
	_createItemFromData ($name, $qty, $amount, $identifier=null)
	_resetAmounts ()

Protected Attributes
	$_salesModel
	$_eventManager
	$_amounts
	$_customItems = []
	$_salesModelItems = []
	$_transferFlags = []
	$_itemsCollectingRequired = true

Detailed Description

Provide methods for collecting cart items information of specific sales model entity

@api

Since

100.0.2

Definition at line 14 of file Cart.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Payment\Model\Cart\SalesModel\Factory	$salesModelFactory,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
			$salesModel
	)

Parameters

\Magento\Payment\Model\Cart\SalesModel\Factory	$salesModelFactory
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Quote\Api\Data\CartInterface	$salesModel

Definition at line 78 of file Cart.php.

      {
        $this->_eventManager = $eventManager;
        $this->_salesModel = $salesModelFactory->create($salesModel);
        $this->_resetAmounts();
    }

Member Function Documentation

_addAmount()

_addAmount (   $amountType,   $amount  )

protected

Parameters

string	$amountType
float	$amount

Returns

void

Definition at line 389 of file Cart.php.

    {
        $this->_amounts[$amountType] += (double)$amount;
    }

_calculateCustomItemsSubtotal()

_calculateCustomItemsSubtotal ( )

protected

Calculate subtotal from custom items

Returns

void

Definition at line 346 of file Cart.php.

    {
        if (!empty($this->_transferFlags[self::AMOUNT_DISCOUNT]) && $this->getDiscount()) {
            $this->addCustomItem(__('Discount'), 1, -1.00 * $this->getDiscount());
            $this->setDiscount(0);
        }

        if (!empty($this->_transferFlags[self::AMOUNT_SHIPPING]) && $this->getShipping()) {
            $this->addCustomItem(__('Shipping'), 1, $this->getShipping());
            $this->setShipping(0);
        }

        foreach ($this->_customItems as $item) {
            $this->_amounts[self::AMOUNT_SUBTOTAL] += $item->getAmount();
        }
    }

_collectItemsAndAmounts()

_collectItemsAndAmounts ( )

protected

Collect all items, discounts, taxes, shipping to cart

Returns

void

Definition at line 294 of file Cart.php.

    {
        if (!$this->_itemsCollectingRequired) {
            return;
        }

        $this->_itemsCollectingRequired = false;

        $this->_salesModelItems = [];
        $this->_customItems = [];

        $this->_resetAmounts();

        $this->_eventManager->dispatch('payment_cart_collect_items_and_amounts', ['cart' => $this]);

        $this->_importItemsFromSalesModel();
        $this->_calculateCustomItemsSubtotal();
    }

_createItemFromData()

_createItemFromData (   $name,   $qty,   $amount,   $identifier = null  )

protected

Create item object from item data

Parameters

string	$name
int	$qty
float	$amount
null | string	$identifier

Returns

\Magento\Framework\DataObject

Definition at line 414 of file Cart.php.

    {
        $item = new \Magento\Framework\DataObject(['name' => $name, 'qty' => $qty, 'amount' => (double)$amount]);

        if ($identifier) {
            $item->setData('id', $identifier);
        }

        return $item;
    }

_getAmount()

_getAmount (   $amountType )

protected

Get amount of specified type

Parameters

string

$amountType

Returns

float

Definition at line 400 of file Cart.php.

    {
        return $this->_amounts[$amountType];
    }

_importItemsFromSalesModel()

_importItemsFromSalesModel ( )

protected

Import items from sales model

Returns

void

Definition at line 318 of file Cart.php.

    {
        $this->_salesModelItems = [];

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

            $this->_salesModelItems[] = $this->_createItemFromData(
                $item->getName(),
                $item->getQty(),
                $item->getPrice(),
                $item->getOriginalItem()->getId()
            );
        }

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

_resetAmounts()

_resetAmounts ( )

protected

Set all amount types to zero

Returns

void

Definition at line 430 of file Cart.php.

    {
        $this->_amounts = [
            self::AMOUNT_DISCOUNT => 0,
            self::AMOUNT_SHIPPING => 0,
            self::AMOUNT_SUBTOTAL => 0,
            self::AMOUNT_TAX => 0,
        ];
    }

_setAmount()

_setAmount (   $amountType,   $amount  )

protected

Parameters

string	$amountType
float	$amount

Returns

void

Definition at line 379 of file Cart.php.

    {
        $this->_amounts[$amountType] = (double)$amount;
    }

_setTransferFlag()

_setTransferFlag (   $flagType,   $value  )

protected

Parameters

string	$flagType
bool	$value

Returns

void

Definition at line 368 of file Cart.php.

    {
        $this->_transferFlags[$flagType] = (bool)$value;
        $this->_itemsCollectingRequired = true;
    }

addCustomItem()

addCustomItem	(		$name,
			$qty,
			$amount,
			$identifier = null
	)

Add custom item (such as discount as line item, shipping as line item, etc)

Parameters

string	$name
int	$qty
float	$amount
string | null	$identifier

Returns

void @api

Definition at line 237 of file Cart.php.

    {
        $this->_customItems[] = $this->_createItemFromData($name, $qty, $amount, $identifier);
    }

addDiscount()

addDiscount

(

$discountAmount

)

Add amount to existing discount amount

Parameters

float

$discountAmount

Returns

void @api

Definition at line 141 of file Cart.php.

    {
        $this->_addAmount(self::AMOUNT_DISCOUNT, $discountAmount);
    }

addShipping()

addShipping

(

$shippingAmount

)

Add amount to existing shipping amount

Parameters

float

$shippingAmount

Returns

void @api

Definition at line 176 of file Cart.php.

    {
        $this->_addAmount(self::AMOUNT_SHIPPING, $shippingAmount);
    }

addSubtotal()

addSubtotal

(

$subtotalAmount

)

Add amount to existing subtotal amount

Parameters

float

$subtotalAmount

Returns

void @api

Definition at line 211 of file Cart.php.

    {
        $this->_addAmount(self::AMOUNT_SUBTOTAL, $subtotalAmount);
    }

addTax()

addTax

(

$taxAmount

)

Add amount to existing tax amount

Parameters

float

$taxAmount

Returns

void @api

Definition at line 106 of file Cart.php.

    {
        $this->_addAmount(self::AMOUNT_TAX, $taxAmount);
    }

getAllItems()

getAllItems

(

)

Get all cart items

Returns

array @api

Definition at line 248 of file Cart.php.

    {
        $this->_collectItemsAndAmounts();
        return array_merge($this->_salesModelItems, $this->_customItems);
    }

getAmounts()

getAmounts

(

)

Get shipping, tax, subtotal and discount amounts all together

Returns

array @api

Definition at line 260 of file Cart.php.

    {
        $this->_collectItemsAndAmounts();

        return $this->_amounts;
    }

getDiscount()

getDiscount

(

)

Get discount amount

Returns

float @api

Definition at line 164 of file Cart.php.

    {
        return $this->_getAmount(self::AMOUNT_DISCOUNT);
    }

getSalesModel()

getSalesModel

(

)

Return payment cart sales model

Returns

\Magento\Payment\Model\Cart\SalesModel\SalesModelInterface @api

Definition at line 94 of file Cart.php.

    {
        return $this->_salesModel;
    }

getShipping()

getShipping

(

)

Get shipping amount

Returns

float @api

Definition at line 199 of file Cart.php.

    {
        return $this->_getAmount(self::AMOUNT_SHIPPING);
    }

getSubtotal()

getSubtotal

(

)

Get subtotal amount

Returns

float @api

Definition at line 222 of file Cart.php.

    {
        return $this->_getAmount(self::AMOUNT_SUBTOTAL);
    }

getTax()

getTax

(

)

Get tax amount

Returns

float @api

Definition at line 129 of file Cart.php.

    {
        return $this->_getAmount(self::AMOUNT_TAX);
    }

setDiscount()

setDiscount

(

$discountAmount

)

Set discount. Old value will be overwritten

Parameters

float

$discountAmount

Returns

void @api

Definition at line 153 of file Cart.php.

    {
        $this->_setAmount(self::AMOUNT_DISCOUNT, $discountAmount);
    }

setShipping()

setShipping

(

$shippingAmount

)

Set shipping. Old value will be overwritten

Parameters

float

$shippingAmount

Returns

void @api

Definition at line 188 of file Cart.php.

    {
        $this->_setAmount(self::AMOUNT_SHIPPING, $shippingAmount);
    }

setTax()

setTax

(

$taxAmount

)

Set tax. Old value will be overwritten

Parameters

float

$taxAmount

Returns

void @api

Definition at line 118 of file Cart.php.

    {
        $this->_setAmount(self::AMOUNT_TAX, $taxAmount);
    }

setTransferDiscountAsItem()

setTransferDiscountAsItem

(

)

Specify that discount should be transferred as cart item

Returns

void @api

Definition at line 284 of file Cart.php.

    {
        $this->_setTransferFlag(self::AMOUNT_DISCOUNT, true);
    }

setTransferShippingAsItem()

setTransferShippingAsItem

(

)

Specify that shipping should be transferred as cart item

Returns

void @api

Definition at line 273 of file Cart.php.

    {
        $this->_setTransferFlag(self::AMOUNT_SHIPPING, true);
    }

Field Documentation

$_amounts

$_amounts

protected

Definition at line 43 of file Cart.php.

$_customItems

$_customItems = []

protected

Definition at line 50 of file Cart.php.

$_eventManager

$_eventManager

protected

Definition at line 36 of file Cart.php.

$_itemsCollectingRequired

$_itemsCollectingRequired = true

protected

Definition at line 71 of file Cart.php.

$_salesModel

$_salesModel

protected

#- #-

Definition at line 29 of file Cart.php.

$_salesModelItems

$_salesModelItems = []

protected

Definition at line 57 of file Cart.php.

$_transferFlags

$_transferFlags = []

protected

Definition at line 64 of file Cart.php.

AMOUNT_DISCOUNT

const AMOUNT_DISCOUNT = 'discount'

Definition at line 23 of file Cart.php.

AMOUNT_SHIPPING

const AMOUNT_SHIPPING = 'shipping'

Definition at line 21 of file Cart.php.

AMOUNT_SUBTOTAL

const AMOUNT_SUBTOTAL = 'subtotal'

Definition at line 25 of file Cart.php.

AMOUNT_TAX

const AMOUNT_TAX = 'tax'

#+ Amounts

Definition at line 19 of file Cart.php.

---

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

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