Class Mage_Sales_Model_Quote

Quote model

Supported events: sales_quote_load_after sales_quote_save_before sales_quote_save_after sales_quote_delete_before sales_quote_delete_after

Varien_Object

Mage_Core_Model_Abstract

Mage_Sales_Model_Quote

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Quote.php

Methods summary
`protected`	# `_construct( )` Init resource model Init resource model
`protected Varien_Object`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Varien_Object`
`public integer`	# `getStoreId( )` Get quote store identifier Get quote store identifier Returns `integer`
`public Mage_Core_Model_Store`	# `getStore( )` Get quote store model object Get quote store model object Returns `Mage_Core_Model_Store`
`public Mage_Sales_Model_Quote`	# `setStore( Mage_Core_Model_Store $store )` Declare quote store model Declare quote store model Parameters `$store` `Mage_Core_Model_Store` $store Returns `Mage_Sales_Model_Quote`
`public array`	# `getSharedStoreIds( )` Get all available store ids for quote Get all available store ids for quote Returns `array`
`protected Mage_Sales_Model_Quote`	# `_beforeSave( )` Prepare data before save Prepare data before save Returns `Mage_Sales_Model_Quote` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected Mage_Sales_Model_Quote`	# `_afterSave( )` Save related items Save related items Returns `Mage_Sales_Model_Quote` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public Mage_Sales_Model_Quote`	# `loadByCustomer( mixed $customer )` Loading quote data by customer Loading quote data by customer Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `loadActive( integer $quoteId )` Loading only active quote Loading only active quote Parameters `$quoteId` `integer` $quoteId Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `loadByIdWithoutStore( integer $quoteId )` Loading quote by identifier Loading quote by identifier Parameters `$quoteId` `integer` $quoteId Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `assignCustomer( Mage_Customer_Model_Customer $customer )` Assign customer model object data to quote Assign customer model object data to quote Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `assignCustomerWithAddressChange( Mage_Customer_Model_Customer $customer, Mage_Sales_Model_Quote_Address $billingAddress = null, Mage_Sales_Model_Quote_Address $shippingAddress = null )` Assign customer model to quote with billing and shipping address change Assign customer model to quote with billing and shipping address change Parameters `$customer` `Mage_Customer_Model_Customer` $customer `$billingAddress` `Mage_Sales_Model_Quote_Address` $billingAddress `$shippingAddress` `Mage_Sales_Model_Quote_Address` $shippingAddress Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `setCustomer( Mage_Customer_Model_Customer $customer )` Define customer object Define customer object Parameters `$customer` `Mage_Customer_Model_Customer` $customer Returns `Mage_Sales_Model_Quote`
`public Mage_Customer_Model_Customer`	# `getCustomer( )` Retrieve customer model object Retrieve customer model object Returns `Mage_Customer_Model_Customer`
`public integer`	# `getCustomerGroupId( )` Retrieve customer group id Retrieve customer group id Returns `integer`
`public`	# `getCustomerTaxClassId( )`
`public Mage_Eav_Model_Entity_Collection_Abstract`	# `getAddressesCollection( )` Retrieve quote address collection Retrieve quote address collection Returns `Mage_Eav_Model_Entity_Collection_Abstract`
`protected Mage_Sales_Model_Quote_Address`	# `_getAddressByType( string $type )` Retrieve quote address by type Retrieve quote address by type Parameters `$type` `string` $type Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `getBillingAddress( )` Retrieve quote billing address Retrieve quote billing address Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `getShippingAddress( )` retrieve quote shipping address retrieve quote shipping address Returns `Mage_Sales_Model_Quote_Address`
`public`	# `getAllShippingAddresses( )`
`public`	# `getAllAddresses( )`
`public Mage_Sales_Model_Quote_Address`	# `getAddressById( integer $addressId )` Parameters `$addressId` `integer` $addressId Returns `Mage_Sales_Model_Quote_Address`
`public`	# `getAddressByCustomerAddressId( mixed $addressId )`
`public`	# `getShippingAddressByCustomerAddressId( mixed $addressId )`
`public`	# `removeAddress( mixed $addressId )`
`public`	# `removeAllAddresses( )`
`public`	# `addAddress( Mage_Sales_Model_Quote_Address $address )`
`public Mage_Sales_Model_Quote`	# `setBillingAddress( Mage_Sales_Model_Quote_Address $address )` Enter description here... Enter description here... Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `setShippingAddress( Mage_Sales_Model_Quote_Address $address )` Enter description here... Enter description here... Parameters `$address` `Mage_Sales_Model_Quote_Address` $address Returns `Mage_Sales_Model_Quote`
`public`	# `addShippingAddress( Mage_Sales_Model_Quote_Address $address )`
`public Mage_Eav_Model_Entity_Collection_Abstract`	# `getItemsCollection( boolean $useCache = true )` Retrieve quote items collection Retrieve quote items collection Parameters `$useCache` `boolean` $loaded Returns `Mage_Eav_Model_Entity_Collection_Abstract`
`public array`	# `getAllItems( )` Retrieve quote items array Retrieve quote items array Returns `array`
`public array`	# `getAllVisibleItems( )` Get array of all items what can be display directly Get array of all items what can be display directly Returns `array`
`public boolean`	# `hasItems( )` Checking items availability Checking items availability Returns `boolean`
`public boolean`	# `hasItemsWithDecimalQty( )` Checking availability of items with decimal qty Checking availability of items with decimal qty Returns `boolean`
`public boolean`	# `hasProductId( integer $productId )` Checking product exist in Quote Checking product exist in Quote Parameters `$productId` `integer` $productId Returns `boolean`
`public Mage_Sales_Model_Quote_Item`	# `getItemById( integer $itemId )` Retrieve item model object by item identifier Retrieve item model object by item identifier Parameters `$itemId` `integer` $itemId Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote`	# `removeItem( integer $itemId )` Remove quote item by item identifier Remove quote item by item identifier Parameters `$itemId` `integer` $itemId Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `removeAllItems( )` Mark all quote items as deleted (empty quote) Mark all quote items as deleted (empty quote) Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `addItem( Mage_Sales_Model_Quote_Item $item )` Adding new item to quote Adding new item to quote Parameters `$item` `Mage_Sales_Model_Quote_Item` $item Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote_Item\|string`	# `addProductAdvanced( Mage_Catalog_Model_Product $product, null\|float\|Varien_Object $request = null, null\|string $processMode = null )` Advanced func to add product to quote - processing mode can be specified there. Returns error message if product type instance can't prepare product. Advanced func to add product to quote - processing mode can be specified there. Returns error message if product type instance can't prepare product. Parameters `$product` `mixed` $product `$request` `null\|float\|Varien_Object` $request `$processMode` `null\|string` $processMode Returns `Mage_Sales_Model_Quote_Item\|string`
`public Mage_Sales_Model_Quote_Item\|string`	# `addProduct( Mage_Catalog_Model_Product $product, null\|float\|Varien_Object $request = null )` Add product to quote Add product to quote return error message if product type instance can't prepare product Parameters `$product` `mixed` $product `$request` `null\|float\|Varien_Object` $request Returns `Mage_Sales_Model_Quote_Item\|string`
`protected Mage_Sales_Model_Quote_Item`	# `_addCatalogProduct( Mage_Catalog_Model_Product $product, mixed $qty = 1 )` Adding catalog product object data to quote Adding catalog product object data to quote Parameters `$product` `Mage_Catalog_Model_Product` $product `$qty` Returns `Mage_Sales_Model_Quote_Item`
`public Mage_Sales_Model_Quote_Item`	# `updateItem( integer $itemId, Varien_Object $buyRequest, null\|array\|Varien_Object $params = null )` Updates quote item with new configuration Updates quote item with new configuration $params sets how current item configuration must be taken into account and additional options. It's passed to Mage_Catalog_Helper_Product->addParamsToBuyRequest() to compose resulting buyRequest. Basically it can hold 'current_config', Varien_Object or array - current buyRequest that configures product in this item, used to restore currently attached files 'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file options (file inputs), so they won't intersect with other submitted options For more options see Mage_Catalog_Helper_Product->addParamsToBuyRequest() Parameters `$itemId` `integer` $itemId `$buyRequest` `Varien_Object` $buyRequest `$params` `null\|array\|Varien_Object` $params Returns `Mage_Sales_Model_Quote_Item` See `Mage_Catalog_Helper_Product::addParamsToBuyRequest()`
`public Mage_Sales_Model_Quote_Item`	# `getItemByProduct( Mage_Catalog_Model_Product $product )` Retrieve quote item by product id Retrieve quote item by product id Parameters `$product` `Mage_Catalog_Model_Product` $product Returns `Mage_Sales_Model_Quote_Item` \|\| false
`public`	# `getItemsSummaryQty( )`
`public`	# `getItemVirtualQty( )`
`public`	# `getPaymentsCollection( )`
`public Mage_Sales_Model_Quote_Payment`	# `getPayment( )` Returns `Mage_Sales_Model_Quote_Payment`
`public`	# `getPaymentById( mixed $paymentId )`
`public`	# `addPayment( Mage_Sales_Model_Quote_Payment $payment )`
`public`	# `setPayment( Mage_Sales_Model_Quote_Payment $payment )`
`public`	# `removePayment( )`
`public Mage_Sales_Model_Quote`	# `collectTotals( )` Collect totals Collect totals Returns `Mage_Sales_Model_Quote`
`public array`	# `getTotals( )` Get all quote totals (sorted by priority) Method process quote states isVirtual and isMultiShipping Get all quote totals (sorted by priority) Method process quote states isVirtual and isMultiShipping Returns `array`
`public`	# `addMessage( mixed $message, mixed $index = 'error' )`
`public array`	# `getMessages( )` Retrieve current quote messages Retrieve current quote messages Returns `array`
`public array`	# `getErrors( )` Retrieve current quote errors Retrieve current quote errors Returns `array`
`protected Mage_Sales_Model_Quote`	# `_setHasError( boolean $flag )` Sets flag, whether this quote has some error associated with it. Sets flag, whether this quote has some error associated with it. Parameters `$flag` `boolean` $flag Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `setHasError( boolean $flag )` Sets flag, whether this quote has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote errors. When FALSE - clears whole list of quote errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later. Sets flag, whether this quote has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote errors. When FALSE - clears whole list of quote errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later. Parameters `$flag` `boolean` $flag Returns `Mage_Sales_Model_Quote` See `Mage_Sales_Model_Quote::addErrorInfo()`
`protected Mage_Sales_Model_Quote`	# `_clearErrorInfo( )` Clears list of errors, associated with this quote. Also automatically removes error-flag from oneself. Clears list of errors, associated with this quote. Also automatically removes error-flag from oneself. Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `addErrorInfo( string $type = 'error', string\|null $origin = null, integer\|null $code = null, string\|null $message = null, Varien_Object\|null $additionalData = null )` Adds error information to the quote. Automatically sets error flag. Adds error information to the quote. Automatically sets error flag. Parameters `$type` `string` $type An internal error type ('error', 'qty', etc.), passed then to adding messages routine `$origin` `string\|null` $origin Usually a name of module, that embeds error `$code` `integer\|null` $code Error code, unique for origin, that sets it `$message` `string\|null` $message Error message `$additionalData` `Varien_Object\|null` $additionalData Any additional data, that caller would like to store Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `removeErrorInfosByParams( string $type = 'error', array $params )` Removes error infos, that have parameters equal to passed in $params. $params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message' Removes error infos, that have parameters equal to passed in $params. $params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message' Parameters `$type` `string` $type An internal error type ('error', 'qty', etc.), passed then to adding messages routine `$params` `array` $params Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `removeMessageByText( string $type = 'error', string $text )` Removes message by text Removes message by text Parameters `$type` `string` $type `$text` `string` $text Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `reserveOrderId( )` Generate new increment order id and associate it with current quote Generate new increment order id and associate it with current quote Returns `Mage_Sales_Model_Quote`
`public`	# `validateMinimumAmount( mixed $multishipping = false )`
`public boolean`	# `isVirtual( )` Check quote for virtual product only Check quote for virtual product only Returns `boolean`
`public boolean`	# `getIsVirtual( )` Check quote for virtual product only Check quote for virtual product only Returns `boolean`
`public boolean`	# `hasVirtualItems( )` Has a virtual products on quote Has a virtual products on quote Returns `boolean`
`public Mage_Sales_Model_Quote`	# `merge( Mage_Sales_Model_Quote $quote )` Merge quotes Merge quotes Parameters `$quote` `Mage_Sales_Model_Quote` $quote Returns `Mage_Sales_Model_Quote`
`public boolean`	# `hasRecurringItems( )` Whether there are recurring items Whether there are recurring items Returns `boolean`
`public boolean`	# `hasNominalItems( boolean $countVirtual = true )` Getter whether quote has nominal items Can bypass treating virtual items as nominal Getter whether quote has nominal items Can bypass treating virtual items as nominal Parameters `$countVirtual` `boolean` $countVirtual Returns `boolean`
`public boolean`	# `isNominal( )` Whether quote has nominal items only Whether quote has nominal items only Returns `boolean`
`public array`	# `prepareRecurringPaymentProfiles( )` Create recurring payment profiles basing on the current items Create recurring payment profiles basing on the current items Returns `array`
`protected`	# `_validateCouponCode( )`
`protected Mage_Sales_Model_Quote`	# `_afterLoad( )` Trigger collect totals after loading, if required Trigger collect totals after loading, if required Returns `Mage_Sales_Model_Quote` Overrides `Mage_Core_Model_Abstract::_afterLoad()`
`public Mage_Sales_Model_Quote`	# `preventSaving( )` Prevent quote from saving Prevent quote from saving Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote`	# `save( )` Save quote with prevention checking Save quote with prevention checking Returns `Mage_Sales_Model_Quote` Overrides `Mage_Core_Model_Abstract::save()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _beforeDelete(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), setId()`

Constants summary
`string`	`CHECKOUT_METHOD_GUEST`	`'guest'`	#
`string`	`CHECKOUT_METHOD_LOGIN_IN`	`'login_in'`	#

Properties summary
`protected string`	`$_eventPrefix`	`'sales_quote'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'quote'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case
`protected Mage_Customer_Model_Customer`	`$_customer`		# Quote customer model object Quote customer model object
`protected Mage_Eav_Model_Entity_Collection_Abstract`	`$_addresses`	`null`	# Quote addresses collection Quote addresses collection
`protected Mage_Eav_Model_Entity_Collection_Abstract`	`$_items`	`null`	# Quote items collection Quote items collection
`protected Mage_Eav_Model_Entity_Collection_Abstract`	`$_payments`	`null`	# Quote payments Quote payments
`protected array`	`$_errorInfoGroups`	`array()`	# Different groups of error infos Different groups of error infos
`protected boolean`	`$_preventSaving`	`false`	# Whether quote should not be saved Whether quote should not be saved

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Quote

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Parameters

Returns

Parameters

Returns

Parameters