Class Mage_Sales_Model_Quote_Address

Sales Quote address model

Varien_Object

Mage_Sales_Model_Quote_Address

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/Address.php

Methods summary
`protected`	# `_construct( )` Initialize resource Initialize resource
`protected Mage_Sales_Model_Quote_Address`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Mage_Sales_Model_Quote_Address`
`protected Mage_Sales_Model_Quote_Address`	# `_beforeSave( )` Initialize quote identifier before save Initialize quote identifier before save Returns `Mage_Sales_Model_Quote_Address` Overrides `Mage_Customer_Model_Address_Abstract::_beforeSave()`
`protected Mage_Sales_Model_Quote_Address`	# `_afterSave( )` Save child collections Save child collections Returns `Mage_Sales_Model_Quote_Address` Overrides `Mage_Core_Model_Abstract::_afterSave()`
`public Mage_Sales_Model_Quote_Address`	# `setQuote( Mage_Sales_Model_Quote $quote )` Declare adress quote model object Declare adress quote model object Parameters `$quote` `Mage_Sales_Model_Quote` $quote Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote`	# `getQuote( )` Retrieve quote object Retrieve quote object Returns `Mage_Sales_Model_Quote`
`public Mage_Sales_Model_Quote_Address`	# `importCustomerAddress( Mage_Customer_Model_Address $address )` Import quote address data from customer address object Import quote address data from customer address object Parameters `$address` `Mage_Customer_Model_Address` $address Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Customer_Model_Address`	# `exportCustomerAddress( )` Export data to customer address object Export data to customer address object Returns `Mage_Customer_Model_Address`
`public Mage_Sales_Model_Quote_Address`	# `importOrderAddress( Mage_Sales_Model_Order_Address $address )` Import address data from order address Import address data from order address Parameters `$address` `Mage_Sales_Model_Order_Address` $address Returns `Mage_Sales_Model_Quote_Address`
`public array`	# `toArray( array $arrAttributes = array() )` Convert object to array Convert object to array Parameters `$arrAttributes` `array` $arrAttributes Returns `array`
`public Mage_Eav_Model_Entity_Collection_Abstract`	# `getItemsCollection( )` Retrieve address items collection Retrieve address items collection Returns `Mage_Eav_Model_Entity_Collection_Abstract`
`public array`	# `getAllItems( )` Get all available address items Get all available address items Returns `array`
`public array`	# `getAllNonNominalItems( )` Getter for all non-nominal items Getter for all non-nominal items Returns `array`
`public array`	# `getAllNominalItems( )` Getter for all nominal items Getter for all nominal items Returns `array`
`protected Mage_Sales_Model_Quote_Item_Abstract\|false`	# `_filterNominal( Mage_Sales_Model_Quote_Item_Abstract $item )` Segregate by nominal criteria Segregate by nominal criteria true: get nominals only false: get non-nominals only null: get all Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` Returns `Mage_Sales_Model_Quote_Item_Abstract\|false`
`public array`	# `getAllVisibleItems( )` Retrieve all visible items Retrieve all visible items Returns `array`
`public float\|integer`	# `getItemQty( integer $itemId = 0 )` Retrieve item quantity by id Retrieve item quantity by id Parameters `$itemId` `integer` $itemId Returns `float\|integer`
`public boolean`	# `hasItems( )` Check Quote address has Items Check Quote address has Items Returns `boolean`
`public Mage_Sales_Model_Quote_Address_Item`	# `getItemById( integer $itemId )` Get address item object by id without Get address item object by id without Parameters `$itemId` `integer` $itemId Returns `Mage_Sales_Model_Quote_Address_Item`
`public Mage_Sales_Model_Quote_Address_Item`	# `getValidItemById( mixed $itemId )` Get prepared not deleted item Get prepared not deleted item Parameters `$itemId` `mixed` $itemId Returns `Mage_Sales_Model_Quote_Address_Item`
`public Mage_Sales_Model_Quote_Address_Item`	# `getItemByQuoteItemId( integer $itemId )` Retrieve item object by quote item Id Retrieve item object by quote item Id Parameters `$itemId` `integer` $itemId Returns `Mage_Sales_Model_Quote_Address_Item`
`public Mage_Sales_Model_Quote_Address`	# `removeItem( integer $itemId )` Remove item from collection Remove item from collection Parameters `$itemId` `integer` $itemId Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `addItem( Mage_Sales_Model_Quote_Item_Abstract $item, integer $qty = null )` Add item to address Add item to address Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item `$qty` `integer` $qty Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Eav_Model_Entity_Collection_Abstract`	# `getShippingRatesCollection( )` Retrieve collection of quote shipping rates Retrieve collection of quote shipping rates Returns `Mage_Eav_Model_Entity_Collection_Abstract`
`public array`	# `getAllShippingRates( )` Retrieve all address shipping rates Retrieve all address shipping rates Returns `array`
`public array`	# `getGroupedAllShippingRates( )` Retrieve all grouped shipping rates Retrieve all grouped shipping rates Returns `array`
`protected integer`	# `_sortRates( array $a, array $b )` Sort rates recursive callback Sort rates recursive callback Parameters `$a` `array` $a `$b` `array` $b Returns `integer`
`public Mage_Sales_Model_Quote_Address_Rate`	# `getShippingRateById( integer $rateId )` Retrieve shipping rate by identifier Retrieve shipping rate by identifier Parameters `$rateId` `integer` $rateId Returns `Mage_Sales_Model_Quote_Address_Rate` \| false
`public Mage_Sales_Model_Quote_Address_Rate`	# `getShippingRateByCode( string $code )` Retrieve shipping rate by code Retrieve shipping rate by code Parameters `$code` `string` $code Returns `Mage_Sales_Model_Quote_Address_Rate`
`public Mage_Sales_Model_Quote_Address`	# `removeAllShippingRates( )` Mark all shipping rates as deleted Mark all shipping rates as deleted Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `addShippingRate( Mage_Sales_Model_Quote_Address_Rate $rate )` Add shipping rate Add shipping rate Parameters `$rate` `Mage_Sales_Model_Quote_Address_Rate` $rate Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `collectShippingRates( )` Collecting shipping rates by address Collecting shipping rates by address Returns `Mage_Sales_Model_Quote_Address`
`public boolean`	# `requestShippingRates( Mage_Sales_Model_Quote_Item_Abstract $item = null )` 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 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 Parameters `$item` `Mage_Sales_Model_Quote_Item_Abstract` $item Returns `boolean`
`public Mage_Sales_Model_Quote_Address_Total_Collector`	# `getTotalCollector( )` Get totals collector model Get totals collector model Returns `Mage_Sales_Model_Quote_Address_Total_Collector`
`public Mage_Sales_Model_Quote_Address`	# `collectTotals( )` Collect address totals Collect address totals Returns `Mage_Sales_Model_Quote_Address`
`public array`	# `getTotals( )` Get address totals as array Get address totals as array Returns `array`
`public Mage_Sales_Model_Quote_Address`	# `addTotal( Mage_Sales_Model_Quote_Total\|array $total )` Add total data or model Add total data or model Parameters `$total` `Mage_Sales_Model_Quote_Total\|array` $total Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `__clone( )` Rewrite clone method Rewrite clone method Returns `Mage_Sales_Model_Quote_Address`
`public boolean`	# `validateMinimumAmount( )` Validate minimum amount Validate minimum amount Returns `boolean`
`public array`	# `getAppliedTaxes( )` Retrieve applied taxes Retrieve applied taxes Returns `array`
`public Mage_Sales_Model_Quote_Address`	# `setAppliedTaxes( array $data )` Set applied taxes Set applied taxes Parameters `$data` `array` $data Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `setShippingAmount( float $value, boolean $alreadyExclTax = false )` Set shipping amount Set shipping amount Parameters `$value` `float` $value `$alreadyExclTax` `boolean` $alreadyExclTax Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `setBaseShippingAmount( float $value, boolean $alreadyExclTax = false )` Set base shipping amount Set base shipping amount Parameters `$value` `float` $value `$alreadyExclTax` `boolean` $alreadyExclTax Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `setTotalAmount( string $code, float $amount )` Set total amount value Set total amount value Parameters `$code` `string` $code `$amount` `float` $amount Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `setBaseTotalAmount( string $code, float $amount )` Set total amount value in base store currency Set total amount value in base store currency Parameters `$code` `string` $code `$amount` `float` $amount Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `addTotalAmount( string $code, float $amount )` Add amount total amount value Add amount total amount value Parameters `$code` `string` $code `$amount` `float` $amount Returns `Mage_Sales_Model_Quote_Address`
`public Mage_Sales_Model_Quote_Address`	# `addBaseTotalAmount( string $code, float $amount )` Add amount total amount value in base store currency Add amount total amount value in base store currency Parameters `$code` `string` $code `$amount` `float` $amount Returns `Mage_Sales_Model_Quote_Address`
`public float`	# `getTotalAmount( string $code )` Get total amount value by code Get total amount value by code Parameters `$code` `string` $code Returns `float`
`public float`	# `getBaseTotalAmount( string $code )` Get total amount value by code in base store curncy Get total amount value by code in base store curncy Parameters `$code` `string` $code Returns `float`
`public array`	# `getAllTotalAmounts( )` Get all total amount values Get all total amount values Returns `array`
`public array`	# `getAllBaseTotalAmounts( )` Get all total amount values in base currency Get all total amount values in base currency Returns `array`
`public float`	# `getBaseSubtotalWithDiscount( )` Get subtotal amount with applied discount in base currency Get subtotal amount with applied discount in base currency Returns `float`
`public float`	# `getSubtotalWithDiscount( )` Get subtotal amount with applied discount Get subtotal amount with applied discount Returns `float`

