Class Mage_Sales_Model_Quote

Description
Description | Vars (details) | Methods (details)

Quote model

Supported events: sales_quote_load_after sales_quote_save_before sales_quote_save_after sales_quote_delete_before sales_quote_delete_after

Located in /Sales/Model/Quote.php (line 39) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Sales_Model_Quote
Variable Summary
Description | Vars (details) | Methods (details)
Mage_Eav_Model_Entity_Collection_Abstract $_addresses
Mage_Customer_Model_Customer $_customer
mixed $_eventObject
mixed $_eventPrefix
Mage_Eav_Model_Entity_Collection_Abstract $_items
Mage_Eav_Model_Entity_Collection_Abstract $_payments
Method Summary
Description | Vars (details) | Methods (details)
void addAddress (Mage_Sales_Model_Quote_Address $address)
Mage_Sales_Model_Quote addItem (Mage_Sales_Model_Quote_Item $item)
void addMessage ( $message, [ $index = 'error'])
void addPayment (Mage_Sales_Model_Quote_Payment $payment)
Mage_Sales_Model_Quote_Item addProduct ( $product, [ $request = null])
void addShippingAddress (Mage_Sales_Model_Quote_Address $address)
Mage_Sales_Model_Quote assignCustomer ( $customer)
Mage_Sales_Model_Quote collectTotals ()
void getAddressByCustomerAddressId ( $addressId)
Mage_Sales_Model_Quote_Address getAddressById (int $addressId)
Mage_Eav_Model_Entity_Collection_Abstract getAddressesCollection ()
void getAllAddresses ()
array getAllItems ()
void getAllShippingAddresses ()
array getAllVisibleItems ()
Mage_Sales_Model_Quote_Address getBillingAddress ()
Mage_Customer_Model_Customer getCustomer ()
void getCustomerTaxClassId ()
bool getIsVirtual ()
Mage_Sales_Model_Quote_Item getItemById (int $itemId)
Mage_Sales_Model_Quote_Item getItemByProduct ( $product, int $productId)
Mage_Eav_Model_Entity_Collection_Abstract getItemsCollection ([ $useCache = true], bool $loaded)
void getItemsSummaryQty ()
void getItemVirtualQty ()
void getMessages ()
Mage_Sales_Model_Quote_Payment getPayment ()
void getPaymentById ( $paymentId)
void getPaymentsCollection ()
array getSharedStoreIds ()
Mage_Sales_Model_Quote_Address getShippingAddress ()
void getShippingAddressByCustomerAddressId ( $addressId)
Mage_Core_Model_Store getStore ()
int getStoreId ()
array getTotals ()
bool hasItems ()
bool hasItemsWithDecimalQty ()
bool hasVirtualItems ()
bool isAllowedGuestCheckout ()
bool isVirtual ()
Mage_Sales_Model_Quote loadByCustomer ( $customer)
Mage_Sales_Model_Quote merge (Mage_Sales_Model_Quote $quote)
void removeAddress ( $addressId)
void removeAllAddresses ()
Mage_Sales_Model_Quote removeItem (int $itemId)
void removePayment ()
void reserveOrderId ()
Mage_Sales_Model_Quote setBillingAddress (Mage_Sales_Model_Quote_Address $address)
Mage_Sales_Model_Quote setCustomer ( $customer)
void setPayment (Mage_Sales_Model_Quote_Payment $payment)
Mage_Sales_Model_Quote setShippingAddress (Mage_Sales_Model_Quote_Address $address)
Mage_Sales_Model_Quote setStore ( $store)
void validateMinimumAmount ([ $multishipping = false])
Mage_Sales_Model_Quote_Item _addCatalogProduct ( $product, [ $qty = 1])
Mage_Sales_Model_Quote _afterLoad ()
Mage_Sales_Model_Quote _afterSave ()
Mage_Sales_Model_Quote _beforeSave ()
void _construct ()
Mage_Sales_Model_Quote_Address _getAddressByType (string $type)
void _validateCouponCode ()
Variables
Description | Vars (details) | Methods (details)
Mage_Eav_Model_Entity_Collection_Abstract $_addresses = null (line 62)

Quote addresses collection

  • access: protected
