Docs For Class GedcomRecord

Description

Located in /includes/gedcomrecord.php (line 37)

Direct descendents

Class	Description
Family
Media
Person
Repository
ServiceClient
Source

Variable Summary

mixed $changed

mixed $gedrec

mixed $rfn

mixed $type

mixed $xref

Method Summary

GedcomRecord GedcomRecord ( $gedrec, [ $simple = false])

boolean canDisplayDetails ()

void equals ( &$obj, GedcomRecord $obj)

void getAbsoluteLinkUrl ()

boolean getChanged ()

void getDateUrl ( $gedcom_date)

void getGedcomRecord ()

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

string getLastchangeDate ()

string getLastchangeRecord ()

string getLastchangeUser ()

string getLinkTitle ()

void getLinkUrl ()

void getPlaceShort ( $gedcom_place)

void getPlaceUrl ( $gedcom_place)

string getSortableLastchangeDate ()

string getSortableName ()

void getType ()

void getXref ()

boolean isMarkedDeleted ()

boolean isRemote ()

void setChanged (boolean $changed)

void setGedcomRecord ( $gcRec)

void undoChange ()

Variables

mixed $changed = false (line 41)

mixed $gedrec = "" (line 38)

mixed $rfn = null (line 42)

mixed $type = "" (line 40)

Redefined in descendants as:

ServiceClient::$type

mixed $xref = "" (line 39)

Methods

Constructor GedcomRecord (line 47)

constructor for this class

GedcomRecord GedcomRecord ( $gedrec, [ $simple = false])

$gedrec
$simple

canDisplayDetails (line 328)

can the details of this record be shown

This method should be overridden in sub classes

boolean canDisplayDetails ()

Redefined in descendants as:

Family::canDisplayDetails() : Check if privacy options allow this record to be displayed
Media::canDisplayDetails() : Check if privacy options allow this record to be displayed
Person::canDisplayDetails() : Check if privacy options allow this record to be displayed
Repository::canDisplayDetails() : Check if privacy options allow this record to be displayed
Source::canDisplayDetails() : Check if privacy options allow this record to be displayed

equals (line 228)

check if this object is equal to the given object

basically just checks if the IDs are the same

void equals ( &$obj, GedcomRecord $obj)

GedcomRecord $obj
&$obj

Redefined in descendants as:

Media::equals() : check if this object is equal to the given object

getAbsoluteLinkUrl (line 288)

return an absolute url for linking to this record from another site

void getAbsoluteLinkUrl ()

getChanged (line 206)

get if this is a changed record from the gedcom file

boolean getChanged ()

getDateUrl (line 336)

get the URL to link to a date

void getDateUrl ( $gedcom_date)

$gedcom_date

getGedcomRecord (line 186)

get gedcom record

void getGedcomRecord ()

getInstance (line 82)

Static function used to get an instance of an object

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

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

Redefined in descendants as:

Family::getInstance() : Static function used to get an instance of a family object
Media::getInstance() : Static function used to get an instance of a media object
Person::getInstance() : Static function used to get an instance of a person object
Repository::getInstance() : Static function used to get an instance of a repository object
ServiceClient::getInstance() : get a singleton instance of this client
Source::getInstance() : Static function used to get an instance of a source object

getLastchangeDate (line 396)

get lastchange date

return: the lastchange date

string getLastchangeDate ()

getLastchangeRecord (line 388)

get lastchange record

return: the lastchange record

string getLastchangeRecord ()

getLastchangeUser (line 415)

get lastchange PGV user

return: the lastchange user

string getLastchangeUser ()

getLinkTitle (line 264)

Get the title that should be used in the link

string getLinkTitle ()

getLinkUrl (line 239)

get the URL to link to this record

This method should be overriden in child sub-classes

void getLinkUrl ()

Redefined in descendants as:

Family::getLinkUrl() : get the URL to link to this family
Media::getLinkUrl() : get the URL to link to this object
Person::getLinkUrl() : get the URL to link to this person
Repository::getLinkUrl() : get the URL to link to this repository
Source::getLinkUrl() : get the URL to link to this source

getPlaceShort (line 367)

get the first part of a place record

void getPlaceShort ( $gedcom_place)

$gedcom_place

getPlaceUrl (line 353)

get the URL to link to a place

void getPlaceUrl ( $gedcom_place)

$gedcom_place

getSortableLastchangeDate (line 404)

get sortable lastchange date

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

string getSortableLastchangeDate ()

getSortableName (line 380)

get the sortable name

This method should be overriden in child sub-classes (no class yet for NOTE record)

string getSortableName ()

Redefined in descendants as:

Family::getSortableName() : get the family sortable name
Media::getSortableName() : get the media sortable name
Person::getSortableName() : get the sortable name
Repository::getSortableName() : get the repository sortable name
Source::getSortableName() : get the source sortable name

getType (line 180)

get the object type

void getType ()

getXref (line 174)

get the xref

void getXref ()

isMarkedDeleted (line 311)

check if this record has been marked for deletion

boolean isMarkedDeleted ()

isRemote (line 214)

is this person from another server

return: return true if this person was linked from another server

boolean isRemote ()

setChanged (line 199)

set if this is a changed record from the gedcom file

void setChanged (boolean $changed)

boolean $changed

setGedcomRecord (line 192)

set gedcom record

void setGedcomRecord ( $gcRec)

$gcRec

undoChange (line 296)

Undo the latest change to this gedcom record

void undoChange ()