Overview

Packages

  • currencysymbol
  • MAbout
  • Mage
    • Admin
    • Adminhtml
    • AdminNotification
    • Api
    • Api2
    • Authorizenet
    • Backup
    • Bundle
    • Captcha
    • Catalog
    • CatalogIndex
    • CatalogInventory
    • CatalogRule
    • CatalogSearch
    • Centinel
    • Checkout
    • Cms
    • Compiler
    • Connect
    • Contacts
    • Core
    • Cron
    • CurrencySymbol
    • Customer
    • Dataflow
    • Directory
    • DirtectPost
    • Downloadable
    • Eav
    • GiftMessage
    • GoogleAnalytics
    • GoogleBase
    • GoogleCheckout
    • ImportExport
    • Index
    • Install
    • Log
    • Media
    • Newsletter
    • Oauth
    • Page
    • PageCache
    • Paygate
    • Payment
    • Paypal
    • PaypalUk
    • Persistent
    • Poll
    • ProductAlert
    • Rating
    • Reports
    • Review
    • Rss
    • Rule
    • Sales
    • SalesRule
    • Sedfriend
    • Sendfriend
    • Shipping
    • Sitemap
    • Tag
    • Tax
    • Usa
    • Weee
    • Widget
    • Wishlist
    • XmlConnect
  • None
  • Phoenix
    • Moneybookers
  • PHP
  • Zend
    • Date
    • Mime
    • XmlRpc

Classes

  • Mage_Tax_Block_Adminhtml_Frontend_Region_Updater
  • Mage_Tax_Block_Checkout_Discount
  • Mage_Tax_Block_Checkout_Grandtotal
  • Mage_Tax_Block_Checkout_Shipping
  • Mage_Tax_Block_Checkout_Subtotal
  • Mage_Tax_Block_Checkout_Tax
  • Mage_Tax_Block_Sales_Order_Tax
  • Mage_Tax_Helper_Data
  • Mage_Tax_Model_Calculation
  • Mage_Tax_Model_Calculation_Rate
  • Mage_Tax_Model_Calculation_Rate_Title
  • Mage_Tax_Model_Calculation_Rule
  • Mage_Tax_Model_Class
  • Mage_Tax_Model_Class_Source_Customer
  • Mage_Tax_Model_Class_Source_Product
  • Mage_Tax_Model_Config
  • Mage_Tax_Model_Config_Price_Include
  • Mage_Tax_Model_Mysql4_Calculation
  • Mage_Tax_Model_Mysql4_Calculation_Collection
  • Mage_Tax_Model_Mysql4_Calculation_Rate
  • Mage_Tax_Model_Mysql4_Calculation_Rate_Collection
  • Mage_Tax_Model_Mysql4_Calculation_Rate_Title
  • Mage_Tax_Model_Mysql4_Calculation_Rate_Title_Collection
  • Mage_Tax_Model_Mysql4_Calculation_Rule
  • Mage_Tax_Model_Mysql4_Calculation_Rule_Collection
  • Mage_Tax_Model_Mysql4_Class
  • Mage_Tax_Model_Mysql4_Class_Collection
  • Mage_Tax_Model_Mysql4_Report_Collection
  • Mage_Tax_Model_Mysql4_Report_Tax
  • Mage_Tax_Model_Mysql4_Report_Updatedat_Collection
  • Mage_Tax_Model_Mysql4_Sales_Order_Tax
  • Mage_Tax_Model_Mysql4_Sales_Order_Tax_Collection
  • Mage_Tax_Model_Mysql4_Setup
  • Mage_Tax_Model_Observer
  • Mage_Tax_Model_Resource_Calculation
  • Mage_Tax_Model_Resource_Calculation_Collection
  • Mage_Tax_Model_Resource_Calculation_Rate
  • Mage_Tax_Model_Resource_Calculation_Rate_Collection
  • Mage_Tax_Model_Resource_Calculation_Rate_Title
  • Mage_Tax_Model_Resource_Calculation_Rate_Title_Collection
  • Mage_Tax_Model_Resource_Calculation_Rule
  • Mage_Tax_Model_Resource_Calculation_Rule_Collection
  • Mage_Tax_Model_Resource_Class
  • Mage_Tax_Model_Resource_Class_Collection
  • Mage_Tax_Model_Resource_Report_Collection
  • Mage_Tax_Model_Resource_Report_Tax
  • Mage_Tax_Model_Resource_Report_Tax_Createdat
  • Mage_Tax_Model_Resource_Report_Tax_Updatedat
  • Mage_Tax_Model_Resource_Report_Updatedat_Collection
  • Mage_Tax_Model_Resource_Sales_Order_Tax
  • Mage_Tax_Model_Resource_Sales_Order_Tax_Collection
  • Mage_Tax_Model_Resource_Sales_Order_Tax_Item
  • Mage_Tax_Model_Resource_Sales_Order_Tax_Item_Collection
  • Mage_Tax_Model_Resource_Setup
  • Mage_Tax_Model_Sales_Order_Tax
  • Mage_Tax_Model_Sales_Order_Tax_Item
  • Mage_Tax_Model_Sales_Pdf_Grandtotal
  • Mage_Tax_Model_Sales_Pdf_Shipping
  • Mage_Tax_Model_Sales_Pdf_Subtotal
  • Mage_Tax_Model_Sales_Pdf_Tax
  • Mage_Tax_Model_Sales_Total_Quote_Discount
  • Mage_Tax_Model_Sales_Total_Quote_Nominal_Subtotal
  • Mage_Tax_Model_Sales_Total_Quote_Nominal_Tax
  • Mage_Tax_Model_Sales_Total_Quote_Shipping
  • Mage_Tax_Model_Sales_Total_Quote_Subtotal
  • Mage_Tax_Model_Sales_Total_Quote_Tax
  • Mage_Tax_Model_System_Config_Source_Algorithm
  • Mage_Tax_Model_System_Config_Source_Apply
  • Mage_Tax_Model_System_Config_Source_PriceType
  • Mage_Tax_Model_System_Config_Source_Tax_Country
  • Mage_Tax_Model_System_Config_Source_Tax_Display_Type
  • Mage_Tax_Model_System_Config_Source_Tax_Region

