Commerce 3 Class Reference

Address

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\Address » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
2.0

Address Model

View source (opens new window)

# Public Properties

Property Description
abbreviationText string (opens new window)
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
address1 string (opens new window) – Address Line 1
address2 string (opens new window) – Address Line 2
address3 string (opens new window) – Address Line 3
addressLines array (opens new window)
alternativePhone string (opens new window) – Alternative Phone
attention string (opens new window) – Attention
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
businessId string (opens new window) – Business ID
businessName string (opens new window) – Business Name
businessTaxId string (opens new window) – Business Tax ID
city string (opens new window) – City
country craft\commerce\models\Country
countryId integer (opens new window) – Country ID
countryIso string (opens new window)
countryText string (opens new window)
cpEditUrl string (opens new window)
custom1 string (opens new window) – Custom Field 1
custom2 string (opens new window) – Custom Field 2
custom3 string (opens new window) – Custom Field 3
custom4 string (opens new window) – Custom Field 4
dateCreated DateTime (opens new window), null (opens new window)
dateUpdated DateTime (opens new window), null (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
firstName string (opens new window) – First Name
fullName string (opens new window) – Full Name
id integer (opens new window) – Address ID
isEstimated boolean (opens new window) – If this address is used for estimated values
isStoreLocation boolean (opens new window) – Is this the store location.
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
label string (opens new window) – Label
lastName string (opens new window) – Last Name
notes string (opens new window) – Notes, only field that can contain Emoji
phone string (opens new window) – Phone
scenario (opens new window) string (opens new window) – The scenario that this model is in.
state craft\commerce\models\State
stateId integer (opens new window) – State ID
stateName string (opens new window) – State Name
stateText string (opens new window)
stateValue integer (opens new window), string (opens new window)
title string (opens new window) – Title
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.
vatValidator \DvK\Vat\Validator
zipCode string (opens new window) – Zip

# abbreviationText

Type
string (opens new window)
Default value
null

View source (opens new window)

# address1

Type
string (opens new window)
Default value
null

Address Line 1

View source (opens new window)

# address2

Type
string (opens new window)
Default value
null

Address Line 2

View source (opens new window)

# address3

Type
string (opens new window)
Default value
null
Since
2.2

Address Line 3

View source (opens new window)

# addressLines

Type
array (opens new window)
Default value
null

View source (opens new window)

# alternativePhone

Type
string (opens new window)
Default value
null

Alternative Phone

View source (opens new window)

# attention

Type
string (opens new window)
Default value
null

Attention

View source (opens new window)

# businessId

Type
string (opens new window)
Default value
null

Business ID

View source (opens new window)

# businessName

Type
string (opens new window)
Default value
null

Business Name

View source (opens new window)

# businessTaxId

Type
string (opens new window)
Default value
null

Business Tax ID

View source (opens new window)

# city

Type
string (opens new window)
Default value
null

City

View source (opens new window)

# country

Type
craft\commerce\models\Country
Default value
null

View source (opens new window)

# countryId

Type
integer (opens new window)
Default value
null

Country ID

View source (opens new window)

# countryIso

Type
string (opens new window)
Default value
null

View source (opens new window)

# countryText

Type
string (opens new window)
Default value
null

View source (opens new window)

# cpEditUrl

Type
string (opens new window)
Default value
null

View source (opens new window)

# custom1

Type
string (opens new window)
Default value
null
Since
2.2

Custom Field 1

View source (opens new window)

# custom2

Type
string (opens new window)
Default value
null
Since
2.2

Custom Field 2

View source (opens new window)

# custom3

Type
string (opens new window)
Default value
null
Since
2.2

Custom Field 3

View source (opens new window)

# custom4

Type
string (opens new window)
Default value
null
Since
2.2

Custom Field 4

View source (opens new window)

# dateCreated

Type
DateTime (opens new window), null (opens new window)
Default value
null
Since
3.4

View source (opens new window)

# dateUpdated

Type
DateTime (opens new window), null (opens new window)
Default value
null
Since
3.4

View source (opens new window)

# firstName

Type
string (opens new window)
Default value
null

First Name

View source (opens new window)

# fullName

Type
string (opens new window)
Default value
null
Since
2.2

Full Name

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

Address ID

View source (opens new window)

# isEstimated

Type
boolean (opens new window)
Default value
false
Since
2.2

If this address is used for estimated values

View source (opens new window)

# isStoreLocation

Type
boolean (opens new window)
Default value
false

Is this the store location.

View source (opens new window)

# label

Type
string (opens new window)
Default value
null
Since
2.2

Label

View source (opens new window)

# lastName

Type
string (opens new window)
Default value
null

Last Name

View source (opens new window)

# notes

Type
string (opens new window)
Default value
null
Since
2.2

Notes, only field that can contain Emoji

View source (opens new window)

# phone

Type
string (opens new window)
Default value
null

Phone

View source (opens new window)

# state

Type
craft\commerce\models\State
Default value
null

View source (opens new window)

# stateId

Type
integer (opens new window)
Default value
null

State ID

View source (opens new window)

# stateName

Type
string (opens new window)
Default value
null

State Name

View source (opens new window)

# stateText

Type
string (opens new window)
Default value
null

View source (opens new window)

# stateValue

Type
integer (opens new window), string (opens new window)
Default value
null

View source (opens new window)

# title

Type
string (opens new window)
Default value
null

Title

View source (opens new window)

# vatValidator

Type
\DvK\Vat\Validator
Default value
null

View source (opens new window)

# zipCode

Type
string (opens new window)
Default value
null

Zip

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)
__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.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() (opens new window) Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
beforeValidate() (opens new window) This method is invoked before validation starts.
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.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() (opens new window) Returns the names of any attributes that should hold DateTime (opens new window) values.
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.
extraFields() Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getAbbreviationText()
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAddressLines() Return a keyed array of address lines. Useful for outputting an address in a consistent format.
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCountry()
getCountryIso()
getCountryText()
getCpEditUrl()
getError() (opens new window) Returns the first error of the specified attribute.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getScenario() (opens new window) Returns the scenario that this model is used in.
getState()
getStateText()
getStateValue()
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasErrors() (opens new window) Returns a value indicating whether there is any validation error.
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() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() (opens new window) Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
sameAs() This method can be used to determine if the other addresses supplied has the same address contents (minus the address ID).
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setScenario() (opens new window) Sets the scenario for the model.
setStateValue() Sets the stateId or stateName based on the value parameter.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateBusinessTaxId()
validateMultiple() (opens new window) Validates multiple models.
validateState()

