Address

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

Address Model

View source

Public Properties

PropertyDescription
$abbreviationTextstring
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$address1string – Address Line 1
$address2string – Address Line 2
$alternativePhonestring – Alternative Phone
$attentionstring – Attention
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$businessIdstring – Business ID
$businessNamestring – Business Name
$businessTaxIdstring – Business Tax ID
$citystring – City
$countrycraft\commerce\models\Country, null
$countryIdinteger – Country ID
$countryTextstring
$cpEditUrlstring
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$firstNamestring – First Name
$fullNamestring
$idinteger – Address ID
$isStoreLocationboolean – True, if this address is the stock location.
$iteratorArrayIterator – An iterator for traversing the items in the list.
$lastNamestring – Last Name
$phonestring – Phone
$scenariostring – The scenario that this model is in.
$statecraft\commerce\models\State, null
$stateIdinteger – Country ID
$stateNamestring – State Name
$stateTextstring
$stateValueinteger, string
$titlestring – Title
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.
$zipCodestring – Zip

$abbreviationText

Type
string
Access
Read-only

View source

Signature

public string getAbbreviationText ( )

$address1

Type
string

Address Line 1

View source

Signature

public string $address1 = null

$address2

Type
string

Address Line 2

View source

Signature

public string $address2 = null

$alternativePhone

Type
string

Alternative Phone

View source

Signature

public string $alternativePhone = null

$attention

Type
string

Attention

View source

Signature

public string $attention = null

$businessId

Type
string

Business ID

View source

Signature

public string $businessId = null

$businessName

Type
string

Business Name

View source

Signature

public string $businessName = null

$businessTaxId

Type
string

Business Tax ID

View source

Signature

public string $businessTaxId = null

$city

Signature

public string $city = null

$country

Signature

public craft\commerce\models\Country, null getCountry ( )

$countryId

Type
integer

Country ID

View source

Signature

public integer $countryId = null

$countryText

Type
string
Access
Read-only

View source

Signature

public string getCountryText ( )

$cpEditUrl

Type
string
Access
Read-only

View source

Signature

public string getCpEditUrl ( )

$firstName

Type
string

First Name

View source

Signature

public string $firstName = null

$fullName

Type
string
Access
Read-only

View source

Signature

public string getFullName ( )

$id

Type
integer

Address ID

View source

Signature

public integer $id = null

$isStoreLocation

Type
boolean

True, if this address is the stock location.

View source

Signature

public boolean $isStoreLocation = false

$lastName

Type
string

Last Name

View source

Signature

public string $lastName = null

$phone

Signature

public string $phone = null

$state

Signature

public craft\commerce\models\State, null getState ( )

$stateId

Type
integer

Country ID

View source

Signature

public integer $stateId = null

$stateName

Type
string

State Name

View source

Signature

public string $stateName = null

$stateText

Type
string
Access
Read-only

View source

Signature

public string getStateText ( )

$stateValue

Signature

public integer, string getStateValue ( )
public void setStateValue ( $value )

$title

Signature

public string $title = null

$zipCode

Signature

public string $zipCode = null

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
getAbbreviationText()
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.
getCountry()
getCountryText()
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.
getFullName()
getIterator()Returns an iterator for traversing the attributes in the model.
getScenario()Returns the scenario that this model is used in.
getState()
getStateText()
getStateValue()
getValidators()Returns all the validators declared in rules().
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.
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()
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.
setScenario()Sets the scenario for the model.
setStateValue()Sets the stateId or stateName based on the stateValue set.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()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(). 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

Returns

array – Attribute labels (name => label)

Signature

public array attributeLabels ( )

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

Returns

array – List of attribute names.

Signature

public array attributes ( )

getAbbreviationText()

Signature

public string getAbbreviationText ( )

getCountry()

Signature

public craft\commerce\models\Country, null getCountry ( )

getCountryText()

Signature

public string getCountryText ( )

getCpEditUrl()

Signature

public string getCpEditUrl ( )

getFullName()

Signature

public string getFullName ( )

getState()

Signature

public craft\commerce\models\State, null getState ( )

getStateText()

Signature

public string getStateText ( )

getStateValue()

Signature

public integer, string getStateValue ( )

rules()

Signature

public array rules ( )

setStateValue()

Sets the stateId or stateName based on the stateValue set.

View source

Arguments

Signature

public void setStateValue ( $value )

validateState()

View source

Arguments

  • $attribute
  • $params
  • $validator

Signature

public void validateState ( $attribute, $params, $validator )

Protected Methods

MethodDescription
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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.

Events

EVENT_REGISTER_ADDRESS_VALIDATION_RULES

Type
craft\commerce\events\RegisterAddressRulesEvent

The event that is raised after initial rules were set.

Plugins can add additional address validation rules.

use craft\commerce\events\RegisterAddressRulesEvent;
use craft\commerce\models\Address;

Event::on(Address::class, Address::EVENT_REGISTER_ADDRESS_VALIDATION_RULES, function(RegisterAddressRulesEvent $event) {
     $event->rules[] = [['attention'], 'required'];
});