Docs For Class Family

Description

Located in /includes/family_class.php (line 36)

GedcomRecord
   |
   --Family

Variable Summary

mixed $children

mixed $disp

mixed $div_rec

mixed $husb

mixed $marr_date

mixed $marr_date2

mixed $marr_est

mixed $marr_rec

mixed $marr_rec2

mixed $marr_type

mixed $wife

Method Summary

Family Family (string $gedrec, [ $simple = true])

boolean canDisplayDetails ()

array getChildren ()

string getDivorceDate ()

string getDivorcePlace ()

string getDivorceRecord ()

string getDivorceType ()

string getDivorceYear ()

Person &getHusband ()

string getHusbId ()

void &getInstance (string $pid, [ $simple = true])

void getLinkUrl ()

string getMarriageDate ()

string getMarriagePlace ()

string getMarriageRecord ()

string getMarriageType ()

string getMarriageYear ()

int getNumberOfChildren ()

string getSortableMarriageDate ()

string getSortableMarriageDate2 ()

string getSortableName ([ $linebr = false])

Person &getSpouse ( &$person, Person $person)

string &getSpouseId (string $pid)

void &getUpdatedFamily ()

Person &getWife ()

string getWifeId ()

void hasChild ( &$person, Person $person)

void hasParent ( &$person, Person $person)

boolean isDivorced ()

void _parseMarriageRecord ()

Variables

mixed $children = array() (line 39)

mixed $disp = true (line 40)

mixed $div_rec = null (line 45)

mixed $husb = null (line 37)

mixed $marr_date = null (line 42)

mixed $marr_date2 = null (line 47)

mixed $marr_est = false (line 44)

mixed $marr_rec = null (line 41)

mixed $marr_rec2 = null (line 46)

mixed $marr_type = null (line 43)

mixed $wife = null (line 38)

Inherited Variables

Inherited from GedcomRecord

GedcomRecord::$changed
GedcomRecord::$gedrec
GedcomRecord::$rfn
GedcomRecord::$type
GedcomRecord::$xref

Methods

Constructor Family (line 53)

constructor

Family Family (string $gedrec, [ $simple = true])

string $gedrec: the gedcom record
$simple

canDisplayDetails (line 214)

Check if privacy options allow this record to be displayed

boolean canDisplayDetails ()

Redefinition of:

GedcomRecord::canDisplayDetails(): can the details of this record be shown

getChildren (line 175)

get the children

return: array of children Persons

array getChildren ()

getDivorceDate (line 382)

get divorce date

string getDivorceDate ()

getDivorcePlace (line 400)

get the divorce place

string getDivorcePlace ()

getDivorceRecord (line 299)

get divorce record

string getDivorceRecord ()

getDivorceType (line 391)

get the type for this marriage

string getDivorceType ()

getDivorceYear (line 408)

get the divorce year

string getDivorceYear ()

getHusband (line 136)

get the husband's person object

Person &getHusband ()

getHusbId (line 118)

get the husbands ID

string getHusbId ()

getInstance (line 83)

Static function used to get an instance of a family object

void &getInstance (string $pid, [ $simple = true])

string $pid: the ID of the family to retrieve
$simple

Redefinition of:

GedcomRecord::getInstance(): Static function used to get an instance of an object

getLinkUrl (line 419)

get the URL to link to this family

void getLinkUrl ()

Redefinition of:

GedcomRecord::getLinkUrl(): get the URL to link to this record

getMarriageDate (line 318)

get marriage date

string getMarriageDate ()

getMarriagePlace (line 362)

get the marriage place

string getMarriagePlace ()

getMarriageRecord (line 290)

get marriage record

string getMarriageRecord ()

getMarriageType (line 353)

get the type for this marriage

string getMarriageType ()

getMarriageYear (line 370)

get the marriage year

string getMarriageYear ()

getNumberOfChildren (line 183)

get the number of children in this family

return: the number of children

int getNumberOfChildren ()

getSortableMarriageDate (line 329)

get sortable marriage date

return: the marriage date in sortable format YYYY-MM-DD HH:MM

string getSortableMarriageDate ()

getSortableMarriageDate2 (line 342)

get sortable marriage date2

return: the marriage date2 in sortable format YYYY-MM-DD HH:MM

string getSortableMarriageDate2 ()

getSortableName (line 193)

get the family sortable name

string getSortableName ([ $linebr = false])

$linebr

Redefinition of:

GedcomRecord::getSortableName(): get the sortable name

getSpouse (line 152)

return the spouse of the given person

Person &getSpouse ( &$person, Person $person)

Person $person
&$person

getSpouseId (line 164)

return the spouse id of the given person id

string &getSpouseId (string $pid)

string $pid

getUpdatedFamily (line 223)

get updated Family

If there is an updated family record in the gedcom file return a new family object for it

void &getUpdatedFamily ()

getWife (line 143)

get the wife's person object

Person &getWife ()

getWifeId (line 127)

get the wife ID

string getWifeId ()

hasChild (line 254)

check if this family has the given person

as a child in the family

void hasChild ( &$person, Person $person)

Person $person
&$person

hasParent (line 243)

check if this family has the given person

as a parent in the family

void hasParent ( &$person, Person $person)

Person $person
&$person

isDivorced (line 309)

Return whether or not this family ended in a divorce.

Current implementation returns true if there is a non-empty divorce record.

return: true if there is a non-empty divorce record, false if no divorce record exists

boolean isDivorced ()

_parseMarriageRecord (line 265)

parse marriage record

void _parseMarriageRecord ()

Inherited Methods

Inherited From GedcomRecord

GedcomRecord::GedcomRecord()
GedcomRecord::canDisplayDetails()
GedcomRecord::equals()
GedcomRecord::getAbsoluteLinkUrl()
GedcomRecord::getChanged()
GedcomRecord::getDateUrl()
GedcomRecord::getGedcomRecord()
GedcomRecord::getInstance()
GedcomRecord::getLastchangeDate()
GedcomRecord::getLastchangeRecord()
GedcomRecord::getLastchangeUser()
GedcomRecord::getLinkTitle()
GedcomRecord::getLinkUrl()
GedcomRecord::getPlaceShort()
GedcomRecord::getPlaceUrl()
GedcomRecord::getSortableLastchangeDate()
GedcomRecord::getSortableName()
GedcomRecord::getType()
GedcomRecord::getXref()
GedcomRecord::isMarkedDeleted()
GedcomRecord::isRemote()
GedcomRecord::setChanged()
GedcomRecord::setGedcomRecord()
GedcomRecord::undoChange()