Docs For Class Mage_Sales_Model_Quote_Address_Total

Class Mage_Sales_Model_Quote_Address_Total_Abstract

Description

Sales Quote Address Total abstract model

author: Magento Core Team <[email protected]>
abstract:

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

Direct descendents

Class	Description
Mage_SalesRule_Model_Quote_Freeshipping	Magento
Mage_SalesRule_Model_Quote_Discount	Magento
Mage_Sales_Model_Quote_Address_Total_Grand	Magento
Mage_Sales_Model_Quote_Address_Total_Nominal	Nominal items total
Mage_Sales_Model_Quote_Address_Total_Custbalance	Magento
Mage_Sales_Model_Quote_Address_Total_Subtotal	Magento
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract	Total model for recurring profiles
Mage_Sales_Model_Quote_Address_Total_Tax	Magento
Mage_Sales_Model_Quote_Address_Total_Shipping	Magento
Mage_Sales_Model_Quote_Address_Total_Discount	Magento
Mage_Tax_Model_Sales_Total_Quote_Subtotal	Calculate items and address amounts including/excluding tax
Mage_Tax_Model_Sales_Total_Quote_Tax	Tax totals calculation model
Mage_Tax_Model_Sales_Total_Quote_Shipping	Magento
Mage_Tax_Model_Sales_Total_Quote_Discount	Tax discount totals calculation model

Variable Summary

mixed $_address

bool $_canAddAmountToAddress

mixed $_canSetAddressAmount

string $_code

string $_itemRowTotalKey

Method Summary

Mage_Sales_Model_Quote_Address_Total_Abstract collect (Mage_Sales_Model_Quote_Address $address)

array fetch (Mage_Sales_Model_Quote_Address $address)

unknown getCode ()

bool getIsItemRowTotalCompoundable (Mage_Sales_Model_Quote_Item_Abstract $item)

float getItemBaseRowTotal (Mage_Sales_Model_Quote_Item_Abstract $item)

float getItemRowTotal (Mage_Sales_Model_Quote_Item_Abstract $item)

string getLabel ()

array processConfigArray (array $config, store $store)

Mage_Sales_Model_Quote_Address_Total_Abstract setCode (string $code)

Mage_Sales_Model_Quote_Address_Total_Abstract _addAmount (float $amount)

Mage_Sales_Model_Quote_Address_Total_Abstract _addBaseAmount ( $baseAmount, float $amount)

Mage_Sales_Model_Quote_Address _getAddress ()

