class Event - jcobban/Genealogy GitHub Wiki

class Event

Up: Object-Oriented Access to Database Records

Source Code

This class is derived from Record to implement the logical interface to a record in the Events table (tblER). Each entry in this table contains the description of an event, such as a birth, or the observation of a state, such as an occupation.

Fields

This record presents the following fields:

name description synonyms
'ider' unique numeric identifier 'id'
'idir' unique numeric identifier of an associated instance of class Person or class Family or class Child depending upon the value of 'idtype'.
'idtype' This identifies the type of record that the Event is associated with. See the Event::IDTYPE_xxx constants defined below.
'idet' This is an internal identifier of the type of event described by this record. See the Event::ET_xxx constants described below.
'order' order of presentation. Note that Order is a reserved word in SQL which makes this name difficult to use.
'eventd' date in internal representation. See class LegacyDate 'date'
'eventsd' date for sorting: yyyymmdd
'idlrevent' index to instance of class Location or class Temple 'location'
'notes' secondary information about the event. Note that in the Legacy Family Tree product this was called 'Desc' but that is a reserved word in SQL, so the column is renamed. 'desc'
'gedtag' GEDCOM 5.5 tag string. Not supported.
'eventexclude' if this is not zero event is excluded from reports.
'idar' index to instance of class Address
'description' This field contains information that is an integral part of the Event. For example for an occupation event it contains the job title.
'sentenceoverride' sentence override string. This is not supported.
'qstag' qstag is not supported
'rgexclude' rgexclude is not supported
'kind' kind, if 0 'idlrevent' identifies a Location, if 1 'idlrevent' identifies a Temple
'ldstempleready' LDS temple ready flag. This is non-zero if the event is ready to be reported.
'preferred' if not zero this is the preferred instance of Event within a particular IDET value.

Constants

This class defines the following constants which indicate the purpose to which the record is put:

idtype

constant description value
Event::IDTYPE_INDIV 'idir' points to instance of Person 0
Event::IDTYPE_MAR 'idir' points to instance of Family 20
Event::IDTYPE_CHILD 'idir' points to instance of Child 21

Note that support for associating an Event with an instance of Child is an extension to the functionality of Legacy Family Tree. It supports events that involve three individuals, two parents and a child, for example adoption or LDS child sealed to parents.

idet

constant description value
Event::ET_NULL null 1
Event::ET_ADOPTION adoption 2
Event::ET_BIRTH birth 3
Event::ET_BURIAL burial 4
Event::ET_CHRISTENING christening, that is Christian baptism 5
Event::ET_DEATH death 6
Event::ET_ANNULMENT annulment 7
Event::ET_LDS_BAPTISM LDS baptism 8
Event::ET_BARMITZVAH bar mitzvah 9
Event::ET_BASMITZVAH bas mitzvah 10
Event::ET_BLESSING LDS blessing 11
Event::ET_CENSUS census 12
Event::ET_CIRCUMCISION circumcision 13
Event::ET_CITIZENSHIP citizenship 14
Event::ET_CONFIRMATION confirmation 15
Event::ET_LDS_CONFIRMATION LDS confirmation 16
Event::ET_COURT court 17
Event::ET_CREMATION cremation 18
Event::ET_DEGREE degree 19
Event::ET_DIVORCE divorce 20
Event::ET_DIVORCE_FILING divorce_filing 21
Event::ET_EDUCATION education 22
Event::ET_EMIGRATION emigration 23
Event::ET_EMPLOYMENT employment 24
Event::ET_ENGAGEMENT engagement 25
Event::ET_FIRST_COMMUNION first_communion 26
Event::ET_GRADUATION graduation 27
Event::ET_HOBBIES hobbies 28
Event::ET_HONOURS honours 29
Event::ET_HOSPITAL hospital 30
Event::ET_ILLNESS illness 31
Event::ET_IMMIGRATION immigration 32
Event::ET_INTERVIEW interview 33
Event::ET_LAND land 34
Event::ET_MARRIAGE_BANNS marriage_banns 35
Event::ET_MARRIAGE_CONTRACT marriage_contract 36
Event::ET_MARRIAGE_LICENSE marriage_license 37
Event::ET_MARRIAGE_NOTICE marriage_notice 38
Event::ET_MARRIAGE_SETTLEMENT marriage_settlement 39
Event::ET_MEDICAL medical 40
Event::ET_MEMBERSHIP membership 41
Event::ET_MILITARY_SERVICE military_service 42
Event::ET_MISSION mission 43
Event::ET_NAMESAKE namesake 44
Event::ET_NATURALIZATION naturalization 45
Event::ET_OBITUARY obituary 46
Event::ET_OCCUPATION occupation 47
Event::ET_ORDINANCE ordinance 48
Event::ET_ORDINATION ordination 49
Event::ET_PHYSICAL_DESCRIPTION physical_description 50
Event::ET_PROBATE probate 51
Event::ET_PROPERTY property 52
Event::ET_RELIGION religion 53
Event::ET_RESIDENCE residence 54
Event::ET_RETIREMENT retirement 55
Event::ET_SCHOOL school 56
Event::ET_SOCIAL_SECURITY_NUMBER social security number (SSN) or equivalent for other country 57
Event::ET_WILL will 58
Event::ET_MEDICAL_CONDITION medical_condition 59
Event::ET_MILITARY military 60
Event::ET_PHOTO photo 61
Event::ET_SOC_SEC_NUM social security number (SSN) or equivalent for other country 62
Event::ET_NATIONALITY nationality 64
Event::ET_FAMILY_GROUP family_group 65
Event::ET_ETHNICITY ethnicity 66
Event::ET_FUNERAL funeral 67
Event::ET_ELECTION election 68
Event::ET_MARRIAGE marriage 69
Event::ET_MARRIAGE_FACT other marriage_fact 70
Event::ET_BIRTH_REGISTRATION birth_registration 71
Event::ET_DEATH_REGISTRATION death_registration 72
Event::ET_MARRIAGE_REGISTRATION marriage_registration 73
Event::ET_LDS_ENDOWED LDS endowed 74
Event::ET_LDS_INITIATORY LDS initiatory 75
Event::ET_LDS_SEALED LDS couple sealed to each other 76
Event::ET_MARRIAGE_END marriage_end 77
Event::ET_LDS_PAR_SEALED LDS child sealed to parents 78

Table of Contents

Next: class Family