Docs For Class Mage_Sales_Model_Quote_Address_Total

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
license: Open Software License (OSL 3.0)

Located in /Sales/Model/Quote/Address/Total/Collector.php (line 27)

Direct descendents

Class	Description
Mage_Sales_Model_Quote_Address_Total_Nominal_Collector	Nominal totals collector

Variable Summary

mixed $_collectors

string $_collectorsCacheKey

mixed $_models

mixed $_modelsConfig

mixed $_retrievers

mixed $_store

string $_totalsConfigNode

Method Summary

Mage_Sales_Model_Quote_Address_Total_Collector __construct ( $options)

array getCollectors ()

array getRetrievers ()

int _compareSortOrder (array $a, array $b)

int _compareTotals (array $a, array $b)

array _getSortedCollectorCodes ()

Mage_Sales_Model_Quote_Address_Total_Collector _initCollectors ()

Mage_Sales_Model_Quote_Address_Total_Collector _initModels ()

Mage_Sales_Model_Quote_Address_Total_Collector _initRetrievers ()

array _prepareConfigArray (string $code, Mage_Core_Model_Config_Element $totalConfig)

Variables

mixed $_collectors = array() (line 31)

access: protected

string $_collectorsCacheKey = 'sorted_quote_collectors' (line 47)

Cache key for collectors

access: protected

Redefined in descendants as:

Mage_Sales_Model_Quote_Address_Total_Nominal_Collector::$_collectorsCacheKey : Custom cache key to not confuse with regular totals

mixed $_models = array() (line 29)

access: protected

mixed $_modelsConfig = array() (line 30)

access: protected

mixed $_retrievers = array() (line 32)

access: protected

mixed $_store (line 33)

access: protected

string $_totalsConfigNode = 'global/sales/quote/totals' (line 40)

Configuration path where to collect registered totals

access: protected

Redefined in descendants as:

Mage_Sales_Model_Quote_Address_Total_Nominal_Collector::$_totalsConfigNode : Conf. node for nominal totals declaration

Methods

Constructor __construct (line 50)

access: public

Mage_Sales_Model_Quote_Address_Total_Collector __construct ( $options)

$options

getCollectors (line 67)

Get total models array ordered for right calculation logic

access: public

array getCollectors ()

getRetrievers (line 77)

Get total models array ordered for right display sequence

access: public

array getRetrievers ()

_compareSortOrder (line 237)

uasort() callback that uses sort_order for comparison

access: protected

int _compareSortOrder (array $a, array $b)

array $a
array $b

_compareTotals (line 216)

uasort callback function

access: protected

int _compareTotals (array $a, array $b)

array $a
array $b

_getSortedCollectorCodes (line 142)

Aggregate before/after information from all items and sort totals based on this data

access: protected

array _getSortedCollectorCodes ()

_initCollectors (line 199)

Initialize collectors array.

Collectors array is array of total models ordered based on configuration settings

access: protected

Mage_Sales_Model_Quote_Address_Total_Collector _initCollectors ()

_initModels (line 87)

Initialize total models configuration and objects

access: protected

Mage_Sales_Model_Quote_Address_Total_Collector _initModels ()

_initRetrievers (line 257)

Initialize retrievers array

access: protected

Mage_Sales_Model_Quote_Address_Total_Collector _initRetrievers ()

_prepareConfigArray (line 120)

Prepare configuration array for total model

access: protected

array _prepareConfigArray (string $code, Mage_Core_Model_Config_Element $totalConfig)

string $code
Mage_Core_Model_Config_Element $totalConfig

Class Mage_Sales_Model_Quote_Address_Total_Collector