Mage_Sales_Model_Quote Class Reference

Inheritance diagram for Mage_Sales_Model_Quote:

List of all members.

Public Member Functions
	getStoreId ()
	getStore ()
	setStore (Mage_Core_Model_Store $store)
	getSharedStoreIds ()
	loadByCustomer ($customer)
	assignCustomer (Mage_Customer_Model_Customer $customer)
	setCustomer (Mage_Customer_Model_Customer $customer)
	getCustomer ()
	getCustomerTaxClassId ()
	getCheckoutMethod ($originalMethod=false)
	getAddressesCollection ()
	getBillingAddress ()
	getShippingAddress ()
	getAllShippingAddresses ()
	getAllAddresses ()
	getAddressById ($addressId)
	getAddressByCustomerAddressId ($addressId)
	getShippingAddressByCustomerAddressId ($addressId)
	removeAddress ($addressId)
	removeAllAddresses ()
	addAddress (Mage_Sales_Model_Quote_Address $address)
	setBillingAddress (Mage_Sales_Model_Quote_Address $address)
	setShippingAddress (Mage_Sales_Model_Quote_Address $address)
	addShippingAddress (Mage_Sales_Model_Quote_Address $address)
	getItemsCollection ($useCache=true)
	getAllItems ()
	getAllVisibleItems ()
	hasItems ()
	hasItemsWithDecimalQty ()
	getItemById ($itemId)
	removeItem ($itemId)
	addItem (Mage_Sales_Model_Quote_Item $item)
	addProduct (Mage_Catalog_Model_Product $product, $request=null)
	getItemByProduct ($product)
	getItemsSummaryQty ()
	getItemVirtualQty ()
	getPaymentsCollection ()
	getPayment ()
	getPaymentById ($paymentId)
	addPayment (Mage_Sales_Model_Quote_Payment $payment)
	setPayment (Mage_Sales_Model_Quote_Payment $payment)
	removePayment ()
	collectTotals ()
	getTotals ()
	addMessage ($message, $index='error')
	getMessages ()
	reserveOrderId ()
	validateMinimumAmount ($multishipping=false)
	isVirtual ()
	getIsVirtual ()
	hasVirtualItems ()
	isAllowedGuestCheckout ()
	merge (Mage_Sales_Model_Quote $quote)
Public Attributes
const	CHECKOUT_METHOD_REGISTER = 'register'
const	CHECKOUT_METHOD_GUEST = 'guest'
const	CHECKOUT_METHOD_LOGIN_IN = 'login_in'
Protected Member Functions
	_construct ()
	_beforeSave ()
	_afterSave ()
	_getAddressByType ($type)
	_addCatalogProduct (Mage_Catalog_Model_Product $product, $qty=1)
	_validateCouponCode ()
	_afterLoad ()
Protected Attributes
	$_eventPrefix = 'sales_quote'
	$_eventObject = 'quote'
	$_customer
	$_addresses = null
	$_items = null
	$_payments = null

---

Detailed Description

Quote model

Supported events: sales_quote_load_after sales_quote_save_before sales_quote_save_after sales_quote_delete_before sales_quote_delete_after

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 39 of file Quote.php.

---

Member Function Documentation

_addCatalogProduct	(	Mage_Catalog_Model_Product $	product,
		$	qty = 1
	)			[protected]

Adding catalog product object data to quote

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

Mage_Sales_Model_Quote_Item

We can't modify existing child items

Definition at line 729 of file Quote.php.

    {

        $item = $this->getItemByProduct($product);
        if (!$item) {
            $item = Mage::getModel('sales/quote_item');
            $item->setQuote($this);
        }

        /**
         * We can't modify existing child items
         */
        if ($item->getId() && $product->getParentProductId()) {
            return $item;
        }

        $item->setOptions($product->getCustomOptions())
            ->setProduct($product);

        $this->addItem($item);

        return $item;
    }

_afterLoad

(

)

[protected]

Trigger collect totals after loading, if required

Returns:

Mage_Sales_Model_Quote

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 1213 of file Quote.php.

    {
        // collect totals and save me, if required
        if (1 == $this->getData('trigger_recollect')) {
            $this->collectTotals()->save();
        }
        return parent::_afterLoad();
    }

_afterSave

(

)

[protected]

Save related items

Returns:

