TaxRates
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\TaxRates » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 2.0
Tax Rate service.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| allTaxRates | craft\commerce\models\TaxRate[] – an array of all the existing tax rates |
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| liteTaxRate | craft\commerce\models\TaxRate – the lite tax rate |
# allTaxRates
- Type
- craft\commerce\models\TaxRate[]
- Default value
null
an array of all the existing tax rates
View source (opens new window)
# liteTaxRate
- Type
- craft\commerce\models\TaxRate
- Default value
null
the lite tax rate
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| deleteTaxRateById() | Deletes a tax rate by ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getAllTaxRates() | Returns an array of all existing tax rates. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| getLiteTaxRate() | Returns the Commerce Lite tax rate. |
| getTaxRateById() | Returns a tax rate by ID. |
| getTaxRatesByTaxZoneId() | Returns an array of all rates belonging to the specified zone. |
| getTaxRatesForZone() | Returns an array of all rates belonging to the specified zone. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| saveLiteTaxRate() | Saves a Commerce Lite tax rate. |
| saveTaxRate() | Saves a tax rate. |
| trigger() (opens new window) | Triggers an event. |
# deleteTaxRateById()
Deletes a tax rate by ID.
View source (opens new window)
Arguments
$id
Throws
# getAllTaxRates()
Returns an array of all existing tax rates.
View source (opens new window)
Returns
craft\commerce\models\TaxRate[]
# getLiteTaxRate()
Returns the Commerce Lite tax rate.
View source (opens new window)
Returns
Throws
# getTaxRateById()
Returns a tax rate by ID.
View source (opens new window)
Arguments
$id(integer (opens new window)) – The ID of the desired tax rate
Returns
?\craft\commerce\models\TaxRate
# getTaxRatesByTaxZoneId()
Returns an array of all rates belonging to the specified zone.
View source (opens new window)
Arguments
$taxZoneId(integer (opens new window)) – The ID of the tax zone whose rates we’d like returned
Returns
craft\commerce\models\TaxRate[]
# getTaxRatesForZone()
DEPRECATED
Deprecated in 4.0. Use getTaxRatesByTaxZoneId() instead.
Returns an array of all rates belonging to the specified zone.
View source (opens new window)
Arguments
$zone(craft\commerce\models\TaxAddressZone) – The tax zone whose rates we’d like returned
Returns
craft\commerce\models\TaxRate[]
# saveLiteTaxRate()
Saves a Commerce Lite tax rate.
View source (opens new window)
Arguments
$model(craft\commerce\models\TaxRate) – The tax rate model to be saved$runValidation(boolean (opens new window)) – Whether we should validate this rate before saving
Returns
Throws
# saveTaxRate()
Saves a tax rate.
View source (opens new window)
Arguments
$model(craft\commerce\models\TaxRate) – The tax rate model to be saved$runValidation(boolean (opens new window)) – Whether we should validate this rate before saving