Class Mage_Sales_Model_Quote_Address

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

Sales Quote address model

Located in /Sales/Model/Quote/Address.php (line 35) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Customer_Model_Address_Abstract
         |
         --Mage_Sales_Model_Quote_Address
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
RATES_FETCH = 1
RATES_RECALCULATE = 2
TYPE_BILLING = 'billing'
TYPE_SHIPPING = 'shipping'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
mixed $_baseTotalAmounts
mixed $_eventObject
mixed $_eventPrefix
Mage_Sales_Model_Quote $_items
bool $_nominalOnly
Mage_Sales_Model_Quote $_quote
Mage_Sales_Model_Quote_Address_Rate $_rates
mixed $_totalAmounts
Mage_Sales_Model_Quote_Address_Totla_Collector $_totalCollector
array $_totals
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Mage_Sales_Model_Quote_Address addBaseTotalAmount (string $code, float $amount)
Mage_Sales_Model_Quote_Address addItem (Mage_Sales_Model_Quote_Item_Abstract $item, [int $qty = null])
Mage_Sales_Model_Quote_Address addShippingRate (Mage_Sales_Model_Quote_Address_Rate $rate)
Mage_Sales_Model_Quote_Address addTotal (Mage_Sales_Model_Quote_Total|array $total)
Mage_Sales_Model_Quote_Address addTotalAmount (string $code, float $amount)
Mage_Sales_Model_Quote_Address collectShippingRates ()
Mage_Sales_Model_Quote_Address collectTotals ()
Mage_Customer_Model_Address exportCustomerAddress ()
array getAllBaseTotalAmounts ()
array getAllItems ()
array getAllNominalItems ()
array getAllNonNominalItems ()
array getAllShippingRates ()
array getAllTotalAmounts ()
array getAllVisibleItems ()
array getAppliedTaxes ()
float getBaseSubtotalWithDiscount ()
float getBaseTotalAmount (string $code)
array getGroupedAllShippingRates ()
Mage_Sales_Model_Quote_Address_Item getItemById (int $itemId)
Mage_Sales_Model_Quote_Address_Item getItemByQuoteItemId (int $itemId)
float|int getItemQty ([int $itemId = 0])
Mage_Eav_Model_Entity_Collection_Abstract getItemsCollection ()
Mage_Sales_Model_Quote getQuote ()
Mage_Sales_Model_Quote_Address_Rate getShippingRateByCode (string $code)
Mage_Sales_Model_Quote_Address_Rate getShippingRateById (int $rateId)
Mage_Eav_Model_Entity_Collection_Abstract getShippingRatesCollection ()
float getSubtotalWithDiscount ()
float getTotalAmount (string $code)
Mage_Sales_Model_Quote_Address_Total_Collector getTotalCollector ()
array getTotalModels ()
array getTotals ()
Mage_Sales_Model_Quote_Address_Item getValidItemById ($itemId $itemId)
bool hasItems ()
Mage_Sales_Model_Quote_Address importCustomerAddress ( $address)
Mage_Sales_Model_Quote_Address importOrderAddress (Mage_Sales_Model_Order_Address $address)
Mage_Sales_Model_Quote_Address removeAllShippingRates ()
Mage_Sales_Model_Quote_Address removeItem (int $itemId)
bool requestShippingRates ([Mage_Sales_Model_Quote_Item_Abstract $item = null])
Mage_Sales_Model_Quote_Address setAppliedTaxes (array $data)
Mage_Sales_Model_Quote_Address setBaseShippingAmount (float $value, [bool $alreadyExclTax = false])
Mage_Sales_Model_Quote_Address setBaseTotalAmount (string $code, float $amount)
Mage_Sales_Model_Quote_Address setQuote (Mage_Sales_Model_Quote $quote)
Mage_Sales_Model_Quote_Address setShippingAmount (float $value, [bool $alreadyExclTax = false])
Mage_Sales_Model_Quote_Address setTotalAmount (string $code, float $amount)
array toArray ([ $arrAttributes = array()])
bool validateMinimumAmount ()
Mage_Sales_Model_Quote_Address _afterSave ()
Mage_Sales_Model_Quote_Address _beforeSave ()
void _construct ()
Mage_Sales_Model_Quote_Item_Abstract|false _filterNominal (Mage_Sales_Model_Quote_Item_Abstract $item)
int _sortRates (array $a, array $b)
Mage_Sales_Model_Quote_Address __clone ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
mixed $_baseTotalAmounts = array() (line 81)
  • access: protected