Mage_Sales_Model_Quote

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 205 of file Quote.php.

    {
        parent::_afterSave();

        if (null !== $this->_addresses) {
            $this->getAddressesCollection()->save();
        }

        if (null !== $this->_items) {
            $this->getItemsCollection()->save();
        }

        if (null !== $this->_payments) {
            $this->getPaymentsCollection()->save();
        }
        return $this;
    }

_beforeSave

(

)

[protected]

Prepare data before save

Returns:

Mage_Sales_Model_Quote

Currency logic

global - currency which is set for default in backend base - currency which is set for current website. all attributes that have 'base_' prefix saved in this currency store - all the time it was currency of website and all attributes with 'base_' were saved in this currency. From now on it is deprecated and will be duplication of base currency code. quote/order - currency which was selected by customer or configured by admin for current store. currency in which customer sees price thought all checkout.

Rates: store_to_base & store_to_quote/store_to_order - are deprecated base_to_global & base_to_quote/base_to_order - must be used instead

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 150 of file Quote.php.

    {
        /**
         * Currency logic
         *
         * global - currency which is set for default in backend
         * base - currency which is set for current website. all attributes that
         *      have 'base_' prefix saved in this currency
         * store - all the time it was currency of website and all attributes
         *      with 'base_' were saved in this currency. From now on it is
         *      deprecated and will be duplication of base currency code.
         * quote/order - currency which was selected by customer or configured by
         *      admin for current store. currency in which customer sees
         *      price thought all checkout.
         *
         * Rates:
         *      store_to_base & store_to_quote/store_to_order - are deprecated
         *      base_to_global & base_to_quote/base_to_order - must be used instead
         */

        $globalCurrencyCode  = Mage::app()->getBaseCurrencyCode();
        $baseCurrency = $this->getStore()->getBaseCurrency();

        if ($this->hasForcedCurrency()){
            $quoteCurrency = $this->getForcedCurrency();
        } else {
            $quoteCurrency = $this->getStore()->getCurrentCurrency();
        }

        $this->setGlobalCurrencyCode($globalCurrencyCode);
        $this->setBaseCurrencyCode($baseCurrency->getCode());
        $this->setStoreCurrencyCode($baseCurrency->getCode());
        $this->setQuoteCurrencyCode($quoteCurrency->getCode());

        //deprecated, read above
        $this->setStoreToBaseRate($baseCurrency->getRate($globalCurrencyCode));
        $this->setStoreToQuoteRate($baseCurrency->getRate($quoteCurrency));

        $this->setBaseToGlobalRate($baseCurrency->getRate($globalCurrencyCode));
        $this->setBaseToQuoteRate($baseCurrency->getRate($quoteCurrency));

        if (!$this->hasChangedFlag() || $this->getChangedFlag() == true) {
            $this->setIsChanged(1);
        } else {
            $this->setIsChanged(0);
        }

        parent::_beforeSave();
    }

_construct

(

)

[protected]

Init resource model

Reimplemented from Varien_Object.

Definition at line 88 of file Quote.php.

    {
        $this->_init('sales/quote');
    }

_getAddressByType

(

$

type

)

[protected]

Retrieve quote address by type

Parameters:

string

$type

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 359 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            if ($address->getAddressType() == $type && !$address->isDeleted()) {
                return $address;
            }
        }

        $address = Mage::getModel('sales/quote_address')->setAddressType($type);
        $this->addAddress($address);
        return $address;
    }

_validateCouponCode

(

)

[protected]

Definition at line 1188 of file Quote.php.

    {
        $code = $this->_getData('coupon_code');
        if ($code) {
            $addressHasCoupon = false;
            $addresses = $this->getAllAddresses();
            if (count($addresses)>0) {
                foreach ($addresses as $address) {
                    if ($address->hasCouponCode()) {
                        $addressHasCoupon = true;
                    }
                }
                if (!$addressHasCoupon) {
                    $this->setCouponCode('');
                }
            }
        }
        return $this;
    }

addAddress

(

Mage_Sales_Model_Quote_Address $

address

)

Definition at line 470 of file Quote.php.

    {
        $address->setQuote($this);
        if (!$address->getId()) {
            $this->getAddressesCollection()->addItem($address);
        }
        return $this;
    }

addItem

(

Mage_Sales_Model_Quote_Item $

item

)

Adding new item to quote

Parameters:

Mage_Sales_Model_Quote_Item

$item

Returns:

Mage_Sales_Model_Quote

