Cart Class Reference

Inheritance diagram for Cart:

Public Member Functions
	__construct (\Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Checkout\Model\ResourceModel\Cart $resourceCart, Session $checkoutSession, \Magento\Customer\Model\Session $customerSession, \Magento\Framework\Message\ManagerInterface $messageManager, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, \Magento\CatalogInventory\Api\StockStateInterface $stockState, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, ProductRepositoryInterface $productRepository, array $data=[])
	getCheckoutSession ()
	getCustomerSession ()
	getItems ()
	getQuoteProductIds ()
	getQuote ()
	setQuote (\Magento\Quote\Model\Quote $quote)
	addOrderItem ($orderItem, $qtyFlag=null)
	addProduct ($productInfo, $requestInfo=null)
	addProductsByIds ($productIds)
	suggestItemsQty ($data)
	updateItems ($data)
	removeItem ($itemId)
	save ()
	saveQuote ()
	truncate ()
	getProductIds ()
	getSummaryQty ()
	getItemsCount ()
	getItemsQty ()
	updateItem ($itemId, $requestInfo=null, $updatingParams=null)
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from CartInterface
	setQuote (Quote $quote)

Protected Member Functions
	_getResource ()
	reinitializeState ()
	_getProduct ($productInfo)
	_getProductRequest ($requestInfo)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_summaryQty
	$_productIds
	$_eventManager
	$_scopeConfig
	$_storeManager
	$_resourceCart
	$_checkoutSession
	$_customerSession
	$messageManager
	$stockRegistry
	$stockState
	$quoteRepository
	$productRepository
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Shopping cart model

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Deprecated:

100.1.0 Use \Magento\Quote\Model\Quote instead

See also

\Magento\Quote\Api\Data\CartInterface

Since

100.0.2

Definition at line 24 of file Cart.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Checkout\Model\ResourceModel\Cart	$resourceCart,
		Session	$checkoutSession,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Framework\Message\ManagerInterface	$messageManager,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		\Magento\CatalogInventory\Api\StockStateInterface	$stockState,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		ProductRepositoryInterface	$productRepository,
		array	$data = []
	)

Parameters

\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Checkout\Model\ResourceModel\Cart	$resourceCart
Session	$checkoutSession
\Magento\Customer\Model\Session	$customerSession
\Magento\Framework\Message\ManagerInterface	$messageManager
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
\Magento\CatalogInventory\Api\StockStateInterface	$stockState
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
ProductRepositoryInterface	$productRepository
array	$data	@codeCoverageIgnore @SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 120 of file Cart.php.

      {
        $this->_eventManager = $eventManager;
        $this->_scopeConfig = $scopeConfig;
        $this->_storeManager = $storeManager;
        $this->_resourceCart = $resourceCart;
        $this->_checkoutSession = $checkoutSession;
        $this->_customerSession = $customerSession;
        $this->messageManager = $messageManager;
        $this->stockRegistry = $stockRegistry;
        $this->stockState = $stockState;
        $this->quoteRepository = $quoteRepository;
        parent::__construct($data);
        $this->productRepository = $productRepository;
    }

Member Function Documentation

_getProduct()

_getProduct (   $productInfo )

protected

Get product object based on requested product information

Parameters

Product | int | string

$productInfo

Returns

Product

Exceptions

Definition at line 298 of file Cart.php.

    {
        $product = null;
        if ($productInfo instanceof Product) {
            $product = $productInfo;
            if (!$product->getId()) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __("The product wasn't found. Verify the product and try again.")
                );
            }
        } elseif (is_int($productInfo) || is_string($productInfo)) {
            $storeId = $this->_storeManager->getStore()->getId();
            try {
                $product = $this->productRepository->getById($productInfo, false, $storeId);
            } catch (NoSuchEntityException $e) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __("The product wasn't found. Verify the product and try again."),
                    $e
                );
            }
        } else {
            throw new \Magento\Framework\Exception\LocalizedException(
                __("The product wasn't found. Verify the product and try again.")
            );
        }
        $currentWebsiteId = $this->_storeManager->getStore()->getWebsiteId();
        if (!is_array($product->getWebsiteIds()) || !in_array($currentWebsiteId, $product->getWebsiteIds())) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __("The product wasn't found. Verify the product and try again.")
            );
        }
        return $product;
    }

