Docs For Class Mage_Tax_Model

Class Mage_Tax_Model_Config

Description

Configuration pathes storage

author: Magento Core Team <[email protected]>

Located in /Tax/Model/Config.php (line 34)

Class Constant Summary

CALCULATION_STRING_SEPARATOR = '|'

CONFIG_XML_PATH_APPLY_AFTER_DISCOUNT = 'tax/calculation/apply_after_discount'

CONFIG_XML_PATH_APPLY_ON = 'tax/calculation/apply_tax_on'

CONFIG_XML_PATH_BASED_ON = 'tax/calculation/based_on'

CONFIG_XML_PATH_DEFAULT_COUNTRY = 'tax/defaults/country'

CONFIG_XML_PATH_DEFAULT_POSTCODE = 'tax/defaults/postcode'

CONFIG_XML_PATH_DEFAULT_PRODUCT_TAX_GROUP = 'catalog/product/default_tax_group'

CONFIG_XML_PATH_DEFAULT_REGION = 'tax/defaults/region'

CONFIG_XML_PATH_DISCOUNT_TAX = 'tax/calculation/discount_tax'

CONFIG_XML_PATH_DISPLAY_FULL_SUMMARY = 'tax/display/full_summary'

CONFIG_XML_PATH_DISPLAY_SHIPPING = 'tax/display/shipping'

CONFIG_XML_PATH_DISPLAY_TAX_COLUMN = 'tax/display/column_in_summary'

CONFIG_XML_PATH_DISPLAY_ZERO_TAX = 'tax/display/zero_tax'

CONFIG_XML_PATH_PRICE_DISPLAY_TYPE = 'tax/display/type'

CONFIG_XML_PATH_PRICE_INCLUDES_TAX = 'tax/calculation/price_includes_tax'

CONFIG_XML_PATH_SHIPPING_INCLUDES_TAX = 'tax/calculation/shipping_includes_tax'

CONFIG_XML_PATH_SHIPPING_TAX_CLASS = 'tax/classes/shipping_tax_class'

CONFIG_XML_PATH_SHOW_IN_CATALOG = 'tax/display/show_in_catalog'

DISPLAY_TYPE_BOTH = 3

DISPLAY_TYPE_EXCLUDING_TAX = 1

DISPLAY_TYPE_INCLUDING_TAX = 2

XML_PATH_ALGORITHM = 'tax/calculation/algorithm'

XML_PATH_DISPLAY_CART_DISCOUNT = 'tax/cart_display/discount'

XML_PATH_DISPLAY_CART_FULL_SUMMARY = 'tax/cart_display/full_summary'

XML_PATH_DISPLAY_CART_GRANDTOTAL = 'tax/cart_display/grandtotal'

XML_PATH_DISPLAY_CART_PRICE = 'tax/cart_display/price'

XML_PATH_DISPLAY_CART_SHIPPING = 'tax/cart_display/shipping'

XML_PATH_DISPLAY_CART_SUBTOTAL = 'tax/cart_display/subtotal'

XML_PATH_DISPLAY_CART_ZERO_TAX = 'tax/cart_display/zero_tax'

XML_PATH_DISPLAY_SALES_DISCOUNT = 'tax/sales_display/discount'

XML_PATH_DISPLAY_SALES_FULL_SUMMARY = 'tax/sales_display/full_summary'

XML_PATH_DISPLAY_SALES_GRANDTOTAL = 'tax/sales_display/grandtotal'

XML_PATH_DISPLAY_SALES_PRICE = 'tax/sales_display/price'

XML_PATH_DISPLAY_SALES_SHIPPING = 'tax/sales_display/shipping'

XML_PATH_DISPLAY_SALES_SUBTOTAL = 'tax/sales_display/subtotal'

XML_PATH_DISPLAY_SALES_ZERO_TAX = 'tax/sales_display/zero_tax'

Variable Summary

bool $_needUsePriceExcludeTax

bool $_needUseShippingExcludeTax

$_shippingPriceIncludeTax $_shippingPriceIncludeTax

Method Summary

bool applyTaxAfterDiscount ([mixed $store = null])

01 discountTax ([null|int $store = null])

void displayCartDiscountBoth ([ $store = null])

void displayCartDiscountExclTax ([ $store = null])

void displayCartDiscountInclTax ([ $store = null])

void displayCartFullSummary ([ $store = null])

void displayCartPricesBoth ([ $store = null])

void displayCartPricesExclTax ([ $store = null])

