Docs For Class Person

Class Person

Description

Located in /includes/person_class.php (line 35)

GedcomRecord
   |
   --Person

Variable Summary

mixed $age

mixed $bdate

mixed $bdate2

mixed $best

mixed $brec

mixed $brec2

mixed $childFamilies

mixed $ddate

mixed $ddate2

mixed $dest

mixed $disp

mixed $dispname

mixed $drec

mixed $drec2

mixed $facts_parsed

mixed $famc

mixed $fams

mixed $file

mixed $globalfacts

mixed $highlightedimage

mixed $indifacts

mixed $label

mixed $mediafacts

mixed $otherfacts

mixed $sex

mixed $sosamax

mixed $spouseFamilies

Method Summary

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

records add_asso_facts (string $pid)

records add_children_facts (string $famid, [string $option = ""], [string $except = ""])

void add_family_facts ([boolean $otherfacts = true])

records add_historical_facts ()

records add_parents_facts (string $pid, [int $sosa = 1])

records add_spouse_facts (string $spouse, [string $famrec = ""])

records add_stepsiblings_facts (string $spouse, [string $except = ""])

boolean canDisplayDetails ()

boolean canDisplayName ()

void diffMerge ( &$diff, Person $diff)

array findHighlightedMedia ()

string getAddName ()

string getAge ([string $birtrec = ""], [string $when = ""])

string getBirthDate ()

string getBirthPlace ()

string getBirthRecord ([boolean $estimate = true])

string getBirthYear ()

array getChildFamilies ()

array getChildFamilyIds ()

string getChildFamilyLabel ( &$family, Family $family)

string getDeathDate ()

string getDeathPlace ()

string getDeathRecord ([boolean $estimate = true])

string getDeathYear ()

string getGedcomBirthDate ()

string getGedcomDeathDate ()

string getGivenNames ()

array getGlobalFacts ()

array getIndiFacts ()

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

string getLabel ()

void getLinkUrl ()

string getName ()

int getNumberOfChildren ()

array getOtherFacts ()

string getSex ()

string getSexImage ()

string getSortableBirthDate ([ $est = true])

string getSortableBirthDate2 ()

string getSortableDeathDate ([ $est = true])

string getSortableDeathDate2 ()

string getSortableName ([string $subtag = ""], [int $num = 1], [boolean $starred = true])

array getSpouseFamilies ()

array getSpouseFamilyIds ()

string getSpouseFamilyLabel ( &$family, Family $family)

array getStepFamilies ()

string getStepFamilyLabel ( &$family, Family $family)

string getSurname ()

Person &getUpdatedPerson ()

boolean isDead ()

void parseFacts ()

void setLabel (string $label)

void _parseBirthDeath ()

Variables

mixed $age = null (line 62)

mixed $bdate = "" (line 45)

mixed $bdate2 = "" (line 51)

mixed $best = false (line 49)

mixed $brec = "" (line 47)

mixed $brec2 = "" (line 53)

mixed $childFamilies = null (line 58)

mixed $ddate = "" (line 46)

mixed $ddate2 = "" (line 52)

mixed $dest = false (line 50)

mixed $disp = true (line 37)

mixed $dispname = true (line 38)

mixed $drec = "" (line 48)

mixed $drec2 = "" (line 54)

mixed $facts_parsed = false (line 43)

mixed $famc = null (line 56)

mixed $fams = null (line 55)

mixed $file = "" (line 61)

mixed $globalfacts = array() (line 41)

mixed $highlightedimage = null (line 60)

mixed $indifacts = array() (line 39)

mixed $label = "" (line 59)

mixed $mediafacts = array() (line 42)

mixed $otherfacts = array() (line 40)

mixed $sex = "U" (line 36)

mixed $sosamax = 7 (line 44)

mixed $spouseFamilies = null (line 57)

Inherited Variables

Inherited from GedcomRecord

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

Methods

Constructor Person (line 68)