_getProductRequest()

_getProductRequest (   $requestInfo )

protected

Get request for product add to cart procedure

Parameters

\Magento\Framework\DataObject | int | array

$requestInfo

Returns

\Magento\Framework\DataObject

Exceptions

Definition at line 339 of file Cart.php.

    {
        if ($requestInfo instanceof \Magento\Framework\DataObject) {
            $request = $requestInfo;
        } elseif (is_numeric($requestInfo)) {
            $request = new \Magento\Framework\DataObject(['qty' => $requestInfo]);
        } elseif (is_array($requestInfo)) {
            $request = new \Magento\Framework\DataObject($requestInfo);
        } else {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We found an invalid request for adding product to quote.')
            );
        }
        $this->getRequestInfoFilter()->filter($request);

        return $request;
    }

_getResource()

_getResource ( )

protected

Get shopping cart resource model

Returns

\Magento\Checkout\Model\ResourceModel\Cart @codeCoverageIgnore

Definition at line 154 of file Cart.php.

    {
        return $this->_resourceCart;
    }

addOrderItem()

addOrderItem	(		$orderItem,
			$qtyFlag = null
	)

Convert order item to quote item

Parameters

\Magento\Sales\Model\Order\Item	$orderItem
true | null	$qtyFlag	if is null set product qty like in order

Returns

$this

We need to reload product in this place, because products with the same id may have different sets of order attributes.

Definition at line 264 of file Cart.php.

    {
        /* @var $orderItem \Magento\Sales\Model\Order\Item */
        if ($orderItem->getParentItem() === null) {
            $storeId = $this->_storeManager->getStore()->getId();
            try {
                $product = $this->productRepository->getById($orderItem->getProductId(), false, $storeId, true);
            } catch (NoSuchEntityException $e) {
                return $this;
            }
            $info = $orderItem->getProductOptionByCode('info_buyRequest');
            $info = new \Magento\Framework\DataObject($info);
            if ($qtyFlag === null) {
                $info->setQty($orderItem->getQtyOrdered());
            } else {
                $info->setQty(1);
            }

            $this->addProduct($product, $info);
        }
        return $this;
    }

addProduct()

addProduct	(		$productInfo,
			$requestInfo = null
	)

Add product to shopping cart (quote)

Parameters

int | Product	$productInfo
\Magento\Framework\DataObject | int | array	$requestInfo

Returns

$this

Exceptions

String we can get if prepare process has error

Implements CartInterface.

Definition at line 366 of file Cart.php.

    {
        $product = $this->_getProduct($productInfo);
        $request = $this->_getProductRequest($requestInfo);
        $productId = $product->getId();

        if ($productId) {
            $stockItem = $this->stockRegistry->getStockItem($productId, $product->getStore()->getWebsiteId());
            $minimumQty = $stockItem->getMinSaleQty();
            //If product quantity is not specified in request and there is set minimal qty for it
            if ($minimumQty
                && $minimumQty > 0
                && !$request->getQty()
            ) {
                $request->setQty($minimumQty);
            }

            try {
                $result = $this->getQuote()->addProduct($product, $request);
            } catch (\Magento\Framework\Exception\LocalizedException $e) {
                $this->_checkoutSession->setUseNotice(false);
                $result = $e->getMessage();
            }
            if (is_string($result)) {
                if ($product->hasOptionsValidationFail()) {
                    $redirectUrl = $product->getUrlModel()->getUrl(
                        $product,
                        ['_query' => ['startcustomization' => 1]]
                    );
                } else {
                    $redirectUrl = $product->getProductUrl();
                }
                $this->_checkoutSession->setRedirectUrl($redirectUrl);
                if ($this->_checkoutSession->getUseNotice() === null) {
                    $this->_checkoutSession->setUseNotice(true);
                }
                throw new \Magento\Framework\Exception\LocalizedException(__($result));
            }
        } else {
            throw new \Magento\Framework\Exception\LocalizedException(__('The product does not exist.'));
        }

        $this->_eventManager->dispatch(
            'checkout_cart_product_add_after',
            ['quote_item' => $result, 'product' => $product]
        );
        $this->_checkoutSession->setLastAddedProductId($productId);
        return $this;
    }