void displayCartPricesInclTax ([ $store = null])

void displayCartShippingBoth ([ $store = null])

void displayCartShippingExclTax ([ $store = null])

void displayCartShippingInclTax ([ $store = null])

void displayCartSubtotalBoth ([ $store = null])

void displayCartSubtotalExclTax ([ $store = null])

void displayCartSubtotalInclTax ([ $store = null])

void displayCartTaxWithGrandTotal ([ $store = null])

void displayCartZeroTax ([ $store = null])

bool displayFullSummary ([mixed $store = null])

void displaySalesDiscountBoth ([ $store = null])

void displaySalesDiscountInclTax ([ $store = null])

void displaySalesFullSummary ([ $store = null])

void displaySalesPricesBoth ([ $store = null])

void displaySalesPricesExclTax ([ $store = null])

void displaySalesPricesInclTax ([ $store = null])

void displaySalesShippingBoth ([ $store = null])

void displaySalesShippingExclTax ([ $store = null])

void displaySalesShippingInclTax ([ $store = null])

void displaySalesSubtotalBoth ([ $store = null])

void displaySalesSubtotalExclTax ([ $store = null])

void displaySalesSubtotalInclTax ([ $store = null])

void displaySalesTaxWithGrandTotal ([ $store = null])

void displaySalestDiscountExclTax ([ $store = null])

void displaySalesZeroTax ([ $store = null])

bool displayTaxColumn ([mixed $store = null])

bool displayZeroTax ([mixed $store = null])

string getAlgorithm ([store $store = null])

string getCalculationSequence ([null|int|string|Mage_Core_Model_Store $store = null])

bool getNeedUsePriceExcludeTax ()

bool getNeedUseShippingExcludeTax ()

int getPriceDisplayType ([mixed $store = null])

int getShippingPriceDisplayType ([store $store = null])

int getShippingTaxClass ([store $store = null])

bool priceIncludesTax ([mix $store = null])

Mage_Tax_Model_Config setNeedUsePriceExcludeTax (bool $flag)

Mage_Tax_Model_Config setNeedUseShippingExcludeTax (bool $flag)

void setShippingPriceIncludeTax (bool $flag)

bool shippingPriceIncludesTax ([store $store = null])

Variables

bool $_needUsePriceExcludeTax = false (line 101)

Flag which notify what we need use prices exclude tax for calculations

access: protected

bool $_needUseShippingExcludeTax = false (line 108)

Flag which notify what we need use shipping prices exclude tax for calculations

access: protected

$_shippingPriceIncludeTax $_shippingPriceIncludeTax = null (line 113)

var: bool
access: protected

Methods

applyTaxAfterDiscount (line 135)

Check what taxes should be applied after discount

access: public

bool applyTaxAfterDiscount ([mixed $store = null])

mixed $store

discountTax (line 160)

Get configuration setting "Apply Discount On Prices Including Tax" value

access: public

01 discountTax ([null|int $store = null])

null|int $store

displayCartDiscountBoth (line 387)

access: public

void displayCartDiscountBoth ([ $store = null])

$store

displayCartDiscountExclTax (line 382)

access: public

void displayCartDiscountExclTax ([ $store = null])

$store

displayCartDiscountInclTax (line 377)

access: public

void displayCartDiscountInclTax ([ $store = null])

$store

displayCartFullSummary (line 397)

access: public

void displayCartFullSummary ([ $store = null])

$store

displayCartPricesBoth (line 342)

access: public

void displayCartPricesBoth ([ $store = null])

$store

displayCartPricesExclTax (line 337)

access: public

void displayCartPricesExclTax ([ $store = null])

$store

displayCartPricesInclTax (line 332)

access: public

void displayCartPricesInclTax ([ $store = null])

$store

displayCartShippingBoth (line 372)

access: public

void displayCartShippingBoth ([ $store = null])

$store

displayCartShippingExclTax (line 367)

access: public

void displayCartShippingExclTax ([ $store = null])

$store

displayCartShippingInclTax (line 362)

access: public

void displayCartShippingInclTax ([ $store = null])

$store

displayCartSubtotalBoth (line 357)

access: public

void displayCartSubtotalBoth ([ $store = null])

$store

displayCartSubtotalExclTax (line 352)

access: public

void displayCartSubtotalExclTax ([ $store = null])

$store

displayCartSubtotalInclTax (line 347)

access: public

void displayCartSubtotalInclTax ([ $store = null])

$store

displayCartTaxWithGrandTotal (line 392)