Mage_Customer_Model_Customer $_customer (line 55)

Quote customer model object

  • access: protected
mixed $_eventObject = 'quote' (line 48)
  • access: protected
Redefinition of:
Mage_Core_Model_Abstract::$_eventObject
Parameter name in event
mixed $_eventPrefix = 'sales_quote' (line 47)

Performance +30% without cache

  • access: protected
Redefinition of:
Mage_Core_Model_Abstract::$_eventPrefix
Prefix of model events names
Mage_Eav_Model_Entity_Collection_Abstract $_items = null (line 69)

Quote items collection

  • access: protected
Mage_Eav_Model_Entity_Collection_Abstract $_payments = null (line 76)

Quote payments

  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Vars (details) Methods (details)
addAddress (line 449)
  • access: public
void addAddress (Mage_Sales_Model_Quote_Address $address)
addItem (line 618)

Adding new item to quote

  • access: public
Mage_Sales_Model_Quote addItem (Mage_Sales_Model_Quote_Item $item)
addMessage (line 950)
  • access: public
void addMessage ( $message, [ $index = 'error'])
  • $message
  • $index
addPayment (line 836)
  • access: public
void addPayment (Mage_Sales_Model_Quote_Payment $payment)
addProduct (line 635)

Add product to quote

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

  • return: || string
  • access: public
Mage_Sales_Model_Quote_Item addProduct ( $product, [ $request = null])
  • mixed $product
  • $request
addShippingAddress (line 499)
  • access: public
void addShippingAddress (Mage_Sales_Model_Quote_Address $address)
assignCustomer (line 241)

Assign customer model object data to quote

  • access: public
Mage_Sales_Model_Quote assignCustomer ( $customer)
collectTotals (line 866)

Collect totals

  • access: public
Mage_Sales_Model_Quote collectTotals ()
getAddressByCustomerAddressId (line 409)
  • access: public
void getAddressByCustomerAddressId ( $addressId)
  • $addressId
getAddressById (line 399)
  • access: public
Mage_Sales_Model_Quote_Address getAddressById (int $addressId)
  • int $addressId
getAddressesCollection (line 317)

Retrieve quote address collection

  • access: public
Mage_Eav_Model_Entity_Collection_Abstract getAddressesCollection ()
getAllAddresses (line 383)
  • access: public
void getAllAddresses ()
getAllItems (line 525)

Retrieve quote items array

  • access: public
array getAllItems ()
getAllShippingAddresses (line 371)
  • access: public
void getAllShippingAddresses ()
getAllVisibleItems (line 541)

Get array of all items what can be display directly

  • access: public
array getAllVisibleItems ()
getBillingAddress (line 356)

Retrieve quote billing address

  • access: public
Mage_Sales_Model_Quote_Address getBillingAddress ()
getCustomer (line 285)

Retrieve customer model object

  • access: public
Mage_Customer_Model_Customer getCustomer ()
getCustomerTaxClassId (line 299)
  • access: public
void getCustomerTaxClassId ()
getIsVirtual (line 1053)

Check quote for virtual product only

  • access: public
bool getIsVirtual ()
getItemById (line 584)

Retrieve item model object by item identifier

  • access: public
Mage_Sales_Model_Quote_Item getItemById (int $itemId)
  • int $itemId
getItemByProduct (line 735)

Retrieve quote item by product id

  • return: || false
  • access: public
Mage_Sales_Model_Quote_Item getItemByProduct ( $product, int $productId)
  • int $productId
  • $product
getItemsCollection (line 511)

Retrieve quote items collection

  • access: public
Mage_Eav_Model_Entity_Collection_Abstract getItemsCollection ([ $useCache = true], bool $loaded)
  • bool $loaded
  • $useCache
getItemsSummaryQty (line 745)
  • access: public
void getItemsSummaryQty ()
getItemVirtualQty (line 768)
  • access: public
void getItemVirtualQty ()
getMessages (line 970)
  • access: public
void getMessages ()
getPayment (line 814)
  • access: public
Mage_Sales_Model_Quote_Payment getPayment ()
getPaymentById (line 826)
  • access: public
void getPaymentById ( $paymentId)
  • $paymentId
getPaymentsCollection (line 796)

