ShippingAddressZone

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\ShippingAddressZone » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\commerce\base\AddressZoneInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Shipping zone model.

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
countries array
countriesNames array
countryIds array
cpEditUrl string
default boolean – Default
description string – Description
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
id integer – ID
isCountryBased boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
name string – Name
scenario string – The scenario that this model is in.
stateIds array
states array
statesNames array
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.
zipCodeConditionFormula string – The code to match the zip code.

# countries

Type
array

View source

# countriesNames

Type
array
Access
Read-only

View source

# countryIds

Type
array
Access
Read-only

View source

# cpEditUrl

Type
string
Access
Read-only

View source

# default

Type
boolean

Default

View source

# description

Type
string

Description

View source

# id

Type
integer

ID

View source

# isCountryBased

Type
boolean

View source

# name

Type
string

Name

View source

# stateIds

Type
array
Access
Read-only

View source

# states

Type
array

View source

# statesNames

Type
array
Access
Read-only

View source

# zipCodeConditionFormula

Type
string
Since
2.2

The code to match the zip code.

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__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.
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.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
defineRules() Returns the validation rules for attributes.
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.
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.
getCountries() Returns all countries in this Shipping Zone.
getCountriesNames() Returns the names of all countries in this Shipping Zone.
getCountryIds()
getCpEditUrl()
getError() Returns the first error of the specified attribute.
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.
getIsCountryBased() Whether this zone is based on countries only.
getIterator() Returns an iterator for traversing the attributes in the model.
getScenario() Returns the scenario that this model is used in.
getStateIds()
getStates() Returns all states in this Shipping Zone.
getStatesNames() Returns the names of all states in this Shipping Zone.
getValidators() Returns all the validators declared in rules().
getZipCodeConditionFormula()
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.
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.
setCountries() Sets countries in this Tax Zone.
setIsCountryBased()
setScenario() Sets the scenario for the model.
setStates() Set states in this shipping Zone.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Performs the data validation.
validateMultiple() Validates multiple models.

# defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

# getCountries()

Returns all countries in this Shipping Zone.

View source

Returns

array

# getCountriesNames()

Returns the names of all countries in this Shipping Zone.

View source

Returns

array

# getCountryIds()

View source

Returns

array

# getCpEditUrl()

View source

Returns

string

# getIsCountryBased()

Whether this zone is based on countries only.

View source

Returns

boolean

# getStateIds()

View source

Returns

array

# getStates()

Returns all states in this Shipping Zone.

View source

Returns

array

# getStatesNames()

Returns the names of all states in this Shipping Zone.

View source

Returns

array

# getZipCodeConditionFormula()

Since
2.2

View source

Returns

string

# setCountries()

Sets countries in this Tax Zone.

View source

Arguments

# setIsCountryBased()

View source

Arguments

Returns

boolean

# setStates()

Set states in this shipping Zone.

View source

Arguments

# Protected Methods

Method Description
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.