States

Type
Class
Namespace
craft\commerce\services
Inherits
craft\commerce\services\States » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
2.0

State service.

View source (opens new window)

# Public Properties

Property Description
allEnabledStates craft\commerce\models\State[] – An array of all enabled states.
allEnabledStatesAsList array (opens new window)
allEnabledStatesAsListGroupedByCountryId array (opens new window) – 2D array of states indexed by their ids grouped by country ids.
allStates craft\commerce\models\State[] – an array of all states
allStatesAsList array (opens new window)
allStatesAsListGroupedByCountryId array (opens new window) – 2D array of states indexed by their ids grouped by country ids.
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
statesGroupedByCountries array (opens new window) – all states grouped by countries

# allEnabledStates

Type
craft\commerce\models\State[]
Default value
null
Access
Read-only
Since
3.0

An array of all enabled states.

View source (opens new window)

# allEnabledStatesAsList

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.0

View source (opens new window)

# allEnabledStatesAsListGroupedByCountryId

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.0

2D array of states indexed by their ids grouped by country ids.

View source (opens new window)

# allStates

Type
craft\commerce\models\State[]
Default value
null

an array of all states

View source (opens new window)

# allStatesAsList

Type
array (opens new window)
Default value
null

View source (opens new window)

# allStatesAsListGroupedByCountryId

Type
array (opens new window)
Default value
null
Access
Read-only
Since
3.0

2D array of states indexed by their ids grouped by country ids.

View source (opens new window)

# statesGroupedByCountries

Type
array (opens new window)
Default value
null

all states grouped by countries

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) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__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.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
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.
deleteStateById() Deletes a state by its ID.
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.
getAllEnabledStates() Returns an array of all enabled states.
getAllEnabledStatesAsList() Returns all enabled states as array indexed by ID
getAllEnabledStatesAsListGroupedByCountryId() Returns all enabled states grouped by countries.
getAllStates() Returns an array of all states.
getAllStatesAsList() Returns all states indexed by ID
getAllStatesAsListGroupedByCountryId() Returns all states grouped by countries.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getStateByAbbreviation() Returns a state by its abbreviation.
getStateById() Returns a state by its ID.
getStatesByCountryId()
getStatesByShippingZoneId() Returns all states in a shipping zone.
getStatesByTaxZoneId() Returns all states in a tax zone.
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.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
reorderStates()
saveState() Saves a state.
trigger() (opens new window) Triggers an event.

# deleteStateById()

Deletes a state by its ID.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the state was deleted successfully

# getAllEnabledStates()

Since
3.0

Returns an array of all enabled states.

View source (opens new window)

Returns

craft\commerce\models\State[] – An array of all enabled states.

# getAllEnabledStatesAsList()

Since
3.0

Returns all enabled states as array indexed by ID

View source (opens new window)

Returns

array (opens new window)

# getAllEnabledStatesAsListGroupedByCountryId()

Since
3.0

Returns all enabled states grouped by countries.

View source (opens new window)

Returns

array (opens new window) – 2D array of states indexed by their ids grouped by country ids.

# getAllStates()

Returns an array of all states.

View source (opens new window)

Returns

craft\commerce\models\State[] – An array of all states.

# getAllStatesAsList()

Returns all states indexed by ID

View source (opens new window)

Returns

array (opens new window)

# getAllStatesAsListGroupedByCountryId()

Since
3.0

Returns all states grouped by countries.

View source (opens new window)

Returns

array (opens new window) – 2D array of states indexed by their ids grouped by country ids.

# getStateByAbbreviation()

Returns a state by its abbreviation.

View source (opens new window)

Arguments

Returns

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

# getStateById()

Returns a state by its ID.

View source (opens new window)

Arguments

Returns

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

# getStatesByCountryId()

View source (opens new window)

Arguments

Returns

array (opens new window)

# getStatesByShippingZoneId()

Returns all states in a shipping zone.

View source (opens new window)

Arguments

Returns

craft\commerce\models\State[] – Array of states in the matched shipping zone.

# getStatesByTaxZoneId()

Returns all states in a tax zone.

View source (opens new window)

Arguments

Returns

craft\commerce\models\State[] – Array of states in the matched tax zone.

# reorderStates()

Since
3.1

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# saveState()

Saves a state.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the state was saved successfully.

Throws