Definition at line 640 of file Quote.php.

    {
        $item->setQuote($this);
        if (!$item->getId()) {
            $this->getItemsCollection()->addItem($item);
            Mage::dispatchEvent('sales_quote_add_item', array('quote_item' => $item));
        }
        return $this;
    }

addMessage	(	$	message,
		$	index = 'error'
	)

Definition at line 997 of file Quote.php.

    {
        $messages = $this->getData('messages');
        if (is_null($messages)) {
            $messages = array();
        }

        if (isset($messages[$index])) {
            return $this;
        }

        if (is_string($message)) {
            $message = Mage::getSingleton('core/message')->error($message);
        }

        $messages[$index] = $message;
        $this->setData('messages', $messages);
        return $this;
    }

addPayment

(

Mage_Sales_Model_Quote_Payment $

payment

)

Definition at line 860 of file Quote.php.

    {
        $payment->setQuote($this);
        if (!$payment->getId()) {
            $this->getPaymentsCollection()->addItem($payment);
        }
        return $this;
    }

addProduct	(	Mage_Catalog_Model_Product $	product,
		$	request = null
	)

Add product to quote

return error message if product type instance can't prepare product

Parameters:

mixed

$product

Returns:

Mage_Sales_Model_Quote_Item || string

Error message

If prepare process return one object

As parent item we should always use the item of first added product

We specify qty after we know about parent (for stock)

Definition at line 658 of file Quote.php.

    {

        if ($request === null) {
            $request = 1;
        }
        if (is_numeric($request)) {
            $request = new Varien_Object(array('qty'=>$request));
        }
        if (!($request instanceof Varien_Object)) {
            Mage::throwException(Mage::helper('sales')->__('Invalid request for adding product to quote'));
        }

        $cartCandidates = $product->getTypeInstance(true)
            ->prepareForCart($request, $product);

        /**
         * Error message
         */

        if (is_string($cartCandidates)) {
            return $cartCandidates;
        }

        /**
         * If prepare process return one object
         */
        if (!is_array($cartCandidates)) {
            $cartCandidates = array($cartCandidates);
        }




        $parentItem = null;
        $errors = array();
        foreach ($cartCandidates as $candidate) {
            $item = $this->_addCatalogProduct($candidate, $candidate->getCartQty());

            /**
             * As parent item we should always use the item of first added product
             */
            if (!$parentItem) {
                $parentItem = $item;
            }
            if ($parentItem && $candidate->getParentProductId()) {
                $item->setParentItem($parentItem);
            }

            /**
             * We specify qty after we know about parent (for stock)
             */
            $item->addQty($candidate->getCartQty());

            // collect errors instead of throwing first one
            if ($item->getHasError()) {
                $errors[] = $item->getMessage();
            }
        }
        if (!empty($errors)) {
            Mage::throwException(implode("\n", $errors));
        }
        return $item;
    }

addShippingAddress

(

Mage_Sales_Model_Quote_Address $

address

)

Definition at line 520 of file Quote.php.

    {
        $this->setShippingAddress($address);
        return $this;
    }

assignCustomer

(

Mage_Customer_Model_Customer $

customer

)

Assign customer model object data to quote

Parameters:

Mage_Customer_Model_Customer

$customer

Returns:

Mage_Sales_Model_Quote

Definition at line 248 of file Quote.php.

    {
        if ($customer->getId()) {
            $this->setCustomer($customer);

            $defaultBillingAddress = $customer->getDefaultBillingAddress();
            if ($defaultBillingAddress && $defaultBillingAddress->getId()) {
                $billingAddress = Mage::getModel('sales/quote_address')
                    ->importCustomerAddress($defaultBillingAddress);
                $this->setBillingAddress($billingAddress);
            }

            $defaultShippingAddress= $customer->getDefaultShippingAddress();
            if ($defaultShippingAddress && $defaultShippingAddress->getId()) {
                $shippingAddress = Mage::getModel('sales/quote_address')
                ->importCustomerAddress($defaultShippingAddress);
            }
            else {
                $shippingAddress = Mage::getModel('sales/quote_address');
            }
            $this->setShippingAddress($shippingAddress);
        }

        return $this;
    }

collectTotals

(

)

Collect totals

Returns:

Mage_Sales_Model_Quote