mixed $_eventObject = 'quote_address' (line 43)
  • access: protected
Redefinition of:
Mage_Customer_Model_Address_Abstract::$_eventObject
mixed $_eventPrefix = 'sales_quote_address' (line 42)
  • access: protected
Redefinition of:
Mage_Customer_Model_Address_Abstract::$_eventPrefix
Mage_Sales_Model_Quote $_items = null (line 50)

Quote object

  • access: protected
bool $_nominalOnly = null (line 88)

Whether to segregate by nominal items only

  • access: protected
Mage_Sales_Model_Quote $_quote = null (line 57)

Quote object

  • access: protected
Mage_Sales_Model_Quote_Address_Rate $_rates = null (line 64)

Sales Quote address rates

  • access: protected
mixed $_totalAmounts = array() (line 80)
  • access: protected
Mage_Sales_Model_Quote_Address_Totla_Collector $_totalCollector = null (line 71)

Total models collector

  • access: protected
array $_totals = array() (line 78)

Total data as array

  • access: protected

Inherited Variables

Inherited from Mage_Customer_Model_Address_Abstract

Mage_Customer_Model_Address_Abstract::$_countryModels
 Mage_Customer_Model_Address_Abstract::$_regionModels

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_isObjectNew
 Mage_Core_Model_Abstract::$_resource
 Mage_Core_Model_Abstract::$_resourceCollectionName
 Mage_Core_Model_Abstract::$_resourceName
Methods
Description | Vars (details) Constants (details) Methods (details)
addBaseTotalAmount (line 987)

Add amount total amount value in base store currency

  • access: public
Mage_Sales_Model_Quote_Address addBaseTotalAmount (string $code, float $amount)
  • string $code
  • float $amount
addItem (line 493)

Add item to address

  • access: public
Mage_Sales_Model_Quote_Address addItem (Mage_Sales_Model_Quote_Item_Abstract $item, [int $qty = null])
addShippingRate (line 659)

Add shipping rate

  • access: public
Mage_Sales_Model_Quote_Address addShippingRate (Mage_Sales_Model_Quote_Address_Rate $rate)
addTotal (line 838)

Add total data or model

  • access: public
Mage_Sales_Model_Quote_Address addTotal (Mage_Sales_Model_Quote_Total|array $total)
  • Mage_Sales_Model_Quote_Total|array $total
addTotalAmount (line 973)

Add amount total amount value

  • access: public
Mage_Sales_Model_Quote_Address addTotalAmount (string $code, float $amount)
  • string $code
  • float $amount
collectShippingRates (line 671)

Collecting shipping rates by address

  • access: public
Mage_Sales_Model_Quote_Address collectShippingRates ()
collectTotals (line 811)

Collect address totals

  • access: public
Mage_Sales_Model_Quote_Address collectTotals ()
exportCustomerAddress (line 191)

Export data to customer address object

  • access: public
Mage_Customer_Model_Address exportCustomerAddress ()
getAllBaseTotalAmounts (line 1037)

Get all total amount values in base currency

  • access: public
array getAllBaseTotalAmounts ()
getAllItems (line 258)

Get all available address items

  • access: public
array getAllItems ()
getAllNominalItems (line 345)

Getter for all nominal items

  • access: public
array getAllNominalItems ()
getAllNonNominalItems (line 332)

Getter for all non-nominal items

  • access: public
array getAllNonNominalItems ()
getAllShippingRates (line 555)

Retrieve all address shipping rates

  • access: public
array getAllShippingRates ()
getAllTotalAmounts (line 1027)

Get all total amount values

  • access: public
