TaxEngineInterface

Type
Interface
Namespace
craft\commerce\base
Extends
craft\base\ComponentInterface
Implemented by
craft\commerce\engines\Tax, craft\commerce\services\Taxes
Since
3.1

Tax Engine Interface

View source

# Public Methods

Method Description
cpTaxNavSubItems() The tax subNav items
createTaxCategories() Whether Craft Commerce should allow tax categories to be created by users.
createTaxRates() Whether Craft Commerce should allow tax rates to be created by users.
createTaxZones() Whether Craft Commerce should allow tax zones to be created by users.
deleteTaxCategories() Whether Craft Commerce should allow tax categories to be deleted.
deleteTaxRates() Whether Craft Commerce should allow tax rates to be deleted.
deleteTaxZones() Whether Craft Commerce should allow tax zones to be deleted.
displayName() Returns the display name of this class.
editTaxCategories() Whether Craft Commerce should allow tax categories to be edited.
editTaxRates() Whether Craft Commerce should allow tax rates to be edited.
editTaxZones() Whether Craft Commerce should allow tax zones to be edited.
taxAdjusterClass() Return class name for the Adjuster to be used for tax
taxCategoryActionHtml() Any action html to be added to the tax categories index header
taxRateActionHtml() Any action html to be added to the tax rates index header
taxZoneActionHtml() Any action html to be added to the tax zones index header
viewTaxCategories() Whether Craft Commerce should show the tax categories interface and allow tax categories to be edited.
viewTaxRates() Whether Craft Commerce should show the tax rates interface and allow tax rates to be edited.
viewTaxZones() Whether Craft Commerce should show the tax zones interface and allow tax zones to be edited.

# cpTaxNavSubItems()

The tax subNav items

View source

Returns

array

# createTaxCategories()

Whether Craft Commerce should allow tax categories to be created by users.

will not be called if viewTaxCategories is returned as false;

View source

Returns

boolean

# createTaxRates()

Whether Craft Commerce should allow tax rates to be created by users.

will not be called if viewTaxRates is returned as false;

View source

Returns

boolean

# createTaxZones()

Whether Craft Commerce should allow tax zones to be created by users.

will not be called if viewTaxZones is returned as false;

View source

Returns

boolean

# deleteTaxCategories()

Whether Craft Commerce should allow tax categories to be deleted.

will not be called if viewTaxCategories is returned as false;

View source

Returns

boolean

# deleteTaxRates()

Whether Craft Commerce should allow tax rates to be deleted.

will not be called if viewTaxRates is returned as false;

View source

Returns

boolean

# deleteTaxZones()

Whether Craft Commerce should allow tax zones to be deleted.

will not be called if viewTaxZones is returned as false;

View source

Returns

boolean

# editTaxCategories()

Whether Craft Commerce should allow tax categories to be edited.

will not be called if viewTaxCategories is returned as false;

View source

Returns

boolean

# editTaxRates()

Whether Craft Commerce should allow tax rates to be edited.

will not be called if viewTaxRates is returned as false;

View source

Returns

boolean

# editTaxZones()

Whether Craft Commerce should allow tax zones to be edited.

will not be called if viewTaxZones is returned as false;

View source

Returns

boolean

# taxAdjusterClass()

Return class name for the Adjuster to be used for tax

View source

Returns

string

# taxCategoryActionHtml()

Any action html to be added to the tax categories index header

View source

Returns

string

# taxRateActionHtml()

Any action html to be added to the tax rates index header

View source

Returns

string

# taxZoneActionHtml()

Any action html to be added to the tax zones index header

View source

Returns

string

# viewTaxCategories()

Whether Craft Commerce should show the tax categories interface and allow tax categories to be edited.

View source

Returns

boolean

# viewTaxRates()

Whether Craft Commerce should show the tax rates interface and allow tax rates to be edited.

View source

Returns

boolean

# viewTaxZones()

Whether Craft Commerce should show the tax zones interface and allow tax zones to be edited.

View source

Returns

boolean