Constructor for person object

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

string $gedrec: the raw individual gedcom record
$simple

add_asso_facts (line 1220)

add events where pid is an ASSOciate

return: added to indifacts array

records add_asso_facts (string $pid)

string $pid: Gedcom id

add_children_facts (line 984)

add children events to individual facts array

bdate = indi birth date record ddate = indi death date record

return: added to indifacts array

records add_children_facts (string $famid, [string $option = ""], [string $except = ""])

string $famid: Gedcom family id
string $option: Family level indicator
string $except: Gedcom childid already processed

add_family_facts (line 809)

add facts from the family record

void add_family_facts ([boolean $otherfacts = true])

boolean $otherfacts: whether or not to add other related facts such as parents facts, associated people facts, and historical facts

add_historical_facts (line 1196)

add historical events to individual facts array

return:
added to indifacts array
Historical facts are imported from optional language file : histo.xx.php where xx is language code This file should contain records similar to :
$histo[]="1 EVEN\n2 TYPE History\n2 DATE 11 NOV 1918\n2 NOTE WW1 Armistice"; $histo[]="1 EVEN\n2 TYPE History\n2 DATE 8 MAY 1945\n2 NOTE WW2 Armistice"; etc...

records add_historical_facts ()

add_parents_facts (line 880)

add parents events to individual facts array

sosamax = sosa max for recursive call bdate = indi birth date record ddate = indi death date record

return: added to indifacts array

records add_parents_facts (string $pid, [int $sosa = 1])

string $pid: Gedcom id
int $sosa: 2=father 3=mother ...

add_spouse_facts (line 1145)

add spouse events to individual facts array

bdate = indi birth date record ddate = indi death date record

return: added to indifacts array

records add_spouse_facts (string $spouse, [string $famrec = ""])

string $spouse: Gedcom id
string $famrec: family Gedcom record

add_stepsiblings_facts (line 1175)

add step-siblings events to individual facts array

return: added to indifacts array

records add_stepsiblings_facts (string $spouse, [string $except = ""])

string $spouse: Father or mother Gedcom id
string $except: Gedcom famid already processed

canDisplayDetails (line 224)

Check if privacy options allow this record to be displayed

boolean canDisplayDetails ()

Redefinition of:

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

canDisplayName (line 231)

Check if privacy options allow the display of the persons name

boolean canDisplayName ()

diffMerge (line 1279)

Merge the facts from another Person object into this object

for generating a diff view

void diffMerge ( &$diff, Person $diff)

Person $diff: the person to compare facts with
&$diff

findHighlightedMedia (line 247)

get highlighted media

array findHighlightedMedia ()

getAddName (line 216)

Check if an additional name exists for this person

string getAddName ()

getAge (line 455)

get the age

return: the age

string getAge ([string $birtrec = ""], [string $when = ""])

string $birtrec: gedcom record containing BIRT date
string $when: ending date to calculate age

getBirthDate (line 320)

get birth date

return: the birth date in the GEDCOM format of '1 JAN 2006'

string getBirthDate ()

getBirthPlace (line 368)

get the birth place

string getBirthPlace ()

getBirthRecord (line 301)

get birth record

string getBirthRecord ([boolean $estimate = true])

boolean $estimate: Provide an estimated birth date for people without a birth record

getBirthYear (line 376)

get the birth year

string getBirthYear ()

getChildFamilies (line 571)

get an array of families with parents

return: array of Family objects indexed by family id

array getChildFamilies ()

getChildFamilyIds (line 562)

get family with child ids

return: array of the FAMC ids

array getChildFamilyIds ()

getChildFamilyLabel (line 643)

get the correct label for a family

string getChildFamilyLabel ( &$family, Family $family)

Family $family: the family to get the label for
&$family

getDeathDate (line 388)

get death date

return: the death date in the GEDCOM format of '1 JAN 2006'

string getDeathDate ()

getDeathPlace (line 437)

