Addresses

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

Addresses service.

An instance of the Addresses service is globally accessible in Craft via Craft::$app->addresses.

View source (opens new window)

# Public Properties

Property Description
addressFormatRepository \CommerceGuys\Addressing\AddressFormat\AddressFormatRepository
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
countryRepository \CommerceGuys\Addressing\Country\CountryRepository
formatter \CommerceGuys\Addressing\Formatter\FormatterInterface, null (opens new window) – The default address formatter used by formatAddress()
layout craft\models\FieldLayout
subdivisionRepository craft\addresses\SubdivisionRepository

# addressFormatRepository

Type
\CommerceGuys\Addressing\AddressFormat\AddressFormatRepository
Default value
null

View source (opens new window)

# countryRepository

Type
\CommerceGuys\Addressing\Country\CountryRepository
Default value
null

View source (opens new window)

# formatter

Type
\CommerceGuys\Addressing\Formatter\FormatterInterface, null (opens new window)
Default value
null
Since
4.5.0

The default address formatter used by formatAddress()

View source (opens new window)

# layout

Type
craft\models\FieldLayout
Default value
null
Access
Read-only

View source (opens new window)

# subdivisionRepository

Type
craft\addresses\SubdivisionRepository
Default value
null

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.
defineAddressSubdivisions() Returns subdivisions for a field based on its parents.
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.
formatAddress() Formats the address model into the correct sequence and format in HTML.
getAddressFormatRepository()
getAdministrativeAreaTypeLabel()
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCountryRepository()
getDependentLocalityTypeLabel()
getFieldLabel() Returns the user-facing label for an address field, for a given country code.
getLayout() Returns the address field layout.
getLocalityTypeLabel()
getPostalCodeTypeLabel()
getSubdivisionRepository()
getUsedFields() Returns the address fields that are used by a given country code.
getUsedSubdivisionFields() Returns the subdivision address fields that are used by a given country code.
handleChangedAddressFieldLayout() Handle address field layout changes.
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.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
saveLayout() Save the address field layout
trigger() (opens new window) Triggers an event.

# defineAddressSubdivisions()

Since
4.5.0

Returns subdivisions for a field based on its parents.

View source (opens new window)

Arguments

Returns

array (opens new window)

# formatAddress()

Formats the address model into the correct sequence and format in HTML.

View source (opens new window)

Arguments

Returns

string (opens new window)

# getAddressFormatRepository()

View source (opens new window)

Returns

\CommerceGuys\Addressing\AddressFormat\AddressFormatRepository

# getAdministrativeAreaTypeLabel()

View source (opens new window)

Arguments

Returns

string (opens new window)

# getCountryRepository()

View source (opens new window)

Returns

\CommerceGuys\Addressing\Country\CountryRepository

# getDependentLocalityTypeLabel()

View source (opens new window)

Arguments

Returns

string (opens new window)

# getFieldLabel()

Since
4.3.0

Returns the user-facing label for an address field, for a given country code.

View source (opens new window)

Arguments

Returns

string (opens new window)

# getLayout()

Returns the address field layout.

View source (opens new window)

Returns

craft\models\FieldLayout

# getLocalityTypeLabel()

View source (opens new window)

Arguments

Returns

string (opens new window)

# getPostalCodeTypeLabel()

View source (opens new window)

Arguments

Returns

string (opens new window)

# getSubdivisionRepository()

View source (opens new window)

Returns

craft\addresses\SubdivisionRepository

# getUsedFields()

Since
4.3.0

Returns the address fields that are used by a given country code.

See also \CommerceGuys\Addressing\AddressFormat\AddressField View source (opens new window)

Arguments

Returns

string (opens new window)[]

# getUsedSubdivisionFields()

Since
4.3.0

Returns the subdivision address fields that are used by a given country code.

See also \CommerceGuys\Addressing\AddressFormat\AddressField View source (opens new window)

Arguments

Returns

string (opens new window)[]

# handleChangedAddressFieldLayout()

Handle address field layout changes.

View source (opens new window)

Arguments

# 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)

# saveLayout()

Save the address field layout

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# Events

# EVENT_DEFINE_ADDRESS_SUBDIVISIONS

Type
craft\events\DefineAddressSubdivisionsEvent
Since
4.5.0

The event that is triggered when defining subdivisions options for an address field for a given country code, and optionally administrativeArea and locality.

See also defineAddressSubdivisions()

# EVENT_DEFINE_FIELD_LABEL

Type
craft\events\DefineAddressFieldLabelEvent
Since
4.3.0

The event that is triggered when defining the label of an address field for a given country code.

See also getFieldLabel()

# EVENT_DEFINE_USED_FIELDS

Type
craft\events\DefineAddressFieldsEvent
Since
4.3.0

The event that is triggered when defining the address fields that are used by a given country code.

See also getUsedFields()

# EVENT_DEFINE_USED_SUBDIVISION_FIELDS

Type
craft\events\DefineAddressFieldsEvent
Since
4.3.0

The event that is triggered when defining the subdivision address fields that are used by a given country code.

See also getUsedSubdivisionFields()