Definition at line 890 of file Quote.php.

    {
        Mage::dispatchEvent(
            $this->_eventPrefix . '_collect_totals_before',
            array(
                $this->_eventObject=>$this
            )
        );

        $this->setSubtotal(0);
        $this->setBaseSubtotal(0);

        $this->setSubtotalWithDiscount(0);
        $this->setBaseSubtotalWithDiscount(0);

        $this->setGrandTotal(0);
        $this->setBaseGrandTotal(0);

        foreach ($this->getAllAddresses() as $address) {
            $address->setSubtotal(0);
            $address->setBaseSubtotal(0);

            $address->setSubtotalWithDiscount(0);
            $address->setBaseSubtotalWithDiscount(0);

            $address->setGrandTotal(0);
            $address->setBaseGrandTotal(0);

            $address->collectTotals();

            $this->setSubtotal((float) $this->getSubtotal()+$address->getSubtotal());
            $this->setBaseSubtotal((float) $this->getBaseSubtotal()+$address->getBaseSubtotal());

            $this->setSubtotalWithDiscount((float) $this->getSubtotalWithDiscount()+$address->getSubtotalWithDiscount());
            $this->setBaseSubtotalWithDiscount((float) $this->getBaseSubtotalWithDiscount()+$address->getBaseSubtotalWithDiscount());

            $this->setGrandTotal((float) $this->getGrandTotal()+$address->getGrandTotal());
            $this->setBaseGrandTotal((float) $this->getBaseGrandTotal()+$address->getBaseGrandTotal());
        }

        Mage::helper('sales')->checkQuoteAmount($this, $this->getGrandTotal());
        Mage::helper('sales')->checkQuoteAmount($this, $this->getBaseGrandTotal());

        $this->setItemsCount(0);
        $this->setItemsQty(0);
        $this->setVirtualItemsQty(0);

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

            if (($children = $item->getChildren()) && $item->isShipSeparately()) {
                foreach ($children as $child) {
                    if ($child->getProduct()->getIsVirtual()) {
                        $this->setVirtualItemsQty($this->getVirtualItemsQty() + $child->getQty()*$item->getQty());
                    }
                }
            }

            if ($item->getProduct()->getIsVirtual()) {
                $this->setVirtualItemsQty($this->getVirtualItemsQty() + $item->getQty());
            }
            $this->setItemsCount($this->getItemsCount()+1);
            $this->setItemsQty((float) $this->getItemsQty()+$item->getQty());
        }

        $this->setData('trigger_recollect', 0);
        $this->_validateCouponCode();

        Mage::dispatchEvent(
            $this->_eventPrefix . '_collect_totals_after',
            array(
                $this->_eventObject=>$this
            )
        );

        return $this;
    }

getAddressByCustomerAddressId

(

$

addressId

)

Definition at line 430 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            if (!$address->isDeleted() && $address->getCustomerAddressId()==$addressId) {
                return $address;
            }
        }
        return false;
    }

getAddressById

(

$

addressId

)

Parameters:

int

$addressId

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 420 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            if ($address->getId()==$addressId) {
                return $address;
            }
        }
        return false;
    }

getAddressesCollection

(

)

Retrieve quote address collection

Returns:

Mage_Eav_Model_Entity_Collection_Abstract

Definition at line 338 of file Quote.php.

    {
        if (is_null($this->_addresses)) {
            $this->_addresses = Mage::getModel('sales/quote_address')->getCollection()
                ->setQuoteFilter($this->getId());

            if ($this->getId()) {
                foreach ($this->_addresses as $address) {
                    $address->setQuote($this);
                }
            }
        }
        return $this->_addresses;
    }

getAllAddresses

(

)

Definition at line 404 of file Quote.php.

    {
        $addresses = array();
        foreach ($this->getAddressesCollection() as $address) {
            if (!$address->isDeleted()) {
                $addresses[] = $address;
            }
        }
        return $addresses;
    }

getAllItems

(

)

Retrieve quote items array

Returns:

array

Definition at line 546 of file Quote.php.

    {
        $items = array();
        foreach ($this->getItemsCollection() as $item) {
            if (!$item->isDeleted()) {
                $items[] =  $item;
            }
        }
        return $items;
    }

getAllShippingAddresses

(

)

Definition at line 392 of file Quote.php.

    {
        $addresses = array();
        foreach ($this->getAddressesCollection() as $address) {
            if ($address->getAddressType()==Mage_Sales_Model_Quote_Address::TYPE_SHIPPING
                && !$address->isDeleted()) {
                $addresses[] = $address;
            }
        }
        return $addresses;
    }

getAllVisibleItems

(

)

Get array of all items what can be display directly

Returns:

array