get the death place

string getDeathPlace ()

getDeathRecord (line 311)

get death record

string getDeathRecord ([boolean $estimate = true])

boolean $estimate: Provide an estimated death date for people without a death record

getDeathYear (line 445)

get the death year

return: the year of death

string getDeathYear ()

getGedcomBirthDate (line 360)

a function that returns the full GEDCOM line containing the birth date

return: the date line from the gedcom birth record in the format of '2 DATE 1 JAN 1900'

string getGedcomBirthDate ()

getGedcomDeathDate (line 429)

a function that returns the full GEDCOM line containing the death date

return: the death date line from the gedcom in the format of '2 DATE 1 JAN 1900'

string getGedcomDeathDate ()

getGivenNames (line 202)

get the given names

string getGivenNames ()

getGlobalFacts (line 617)

get global facts

array getGlobalFacts ()

getIndiFacts (line 625)

get indi facts

array getIndiFacts ()

getInstance (line 85)

Static function used to get an instance of a person object

return: returns an instance of a person object

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

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

Redefinition of:

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

getLabel (line 507)

get the label for this person

The label can be used when building a list of people to display the relationship between this person and the person listed on the page

string getLabel ()

getLinkUrl (line 1412)

get the URL to link to this person

void getLinkUrl ()

Redefinition of:

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

getName (line 131)

get the name

string getName ()

getNumberOfChildren (line 543)

get the number of children for this person

return: the number of children

int getNumberOfChildren ()

getOtherFacts (line 634)

get other facts

array getOtherFacts ()

getSex (line 474)

get the sex

return: return M, F, or U

string getSex ()

getSexImage (line 482)

get the person's sex image

return: <img ... />

string getSexImage ()

getSortableBirthDate (line 331)

get sortable birth date

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

string getSortableBirthDate ([ $est = true])

$est

getSortableBirthDate2 (line 349)

get sortable birth date2

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

string getSortableBirthDate2 ()

getSortableDeathDate (line 399)

get sortable death date

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

string getSortableDeathDate ([ $est = true])

$est

getSortableDeathDate2 (line 418)

get sortable death date2

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

string getSortableDeathDate2 ()

getSortableName (line 146)

get the sortable name

string getSortableName ([string $subtag = ""], [int $num = 1], [boolean $starred = true])

string $subtag: optional subtag _AKA _HEB etc...
int $num: which matching subtag to get
boolean $starred: option to add starredname html code

Redefinition of:

GedcomRecord::getSortableName(): get the sortable name

getSpouseFamilies (line 523)

get the families with spouses

return: array of Family objects

array getSpouseFamilies ()

getSpouseFamilyIds (line 514)

get family with spouse ids

return: array of the FAMS ids

array getSpouseFamilyIds ()

getSpouseFamilyLabel (line 693)

get the correct label for a family

string getSpouseFamilyLabel ( &$family, Family $family)

Family $family: the family to get the label for
&$family

getStepFamilies (line 590)

get the step families from the parents

return: array of Family objects

array getStepFamilies ()

getStepFamilyLabel (line 660)

get the correct label for a step family

string getStepFamilyLabel ( &$family, Family $family)

Family $family: the family to get the label for
&$family

getSurname (line 189)

get the surname

string getSurname ()

getUpdatedPerson (line 722)

get updated Person

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

Person &getUpdatedPerson ()

isDead (line 239)

Return whether or not this person is already dead

return: true if dead, false if alive

boolean isDead ()

parseFacts (line 740)

Parse the facts from the individual record

void parseFacts ()

setLabel (line 497)

set a label for this person

The label can be used when building a list of people to display the relationship between this person and the person listed on the page

void setLabel (string $label)

string $label

_parseBirthDeath (line 256)

parse birth and death records

void _parseBirthDeath ()

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()

Documentation generated on Wed, 28 Mar 2007 09:54:29 -0600 by phpDocumentor 1.3.1