AddressZoneInterface

Type
Interface
Namespace
craft\commerce\base
Implemented by
craft\commerce\models\ShippingAddressZone, craft\commerce\models\TaxAddressZone
Since
2.0

Zone Interface defines the common interface to be implemented by zones in commerce.

View source

Public Methods

MethodDescription
getCountries()Return the array of Commerce Countries this zone contains
getCountryIds()Return the array of Commerce Country IDs this zone contains
getIsCountryBased()Whether this zone is based on countries only.
getStateIds()Return the array of Commerce State IDs this zone contains
getStates()Return the array of Commerce States this zone contains

getCountries()

Return the array of Commerce Countries this zone contains

View source

Returns

craft\commerce\models\Country[]

Signature

public abstract craft\commerce\models\Country[] getCountries ( )

getCountryIds()

Return the array of Commerce Country IDs this zone contains

View source

Returns

integer[]

Signature

public abstract integer[] getCountryIds ( )

getIsCountryBased()

Whether this zone is based on countries only.

View source

Returns

boolean

Signature

public abstract boolean getIsCountryBased ( )

getStateIds()

Return the array of Commerce State IDs this zone contains

View source

Returns

integer[]

Signature

public abstract integer[] getStateIds ( )

getStates()

Return the array of Commerce States this zone contains

View source

Returns

craft\commerce\models\State[]

Signature

public abstract craft\commerce\models\State[] getStates ( )