Docs For Class LocalClient

Description

Located in /includes/localclient_class.php (line 33)

GedcomRecord
   |
   --ServiceClient
      |
      --LocalClient

Method Summary

LocalClient LocalClient (string $gedrec)

void authenticate ()

void getRemoteRecord (string $remoteid)

void mergeGedcomRecord (string $xref, string $localrec, [boolean $isStub = false], [boolean $firstLink = false])

void &search (string $query, [integer $start = 0], [integer $max = 100])

Variables

Inherited Variables

Inherited from ServiceClient

ServiceClient::$data_type
ServiceClient::$DEBUG
ServiceClient::$gedfile
ServiceClient::$password
ServiceClient::$SID
ServiceClient::$soapClient
ServiceClient::$title
ServiceClient::$type
ServiceClient::$url
ServiceClient::$username

Inherited from GedcomRecord

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

Methods

Constructor LocalClient (line 38)

constructor

LocalClient LocalClient (string $gedrec)

string $gedrec: the gedcom record

authenticate (line 46)

authenticate the client

void authenticate ()

Redefinition of:

ServiceClient::authenticate(): authenticate the client

getRemoteRecord (line 54)

Get a record from the remote site

void getRemoteRecord (string $remoteid)

string $remoteid: the id of the record to get

Redefinition of:

ServiceClient::getRemoteRecord(): Get a record from the remote site

mergeGedcomRecord (line 67)

merge a local gedcom record with the information from the remote site

void mergeGedcomRecord (string $xref, string $localrec, [boolean $isStub = false], [boolean $firstLink = false])

string $xref: the remote ID to merge with
string $localrec: the local gedcom record to merge the remote record with
boolean $isStub: whether or not this is a stub record
boolean $firstLink: is this the first time this record is being linked

Redefinition of:

ServiceClient::mergeGedcomRecord(): merge a local gedcom record with the information from the remote site

search (line 143)

get a singleton instance of the results returned by the soapClient search method

void &search (string $query, integer $start, [integer $max = 100])

string $query: - the query to search on
integer $start: - the start index of the results to return
integer $max: - the maximum number of results to return

Redefinition of:

ServiceClient::search(): get a singleton instance of the results returned by the soapClient search method

Inherited Methods

Inherited From ServiceClient

ServiceClient::ServiceClient()
ServiceClient::authenticate()
ServiceClient::checkIds()
ServiceClient::CompairForUpdateFamily()
ServiceClient::ComparePeople()
ServiceClient::getGedfile()
ServiceClient::getInstance()
ServiceClient::getRemoteRecord()
ServiceClient::getServiceTitle()
ServiceClient::getTitle()
ServiceClient::getURL()
ServiceClient::isError()
ServiceClient::MergeForUpdateFamily()
ServiceClient::mergeGedcomRecord()
ServiceClient::search()
ServiceClient::setSameId()
ServiceClient::UpdateFamily()
ServiceClient::_merge()
ServiceClient::__change_encoding()

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