Methods inherited from Mage_Customer_Model_Address_Abstract
`explodeStreetAddress(), format(), getConfig(), getCountry(), getCountryModel(), getName(), getRegion(), getRegionCode(), getRegionId(), getRegionModel(), getStreet(), getStreet1(), getStreet2(), getStreet3(), getStreet4(), getStreetFull(), implodeStreetAddress(), setStreet(), setStreetFull(), validate()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _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(), save(), setId()`

Constants summary
`integer`	`RATES_FETCH`	`1`	#
`integer`	`RATES_RECALCULATE`	`2`	#

Constants inherited from Mage_Customer_Model_Address_Abstract
`TYPE_BILLING, TYPE_SHIPPING`

Properties summary
`protected string`	`$_eventPrefix`	`'sales_quote_address'`	# Prefix of model events Prefix of model events
`protected string`	`$_eventObject`	`'quote_address'`	# Name of event object Name of event object
`protected Mage_Sales_Model_Quote`	`$_items`	`null`	# Quote object Quote object
`protected Mage_Sales_Model_Quote`	`$_quote`	`null`	# Quote object Quote object
`protected Mage_Sales_Model_Quote_Address_Rate`	`$_rates`	`null`	# Sales Quote address rates Sales Quote address rates
`protected Mage_Sales_Model_Quote_Address_Totla_Collector`	`$_totalCollector`	`null`	# Total models collector Total models collector
`protected array`	`$_totals`	`array()`	# Total data as array Total data as array
`protected array`	`$_totalAmounts`	`array()`	#
`protected array`	`$_baseTotalAmounts`	`array()`	#
`protected boolean`	`$_nominalOnly`	`null`	# Whether to segregate by nominal items only Whether to segregate by nominal items only

Properties inherited from Mage_Customer_Model_Address_Abstract
`$_countryModels, $_regionModels`

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

Packages

Classes

Interfaces

Class Mage_Sales_Model_Quote_Address

Returns

Returns

Overrides

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns