class Family - jcobban/Genealogy GitHub Wiki
Up: Object-Oriented Access to Database Records
This class is derived from Record to implement the logical interface to a record in the Family table (Families or tblMR). Each entry in this table contains the description of a Family.
Fields
This record presents the following fields:
| name | description | Notes |
|---|---|---|
| 'id' | id | |
| 'idmr' | idmr | |
| 'idirhusb' | idir of husband | |
| 'husborder' | order of marriage from point of view of husband | |
| 'husbprefmar' | true if this is the husband's preferred marriage | |
| 'husbsurname' | husband surname | see $family->getHusbPriName() |
| 'husbgivenname' | husband given name | see $family->getHusbPriName() |
| 'husbmarrsurname' | husband married surname | see $family->getHusbMarName() |
| 'husbbirthsd' | husband internal birthdate for sorting YYYYMMDD | see $family->getHusband() |
| 'idirwife' | idir of wife | |
| 'wifeorder' | order of marriage from point of view of wife | |
| 'wifeprefmar' | true if this is the wife's preferred marriage | |
| 'wifesurname' | wife surname | see $family->getWifePriName() |
| 'wifegivenname' | wife given name | see $family->getWifePriName() |
| 'wifemarrsurname' | wife married surname | see $family->getWifeMarName() |
| 'wifebirthsd' | wife internal birthdate for sorting YYYYMMD | see $family->getWife() |
| 'marriednamerule' | married name rule | |
| 'idms' | marriage status code | |
| 'marsd' | internal marriage date for sorting YYYYMMDD | see $family->getMarEvent() |
| 'mard' | marriage date in internal format | see $family->getMarEvent() |
| 'marendsd' | internal marriage end date for sorting YYYYMMDD | see $family->getMarEndEvent() |
| 'marendd' | marriage end date in internal format | see $family->getMarEndEvent() |
| 'idlrmar' | idlr of marriage location | see $family->getMarEvent() |
| 'sealsd' | internal LDS sealing date for sorting YYYYMMD | see $family->getSealEvent() |
| 'seald' | LDS sealing date in internal format | see $family->getSealEvent() |
| 'idtrseal' | idtr of LDS sealing Temple | see $family->getSealEvent() |
| 'sealnote' | LDS sealing note | see $family->getSealEvent() |
| 'ldss' | LDS sealing flag | see $family->getSealEvent() |
| 'notmarried' | never married | |
| 'nochildren' | no children | |
| 'notes' | notes | see $family->getMarEvent() |
| 'added' | added date | |
| 'addedtime' | added time | |
| 'updated' | updated date | |
| 'updatedtime' | updated time | |
| 'idar' | idar of marriage location | see $family->getMarEvent() |
| 'private' | information about this marriage is private |
Constants
This class defines the following constants which indicate the final status of the Family:
$statusText = Family::$statusText[$family[idms]]; // English language interpretation
$family['idms'] = Family::MS_ANNULLED;
| constant | description | value |
|---|---|---|
| Family::MS_COMMON | common | 1 |
| Family::MS_ANNULLED | annulled | 2 |
| Family::MS_COMMON_LAW | common_law | 3 |
| Family::MS_DIVORCED | divorced | 4 |
| Family::MS_MARRIED | married | 5 |
| Family::MS_OTHER | other | 6 |
| Family::MS_SEPARATED | separated | 7 |
| Family::MS_UNMARRIED | unmarried | 8 |
| Family::MS_DIVORCE | divorce | 9 |
| Family::MS_SEPARATION | separation | 10 |
| Family::MS_PRIVATE | private | 11 |
| Family::MS_PARTNERS | partners | 12 |
| Family::MS_DEATH_1_SPOUSE | death of 1 spouse | 13 |
| Family::MS_SINGLE | single | 14 |
| Family::MS_FRIENDS | friends | 15 |
The class provides two tables for converting values of marriage status obtained from $family['idms'] to text, but they are only in English so application scripts should translate them for Internationalization:
Family::$statusText[$family['idms']] // value suitable for selection lists
Family::$statusVerb[$family['idms']] // value suitable for anecdotal text
Table of Contents
- new Family($parms)
- $family->getName($options)
- $family->get($fieldname)
- $family->set($fieldname, $value)
- $family->getHusband()
- $family->getHusbPriName()
- $family->getHusbMarName()
- $family->getHusbName()
- $family->getWife()
- $family->getWifePriName()
- $family->getWifeMarName()
- $family->getWifeName()
- $family->setName($person)
- $family->getMarEvent($create)
- $family->getSealEvent($create)
- $family->getMarEndEvent($create)
- $family->getEvents()
- $family->addEvent($event)
- $family->getStatus()
- $family->getStatusVerb()
- $family->getChildren()
- $family->addChild($idir)
- $family->detachChild($idcr, $xml)
- $family->showCitationsXml($top, $citType, $print = true)
- $family->showCitationsJson($citType, $print = true)
- $family->merge($oldFamily)
- $family->save($xml)
- $family->delete($xml)
Next: new Family($parms)