Skip to content

TaxZones ​

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\TaxZones » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
2.0

Tax zone service.

View source

Public Properties ​

PropertyDescription
allTaxZonescraft\commerce\models\TaxAddressZone[], array
behaviorsyii\base\Behavior – List of behaviors attached to this component.

allTaxZones ​

Type
craft\commerce\models\TaxAddressZone[], array
Default value
null

View source

Public Methods ​

MethodDescription
__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.
deleteTaxZoneById()
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.
getAllTaxZones()Get all tax zones.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getTaxZoneById()Get a tax zone by its ID.
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.
saveTaxZone()Save a tax zone.
trigger()Triggers an event.

deleteTaxZoneById() ​

View source

Arguments ​

  • $id

Throws ​

getAllTaxZones() ​

Get all tax zones.

View source

Arguments ​

Returns ​

\Illuminate\Support\Collection

Throws ​

getTaxZoneById() ​

Get a tax zone by its ID.

View source

Arguments ​

  • $id
  • $storeId

saveTaxZone() ​

Save a tax zone.

View source

Arguments ​

  • $model
  • $runValidation (boolean) – Should we validate this zone before saving

Throws ​