access: public

void displayCartTaxWithGrandTotal ([ $store = null])

$store

displayCartZeroTax (line 402)

access: public

void displayCartZeroTax ([ $store = null])

$store

displayFullSummary (line 300)

Check if need display full tax summary information in totals block

deprecated: please use displayCartFullSummary or displaySalesFullSummary
access: public

bool displayFullSummary ([mixed $store = null])

mixed $store

displaySalesDiscountBoth (line 463)

access: public

void displaySalesDiscountBoth ([ $store = null])

$store

displaySalesDiscountInclTax (line 453)

access: public

void displaySalesDiscountInclTax ([ $store = null])

$store

displaySalesFullSummary (line 473)

access: public

void displaySalesFullSummary ([ $store = null])

$store

displaySalesPricesBoth (line 418)

access: public

void displaySalesPricesBoth ([ $store = null])

$store

displaySalesPricesExclTax (line 413)

access: public

void displaySalesPricesExclTax ([ $store = null])

$store

displaySalesPricesInclTax (line 408)

access: public

void displaySalesPricesInclTax ([ $store = null])

$store

displaySalesShippingBoth (line 448)

access: public

void displaySalesShippingBoth ([ $store = null])

$store

displaySalesShippingExclTax (line 443)

access: public

void displaySalesShippingExclTax ([ $store = null])

$store

displaySalesShippingInclTax (line 438)

access: public

void displaySalesShippingInclTax ([ $store = null])

$store

displaySalesSubtotalBoth (line 433)

access: public

void displaySalesSubtotalBoth ([ $store = null])

$store

displaySalesSubtotalExclTax (line 428)

access: public

void displaySalesSubtotalExclTax ([ $store = null])

$store

displaySalesSubtotalInclTax (line 423)

access: public

void displaySalesSubtotalInclTax ([ $store = null])

$store

displaySalesTaxWithGrandTotal (line 468)

access: public

void displaySalesTaxWithGrandTotal ([ $store = null])

$store

displaySalestDiscountExclTax (line 458)

access: public

void displaySalestDiscountExclTax ([ $store = null])

$store

displaySalesZeroTax (line 478)

access: public

void displaySalesZeroTax ([ $store = null])

$store

displayTaxColumn (line 324)

Get shopping cart prices display type

deprecated: please use displayCartPrice or displaySalesZeroTax
access: public

bool displayTaxColumn ([mixed $store = null])

mixed $store

displayZeroTax (line 312)

Check if need display zero tax in subtotal

deprecated: please use displayCartZeroTax or displaySalesZeroTax
access: public

bool displayZeroTax ([mixed $store = null])

mixed $store

getAlgorithm (line 241)

Get defined tax calculation agorithm

access: public

string getAlgorithm ([store $store = null])

store $store

getCalculationSequence (line 172)

Get taxes/discounts calculation sequence.

This sequence depends on "Apply Customer Tax" and "Apply Discount On Prices" configuration options.

access: public

string getCalculationSequence ([null|int|string|Mage_Core_Model_Store $store = null])

null|int|string|Mage_Core_Model_Store $store

getNeedUsePriceExcludeTax (line 207)

Get flag what we need use price exclude tax

access: public

bool getNeedUsePriceExcludeTax ()

getNeedUseShippingExcludeTax (line 229)

Get flag what we need use shipping price exclude tax

access: public

bool getNeedUseShippingExcludeTax ()

getPriceDisplayType (line 149)

Get product price display type

- Excluding tax
- Including tax
- Both

access: public

int getPriceDisplayType ([mixed $store = null])

mixed $store

getShippingPriceDisplayType (line 263)

Get shipping methods prices display type

access: public

int getShippingPriceDisplayType ([store $store = null])

store $store

getShippingTaxClass (line 252)

Get tax class id specified for shipping tax estimation

access: public

int getShippingTaxClass ([store $store = null])

store $store

priceIncludesTax (line 121)

Check if product prices inputed include tax

access: public

bool priceIncludesTax ([mix $store = null])

mix $store

setNeedUsePriceExcludeTax (line 196)

Specify flag what we need use price exclude tax

access: public

Mage_Tax_Model_Config setNeedUsePriceExcludeTax (bool $flag)

bool $flag

setNeedUseShippingExcludeTax (line 218)

Specify flag what we need use shipping price exclude tax

access: public

Mage_Tax_Model_Config setNeedUseShippingExcludeTax (bool $flag)

bool $flag