Definition at line 562 of file Quote.php.

    {
        $items = array();
        foreach ($this->getItemsCollection() as $item) {
            if (!$item->isDeleted() && !$item->getParentItemId()) {
                $items[] =  $item;
            }
        }
        return $items;
    }

getBillingAddress

(

)

Retrieve quote billing address

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 377 of file Quote.php.

    {
        return $this->_getAddressByType(Mage_Sales_Model_Quote_Address::TYPE_BILLING);
    }

getCheckoutMethod

(

$

originalMethod = false

)

Return quote checkout method code

Parameters:

boolean

$originalMethod if true return defined method from begining

Returns:

string

Definition at line 325 of file Quote.php.

    {
        if ($this->getCustomerId() && !$originalMethod) {
            return self::CHECKOUT_METHOD_LOGIN_IN;
        }
        return $this->_getData('checkout_method');
    }

getCustomer

(

)

Retrieve customer model object

Returns:

Mage_Customer_Model_Customer

Definition at line 292 of file Quote.php.

    {
        if (is_null($this->_customer)) {
            $this->_customer = Mage::getModel('customer/customer');
            if ($customerId = $this->getCustomerId()) {
                $this->_customer->load($customerId);
                if (!$this->_customer->getId()) {
                    $this->_customer->setCustomerId(null);
                }
            }
        }
        return $this->_customer;
    }

getCustomerTaxClassId

(

)

Definition at line 306 of file Quote.php.

    {
        /*
        * tax class can vary at any time. so instead of using the value from session, we need to retrieve from db everytime
        * to get the correct tax class
        */
        //if (!$this->getData('customer_group_id') && !$this->getData('customer_tax_class_id')) {
            $classId = Mage::getModel('customer/group')->getTaxClassId($this->getCustomerGroupId());
            $this->setCustomerTaxClassId($classId);
        //}
        return $this->getData('customer_tax_class_id');
    }

getIsVirtual

(

)

Check quote for virtual product only

Returns:

bool

Definition at line 1100 of file Quote.php.

    {
        return intval($this->isVirtual());
    }

getItemById

(

$

itemId

)

Retrieve item model object by item identifier

Parameters:

int

$itemId

Returns:

Mage_Sales_Model_Quote_Item

Definition at line 605 of file Quote.php.

    {
        return $this->getItemsCollection()->getItemById($itemId);
    }

getItemByProduct

(

$

product

)

Retrieve quote item by product id

Parameters:

int

$productId

Returns:

Mage_Sales_Model_Quote_Item || false

Definition at line 759 of file Quote.php.

    {
        foreach ($this->getAllItems() as $item) {
            if ($item->representProduct($product)) {
                return $item;
            }
        }
        return false;
    }

getItemsCollection

(

$

useCache = true

)

Retrieve quote items collection

Parameters:

bool

$loaded

Returns:

Mage_Eav_Model_Entity_Collection_Abstract

Definition at line 532 of file Quote.php.

    {
        if (is_null($this->_items)) {
            $this->_items = Mage::getModel('sales/quote_item')->getCollection();
            $this->_items->setQuote($this);
        }
        return $this->_items;
    }

getItemsSummaryQty

(

)

Definition at line 769 of file Quote.php.

    {
        $qty = $this->getData('all_items_qty');
        if (is_null($qty)) {
            $qty = 0;
            foreach ($this->getAllItems() as $item) {
                if ($item->getParentItem()) {
                    continue;
                }

                if (($children = $item->getChildren()) && $item->isShipSeparately()) {
                    foreach ($children as $child) {
                        $qty+= $child->getQty()*$item->getQty();
                    }
                } else {
                    $qty+= $item->getQty();
                }
            }
            $this->setData('all_items_qty', $qty);
        }
        return $qty;
    }

getItemVirtualQty

(

)

Definition at line 792 of file Quote.php.

    {
        $qty = $this->getData('virtual_items_qty');
        if (is_null($qty)) {
            $qty = 0;
            foreach ($this->getAllItems() as $item) {
                if ($item->getParentItem()) {
                    continue;
                }

                if (($children = $item->getChildren()) && $item->isShipSeparately()) {
                    foreach ($children as $child) {
                        if ($child->getProduct()->getIsVirtual()) {
                            $qty+= $child->getQty();
                        }
                    }
                } else {
                    if ($item->getProduct()->getIsVirtual()) {
                        $qty+= $item->getQty();
                    }
                }
            }
            $this->setData('virtual_items_qty', $qty);
        }
        return $qty;
    }