Exceptions

  • Mage_Tax_Exception
  • Overview
  • Package
  • Class
  • Tree

Class Mage_Tax_Model_Config

Configuration pathes storage

Package: Mage\Tax
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/Tax/Model/Config.php
Methods summary
public boolean
# priceIncludesTax( mix $store = null )

Check if product prices inputed include tax

Check if product prices inputed include tax

Parameters

$store
mix
$store

Returns

boolean
public boolean
# applyTaxAfterDiscount( mixed $store = null )

Check what taxes should be applied after discount

Check what taxes should be applied after discount

Parameters

$store
mixed
$store

Returns

boolean
public integer
# getPriceDisplayType( mixed $store = null )

Get product price display type
1 - Excluding tax
2 - Including tax
3 - Both

Get product price display type 1 - Excluding tax 2 - Including tax 3 - Both

Parameters

$store
mixed
$store

Returns

integer
public 0|1
# discountTax( null|integer $store = null )

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

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

Parameters

$store
null|integer
$store

Returns

0|1
public string
# getCalculationSequence( null|integer|string|Mage_Core_Model_Store $store = null )

Get taxes/discounts calculation sequence. This sequence depends on "Apply Customer Tax" and "Apply Discount On Prices" configuration options.

Get taxes/discounts calculation sequence. This sequence depends on "Apply Customer Tax" and "Apply Discount On Prices" configuration options.

Parameters

$store
null|integer|string|Mage_Core_Model_Store
$store

Returns