********************* PAYMENTS **************************

  • access: public
void getPaymentsCollection ()
getSharedStoreIds (line 126)

Get all available store ids for quote

  • access: public
array getSharedStoreIds ()
getShippingAddress (line 366)

retrieve quote shipping address

  • access: public
Mage_Sales_Model_Quote_Address getShippingAddress ()
getShippingAddressByCustomerAddressId (line 419)
  • access: public
void getShippingAddressByCustomerAddressId ( $addressId)
  • $addressId
getStore (line 104)

Get quote store model object

  • access: public
Mage_Core_Model_Store getStore ()
getStoreId (line 91)

Get quote store identifier

  • access: public
int getStoreId ()
getTotals (line 936)

Get all quote totals

  • access: public
array getTotals ()
hasItems (line 557)

Checking items availability

  • access: public
bool hasItems ()
hasItemsWithDecimalQty (line 567)

Checking availability of items with decimal qty

  • access: public
bool hasItemsWithDecimalQty ()
hasVirtualItems (line 1063)

Has a virtual products on quote

  • access: public
bool hasVirtualItems ()
isAllowedGuestCheckout (line 1082)

Check is allow Guest Checkout

  • access: public
bool isAllowedGuestCheckout ()
isVirtual (line 1031)

Check quote for virtual product only

  • access: public
bool isVirtual ()
loadByCustomer (line 221)

Loading quote data by customer

  • access: public
Mage_Sales_Model_Quote loadByCustomer ( $customer)
  • $customer
merge (line 1093)

Merge quotes

  • access: public
Mage_Sales_Model_Quote merge (Mage_Sales_Model_Quote $quote)
removeAddress (line 430)
  • access: public
void removeAddress ( $addressId)
  • $addressId
removeAllAddresses (line 441)
  • access: public
void removeAllAddresses ()
removeItem (line 595)

Remove quote item by item identifier

  • access: public
Mage_Sales_Model_Quote removeItem (int $itemId)
  • int $itemId
removePayment (line 855)
  • access: public
void removePayment ()
reserveOrderId (line 980)
  • access: public
void reserveOrderId ()
setBillingAddress (line 464)

Enter description here...

  • access: public
Mage_Sales_Model_Quote setBillingAddress (Mage_Sales_Model_Quote_Address $address)
setCustomer (line 273)

Define customer object

  • access: public
Mage_Sales_Model_Quote setCustomer ( $customer)
setPayment (line 845)
  • access: public
void setPayment (Mage_Sales_Model_Quote_Payment $payment)
setShippingAddress (line 482)

Enter description here...

  • access: public
Mage_Sales_Model_Quote setShippingAddress (Mage_Sales_Model_Quote_Address $address)
setStore (line 115)

Declare quote store model

  • access: public
Mage_Sales_Model_Quote setStore ( $store)
validateMinimumAmount (line 994)
  • access: public
void validateMinimumAmount ([ $multishipping = false])
  • $multishipping
_addCatalogProduct (line 705)

Adding catalog product object data to quote

  • access: protected
Mage_Sales_Model_Quote_Item _addCatalogProduct ( $product, [ $qty = 1])
_afterLoad (line 1146)

Trigger collect totals after loading, if required

  • access: protected
Mage_Sales_Model_Quote _afterLoad ()
Redefinition of:
Mage_Core_Model_Abstract::_afterLoad()
Processing object after load data
_afterSave (line 198)

Save related items

  • access: protected
Mage_Sales_Model_Quote _afterSave ()
Redefinition of:
Mage_Core_Model_Abstract::_afterSave()
Processing object after save data
_beforeSave (line 143)

Prepare data before save

  • access: protected
Mage_Sales_Model_Quote _beforeSave ()
Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
_construct (line 81)

Init resource model

  • access: protected
void _construct ()
_getAddressByType (line 338)

Retrieve quote address by type

  • access: protected
Mage_Sales_Model_Quote_Address _getAddressByType (string $type)
  • string $type
_validateCouponCode (line 1124)
  • access: protected
void _validateCouponCode ()

Inherited Methods

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()

Documentation generated on Wed, 04 Feb 2009 03:30:58 +0200 by phpDocumentor 1.4.2