Class Mage_Tax_Model_Calculation

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

Tax Calculation Model

Located in /Tax/Model/Calculation.php (line 32) 

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Tax_Model_Calculation
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
CALC_ROW_BASE = 'ROW_BASE_CALCULATION'
CALC_TAX_AFTER_DISCOUNT_ON_EXCL = '1_0'
CALC_TAX_AFTER_DISCOUNT_ON_INCL = '1_1'
CALC_TAX_BEFORE_DISCOUNT_ON_EXCL = '0_0'
CALC_TAX_BEFORE_DISCOUNT_ON_INCL = '0_1'
CALC_TOTAL_BASE = 'TOTAL_BASE_CALCULATION'
CALC_UNIT_BASE = 'UNIT_BASE_CALCULATION'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
mixed $_ctc
mixed $_customer
mixed $_defaultCustomerTaxClass
mixed $_ptc
mixed $_rateCache
mixed $_rateCalculationProcess
mixed $_rates
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
float calcTaxAmount (float $price, float $taxRate, [boolean $priceIncludeTax = false], [ $round = true])
bool compareRequests (Varien_Object $first, Varien_Object $second)
Mage_Tax_Model_Calculation deleteByRuleId (int $ruleId)
array getAppliedRates (Varien_Object $request)
Mage_Tax_Model_Calculation getCustomer ()
array getCustomerTaxClasses (int $ruleId)
void getDefaultCustomerTaxClass ([ $store = null])
array getProductTaxClasses (int $ruleId)
float getRate (Varien_Object $request)
Varien_Object getRateOriginRequest ([null|store $store = null])
Varien_Object getRateRequest ([null|false|Varien_Object $shippingAddress = null], [null|false|Varien_Object $billingAddress = null], [null|int $customerTaxClass = null], [null|int $store = null])
array getRates (int $ruleId)
void getRatesByCustomerAndProductTaxClasses ( $customerTaxClass,  $productTaxClass)
void getRatesByCustomerTaxClass ( $customerTaxClass)
void getRatesForAllCustomerTaxClasses ( $request)
void getRatesForAllProductTaxClasses ( $request)
float getStoreRate (Varien_Object $request, [ $store = null])
void reproduceProcess ( $rates)
float round (float $price)
float roundUp (float $price)
Mage_Tax_Model_Calculation setCustomer ( $customer)
float truncate (float $price, [int $precision = 4])
void _construct ()
array _formCalculationProcess ()
void _getRates ( $request,  $fieldName,  $type)
string _getRequestCacheKey ($request $request)
Variables
Description | Vars (details) Constants (details) | Methods (details)
mixed $_ctc = array() (line 44)
  • access: protected
mixed $_customer = null (line 50)
  • access: protected
mixed $_defaultCustomerTaxClass = null (line 51)
  • access: protected
mixed $_ptc = array() (line 45)
  • access: protected
mixed $_rateCache = array() (line 47)
  • access: protected
mixed $_rateCalculationProcess = array() (line 48)
  • access: protected
mixed $_rates = array() (line 43)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
 Mage_Core_Model_Abstract::$_dataSaveAllowed
 Mage_Core_Model_Abstract::$_eventObject
 Mage_Core_Model_Abstract::$_eventPrefix
 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)
calcTaxAmount (line 450)

Calculate rated tax abount based on price and tax rate.

If you are using price including tax $priceIncludeTax should be true.

  • access: public
float calcTaxAmount (float $price, float $taxRate, [boolean $priceIncludeTax = false], [ $round = true])
  • float $price
  • float $taxRate
  • boolean $priceIncludeTax
  • $round
compareRequests (line 341)

Compare data and rates for two tax rate requests for same products (product tax class ids).

Returns true if requests are similar (i.e. equal taxes rates will be applied to them)

Notice: a) productClassId MUST be identical for both requests, because we intend to check selling SAME products to DIFFERENT locations b) due to optimization productClassId can be array of ids, not only single id

  • access: public
bool compareRequests (Varien_Object $first, Varien_Object $second)
  • Varien_Object $first
  • Varien_Object $second
deleteByRuleId (line 103)

Delete calculation settings by rule id

  • access: public
Mage_Tax_Model_Calculation deleteByRuleId (int $ruleId)
  • int $ruleId
getAppliedRates (line 417)

Get information about tax rates applied to request

  • access: public
array getAppliedRates (Varien_Object $request)
  • Varien_Object $request
