Taxes

Type

Class

Namespace

craft\commerce\services

Inherits

craft\commerce\services\Taxes » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ModelInterface, craft\commerce\base\TaxEngineInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Class Taxes

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
enabledTaxIdValidators	\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>
engine	craft\commerce\base\TaxEngineInterface
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
iterator	ArrayIterator – An iterator for traversing the items in the list.
scenario	string – The scenario that this model is in.
taxIdValidators	\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

enabledTaxIdValidators

Type

\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>

Default value

null

Access

Read-only

View source

engine

Type

craft\commerce\base\TaxEngineInterface

Default value

null

View source

taxIdValidators

Type

\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>

Default value

null

Access

Read-only

Since

5.3.0

View source

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()
__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.
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.
addError()	Adds a new error to the specified attribute.
addErrors()	Adds a list of errors.
addModelErrors()	Adds errors from another model, with a given attribute name prefix.
afterValidate()	This method is invoked after validation ends.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
attributeHints()	Returns the attribute hints.
attributeLabels()	Returns the attribute labels.
attributes()	Returns the list of attribute names.
beforeValidate()	This method is invoked before validation starts.
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.
clearErrors()	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()	Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()	Returns the names of any attributes that should hold DateTime 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()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
displayName()	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()	Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()	Returns the form name that this model class should use.
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()	Returns the validators applicable to the current scenario.
getAttributeHint()	Returns the text hint for the specified attribute.
getAttributeLabel()	Returns the text label for the specified attribute.
getAttributes()	Returns attribute values.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getEnabledTaxIdValidators()
getEngine()	Get the current tax engine.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getFirstError()	Returns the first error of the specified attribute.
getFirstErrors()	Returns the first error of every attribute in the model.
getIterator()	Returns an iterator for traversing the attributes in the model.
getScenario()	Returns the scenario that this model is used in.
getTaxIdValidators()
getValidators()	Returns all the validators declared in rules().
hasErrors()	Returns a value indicating whether there is any validation error.
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.
instance()	Returns static class instance, which can be used to obtain meta information.
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()	Returns a value indicating whether the attribute is required.
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable()	Returns whether the component should be selectable in component Type selects.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
off()	Detaches an existing event handler from this component.
offsetExists()	Returns whether there is an element at the specified offset.
offsetGet()	Returns the element at the specified offset.
offsetSet()	Sets the element at the specified offset.
offsetUnset()	Sets the element value at the specified offset to null.
on()	Attaches an event handler to an event.
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.
rules()	Returns the validation rules for attributes.
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()	Returns a list of scenarios and the corresponding active attributes.
setAttributes()	Sets the attribute values in a massive way.
setScenario()	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()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	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

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

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

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

deleteTaxCategories()

Whether Craft Commerce should allow tax categories to be deleted.

will not be called if viewTaxCategories is returned as false;

View source

deleteTaxRates()

Whether Craft Commerce should allow tax rates to be deleted.

will not be called if viewTaxRates is returned as false;

View source

deleteTaxZones()

Whether Craft Commerce should allow tax zones to be deleted.

will not be called if viewTaxZones is returned as false;

View source

editTaxCategories()

Whether Craft Commerce should allow tax categories to be edited.

will not be called if viewTaxCategories is returned as false;

View source

editTaxRates()

Whether Craft Commerce should allow tax rates to be edited.

will not be called if viewTaxRates is returned as false;

View source

editTaxZones()

Whether Craft Commerce should allow tax zones to be edited.

will not be called if viewTaxZones is returned as false;

View source

getEnabledTaxIdValidators()

View source

Returns

\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>

Throws

• yii\base\InvalidConfigException

getEngine()

Get the current tax engine.

View source

getTaxIdValidators()

Since

5.3.0

View source

Returns

\Illuminate\Support\Collection<\craft\commerce\base\TaxIdValidatorInterface>

Throws

• yii\base\InvalidConfigException

taxAdjusterClass()

Return class name for the Adjuster to be used for tax

View source

taxCategoryActionHtml()

Any action html to be added to the tax categories index header

View source

taxRateActionHtml()

Any action html to be added to the tax rates index header

View source

taxZoneActionHtml()

Any action html to be added to the tax zones index header

View source

viewTaxCategories()

Whether Craft Commerce should show the tax categories interface and allow tax categories to be edited.

View source

viewTaxRates()

Whether Craft Commerce should show the tax rates interface and allow tax rates to be edited.

View source

viewTaxZones()

Whether Craft Commerce should show the tax zones interface and allow tax zones to be edited.

View source

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
extractFieldsFor()	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()	Extracts the root field names from nested fields.
resolveFields()	Determines which fields can be returned by toArray().

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.

Events

EVENT_REGISTER_TAX_ENGINE

Type

craft\commerce\events\TaxEngineEvent

The event that is triggered when determining the tax engine.

---

EVENT_REGISTER_TAX_ID_VALIDATORS

Type

craft\commerce\events\TaxIdValidatorsEvent

The event that is raised when tax ID validators are registered.

Any validator added must be a TaxIdValidatorInterface.

use craft\commerce\events\TaxIdValidatorsEvent;
use craft\commerce\services\Taxes;
use yii\base\Event;

Event::on(
    Taxes::class,
    Taxes::EVENT_REGISTER_TAX_ID_VALIDATORS,
    function(TaxIdValidatorsEvent $event) {
         $event->validators[] = new MyTaxIdValidator();
    }
);

---