TaxRate

Type: Class
Namespace: craft\commerce\models
Inherits: craft\commerce\models\TaxRate » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ModelInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since: 2.0

Tax Rate model.

# Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
code	string (opens new window), null (opens new window) – Optional code used for internal reference
cpEditUrl	string (opens new window)
dateCreated	DateTime (opens new window), null (opens new window)
dateUpdated	DateTime (opens new window), null (opens new window)
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window)	array (opens new window) – The first errors.
id	integer (opens new window), null (opens new window) – ID
include	boolean (opens new window) – Whether the tax amount should be included in the subject price
isEverywhere	boolean (opens new window)
isLite	boolean (opens new window) – Is this the tax rate for the lite edition
isVat	boolean (opens new window) – Whether this tax rate represents VAT
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name	string (opens new window), null (opens new window) – Human-friendly name for the tax rate
rate	float (opens new window) – Rate percentage applied to the taxable subject
rateAsPercent	string (opens new window)
removeIncluded	boolean (opens new window) – Whether the included tax amount should be removed from disqualified subject prices
removeVatIncluded	boolean (opens new window) – Whether an included VAT tax amount should be removed from VAT-disqualified subject prices
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
taxCategory	craft\commerce\models\TaxCategory, null (opens new window)
taxCategoryId	integer (opens new window), null (opens new window) – Tax category ID
taxZone	craft\commerce\models\TaxAddressZone, null (opens new window)
taxZoneId	integer (opens new window), null (opens new window) – Tax zone ID
taxable	string (opens new window) – The subject to which `$rate` should be applied.
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# `code`

Type: string (opens new window), null (opens new window)
Default value: null
Since: 2.2

Optional code used for internal reference

View source (opens new window)

# `cpEditUrl`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `include`

Type: boolean (opens new window)
Default value: false

Whether the tax amount should be included in the subject price

View source (opens new window)

# `isEverywhere`

Type: boolean (opens new window)
Default value: null

View source (opens new window)

# `isLite`

Type: boolean (opens new window)
Default value: false

Is this the tax rate for the lite edition

View source (opens new window)

# `isVat`

Type: boolean (opens new window)
Default value: false

Whether this tax rate represents VAT

View source (opens new window)

# `name`

Type: string (opens new window), null (opens new window)
Default value: null

Human-friendly name for the tax rate

View source (opens new window)

# `rate`

Type: float (opens new window)
Default value: 0.0

Rate percentage applied to the taxable subject

View source (opens new window)

# `rateAsPercent`

Type: string (opens new window)
Default value: null

View source (opens new window)

# `removeIncluded`

Type: boolean (opens new window)
Default value: false
Since: 3.4

Whether the included tax amount should be removed from disqualified subject prices

View source (opens new window)

# `removeVatIncluded`

Type: boolean (opens new window)
Default value: false
Since: 3.4

Whether an included VAT tax amount should be removed from VAT-disqualified subject prices

View source (opens new window)

# `taxCategory`

Type: craft\commerce\models\TaxCategory, null (opens new window)
Default value: null

View source (opens new window)

# `taxCategoryId`

Type: integer (opens new window), null (opens new window)
Default value: null

Tax category ID

View source (opens new window)

# `taxZone`

Type: craft\commerce\models\TaxAddressZone, null (opens new window)
Default value: null

View source (opens new window)

# `taxZoneId`

Type: integer (opens new window), null (opens new window)
Default value: null

Tax zone ID

View source (opens new window)

# `taxable`

Type: string (opens new window)
Default value: 'price'

The subject to which $rate should be applied. Options:

price – line item price
shipping – line item shipping cost
price_shipping – line item price and shipping cost
order_total_shipping – order total shipping cost
order_total_price – order total taxable price (line item subtotal + total discounts + total shipping)

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)
__construct() (opens new window)
__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.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes() (opens new window)	Returns the list of attribute names.
beforeValidate() (opens new window)	This method is invoked before validation starts.
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.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() (opens new window)	Returns the names of any attributes that should hold DateTime (opens new window) values.
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.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray() (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.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getCpEditUrl()	Returns the tax rate’s control panel edit page URL.
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getIsEverywhere()	Returns `true` is this tax rate isn’t limited by zone.
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getRateAsPercent()	Returns `$rate` formatted as a percentage.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getTaxCategory()	Returns the designated Tax Category for the rate, or `null` if none has been designated.
getTaxZone()	Returns the designated Tax Zone for the rate, or `null` if none has been designated.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
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.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
rules() (opens new window)	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setScenario() (opens new window)	Sets the scenario for the model.
toArray() (opens new window)	Converts the model into an array.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateMultiple() (opens new window)	Validates multiple models.

# `extraFields()`

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() (opens new window) except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() (opens new window) on the format of the return value.

# `getCpEditUrl()`

Returns the tax rate’s control panel edit page URL.

View source (opens new window)

Returns

string (opens new window)

# `getIsEverywhere()`

Returns true is this tax rate isn’t limited by zone.

View source (opens new window)

Returns

boolean (opens new window) – Whether this tax rate applies to any zone

Throws

yii\base\InvalidConfigException (opens new window)

# `getRateAsPercent()`

Returns $rate formatted as a percentage.

View source (opens new window)

Returns

string (opens new window)

# `getTaxCategory()`

Returns the designated Tax Category for the rate, or null if none has been designated.

View source (opens new window)

Returns

craft\commerce\models\TaxCategory, null (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `getTaxZone()`

Returns the designated Tax Zone for the rate, or null if none has been designated.

View source (opens new window)

Returns

craft\commerce\models\TaxAddressZone, null (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# Protected Methods

Method	Description
defineBehaviors() (opens new window)	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor() (opens new window)	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window)	Extracts the root field names from nested fields.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

# `defineRules()`

Returns the validation rules for attributes.

See rules() (opens new window) for details about what should be returned.

Models should override this method instead of rules() (opens new window) so EVENT_DEFINE_RULES (opens new window) handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# Constants

Constant	Description
`SCENARIO_DEFAULT`	The name of the default scenario.

← TaxCategory Transaction →

TaxRate

# Public Properties

# code

# cpEditUrl

# dateCreated

# dateUpdated

# id

# include

# isEverywhere

# isLite

# isVat

# name

# rate

# rateAsPercent

# removeIncluded

# removeVatIncluded

# taxCategory

# taxCategoryId

# taxZone

# taxZoneId

# taxable

# Public Methods

# extraFields()

Returns

# getCpEditUrl()

Returns

# getIsEverywhere()

Returns

Throws

# getRateAsPercent()

Returns

# getTaxCategory()

Returns

Throws

# getTaxZone()

Returns

Throws

# Protected Methods

# defineRules()

Returns

# Constants

# `code`

# `cpEditUrl`

# `dateCreated`

# `dateUpdated`

# `id`

# `include`

# `isEverywhere`

# `isLite`

# `isVat`

# `name`

# `rate`

# `rateAsPercent`

# `removeIncluded`

# `removeVatIncluded`

# `taxCategory`

# `taxCategoryId`

# `taxZone`

# `taxZoneId`

# `taxable`

# `extraFields()`

# `getCpEditUrl()`

# `getIsEverywhere()`

# `getRateAsPercent()`

# `getTaxCategory()`

# `getTaxZone()`

# `defineRules()`