TaxEngineInterface
- Type
- Interface
- Namespace
- craft\commerce\base
- Extends
- craft\base\ComponentInterface (opens new window)
- Implemented by
- craft\commerce\engines\Tax, craft\commerce\services\Taxes
- Since
- 3.1
Tax Engine Interface
View source (opens new window)
# 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() (opens new window) | 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. |
| extraFields() (opens new window) | Returns the list of additional fields that can be returned by toArray() (opens new window) in addition to those listed in fields() (opens new window). |
| fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified. |
| instance() (opens new window) | Returns static class instance, which can be used to obtain meta information. |
| isSelectable() (opens new window) | Returns whether the component should be selectable in component Type selects. |
| 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 |
| toArray() (opens new window) | Converts the object into an array. |
| 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 (opens new window)
# 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 (opens new window)
# 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 (opens new window)
# 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 (opens new window)
# deleteTaxCategories()
Whether Craft Commerce should allow tax categories to be deleted.
will not be called if viewTaxCategories is returned as false;
View source (opens new window)
# deleteTaxRates()
Whether Craft Commerce should allow tax rates to be deleted.
will not be called if viewTaxRates is returned as false;
View source (opens new window)
# deleteTaxZones()
Whether Craft Commerce should allow tax zones to be deleted.
will not be called if viewTaxZones is returned as false;
View source (opens new window)
# editTaxCategories()
Whether Craft Commerce should allow tax categories to be edited.
will not be called if viewTaxCategories is returned as false;
View source (opens new window)
# editTaxRates()
Whether Craft Commerce should allow tax rates to be edited.
will not be called if viewTaxRates is returned as false;
View source (opens new window)
# editTaxZones()
Whether Craft Commerce should allow tax zones to be edited.
will not be called if viewTaxZones is returned as false;
View source (opens new window)
# taxAdjusterClass()
Return class name for the Adjuster to be used for tax
View source (opens new window)
# taxCategoryActionHtml()
Any action html to be added to the tax categories index header
View source (opens new window)
# taxRateActionHtml()
Any action html to be added to the tax rates index header
View source (opens new window)
# taxZoneActionHtml()
Any action html to be added to the tax zones index header
View source (opens new window)
# viewTaxCategories()
Whether Craft Commerce should show the tax categories interface and allow tax categories to be edited.
View source (opens new window)
# viewTaxRates()
Whether Craft Commerce should show the tax rates interface and allow tax rates to be edited.
View source (opens new window)
# viewTaxZones()
Whether Craft Commerce should show the tax zones interface and allow tax zones to be edited.