getMessages

(

)

Definition at line 1017 of file Quote.php.

    {
        $messages = $this->getData('messages');
        if (is_null($messages)) {
            $messages = array();
            $this->setData('messages', $messages);
        }
        return $messages;
    }

getPayment

(

)

Returns:

Mage_Sales_Model_Quote_Payment

Definition at line 838 of file Quote.php.

    {
        foreach ($this->getPaymentsCollection() as $payment) {
            if (!$payment->isDeleted()) {
                return $payment;
            }
        }
        $payment = Mage::getModel('sales/quote_payment');
        $this->addPayment($payment);
        return $payment;
    }

getPaymentById

(

$

paymentId

)

Definition at line 850 of file Quote.php.

    {
        foreach ($this->getPaymentsCollection() as $payment) {
            if ($payment->getId()==$paymentId) {
                return $payment;
            }
        }
        return false;
    }

getPaymentsCollection

(

)

Definition at line 820 of file Quote.php.

    {
        if (is_null($this->_payments)) {
            $this->_payments = Mage::getModel('sales/quote_payment')->getCollection()
                ->setQuoteFilter($this->getId());

            if ($this->getId()) {
                foreach ($this->_payments as $payment) {
                    $payment->setQuote($this);
                }
            }
        }
        return $this->_payments;
    }

getSharedStoreIds

(

)

Get all available store ids for quote

Returns:

array

Definition at line 133 of file Quote.php.

    {
        $ids = $this->_getData('shared_store_ids');
        if (is_null($ids) || !is_array($ids)) {
            if ($website = $this->getWebsite()) {
                return $website->getStoreIds();
            }
            return $this->getStore()->getWebsite()->getStoreIds();
        }
        return $ids;
    }

getShippingAddress

(

)

retrieve quote shipping address

Returns:

Mage_Sales_Model_Quote_Address

Definition at line 387 of file Quote.php.

    {
        return $this->_getAddressByType(Mage_Sales_Model_Quote_Address::TYPE_SHIPPING);
    }

getShippingAddressByCustomerAddressId

(

$

addressId

)

Definition at line 440 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            if (!$address->isDeleted() && $address->getAddressType()==Mage_Sales_Model_Quote_Address::TYPE_SHIPPING
                && $address->getCustomerAddressId()==$addressId) {
                return $address;
            }
        }
        return false;
    }

getStore

(

)

Get quote store model object

Returns:

Mage_Core_Model_Store

Definition at line 111 of file Quote.php.

    {
        return Mage::app()->getStore($this->getStoreId());
    }

getStoreId

(

)

Get quote store identifier

Returns:

int

Definition at line 98 of file Quote.php.

    {
        if (!$this->hasStoreId()) {
            return Mage::app()->getStore()->getId();
        }
        return $this->_getData('store_id');
    }

getTotals

(

)

Get all quote totals (sorted by priority)

Returns:

array

Definition at line 975 of file Quote.php.

    {
        $totals = $this->getShippingAddress()->getTotals();
        foreach ($this->getBillingAddress()->getTotals() as $code => $total) {
            if (isset($totals[$code])) {
                $totals[$code]->setValue($totals[$code]->getValue()+$total->getValue());
            }
            else {
                $totals[$code] = $total;
            }
        }

        $sortedTotals = array();
        foreach ($this->getBillingAddress()->getTotalModels() as $total) {
            /* @var $total Mage_Sales_Model_Quote_Address_Total_Abstract */
            if (isset($totals[$total->getCode()])) {
                $sortedTotals[$total->getCode()] = $totals[$total->getCode()];
            }
        }
        return $sortedTotals;
    }

hasItems

(

)

Checking items availability

Returns:

bool

Definition at line 578 of file Quote.php.

    {
        return sizeof($this->getAllItems())>0;
    }

hasItemsWithDecimalQty

(

)

Checking availability of items with decimal qty

Returns:

bool

Definition at line 588 of file Quote.php.

    {
        foreach ($this->getAllItems() as $item) {
            if ($item->getProduct()->getStockItem()
                && $item->getProduct()->getStockItem()->getIsQtyDecimal()) {
                return true;
            }
        }
        return false;
    }

hasVirtualItems

(

)

Has a virtual products on quote

Returns:

bool

Definition at line 1110 of file Quote.php.

    {
        $hasVirtual = false;
        foreach ($this->getItemsCollection() as $_item) {
            if ($_item->getParentItemId()) {
                continue;
            }
            if ($_item->getProduct()->isVirtual()) {
                $hasVirtual = true;
            }
        }
        return $hasVirtual;
    }

