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[] |
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component |
liteTaxRate | craft\commerce\models\TaxRate |
# allTaxRates
- Type
- craft\commerce\models\TaxRate[]
- Access
- Read-only
View source (opens new window)
# liteTaxRate
- Type
- craft\commerce\models\TaxRate
- Access
- Read-only
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 an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__unset() (opens new window) | Sets an object property to 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 of the existing tax rates. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getLiteTaxRate() | |
getTaxRateById() | Returns a tax rate by ID. |
getTaxRatesForZone() | Returns an array of all of the rates belonging to the 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. |
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 lite tax rate |
saveTaxRate() | |
trigger() (opens new window) | Triggers an event. |
# deleteTaxRateById()
Deletes a tax rate by ID.
View source (opens new window)
Arguments
Returns
# getAllTaxRates()
Returns an array of all of the existing tax rates.
View source (opens new window)
Returns
craft\commerce\models\TaxRate[]
# getLiteTaxRate()
View source (opens new window)
Returns
# getTaxRateById()
Returns a tax rate by ID.
View source (opens new window)
Arguments
Returns
craft\commerce\models\TaxRate, null (opens new window)
# getTaxRatesForZone()
Returns an array of all of the rates belonging to the zone
View source (opens new window)
Arguments
Returns
craft\commerce\models\TaxRate[]
# saveLiteTaxRate()
Saves a lite tax rate
View source (opens new window)
Arguments
$model
(craft\commerce\models\TaxRate)$runValidation
(boolean (opens new window)) – Should we validate this rate before saving.
Returns
Throws
# saveTaxRate()
View source (opens new window)
Arguments
$model
(craft\commerce\models\TaxRate)$runValidation
(boolean (opens new window)) – Should we validate this rate before saving.