☰ Browse the reference

Model·Common module

Address

A model in the Common module, with 32 members for templates, 20 API properties and 32 members for admin templates.

Common\Models\Frontend\AddressCopy Common\Models\Api\AddressCopy Common\Models\Backend\AddressCopy Also in Common: AddressCustomFieldValue Area Category CategoryCustomFieldValue ClientLlmCredential CollectionElement Component ComponentArea ComponentCollection Content Country Currency CustomField CustomFieldValue CustomUrl EditLock GlobalComponent GlobalComponentRevision GlobalComponentRevisionArea ImportDeduplication InputType InputTypePossibleValue Language Layout LayoutArea LayoutAreaGroup LayoutCategory LayoutCustomFieldValue SeoSettings SeoSettingsCustomFieldValue Setting SettingValue State Tag TagCustomFieldValue Widget WidgetSetting WidgetSettingValue

View

Templates32 API & Jobs20 Admin32

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 22

Take no arguments.

# getStateName()

?string

Get the state name; either from an explicitly saved state name or from the state

# getCountryName()

?string

Get the country name. Either from the country relationship or from the country name.

# getId()

?int

# getFirstName()

?string

# getLastName()

?string

# getCompanyName()

?string

# getUnit()

?string

# getAddressLine1()

?string

# getAddressLine2()

?string

# getSuburb()

?string

# getCity()

?string

# getPostcode()

?string

# getCountry()

?Country

# getState()

?State

# getPhone()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getModified()

?DateTime

Get the last modification date for the record.

# getCustomFieldValues()

?Collection<AddressCustomFieldValue>

# getCustomFields()

array

Get the custom fields for this entity

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

Methods 10

Take arguments. The API serialises only getters that need none.

# isMatching(Address $address)

bool

Check if this address matches another address

# getCustomFieldValue(CustomField $customField)

?CustomFieldValue

Get the value for a custom field

# getCustomFieldValueByName(string $customFieldName)

?CustomFieldValue

Get the value for a custom field by the custom field name

# getCustomFieldContent(string $customFieldName)

?Content

Get the content for the custom field identified by the specified name

# getCustomFieldContentOrDefault(string $customFieldName)

?Content

Get the (default) content for the custom field identified by the specified name

# getCustomFieldBoolean(string $customFieldName, ?bool $default)

?bool

Get the (default) content of the custom field as boolean value

# getCustomFieldText(string $customFieldName, ?string $default)

?string

Get the (default) content of the custom field as text

# getCustomFieldImage(string $customFieldName)

?Image

Get the (default) image contained in the custom field

# getCustomFieldFile(string $customFieldName)

?File

Get the (default) file contained in the custom field

# hasCustomField(string $customFieldName)

bool

Check if the entity has a custom field with the specified name

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 20

Read-only values on the record.

# stateName

?string

Get the state name; either from an explicitly saved state name or from the state

# countryName

?string

Get the country name. Either from the country relationship or from the country name.

# id

?int

# firstName

?string

# lastName

?string

# companyName

?string

# unit

?string

# addressLine1

?string

# addressLine2

?string

# suburb

?string

# city

?string

# postcode

?string

# country

?Country

# state

?State

# phone

?string

# created

?DateTime

Get the date the record was created.

# modified

?DateTime

Get the last modification date for the record.

# customFieldValues

?Collection<AddressCustomFieldValue>

# customFieldContent

object

Get a serialized representation of the custom fields associated with the record

# customFields

array

Get the custom fields for this entity

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 22

Take no arguments.

# getStateName()

?string

Get the state name; either from an explicitly saved state name or from the state

# getCountryName()

?string

Get the country name. Either from the country relationship or from the country name.

# getId()

?int

# getFirstName()

?string

# getLastName()

?string

# getCompanyName()

?string

# getUnit()

?string

# getAddressLine1()

?string

# getAddressLine2()

?string

# getSuburb()

?string

# getCity()

?string

# getPostcode()

?string

# getCountry()

?Country

# getState()

?State

# getPhone()

?string

# getCreated()

?DateTime

Get the date the record was created.

# getModified()

?DateTime

Get the last modification date for the record.

# getCustomFieldValues()

?Collection<AddressCustomFieldValue>

# getCustomFields()

array

Get the custom fields for this entity

# isNewRecord() Not in API & Jobs

bool

Check if the record is a new record

# isHierarchicalModel() Not in API & Jobs

bool

Check whether a model is a hierarchical model, i.e. can have children

# isVersionedModel() Not in API & Jobs

bool

Check whether a model is versioned

Methods 10

Take arguments. The API serialises only getters that need none.

# isMatching(Address $address)

bool

Check if this address matches another address

# getCustomFieldValue(CustomField $customField)

?CustomFieldValue

Get the value for a custom field

# getCustomFieldValueByName(string $customFieldName)

?CustomFieldValue

Get the value for a custom field by the custom field name

# getCustomFieldContent(string $customFieldName)

?Content

Get the content for the custom field identified by the specified name

# getCustomFieldContentOrDefault(string $customFieldName)

?Content

Get the (default) content for the custom field identified by the specified name

# getCustomFieldBoolean(string $customFieldName, ?bool $default)

?bool

Get the (default) content of the custom field as boolean value

# getCustomFieldText(string $customFieldName, ?string $default)

?string

Get the (default) content of the custom field as text

# getCustomFieldImage(string $customFieldName)

?Image

Get the (default) image contained in the custom field

# getCustomFieldFile(string $customFieldName)

?File

Get the (default) file contained in the custom field

# hasCustomField(string $customFieldName)

bool

Check if the entity has a custom field with the specified name