isAllowedGuestCheckout

(

)

Check is allow Guest Checkout

Returns:

bool

Definition at line 1129 of file Quote.php.

    {
        return Mage::helper('checkout')->isAllowedGuestCheckout($this, $this->getStoreId());
    }

isVirtual

(

)

Check quote for virtual product only

Returns:

bool

Definition at line 1078 of file Quote.php.

    {
        $isVirtual = true;
        $countItems = 0;
        foreach ($this->getItemsCollection() as $_item) {
            /* @var $_item Mage_Sales_Model_Quote_Item */
            if ($_item->isDeleted() || $_item->getParentItemId()) {
                continue;
            }
            $countItems ++;
            if (!$_item->getProduct()->getIsVirtual()) {
                $isVirtual = false;
            }
        }
        return $countItems == 0 ? false : $isVirtual;
    }

loadByCustomer

(

$

customer

)

Loading quote data by customer

Returns:

Mage_Sales_Model_Quote

Definition at line 228 of file Quote.php.

    {
        if ($customer instanceof Mage_Customer_Model_Customer) {
            $customerId = $customer->getId();
            $this->setStoreId($customer->getStoreId());
        }
        else {
            $customerId = (int) $customer;
        }
        $this->_getResource()->loadByCustomerId($this, $customerId);
        $this->_afterLoad();
        return $this;
    }

merge

(

Mage_Sales_Model_Quote $

quote

)

Merge quotes

Parameters:

Mage_Sales_Model_Quote

$quote

Returns:

Mage_Sales_Model_Quote

Definition at line 1140 of file Quote.php.

    {
        Mage::dispatchEvent(
            $this->_eventPrefix . '_merge_before',
            array(
                $this->_eventObject=>$this,
                'source'=>$quote
            )
        );

        foreach ($quote->getAllVisibleItems() as $item) {
            $found = false;
            foreach ($this->getAllItems() as $quoteItem) {
                if ($quoteItem->compare($item)) {
                    $quoteItem->setQty($quoteItem->getQty() + $item->getQty());
                    $found = true;
                    break;
                }
            }

            if (!$found) {
                $newItem = clone $item;
                $this->addItem($newItem);
                if ($item->getHasChildren()) {
                    foreach ($item->getChildren() as $child) {
                        $newChild = clone $child;
                        $newChild->setParentItem($newItem);
                        $this->addItem($newChild);
                    }
                }
            }
        }

        if ($quote->getCouponCode()) {
            $this->setCouponCode($quote->getCouponCode());
        }

        Mage::dispatchEvent(
            $this->_eventPrefix . '_merge_after',
            array(
                $this->_eventObject=>$this,
                'source'=>$quote
            )
        );

        return $this;
    }

removeAddress

(

$

addressId

)

Definition at line 451 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            if ($address->getId()==$addressId) {
                $address->isDeleted(true);
                break;
            }
        }
        return $this;
    }

removeAllAddresses

(

)

Definition at line 462 of file Quote.php.

    {
        foreach ($this->getAddressesCollection() as $address) {
            $address->isDeleted(true);
        }
        return $this;
    }

removeItem

(

$

itemId

)

Remove quote item by item identifier

Parameters:

int

$itemId

Returns:

Mage_Sales_Model_Quote

If we remove item from quote - we can't use multishipping mode

Definition at line 616 of file Quote.php.

    {
        if ($item = $this->getItemById($itemId)) {
            /**
             * If we remove item from quote - we can't use multishipping mode
             */
            $this->setIsMultiShipping(false);
            $item->isDeleted(true);
            if ($item->getHasChildren()) {
                foreach ($item->getChildren() as $child) {
                    $child->isDeleted(true);
                }
            }
            Mage::dispatchEvent('sales_quote_remove_item', array('quote_item' => $item));
        }
        return $this;
    }

removePayment

(

)

Definition at line 879 of file Quote.php.

    {
        $this->getPayment()->isDeleted(true);
        return $this;
    }

reserveOrderId

(

)

Definition at line 1027 of file Quote.php.

    {
        if (!$this->getReservedOrderId()) {
            $this->setReservedOrderId($this->_getResource()->getReservedOrderId($this));
        } else {
            //checking if reserved order id was already used for some order
            //if yes reserving new one if not using old one
            if ($this->_getResource()->isOrderIncrementIdUsed($this->getReservedOrderId())) {
                $this->setReservedOrderId($this->_getResource()->getReservedOrderId($this));
            }
        }
        return $this;
    }