addProductsByIds()

addProductsByIds

(

$productIds

)

Adding products to cart by ids

Parameters

int[]

$productIds

Returns

$this

Definition at line 425 of file Cart.php.

    {
        $allAvailable = true;
        $allAdded = true;

        if (!empty($productIds)) {
            foreach ($productIds as $productId) {
                $productId = (int)$productId;
                if (!$productId) {
                    continue;
                }
                $product = $this->_getProduct($productId);
                if ($product->getId() && $product->isVisibleInCatalog()) {
                    try {
                        $this->getQuote()->addProduct($product);
                    } catch (\Exception $e) {
                        $allAdded = false;
                    }
                } else {
                    $allAvailable = false;
                }
            }

            if (!$allAvailable) {
                $this->messageManager->addErrorMessage(__("We don't have some of the products you want."));
            }
            if (!$allAdded) {
                $this->messageManager->addErrorMessage(__("We don't have as many of some products as you want."));
            }
        }
        return $this;
    }

getCheckoutSession()

getCheckoutSession

(

)

Retrieve checkout session model

Returns

Session @codeCoverageIgnore

Definition at line 165 of file Cart.php.

    {
        return $this->_checkoutSession;
    }

getCustomerSession()

getCustomerSession

(

)

Retrieve customer session model

Returns

\Magento\Customer\Model\Session @codeCoverageIgnore

Definition at line 176 of file Cart.php.

    {
        return $this->_customerSession;
    }

getItems()

getItems

(

)

List of shopping cart items

Returns

\Magento\Eav\Model\Entity\Collection\AbstractCollection|array

Definition at line 186 of file Cart.php.

    {
        if (!$this->getQuote()->getId()) {
            return [];
        }
        return $this->getQuote()->getItemsCollection();
    }

getItemsCount()

getItemsCount

(

)

Get shopping cart items count

Returns

int @codeCoverageIgnore

Definition at line 668 of file Cart.php.

    {
        return $this->getQuote()->getItemsCount() * 1;
    }

getItemsQty()

getItemsQty

(

)

Get shopping cart summary qty

Returns

int|float @codeCoverageIgnore

Definition at line 679 of file Cart.php.

    {
        return $this->getQuote()->getItemsQty() * 1;
    }

getProductIds()

getProductIds

(

)

Returns

int[]

Definition at line 621 of file Cart.php.

    {
        if (null === $this->_productIds) {
            $this->_productIds = [];
            if ($this->getSummaryQty() > 0) {
                foreach ($this->getQuote()->getAllItems() as $item) {
                    $this->_productIds[] = $item->getProductId();
                }
            }
            $this->_productIds = array_unique($this->_productIds);
        }
        return $this->_productIds;
    }

getQuote()

getQuote

(

)

Get quote object associated with cart. By default it is current customer session quote

Returns

\Magento\Quote\Model\Quote

Implements CartInterface.

Definition at line 217 of file Cart.php.

    {
        if (!$this->hasData('quote')) {
            $this->setData('quote', $this->_checkoutSession->getQuote());
        }
        return $this->_getData('quote');
    }

getQuoteProductIds()

getQuoteProductIds

(

)

Retrieve array of cart product ids

Returns

array

Definition at line 199 of file Cart.php.

    {
        $products = $this->getData('product_ids');
        if ($products === null) {
            $products = [];
            foreach ($this->getQuote()->getAllItems() as $item) {
                $products[$item->getProductId()] = $item->getProductId();
            }
            $this->setData('product_ids', $products);
        }
        return $products;
    }

getSummaryQty()

getSummaryQty

(

)

Get shopping cart items summary (includes config settings)

Returns

int|float

Definition at line 640 of file Cart.php.

    {
        $quoteId = $this->_checkoutSession->getQuoteId();

        //If there is no quote id in session trying to load quote
        //and get new quote id. This is done for cases when quote was created
        //not by customer (from backend for example).
        if (!$quoteId && $this->_customerSession->isLoggedIn()) {
            $this->_checkoutSession->getQuote();
            $quoteId = $this->_checkoutSession->getQuoteId();
        }

        if ($quoteId && $this->_summaryQty === null) {
            $useQty = $this->_scopeConfig->getValue(
                'checkout/cart_link/use_qty',
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            );
            $this->_summaryQty = $useQty ? $this->getItemsQty() : $this->getItemsCount();
        }
        return $this->_summaryQty;
    }