array _getAddressItems (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address_Total_Abstract _setAddress (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address_Total_Abstract _setAmount (float $amount)

Mage_Sales_Model_Quote_Address_Total_Abstract _setBaseAmount ( $baseAmount, float $amount)

Variables

mixed $_address = null (line 43)

access: protected

bool $_canAddAmountToAddress = true (line 49)

Various abstract abilities

access: protected

Redefined in descendants as:

Mage_SalesRule_Model_Quote_Nominal_Discount::$_canAddAmountToAddress : Don't add amounts to address
Mage_Sales_Model_Quote_Address_Total_Nominal_Subtotal::$_canAddAmountToAddress : Don't add amounts to address
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract::$_canAddAmountToAddress : Don't add amounts to address
Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::$_canAddAmountToAddress : Don't add/set amounts
Mage_Tax_Model_Sales_Total_Quote_Nominal_Subtotal::$_canAddAmountToAddress : Don't add amounts to address
Mage_Weee_Model_Total_Quote_Nominal_Weee::$_canAddAmountToAddress : Don't add amounts to address
Mage_Tax_Model_Sales_Total_Quote_Nominal_Tax::$_canAddAmountToAddress : Don't add amounts to address

mixed $_canSetAddressAmount = true (line 50)

access: protected

Redefined in descendants as:

Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::$_canSetAddressAmount

string $_code (line 42)

Total Code name

access: protected

string $_itemRowTotalKey = null (line 57)

Key for item row total getting

access: protected

Redefined in descendants as:

Mage_Sales_Model_Quote_Address_Total_Nominal_Subtotal::$_itemRowTotalKey : Custom row total key
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract::$_itemRowTotalKey : By what key to set data into item
Mage_Sales_Model_Quote_Address_Total_Nominal_Recurring_Initial::$_itemRowTotalKey : Custom row total/profile keys
Mage_Sales_Model_Quote_Address_Total_Nominal_Recurring_Trial::$_itemRowTotalKey : Custom row total/profile keys
Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::$_itemRowTotalKey : Custom row total key
Mage_Weee_Model_Total_Quote_Nominal_Weee::$_itemRowTotalKey : Custom row total key
Mage_Tax_Model_Sales_Total_Quote_Nominal_Tax::$_itemRowTotalKey : Custom row total key

Methods

collect (line 97)

Collect totals process.

access: public

Mage_Sales_Model_Quote_Address_Total_Abstract collect (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address $address

Redefined in descendants as:

Mage_SalesRule_Model_Quote_Freeshipping::collect() : Collect information about free shipping for all address items
Mage_SalesRule_Model_Quote_Discount::collect() : Collect address discount amount
Mage_Sales_Model_Quote_Address_Total_Grand::collect() : Collect grand total address amount
Mage_Sales_Model_Quote_Address_Total_Nominal::collect() : Invoke collector for nominal items
Mage_Sales_Model_Quote_Address_Total_Custbalance::collect()
Mage_Sales_Model_Quote_Address_Total_Subtotal::collect() : Collect address subtotal
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract::collect() : Collect recurring item parameters and copy to the address items
Mage_Sales_Model_Quote_Address_Total_Tax::collect()
Mage_Sales_Model_Quote_Address_Total_Shipping::collect() : Collect totals information about shipping
Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::collect() : Collect shipping amount individually for each item
Mage_Sales_Model_Quote_Address_Total_Discount::collect()
Mage_Tax_Model_Sales_Total_Quote_Subtotal::collect() : Calculate item price including/excluding tax, row total including/excluding tax and subotal including/excluding tax.
Mage_Tax_Model_Sales_Total_Quote_Tax::collect() : Collect tax totals for quote address
Mage_Weee_Model_Total_Quote_Weee::collect() : Collect Weee taxes amount ant prepare items prices for taxation and discount
Mage_Tax_Model_Sales_Total_Quote_Shipping::collect() : Collect totals information about shipping
Mage_Tax_Model_Sales_Total_Quote_Discount::collect() : Calculate discount tac amount

fetch (line 114)

Fetch (Retrieve data as array)

access: public

array fetch (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address $address

Redefined in descendants as:

Mage_SalesRule_Model_Quote_Freeshipping::fetch() : Add information about free shipping for all address items to address object By default we not present such information
Mage_SalesRule_Model_Quote_Discount::fetch() : Add discount total information to address
Mage_SalesRule_Model_Quote_Nominal_Discount::fetch() : Don't fetch anything
Mage_Sales_Model_Quote_Address_Total_Grand::fetch() : Add grand total information to adderess
Mage_Sales_Model_Quote_Address_Total_Nominal::fetch() : Fetch collected nominal items
Mage_Sales_Model_Quote_Address_Total_Subtotal::fetch() : Assign subtotal amount and label to address object
Mage_Sales_Model_Quote_Address_Total_Nominal_Subtotal::fetch() : Don't fetch anything
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract::fetch() : Don't fetch anything
Mage_Sales_Model_Quote_Address_Total_Tax::fetch()
Mage_Sales_Model_Quote_Address_Total_Shipping::fetch() : Add shipping totals information to address object
Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::fetch() : Don't fetch anything
Mage_Sales_Model_Quote_Address_Total_Discount::fetch()
Mage_Tax_Model_Sales_Total_Quote_Nominal_Subtotal::fetch() : Don't fetch anything
Mage_Tax_Model_Sales_Total_Quote_Tax::fetch() : Add tax totals information to address object
Mage_Weee_Model_Total_Quote_Weee::fetch() : Fetch FPT data to address object for display in totals block
Mage_Tax_Model_Sales_Total_Quote_Nominal_Tax::fetch() : Don't fetch anything

getCode (line 76)

Retrieve total code name

access: public

unknown getCode ()

getIsItemRowTotalCompoundable (line 249)

Whether the item row total may be compouded with others

access: public

bool getIsItemRowTotalCompoundable (Mage_Sales_Model_Quote_Item_Abstract $item)

Mage_Sales_Model_Quote_Item_Abstract $item

getItemBaseRowTotal (line 235)

Getter for row default base total

access: public

float getItemBaseRowTotal (Mage_Sales_Model_Quote_Item_Abstract $item)

Mage_Sales_Model_Quote_Item_Abstract $item

getItemRowTotal (line 221)

Getter for row default total

access: public

float getItemRowTotal (Mage_Sales_Model_Quote_Item_Abstract $item)

Mage_Sales_Model_Quote_Item_Abstract $item

getLabel (line 86)

Label getter

access: public

string getLabel ()

Redefined in descendants as:

Mage_Sales_Model_Quote_Address_Total_Subtotal::getLabel() : Get Subtotal label
Mage_Sales_Model_Quote_Address_Total_Nominal_Subtotal::getLabel() : Get regular payment label
Mage_Sales_Model_Quote_Address_Total_Nominal_Recurring_Initial::getLabel() : Get initial fee label
Mage_Sales_Model_Quote_Address_Total_Nominal_Recurring_Trial::getLabel() : Get trial payment label
Mage_Sales_Model_Quote_Address_Total_Shipping::getLabel() : Get Shipping label
Mage_Tax_Model_Sales_Total_Quote_Tax::getLabel() : Get Tax label
Mage_Weee_Model_Total_Quote_Weee::getLabel() : No aggregated label for fixed product tax

processConfigArray (line 265)

Process model configuration array.

This method can be used for changing models apply sort order

access: public

array processConfigArray (array $config, store $store)

array $config
store $store

Redefined in descendants as:

Mage_Tax_Model_Sales_Total_Quote_Tax::processConfigArray() : Process model configuration array.
Mage_Weee_Model_Total_Quote_Weee::processConfigArray() : Process model configuration array.

setCode (line 65)

Set total code code name

access: public

Mage_Sales_Model_Quote_Address_Total_Abstract setCode (string $code)

string $code

_addAmount (line 182)

Add total model amount value to address

access: protected

Mage_Sales_Model_Quote_Address_Total_Abstract _addAmount (float $amount)

float $amount

_addBaseAmount (line 196)

Add total model base amount value to address

access: protected

Mage_Sales_Model_Quote_Address_Total_Abstract _addBaseAmount ( $baseAmount, float $amount)

float $amount
$baseAmount

_getAddress (line 138)

Get quote address object

access: protected

Mage_Sales_Model_Quote_Address _getAddress ()

_getAddressItems (line 210)

Get all items except nominals

access: protected

array _getAddressItems (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address $address

Redefined in descendants as:

Mage_SalesRule_Model_Quote_Nominal_Discount::_getAddressItems() : Get nominal items only
Mage_Sales_Model_Quote_Address_Total_Nominal_Subtotal::_getAddressItems() : Get nominal items only
Mage_Sales_Model_Quote_Address_Total_Nominal_RecurringAbstract::_getAddressItems() : Get nominal items only
Mage_Sales_Model_Quote_Address_Total_Nominal_Shipping::_getAddressItems() : Get nominal items only or indeed get all items, depending on current logic requirements
Mage_Tax_Model_Sales_Total_Quote_Nominal_Subtotal::_getAddressItems() : Get nominal items only
Mage_Weee_Model_Total_Quote_Nominal_Weee::_getAddressItems() : Get nominal items only
Mage_Tax_Model_Sales_Total_Quote_Nominal_Tax::_getAddressItems() : Get nominal items only

_setAddress (line 126)

Set address shich can be used inside totals calculation

access: protected

Mage_Sales_Model_Quote_Address_Total_Abstract _setAddress (Mage_Sales_Model_Quote_Address $address)

Mage_Sales_Model_Quote_Address $address

_setAmount (line 154)

Set total model amount value to address

access: protected

Mage_Sales_Model_Quote_Address_Total_Abstract _setAmount (float $amount)

float $amount

_setBaseAmount (line 168)

Set total model base amount value to address

access: protected

Mage_Sales_Model_Quote_Address_Total_Abstract _setBaseAmount ( $baseAmount, float $amount)

float $amount
$baseAmount

Documentation generated on Fri, 11 Feb 2011 16:54:57 +0200 by phpDocumentor 1.4.3