Taxes
- Type
- Class
- Namespace
- craft\commerce\services
- Inherits
- craft\commerce\services\Taxes » craft\base\Component (opens new window) » 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\ComponentInterface (opens new window), craft\base\ModelInterface (opens new window), craft\commerce\base\TaxEngineInterface, 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)
Class Taxes
View source (opens new window)
# 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. |
| engine | craft\commerce\base\TaxEngineInterface |
| 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. |
| iterator (opens new window) | ArrayIterator (opens new window) – An iterator for traversing the items in the list. |
| scenario (opens new window) | string (opens new window) – The scenario that this model is in. |
| validators (opens new window) | ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model. |
# engine
- Type
- craft\commerce\base\TaxEngineInterface
- Default value
null
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. |
| 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. |
| 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. |
| 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. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| 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. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| extraFields() (opens new window) | 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. |
| getEngine() | Get the current tax engine. |
| 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. |
| getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
| getScenario() (opens new window) | Returns the scenario that this model is used in. |
| 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. |
| isSelectable() (opens new window) | Returns whether the component should be selectable in component Type selects. |
| 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. |
| 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 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. |
| 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)
# getEngine()
Get the current tax engine.
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.
View source (opens new window)
# Protected Methods
| Method | Description |
|---|---|
| defineBehaviors() (opens new window) | Returns the behaviors to attach to this class. |
| defineRules() (opens new window) | 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). |
# Constants
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |
# Events
# EVENT_REGISTER_TAX_ENGINE
- Type
- craft\commerce\events\TaxEngineEvent
- Since
- 3.1
The event that is triggered when determining the tax engine.
← TaxZones Transactions →