reinitializeState()

reinitializeState ( )

protected

Reinitialize cart quote state

Returns

$this

Definition at line 243 of file Cart.php.

    {
        $quote = $this->getQuote()->setCheckoutMethod('');
        $this->_checkoutSession->setCartWasUpdated(true);
        // TODO: Move this logic to Multishipping module as plug-in.
        // reset for multiple address checkout
        if ($this->_checkoutSession->getCheckoutState() !== Session::CHECKOUT_STATE_BEGIN
            && $this->_checkoutSession->getCheckoutState() !== null) {
            $quote->removeAllAddresses()->removePayment();
            $this->_checkoutSession->resetCheckout();
        }
        return $this;
    }

removeItem()

removeItem

(

$itemId

)

Remove item from cart

Parameters

int

$itemId

Returns

$this @codeCoverageIgnore

Definition at line 567 of file Cart.php.

    {
        $this->getQuote()->removeItem($itemId);
        return $this;
    }

save()

save

(

)

Save cart

Returns

$this

Cart save usually called after changes with cart items.

Definition at line 578 of file Cart.php.

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

        $this->getQuote()->getBillingAddress();
        $this->getQuote()->getShippingAddress()->setCollectShippingRates(true);
        $this->getQuote()->collectTotals();
        $this->quoteRepository->save($this->getQuote());
        $this->_checkoutSession->setQuoteId($this->getQuote()->getId());
        $this->_eventManager->dispatch('checkout_cart_save_after', ['cart' => $this]);
        $this->reinitializeState();
        return $this;
    }

saveQuote()

saveQuote

(

)

Save cart (implement interface method)

Returns

void @codeCoverageIgnore

Implements CartInterface.

Definition at line 601 of file Cart.php.

    {
        $this->save();
    }

setQuote()

setQuote

(

\Magento\Quote\Model\Quote

$quote

)

Set quote object associated with the cart

Parameters

\Magento\Quote\Model\Quote

$quote

Returns

$this @codeCoverageIgnore

Definition at line 232 of file Cart.php.

    {
        $this->setData('quote', $quote);
        return $this;
    }

suggestItemsQty()

suggestItemsQty

(

$data

)

Returns suggested quantities for items. Can be used to automatically fix user entered quantities before updating cart so that cart contains valid qty values

The $data is an array of ($quoteItemId => (item info array with 'qty' key), ...)

Parameters

array

$data

Returns

array

Definition at line 468 of file Cart.php.

    {
        foreach ($data as $itemId => $itemInfo) {
            if (!isset($itemInfo['qty'])) {
                continue;
            }
            $qty = (float)$itemInfo['qty'];
            if ($qty <= 0) {
                continue;
            }

            $quoteItem = $this->getQuote()->getItemById($itemId);
            if (!$quoteItem) {
                continue;
            }

            $product = $quoteItem->getProduct();
            if (!$product) {
                continue;
            }

            $data[$itemId]['before_suggest_qty'] = $qty;
            $data[$itemId]['qty'] = $this->stockState->suggestQty(
                $product->getId(),
                $qty,
                $product->getStore()->getWebsiteId()
            );
        }
        return $data;
    }

truncate()

truncate

(

)

Mark all quote items as deleted (empty shopping cart)

Returns

$this @codeCoverageIgnore

Definition at line 612 of file Cart.php.

    {
        $this->getQuote()->removeAllItems();
        return $this;
    }

updateItem()

updateItem	(		$itemId,
			$requestInfo = null,
			$updatingParams = null
	)

Update item in shopping cart (quote) $requestInfo - either qty (int) or buyRequest in form of array or \Magento\Framework\DataObject $updatingParams - information on how to perform update, passed to Quote->updateItem() method

Parameters

int	$itemId
int | array | \Magento\Framework\DataObject	$requestInfo
null | array | \Magento\Framework\DataObject	$updatingParams

Returns

\Magento\Quote\Model\Quote\Item|string

Exceptions

We can get string if updating process had some errors

