Mage_Checkout_Model_Cart Class Reference

Inheritance diagram for Mage_Checkout_Model_Cart:

List of all members.

Public Member Functions
	getCheckoutSession ()
	getCustomerSession ()
	getItems ()
	getQuoteProductIds ()
	getQuote ()
	init ()
	addOrderItem ($orderItem, $qtyFlag=null)
	addProduct ($product, $info=null)
	addProductsByIds ($productIds)
	updateItems ($data)
	removeItem ($itemId)
	save ()
	truncate ()
	getProductIds ()
	getSummaryQty ()
	getItemsCount ()
	getItemsQty ()
Protected Member Functions
	_getResource ()
	_getProduct ($productInfo)
	_getProductRequest ($requestInfo)
Protected Attributes
	$_summaryQty = null
	$_productIds = null

---

Detailed Description

Definition at line 34 of file Cart.php.

---

Member Function Documentation

_getProduct

(

$

productInfo

)

[protected]

Get product for product information

Parameters:

mixed

$productInfo

Returns:

Mage_Catalog_Model_Product

Definition at line 161 of file Cart.php.

    {
        if ($productInfo instanceof Mage_Catalog_Model_Product) {
            $product = $productInfo;
        }
        elseif (is_int($productInfo)) {
            $product = Mage::getModel('catalog/product')
                ->setStoreId(Mage::app()->getStore()->getId())
                ->load($productInfo);
        }
        else {

        }
        return $product;
    }

_getProductRequest

(

$

requestInfo

)

[protected]

Get request for product add to cart procedure

Parameters:

mixed

$requestInfo

Returns:

Varien_Object

Definition at line 183 of file Cart.php.

    {
        if ($requestInfo instanceof Varien_Object) {
            $request = $requestInfo;
        }
        elseif (is_numeric($requestInfo)) {
            $request = new Varien_Object();
            $request->setQty($requestInfo);
        }
        else {
            $request = new Varien_Object($requestInfo);
        }

        if (!$request->hasQty()) {
            $request->setQty(1);
        }
        return $request;
    }

_getResource

(

)

[protected]

Definition at line 39 of file Cart.php.

    {
        return Mage::getResourceSingleton('checkout/cart');
    }

addOrderItem	(	$	orderItem,
		$	qtyFlag = null
	)

Convert order item to quote item

Parameters:

	Mage_Sales_Model_Order_Item	$orderItem
	mixed	$qtyFlag if is null set product qty like in order

Returns:

Mage_Checkout_Model_Cart