array getAllTotalAmounts ()
getAllVisibleItems (line 376)

Retrieve all visible items

  • access: public
array getAllVisibleItems ()
getAppliedTaxes (line 892)

Retrieve applied taxes

  • access: public
array getAppliedTaxes ()
getBaseSubtotalWithDiscount (line 1047)

Get subtotal amount with applied discount in base currency

  • access: public
float getBaseSubtotalWithDiscount ()
getBaseTotalAmount (line 1014)

Get total amount value by code in base store curncy

  • access: public
float getBaseTotalAmount (string $code)
  • string $code
getGroupedAllShippingRates (line 571)

Retrieve all grouped shipping rates

  • access: public
array getGroupedAllShippingRates ()
getItemById (line 429)

Get address item object by id without

  • access: public
Mage_Sales_Model_Quote_Address_Item getItemById (int $itemId)
  • int $itemId
getItemByQuoteItemId (line 461)

Retrieve item object by quote item Id

  • access: public
Mage_Sales_Model_Quote_Address_Item getItemByQuoteItemId (int $itemId)
  • int $itemId
getItemQty (line 393)

Retrieve item quantity by id

  • access: public
float|int getItemQty ([int $itemId = 0])
  • int $itemId
getItemsCollection (line 238)

Retrieve address items collection

  • access: public
Mage_Eav_Model_Entity_Collection_Abstract getItemsCollection ()
getQuote (line 159)

Retrieve quote object

  • access: public
Mage_Sales_Model_Quote getQuote ()
getShippingRateByCode (line 630)

Retrieve shipping rate by code

  • access: public
Mage_Sales_Model_Quote_Address_Rate getShippingRateByCode (string $code)
  • string $code
getShippingRateById (line 614)

Retrieve shipping rate by identifier

  • return: | false
  • access: public
Mage_Sales_Model_Quote_Address_Rate getShippingRateById (int $rateId)
  • int $rateId
getShippingRatesCollection (line 533)

Retrieve collection of quote shipping rates

  • access: public
Mage_Eav_Model_Entity_Collection_Abstract getShippingRatesCollection ()
getSubtotalWithDiscount (line 1057)

Get subtotal amount with applied discount

  • access: public
float getSubtotalWithDiscount ()
getTotalAmount (line 1000)

Get total amount value by code

  • access: public
float getTotalAmount (string $code)
  • string $code
getTotalCollector (line 784)

Get totals collector model

  • access: public
Mage_Sales_Model_Quote_Address_Total_Collector getTotalCollector ()
getTotalModels (line 801)

Retrieve total models

  • deprecated:
  • access: public
array getTotalModels ()
getTotals (line 824)

Get address totals as array

  • access: public
array getTotals ()
getValidItemById (line 445)

Get prepared not deleted item

  • access: public
Mage_Sales_Model_Quote_Address_Item getValidItemById ($itemId $itemId)
  • $itemId $itemId
hasItems (line 418)

Check Quote address has Items

  • access: public
bool hasItems ()
importCustomerAddress (line 170)

Import quote address data from customer address object

  • access: public
Mage_Sales_Model_Quote_Address importCustomerAddress ( $address)
importOrderAddress (line 204)

Import address data from order address

  • access: public
Mage_Sales_Model_Quote_Address importOrderAddress (Mage_Sales_Model_Order_Address $address)
removeAllShippingRates (line 645)

Mark all shipping rates as deleted

  • access: public
Mage_Sales_Model_Quote_Address removeAllShippingRates ()
removeItem (line 477)

Remove item from collection

  • access: public
Mage_Sales_Model_Quote_Address removeItem (int $itemId)
  • int $itemId
requestShippingRates (line 703)

Request shipping rates for entire address or specified address item Returns true if current selected shipping method code corresponds to one of the found rates

  • access: public
bool requestShippingRates ([Mage_Sales_Model_Quote_Item_Abstract $item = null])
setAppliedTaxes (line 903)

Set applied taxes

  • access: public
Mage_Sales_Model_Quote_Address setAppliedTaxes (array $data)
  • array $data
setBaseShippingAmount (line 927)

