| Method | Description | Returns |
|---|---|---|
| getStateName() | Get the state name; either from an explicitly saved state name or from the state | string |
| isPrimary() | Determine if the address is the primary address | bool |
| getId() | int | |
| getSuburb() | string | |
| getCity() | string | |
| getPostcode() | string | |
| getAddressName() | string | |
| getAddressLine1() | string | |
| getAddressLine2() | string | |
| getCreated() | Get the date the record was created. | DateTime |
| getModified() | Get the last modification date for the record. | DateTime |
| isActive() | bool | |
| getType() | AddressType | |
| getCountry() | Country | |
| getState() | State | |
| getPerson() | Person | |
| getCustomFieldValues() | Collection (AddressCustomFieldValue) | |
| getCustomFieldValue(CustomField $customField) | Get the value for a custom field | CustomFieldValue |
| getCustomFieldValueByName(string $customFieldName) | Get the value for a custom field by the custom field name | CustomFieldValue |
| getCustomFieldContent(string $customFieldName) | Get the content for the custom field identified by the specified name | Content |
| getCustomFieldContentOrDefault(string $customFieldName) | Get the content (or default content) for the custom field identified by the specified name | Content |
| getCustomFieldBoolean(string $customFieldName, ?bool|null $default) | Get the (default) content of the custom field as boolean value | bool |
| getCustomFieldText(string $customFieldName, ?string|null $default) | Get the (default) content of the custom field as text | string |
| getCustomFieldImage(string $customFieldName) | Get the (default) image contained in the custom field | Image |
| getCustomFieldFile(string $customFieldName) | Get the (default) file contained in the custom field | File |
| getCustomFields() | Get the custom fields for this entity | array |
| hasCustomField(string $customFieldName) | Check if the entity has a custom field with the specified name | bool |
| isNewRecord() | Check if the record is a new record | bool |
| isHierarchicalModel() | Check whether a model is a hierarchical model, i.e. can have children | bool |
Users\Models\Backend\Address
Address