string
public Mage_Tax_Model_Config
# setNeedUsePriceExcludeTax( boolean $flag )

Specify flag what we need use price exclude tax

Specify flag what we need use price exclude tax

Parameters

$flag
boolean
$flag

Returns

Mage_Tax_Model_Config
public boolean
# getNeedUsePriceExcludeTax( )

Get flag what we need use price exclude tax

Get flag what we need use price exclude tax

Returns

boolean
$flag
public Mage_Tax_Model_Config
# setNeedUseShippingExcludeTax( boolean $flag )

Specify flag what we need use shipping price exclude tax

Specify flag what we need use shipping price exclude tax

Parameters

$flag
boolean
$flag

Returns

Mage_Tax_Model_Config
public boolean
# getNeedUseShippingExcludeTax( )

Get flag what we need use shipping price exclude tax

Get flag what we need use shipping price exclude tax

Returns

boolean
$flag
public string
# getAlgorithm( store $store = null )

Get defined tax calculation agorithm

Get defined tax calculation agorithm

Parameters

$store
store
$store

Returns

string
public integer
# getShippingTaxClass( store $store = null )

Get tax class id specified for shipping tax estimation

Get tax class id specified for shipping tax estimation

Parameters

$store
store
$store

Returns

integer
public integer
# getShippingPriceDisplayType( store $store = null )

Get shipping methods prices display type

Get shipping methods prices display type

Parameters

$store
store
$store

Returns

integer
public boolean
# shippingPriceIncludesTax( store $store = null )

Check if shiping prices include tax

Check if shiping prices include tax

Parameters

$store
store
$store

Returns

boolean
public
# setShippingPriceIncludeTax( boolean $flag )

Declare shipping prices type

Declare shipping prices type

Parameters

$flag
boolean
$flag
public
# displayCartPricesInclTax( mixed $store = null )
public
# displayCartPricesExclTax( mixed $store = null )
public
# displayCartPricesBoth( mixed $store = null )
public
# displayCartSubtotalInclTax( mixed $store = null )
public
# displayCartSubtotalExclTax( mixed $store = null )
public
# displayCartSubtotalBoth( mixed $store = null )
public
# displayCartShippingInclTax( mixed $store = null )
public
# displayCartShippingExclTax( mixed $store = null )
public
# displayCartShippingBoth( mixed $store = null )
public
# displayCartDiscountInclTax( mixed $store = null )
public
# displayCartDiscountExclTax( mixed $store = null )
public
# displayCartDiscountBoth( mixed $store = null )
public
# displayCartTaxWithGrandTotal( mixed $store = null )
public
# displayCartFullSummary( mixed $store = null )
public
# displayCartZeroTax( mixed $store = null )
public
# displaySalesPricesInclTax( mixed $store = null )
public
# displaySalesPricesExclTax( mixed $store = null )
public
# displaySalesPricesBoth( mixed $store = null )
public
# displaySalesSubtotalInclTax( mixed $store = null )
public
# displaySalesSubtotalExclTax( mixed $store = null )
public
# displaySalesSubtotalBoth( mixed $store = null )
public
# displaySalesShippingInclTax( mixed $store = null )
public
# displaySalesShippingExclTax( mixed $store = null )
public
# displaySalesShippingBoth( mixed $store = null )
public
# displaySalesDiscountInclTax( mixed $store = null )
public
# displaySalestDiscountExclTax( mixed $store = null )
public
# displaySalesDiscountBoth( mixed $store = null )
public
# displaySalesTaxWithGrandTotal( mixed $store = null )
public
# displaySalesFullSummary( mixed $store = null )
public
# displaySalesZeroTax( mixed $store = null )
Constants summary
string CONFIG_XML_PATH_SHIPPING_TAX_CLASS 'tax/classes/shipping_tax_class'
#
string CONFIG_XML_PATH_PRICE_INCLUDES_TAX 'tax/calculation/price_includes_tax'
#
string CONFIG_XML_PATH_SHIPPING_INCLUDES_TAX 'tax/calculation/shipping_includes_tax'
#
string CONFIG_XML_PATH_BASED_ON 'tax/calculation/based_on'
#
string CONFIG_XML_PATH_APPLY_ON 'tax/calculation/apply_tax_on'
#
string CONFIG_XML_PATH_APPLY_AFTER_DISCOUNT 'tax/calculation/apply_after_discount'
#
string CONFIG_XML_PATH_DISCOUNT_TAX 'tax/calculation/discount_tax'
#
string XML_PATH_ALGORITHM 'tax/calculation/algorithm'
#
string CONFIG_XML_PATH_DEFAULT_COUNTRY 'tax/defaults/country'
#
string CONFIG_XML_PATH_DEFAULT_REGION 'tax/defaults/region'
#
string CONFIG_XML_PATH_DEFAULT_POSTCODE 'tax/defaults/postcode'
#
string CONFIG_XML_PATH_PRICE_DISPLAY_TYPE 'tax/display/type'
#

