class Address - jcobban/Genealogy GitHub Wiki
class Address
Up: Object-Oriented Access to Database Records
This class is derived from Record to implement the logical interface to a record in the Address/Repository List table (tblAR or Addresses). Each entry in this table contains a hierarchically structured address as is required for using surface mail with information about a business, for example a repository of archival documents.
Fields
This record presents the following fields:
| Field Name | Description | Synonyms & Comments |
|---|---|---|
'idar' |
idar | 'id' |
'kind' |
kind | default Address::REPOSITORY |
'style' |
style | |
'addrname' |
name | 'name' |
'addrsort' |
sort key | 'sort' |
'address1' |
address line 1 | |
'address2' |
address line 2 | |
'city' |
city | |
'state' |
state | |
'zipcode' |
postal code | |
'country' |
country | |
'phone1' |
phone 1 | |
'phone2' |
phone 2 | |
'email' |
email address | |
'homepage' |
homepage URL | |
'addrnotes' |
Extended notes about the address. May contain HTML. | 'notes' |
'latitude' |
latitude xDDDMMSS.ddd | |
'longitude' |
longitude xDDDMMSS.ddd | |
'zoom' |
map zoom level | default 12 |
'private' |
private? 0=no, 1=yes | |
'list1' |
unsupported, 0=no, 1=yes | |
'list2' |
unsupported, 0=no, 1=yes | |
'list3' |
unsupported, 0=no, 1=yes | |
'list4' |
unsupported, 0=no, 1=yes | |
'list5' |
unsupported, 0=no, 1=yes | |
'list6' |
unsupported, 0=no, 1=yes | |
'tag1' |
unsupported, 0=no, 1=yes | |
'used' |
unsupported, temporary use, 0=no, 1=yes | |
'fsresolved' |
unsupported, 0=no, 1=yes, 2=could not be resolved | |
'veresolved' |
unsupported, 0=no, 1=yes, 2=could not be resolved | |
'verified' |
unsupported, 0=no, 1=yes | |
'qstag' |
unsupported, temporary use, 0=no, 1=yes |
Constants
This class defines the following constants which are used in the 'kind' field to indicate the purpose to which the record is put:
| constant | description |
|---|---|
| Address::MAILING: | the record represents a surface mailing address of an individual or business. |
| Address::EVENT: | the record represents the structured address of an event, rarely used as an alternative to the unstructured Location record. |
| Address::REPOSITORY: | the record represents the address of an institution such as a library or archives that holds original source documents. |
| Address::MAXKIND: | this constant is the highest value of 'kind' currently defined. |
Table of Contents
- new Address($parms)
- $address->getIdar()
- $address->getName()
- $address->getNotes()
- $address->getLatitude()
- $address->getLongitude()
- $address->getZoom()
- $address->getPreposition()
- $address->get($fieldname)
- $address->set($fieldname, $value)
- $address->toString()
- $address->mergeAddresses($from)
Next: class Advertiser