Set base shipping amount

  • access: public
Mage_Sales_Model_Quote_Address setBaseShippingAmount (float $value, [bool $alreadyExclTax = false])
  • float $value
  • bool $alreadyExclTax
setBaseTotalAmount (line 956)

Set total amount value in base store currency

  • access: public
Mage_Sales_Model_Quote_Address setBaseTotalAmount (string $code, float $amount)
  • string $code
  • float $amount
setQuote (line 147)

Declare adress quote model object

  • access: public
Mage_Sales_Model_Quote_Address setQuote (Mage_Sales_Model_Quote $quote)
setShippingAmount (line 915)

Set shipping amount

  • access: public
Mage_Sales_Model_Quote_Address setShippingAmount (float $value, [bool $alreadyExclTax = false])
  • float $value
  • bool $alreadyExclTax
setTotalAmount (line 939)

Set total amount value

  • access: public
Mage_Sales_Model_Quote_Address setTotalAmount (string $code, float $amount)
  • string $code
  • float $amount
toArray (line 222)

Convert object to array

  • access: public
array toArray ([ $arrAttributes = array()])
  • array $arrAttributes
validateMinimumAmount (line 866)

Validate minimum amount

  • access: public
bool validateMinimumAmount ()
_afterSave (line 129)

Save child collections

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

Initialize quote identifier before save

  • access: protected
Mage_Sales_Model_Quote_Address _beforeSave ()
Redefinition of:
Mage_Customer_Model_Address_Abstract::_beforeSave()
_construct (line 93)

Initialize resource

  • access: protected
void _construct ()
_filterNominal (line 363)

Segregate by nominal criteria

true: get nominals only false: get non-nominals only null: get all

  • access: protected
Mage_Sales_Model_Quote_Item_Abstract|false _filterNominal (Mage_Sales_Model_Quote_Item_Abstract $item)
_sortRates (line 595)

Sort rates recursive callback

  • access: protected
int _sortRates (array $a, array $b)
  • array $a
  • array $b
__clone (line 856)

Rewrite clone method

  • access: public
Mage_Sales_Model_Quote_Address __clone ()

Inherited Methods

Inherited From Mage_Customer_Model_Address_Abstract

Mage_Customer_Model_Address_Abstract::explodeStreetAddress()
Mage_Customer_Model_Address_Abstract::format()
Mage_Customer_Model_Address_Abstract::getConfig()
Mage_Customer_Model_Address_Abstract::getCountry()
Mage_Customer_Model_Address_Abstract::getCountryModel()
Mage_Customer_Model_Address_Abstract::getFormated()
Mage_Customer_Model_Address_Abstract::getHtmlFormat()
Mage_Customer_Model_Address_Abstract::getName()
Mage_Customer_Model_Address_Abstract::getRegion()
Mage_Customer_Model_Address_Abstract::getRegionCode()
Mage_Customer_Model_Address_Abstract::getRegionId()
Mage_Customer_Model_Address_Abstract::getRegionModel()
Mage_Customer_Model_Address_Abstract::getStreet()
Mage_Customer_Model_Address_Abstract::getStreet1()
Mage_Customer_Model_Address_Abstract::getStreet2()
Mage_Customer_Model_Address_Abstract::getStreet3()
Mage_Customer_Model_Address_Abstract::getStreet4()
Mage_Customer_Model_Address_Abstract::getStreetFull()
Mage_Customer_Model_Address_Abstract::implodeStreetAddress()
Mage_Customer_Model_Address_Abstract::setStreet()
Mage_Customer_Model_Address_Abstract::setStreetFull()
Mage_Customer_Model_Address_Abstract::validate()
Mage_Customer_Model_Address_Abstract::_beforeSave()

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
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::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
RATES_FETCH = 1 (line 39)
RATES_RECALCULATE = 2 (line 40)
TYPE_BILLING = 'billing' (line 37)
TYPE_SHIPPING = 'shipping' (line 38)

Documentation generated on Fri, 11 Feb 2011 16:56:06 +0200 by phpDocumentor 1.4.3