# attributeLabels()

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel() (opens new window). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Attribute labels (name => label)

# attributes()

Returns the list of attribute names.

By default, this method returns all public non-static properties of the class. You may override this method to change the default behavior.

View source (opens new window)

Returns

array (opens new window) – List of attribute names.

# extraFields()

Returns the list of fields that can be expanded further and returned by toArray() (opens new window).

This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray() (opens new window). Only when field names to be expanded are explicitly specified when calling toArray() (opens new window), will their values be exported.

The default implementation returns an empty array.

You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).

View source (opens new window)

Returns

array (opens new window) – The list of expandable field names or field definitions. Please refer to fields() on the format of the return value.

# fields()

Since
3.2.1

Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.

A field is a named element in the returned array by toArray() (opens new window).

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

In this method, you may also want to return different lists of fields based on some context information. For example, depending on scenario (opens new window) or the privilege of the current application user, you may return different sets of visible fields or filter out some fields.

The default implementation of this method returns attributes() indexed by the same attribute names.

View source (opens new window)

Returns

array (opens new window) – The list of field names or field definitions.

# getAbbreviationText()

View source (opens new window)

Returns

string (opens new window)

# getAddressLines()

Since
3.2.0

Return a keyed array of address lines. Useful for outputting an address in a consistent format.

View source (opens new window)

Arguments

Returns

array (opens new window)

# getCountry()

View source (opens new window)

Returns

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

# getCountryIso()

Since
3.1.4

View source (opens new window)

Returns

string (opens new window)

# getCountryText()

View source (opens new window)

Returns

string (opens new window)

# getCpEditUrl()

View source (opens new window)

Returns

string (opens new window)

# getState()

View source (opens new window)

Returns

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

# getStateText()

View source (opens new window)

Returns

string (opens new window)

# getStateValue()

View source (opens new window)

Returns

integer (opens new window), string (opens new window)

# init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source (opens new window)

# sameAs()

Since
3.2.1

This method can be used to determine if the other addresses supplied has the same address contents (minus the address ID).

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# setStateValue()

Sets the stateId or stateName based on the value parameter.

View source (opens new window)

Arguments

# validateBusinessTaxId()

View source (opens new window)

Arguments

  • $attribute
  • $params
  • $validator

# validateState()

View source (opens new window)

Arguments

  • $attribute
  • $params
  • $validator

# Protected Methods

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

# defineRules()

Returns the validation rules for attributes.

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

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

View source (opens new window)

Returns

array (opens new window)

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.

# Events

# EVENT_DEFINE_ADDRESS_LINES

Type
craft\commerce\events\DefineAddressLinesEvent
Since
3.2.0

The event that is triggered when determining the lines of the address to display.

See also getAddressLines()

← Country →