Prices display settings

Prices display settings

string CONFIG_XML_PATH_DISPLAY_SHIPPING 'tax/display/shipping'
#
string XML_PATH_DISPLAY_CART_PRICE 'tax/cart_display/price'
#

Shopping cart display settings

Shopping cart display settings

string XML_PATH_DISPLAY_CART_SUBTOTAL 'tax/cart_display/subtotal'
#
string XML_PATH_DISPLAY_CART_SHIPPING 'tax/cart_display/shipping'
#
string XML_PATH_DISPLAY_CART_DISCOUNT 'tax/cart_display/discount'
#
string XML_PATH_DISPLAY_CART_GRANDTOTAL 'tax/cart_display/grandtotal'
#
string XML_PATH_DISPLAY_CART_FULL_SUMMARY 'tax/cart_display/full_summary'
#
string XML_PATH_DISPLAY_CART_ZERO_TAX 'tax/cart_display/zero_tax'
#
string XML_PATH_DISPLAY_SALES_PRICE 'tax/sales_display/price'
#

Shopping cart display settings

Shopping cart display settings

string XML_PATH_DISPLAY_SALES_SUBTOTAL 'tax/sales_display/subtotal'
#
string XML_PATH_DISPLAY_SALES_SHIPPING 'tax/sales_display/shipping'
#
string XML_PATH_DISPLAY_SALES_DISCOUNT 'tax/sales_display/discount'
#
string XML_PATH_DISPLAY_SALES_GRANDTOTAL 'tax/sales_display/grandtotal'
#
string XML_PATH_DISPLAY_SALES_FULL_SUMMARY 'tax/sales_display/full_summary'
#
string XML_PATH_DISPLAY_SALES_ZERO_TAX 'tax/sales_display/zero_tax'
#
string CALCULATION_STRING_SEPARATOR '|'
#
integer DISPLAY_TYPE_EXCLUDING_TAX 1
#
integer DISPLAY_TYPE_INCLUDING_TAX 2
#
integer DISPLAY_TYPE_BOTH 3
#
string CONFIG_XML_PATH_DEFAULT_PRODUCT_TAX_GROUP 'catalog/product/default_tax_group'
#
string CONFIG_XML_PATH_DISPLAY_TAX_COLUMN 'tax/display/column_in_summary'
#
string CONFIG_XML_PATH_DISPLAY_FULL_SUMMARY 'tax/display/full_summary'
#
string CONFIG_XML_PATH_DISPLAY_ZERO_TAX 'tax/display/zero_tax'
#
Properties summary
protected boolean $_needUsePriceExcludeTax false
#

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

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

protected boolean $_needUseShippingExcludeTax false
#

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

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

protected mixed $_shippingPriceIncludeTax null
#

bool

bool

Magento 1.7.0.2 API documentation generated by ApiGen 2.8.0