setBillingAddress

(

Mage_Sales_Model_Quote_Address $

address

)

Enter description here...

Parameters:

Mage_Sales_Model_Quote_Address

$address

Returns:

Mage_Sales_Model_Quote

Definition at line 485 of file Quote.php.

    {
        $old = $this->getBillingAddress();

        if (!empty($old)) {
            $old->addData($address->getData());
        } else {
            $this->addAddress($address->setAddressType(Mage_Sales_Model_Quote_Address::TYPE_BILLING));
        }
        return $this;
    }

setCustomer

(

Mage_Customer_Model_Customer $

customer

)

Define customer object

Parameters:

Mage_Customer_Model_Customer

$customer

Returns:

Mage_Sales_Model_Quote

Definition at line 280 of file Quote.php.

    {
        $this->_customer = $customer;
        Mage::helper('core')->copyFieldset('customer_account', 'to_quote', $customer, $this);
        return $this;
    }

setPayment

(

Mage_Sales_Model_Quote_Payment $

payment

)

Definition at line 869 of file Quote.php.

    {
        if (!$this->getIsMultiPayment() && ($old = $this->getPayment())) {
            $payment->setId($old->getId());
        }
        $this->addPayment($payment);

        return $payment;
    }

setShippingAddress

(

Mage_Sales_Model_Quote_Address $

address

)

Enter description here...

Parameters:

Mage_Sales_Model_Quote_Address

$address

Returns:

Mage_Sales_Model_Quote

Definition at line 503 of file Quote.php.

    {
        if ($this->getIsMultiShipping()) {
            $this->addAddress($address->setAddressType(Mage_Sales_Model_Quote_Address::TYPE_SHIPPING));
        }
        else {
            $old = $this->getShippingAddress();

            if (!empty($old)) {
                $old->addData($address->getData());
            } else {
                $this->addAddress($address->setAddressType(Mage_Sales_Model_Quote_Address::TYPE_SHIPPING));
            }
        }
        return $this;
    }

setStore

(

Mage_Core_Model_Store $

store

)

Declare quote store model

Parameters:

Mage_Core_Model_Store

$store

Returns:

Mage_Sales_Model_Quote

Definition at line 122 of file Quote.php.

    {
        $this->setStoreId($store->getId());
        return $this;
    }

validateMinimumAmount

(

$

multishipping = false

)

Definition at line 1041 of file Quote.php.

    {
        $storeId = $this->getStoreId();
        $minOrderActive = Mage::getStoreConfigFlag('sales/minimum_order/active', $storeId);
        $minOrderMulti  = Mage::getStoreConfigFlag('sales/minimum_order/multi_address', $storeId);

        if (!$minOrderActive) {
            return true;
        }

        if ($multishipping && !$minOrderMulti) {
            $baseTotal = 0;
            foreach ($this->getAllAddresses() as $address) {
                /* @var $address Mage_Sales_Model_Quote_Address */
                $baseTotal += $address->getBaseSubtotalWithDiscount();
            }

            if ($baseTotal < Mage::getStoreConfig('sales/minimum_order/amount', $storeId)) {
                return false;
            }
        }
        else {
            foreach ($this->getAllAddresses() as $address) {
                /* @var $address Mage_Sales_Model_Quote_Address */
                if (!$address->validateMinimumAmount()) {
                    return false;
                }
            }
        }
        return true;
    }

---

Member Data Documentation

$_addresses = null [protected]

Definition at line 69 of file Quote.php.

$_customer [protected]

Definition at line 62 of file Quote.php.

$_eventObject = 'quote' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 55 of file Quote.php.

$_eventPrefix = 'sales_quote' [protected]

Performance +30% without cache

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 54 of file Quote.php.

$_items = null [protected]

Definition at line 76 of file Quote.php.

$_payments = null [protected]

Definition at line 83 of file Quote.php.

const CHECKOUT_METHOD_GUEST = 'guest'

Definition at line 45 of file Quote.php.

const CHECKOUT_METHOD_LOGIN_IN = 'login_in'

Definition at line 46 of file Quote.php.

const CHECKOUT_METHOD_REGISTER = 'register'

Checkout methods

Definition at line 44 of file Quote.php.

---

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

• app/code/core/Mage/Sales/Model/Quote.php