setShippingPriceIncludeTax (line 286)

Declare shipping prices type

access: public

void setShippingPriceIncludeTax (bool $flag)

bool $flag

shippingPriceIncludesTax (line 274)

Check if shiping prices include tax

access: public

bool shippingPriceIncludesTax ([store $store = null])

store $store

Class Constants

CALCULATION_STRING_SEPARATOR = '|' (line 81)

CONFIG_XML_PATH_APPLY_AFTER_DISCOUNT = 'tax/calculation/apply_after_discount' (line 44)

CONFIG_XML_PATH_APPLY_ON = 'tax/calculation/apply_tax_on' (line 43)

CONFIG_XML_PATH_BASED_ON = 'tax/calculation/based_on' (line 42)

CONFIG_XML_PATH_DEFAULT_COUNTRY = 'tax/defaults/country' (line 49)

CONFIG_XML_PATH_DEFAULT_POSTCODE = 'tax/defaults/postcode' (line 51)

CONFIG_XML_PATH_DEFAULT_PRODUCT_TAX_GROUP = 'catalog/product/default_tax_group' (line 91)

CONFIG_XML_PATH_DEFAULT_REGION = 'tax/defaults/region' (line 50)

CONFIG_XML_PATH_DISCOUNT_TAX = 'tax/calculation/discount_tax' (line 45)

CONFIG_XML_PATH_DISPLAY_FULL_SUMMARY = 'tax/display/full_summary' (line 93)

CONFIG_XML_PATH_DISPLAY_SHIPPING = 'tax/display/shipping' (line 57)

CONFIG_XML_PATH_DISPLAY_TAX_COLUMN = 'tax/display/column_in_summary' (line 92)

CONFIG_XML_PATH_DISPLAY_ZERO_TAX = 'tax/display/zero_tax' (line 94)

CONFIG_XML_PATH_PRICE_DISPLAY_TYPE = 'tax/display/type' (line 56)

Prices display settings

CONFIG_XML_PATH_PRICE_INCLUDES_TAX = 'tax/calculation/price_includes_tax' (line 40)

CONFIG_XML_PATH_SHIPPING_INCLUDES_TAX = 'tax/calculation/shipping_includes_tax' (line 41)

CONFIG_XML_PATH_SHIPPING_TAX_CLASS = 'tax/classes/shipping_tax_class' (line 37)

CONFIG_XML_PATH_SHOW_IN_CATALOG = 'tax/display/show_in_catalog' (line 90)

deprecated:

DISPLAY_TYPE_BOTH = 3 (line 85)

DISPLAY_TYPE_EXCLUDING_TAX = 1 (line 83)

DISPLAY_TYPE_INCLUDING_TAX = 2 (line 84)

XML_PATH_ALGORITHM = 'tax/calculation/algorithm' (line 46)

XML_PATH_DISPLAY_CART_DISCOUNT = 'tax/cart_display/discount' (line 65)

XML_PATH_DISPLAY_CART_FULL_SUMMARY = 'tax/cart_display/full_summary' (line 67)

XML_PATH_DISPLAY_CART_GRANDTOTAL = 'tax/cart_display/grandtotal' (line 66)

XML_PATH_DISPLAY_CART_PRICE = 'tax/cart_display/price' (line 62)

Shopping cart display settings

XML_PATH_DISPLAY_CART_SHIPPING = 'tax/cart_display/shipping' (line 64)

XML_PATH_DISPLAY_CART_SUBTOTAL = 'tax/cart_display/subtotal' (line 63)

XML_PATH_DISPLAY_CART_ZERO_TAX = 'tax/cart_display/zero_tax' (line 68)

XML_PATH_DISPLAY_SALES_DISCOUNT = 'tax/sales_display/discount' (line 76)

XML_PATH_DISPLAY_SALES_FULL_SUMMARY = 'tax/sales_display/full_summary' (line 78)

XML_PATH_DISPLAY_SALES_GRANDTOTAL = 'tax/sales_display/grandtotal' (line 77)

XML_PATH_DISPLAY_SALES_PRICE = 'tax/sales_display/price' (line 73)

Shopping cart display settings

XML_PATH_DISPLAY_SALES_SHIPPING = 'tax/sales_display/shipping' (line 75)

XML_PATH_DISPLAY_SALES_SUBTOTAL = 'tax/sales_display/subtotal' (line 74)

XML_PATH_DISPLAY_SALES_ZERO_TAX = 'tax/sales_display/zero_tax' (line 79)

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