Definition at line 698 of file Cart.php.

    {
        try {
            $item = $this->getQuote()->getItemById($itemId);
            if (!$item) {
                throw new \Magento\Framework\Exception\LocalizedException(__('This quote item does not exist.'));
            }
            $productId = $item->getProduct()->getId();
            $product = $this->_getProduct($productId);
            $request = $this->_getProductRequest($requestInfo);

            if ($productId) {
                $stockItem = $this->stockRegistry->getStockItem($productId, $product->getStore()->getWebsiteId());
                $minimumQty = $stockItem->getMinSaleQty();
                // If product was not found in cart and there is set minimal qty for it
                if ($minimumQty
                    && $minimumQty > 0
                    && !$request->getQty()
                    && !$this->getQuote()->hasProductId($productId)
                ) {
                    $request->setQty($minimumQty);
                }
            }

            $result = $this->getQuote()->updateItem($itemId, $request, $updatingParams);
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->_checkoutSession->setUseNotice(false);
            $result = $e->getMessage();
        }

        if (is_string($result)) {
            if ($this->_checkoutSession->getUseNotice() === null) {
                $this->_checkoutSession->setUseNotice(true);
            }
            throw new \Magento\Framework\Exception\LocalizedException(__($result));
        }

        $this->_eventManager->dispatch(
            'checkout_cart_product_update_after',
            ['quote_item' => $result, 'product' => $product]
        );
        $this->_checkoutSession->setLastAddedProductId($productId);
        return $result;
    }

updateItems()

updateItems

(

$data

)

Update cart items information

Parameters

array

$data

Returns

$this

Exceptions

Definition at line 508 of file Cart.php.

    {
        $infoDataObject = new \Magento\Framework\DataObject($data);
        $this->_eventManager->dispatch(
            'checkout_cart_update_items_before',
            ['cart' => $this, 'info' => $infoDataObject]
        );

        $qtyRecalculatedFlag = false;
        foreach ($data as $itemId => $itemInfo) {
            $item = $this->getQuote()->getItemById($itemId);
            if (!$item) {
                continue;
            }

            if (!empty($itemInfo['remove']) || isset($itemInfo['qty']) && $itemInfo['qty'] == '0') {
                $this->removeItem($itemId);
                continue;
            }

            $qty = isset($itemInfo['qty']) ? (double)$itemInfo['qty'] : false;
            if ($qty > 0) {
                $item->setQty($qty);

                if ($item->getHasError()) {
                    throw new \Magento\Framework\Exception\LocalizedException(__($item->getMessage()));
                }

                if (isset($itemInfo['before_suggest_qty']) && $itemInfo['before_suggest_qty'] != $qty) {
                    $qtyRecalculatedFlag = true;
                    $this->messageManager->addNoticeMessage(
                        __('Quantity was recalculated from %1 to %2', $itemInfo['before_suggest_qty'], $qty),
                        'quote_item' . $item->getId()
                    );
                }
            }
        }

        if ($qtyRecalculatedFlag) {
            $this->messageManager->addNoticeMessage(
                __('We adjusted product quantities to fit the required increments.')
            );
        }

        $this->_eventManager->dispatch(
            'checkout_cart_update_items_after',
            ['cart' => $this, 'info' => $infoDataObject]
        );

        return $this;
    }

Field Documentation

$_checkoutSession

$_checkoutSession

protected

Definition at line 67 of file Cart.php.

$_customerSession

$_customerSession

protected

Definition at line 72 of file Cart.php.

$_eventManager

$_eventManager

protected

Definition at line 45 of file Cart.php.

$_productIds

$_productIds

protected

Definition at line 38 of file Cart.php.

$_resourceCart

$_resourceCart

protected

Definition at line 62 of file Cart.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 52 of file Cart.php.

$_storeManager

$_storeManager

protected

Definition at line 57 of file Cart.php.

$_summaryQty

$_summaryQty

protected

Definition at line 31 of file Cart.php.

$messageManager

$messageManager

protected

Definition at line 77 of file Cart.php.

$productRepository

$productRepository

protected

Definition at line 97 of file Cart.php.

$quoteRepository

$quoteRepository

protected

Definition at line 92 of file Cart.php.

$stockRegistry

$stockRegistry

protected

Definition at line 82 of file Cart.php.

$stockState

$stockState

protected

Definition at line 87 of file Cart.php.

---

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

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