getCustomer (line 84)

Get customer object

  • return: | false
  • access: public
Mage_Tax_Model_Calculation getCustomer ()
getCustomerTaxClasses (line 129)

Get allowed customer tax classes by rule id

  • access: public
array getCustomerTaxClasses (int $ruleId)
  • int $ruleId
getDefaultCustomerTaxClass (line 70)
  • access: public
void getDefaultCustomerTaxClass ([ $store = null])
  • $store
getProductTaxClasses (line 143)

Get allowed product tax classes by rule id

  • access: public
array getProductTaxClasses (int $ruleId)
  • int $ruleId
getRate (line 178)

Get calculation tax rate by specific request

  • access: public
float getRate (Varien_Object $request)
  • Varien_Object $request
getRateOriginRequest (line 238)

Get request object for getting tax rate based on store shippig original address

  • access: public
Varien_Object getRateOriginRequest ([null|store $store = null])
  • null|store $store
getRateRequest (line 264)

Get request object with information necessary for getting tax rate

Request object contain: country_id (->getCountryId()) region_id (->getRegionId()) postcode (->getPostcode()) customer_class_id (->getCustomerClassId()) store (->getStore())

  • access: public
Varien_Object getRateRequest ([null|false|Varien_Object $shippingAddress = null], [null|false|Varien_Object $billingAddress = null], [null|int $customerTaxClass = null], [null|int $store = null])
  • null|false|Varien_Object $shippingAddress
  • null|false|Varien_Object $billingAddress
  • null|int $customerTaxClass
  • null|int $store
getRates (line 115)

Get calculation rates by rule id

  • access: public
array getRates (int $ruleId)
  • int $ruleId
getRatesByCustomerAndProductTaxClasses (line 436)
  • access: public
void getRatesByCustomerAndProductTaxClasses ( $customerTaxClass,  $productTaxClass)
  • $customerTaxClass
  • $productTaxClass
getRatesByCustomerTaxClass (line 431)
  • access: public
void getRatesByCustomerTaxClass ( $customerTaxClass)
  • $customerTaxClass
getRatesForAllCustomerTaxClasses (line 406)
  • access: public
void getRatesForAllCustomerTaxClasses ( $request)
  • $request
getRatesForAllProductTaxClasses (line 402)
  • access: public
void getRatesForAllProductTaxClasses ( $request)
  • $request
getStoreRate (line 225)

Get tax rate based on store shipping origin address settings This rate can be used for conversion store price including tax to store price excluding tax

  • access: public
float getStoreRate (Varien_Object $request, [ $store = null])
  • Varien_Object $request
  • $store
reproduceProcess (line 426)
  • access: public
void reproduceProcess ( $rates)
  • $rates
round (line 487)

Round tax amount

  • access: public
float round (float $price)
  • float $price
roundUp (line 498)

Round price up

  • access: public
float roundUp (float $price)
  • float $price
setCustomer (line 64)

Specify customer object which can be used for rate calculation

  • access: public
Mage_Tax_Model_Calculation setCustomer ( $customer)
truncate (line 474)

Truncate number to specified precision

  • access: public
float truncate (float $price, [int $precision = 4])
  • float $price
  • int $precision
_construct (line 53)
  • access: protected
void _construct ()
_formCalculationProcess (line 156)

Aggregate tax calculation data to array

  • access: protected
array _formCalculationProcess ()
_getRates (line 388)
  • access: protected
void _getRates ( $request,  $fieldName,  $type)
  • $request
  • $fieldName
  • $type
_getRequestCacheKey (line 209)

Get cache key value for specific tax rate request

  • access: protected
string _getRequestCacheKey ($request $request)
  • $request $request

Inherited Methods

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)
CALC_ROW_BASE = 'ROW_BASE_CALCULATION' (line 40)
CALC_TAX_AFTER_DISCOUNT_ON_EXCL = '1_0' (line 36)
CALC_TAX_AFTER_DISCOUNT_ON_INCL = '1_1' (line 37)
CALC_TAX_BEFORE_DISCOUNT_ON_EXCL = '0_0' (line 34)
CALC_TAX_BEFORE_DISCOUNT_ON_INCL = '0_1' (line 35)
CALC_TOTAL_BASE = 'TOTAL_BASE_CALCULATION' (line 41)
CALC_UNIT_BASE = 'UNIT_BASE_CALCULATION' (line 39)

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