Definition at line 131 of file Cart.php.

    {
        /* @var $orderItem Mage_Sales_Model_Order_Item */
        if (is_null($orderItem->getParentItem())) {
            $product = Mage::getModel('catalog/product')
                ->setStoreId(Mage::app()->getStore()->getId())
                ->load($orderItem->getProductId());
            if (!$product->getId()) {
                return $this;
            }

            $info = $orderItem->getProductOptionByCode('info_buyRequest');
            $info = new Varien_Object($info);
            if (is_null($qtyFlag)) {
                $info->setQty($orderItem->getQtyOrdered());
            } else {
                $info->setQty(1);
            }

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

addProduct	(	$	product,
		$	info = null
	)

Add product to shopping cart (quote)

Parameters:

	int	$productId
	int	$qty

Returns:

Mage_Checkout_Model_Cart

String we can get if prepare process has error

Definition at line 209 of file Cart.php.

    {
        $product = $this->_getProduct($product);
        $request = $this->_getProductRequest($info);


        if ($product->getId()) {

            $result = $this->getQuote()->addProduct($product, $request);

            /**
             * String we can get if prepare process has error
             */
            if (is_string($result)) {

                $this->getCheckoutSession()->setRedirectUrl($product->getProductUrl());
                if ($this->getCheckoutSession()->getUseNotice() === null) {
                    $this->getCheckoutSession()->setUseNotice(true);
                }
                Mage::throwException($result);
            }
        }
        else {
            Mage::throwException(Mage::helper('checkout')->__('Product does not exist'));
        }

        Mage::dispatchEvent('checkout_cart_product_add_after', array('quote_item'=>$result, 'product'=>$product));
        $this->getCheckoutSession()->setLastAddedProductId($product->getId());
        return $this;
    }

addProductsByIds

(

$

productIds

)

Adding products to cart by ids

Parameters:

array

$productIds

Returns:

Mage_Checkout_Model_Cart

Definition at line 246 of file Cart.php.

    {
        $allAvailable = true;
        $allAdded     = true;

        if (!empty($productIds)) {
            foreach ($productIds as $productId) {
                $productId = (int) $productId;
                if (!$productId) {
                    continue;
                }
                $product = Mage::getModel('catalog/product')
                    ->setStoreId(Mage::app()->getStore()->getId())
                    ->load($productId);
                if ($product->getId() && $product->isVisibleInCatalog()) {
                    try {
                        $this->getQuote()->addProduct($product);
                    }
                    catch (Exception $e){
                        $allAdded = false;
                    }
                }
                else {
                    $allAvailable = false;
                }
            }

            if (!$allAvailable) {
                $this->getCheckoutSession()->addError(
                    Mage::helper('checkout')->__('Some of the products you requested are unavailable')
                );
            }
            if (!$allAdded) {
                $this->getCheckoutSession()->addError(
                    Mage::helper('checkout')->__('Some of the products you requested are not available in the desired quantity')
                );
            }
        }
        return $this;
    }

getCheckoutSession

(

)

Retrieve checkout session model

Returns:

Mage_Checkout_Model_Session

Definition at line 49 of file Cart.php.

    {
        return Mage::getSingleton('checkout/session');
    }

getCustomerSession

(

)

Retrieve custome session model

Returns:

Mage_Customer_Model_Customer

Definition at line 59 of file Cart.php.

    {
        return Mage::getSingleton('customer/session');
    }

getItems

(

)

Definition at line 64 of file Cart.php.

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

getItemsCount

(

)

Get shopping cart items count

Returns:

int

Definition at line 508 of file Cart.php.

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

getItemsQty

(

)

Get shopping cart summary qty

Returns:

decimal

Definition at line 518 of file Cart.php.

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

getProductIds

(

)

Retrieve cart information for sidebar

Returns:

Varien_Object

Definition at line 460 of file Cart.php.

    {
        $quoteId = Mage::getSingleton('checkout/session')->getQuoteId();
        if (null === $this->_productIds) {
            $this->_productIds = array();
            if ($this->getSummaryQty()>0) {
               foreach ($this->getQuote()->getAllItems() as $item) {
                   $this->_productIds[] = $item->getProductId();
               }
            }
            $this->_productIds = array_unique($this->_productIds);
        }
        return $this->_productIds;
    }

getQuote

(

)

Retrieve current quote object

Returns:

Mage_Sales_Model_Quote

Definition at line 96 of file Cart.php.

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

getQuoteProductIds

(

)

Retrieve array of cart product ids

Returns:

array

Definition at line 77 of file Cart.php.

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

getSummaryQty

(

)

Get shopping cart items summary (inchlude config settings)

Returns:

decimal

Definition at line 480 of file Cart.php.

    {
        $quoteId = Mage::getSingleton('checkout/session')->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 && Mage::getSingleton('customer/session')->isLoggedIn()) {
            $quote = Mage::getSingleton('checkout/session')->getQuote();
            $quoteId = Mage::getSingleton('checkout/session')->getQuoteId();
        }

        if ($quoteId && $this->_summaryQty === null) {
            if (Mage::getStoreConfig('checkout/cart_link/use_qty')) {
                $this->_summaryQty = $this->getItemsQty();
            }
            else {
                $this->_summaryQty = $this->getItemsCount();
            }
        }
        return $this->_summaryQty;
    }

init

(

)

If user try do checkout, reset shipiing and payment data

Definition at line 101 of file Cart.php.

    {
        $this->getQuote()->setCheckoutMethod('');

        /**
         * If user try do checkout, reset shipiing and payment data
         */
        if ($this->getCheckoutSession()->getCheckoutState() !== Mage_Checkout_Model_Session::CHECKOUT_STATE_BEGIN) {
            $this->getQuote()
                ->removeAllAddresses()
                ->removePayment();
            $this->getCheckoutSession()->resetCheckout();
        }

        if (!$this->getQuote()->hasItems()) {
            $this->getQuote()->getShippingAddress()
                ->setCollectShippingRates(false)
                ->removeAllShippingRates();
        }

        return $this;
    }

removeItem

(

$

itemId

)

Remove item from cart

Parameters:

int

$itemId

Returns:

Mage_Checkout_Model_Cart

Definition at line 324 of file Cart.php.

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

save

(

)

Save cart

Returns:

Mage_Checkout_Model_Cart

Definition at line 335 of file Cart.php.

    {
        $this->getQuote()->getBillingAddress();
        $this->getQuote()->getShippingAddress()->setCollectShippingRates(true);
        $this->getQuote()->collectTotals();
        $this->getQuote()->save();
        $this->getCheckoutSession()->setQuoteId($this->getQuote()->getId());
        return $this;
    }

truncate

(

)

Definition at line 345 of file Cart.php.

    {
        foreach ($this->getQuote()->getItemsCollection() as $item) {
            $item->isDeleted(true);
        }
    }

updateItems

(

$

data

)

Update cart items information

Parameters:

array

$data

Returns:

Mage_Checkout_Model_Cart

Definition at line 293 of file Cart.php.

    {
        Mage::dispatchEvent('checkout_cart_update_items_before', array('cart'=>$this, 'info'=>$data));

        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']) ? (float) $itemInfo['qty'] : false;
            if ($qty > 0) {
                $item->setQty($qty);
            }
        }

        Mage::dispatchEvent('checkout_cart_update_items_after', array('cart'=>$this, 'info'=>$data));
        return $this;
    }

---

Member Data Documentation

$_productIds = null [protected]

Definition at line 37 of file Cart.php.

$_summaryQty = null [protected]

Definition at line 36 of file Cart.php.

---

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

• app/code/core/Mage/Checkout/Model/Cart.php