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