Docs For Class ServiceClient

Description

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

GedcomRecord
   |
   --ServiceClient

Direct descendents

Class	Description
LocalClient

Variable Summary

mixed $data_type

mixed $DEBUG

mixed $gedfile

mixed $password

mixed $SID

mixed $soapClient

mixed $title

mixed $type

mixed $url

mixed $username

Method Summary

ServiceClient ServiceClient (string $gedrec)

void authenticate ()

string checkIds (string $gedrec)

void CompairForUpdateFamily ( $family1, $family2)

void ComparePeople ( &$Person1, &$Person2)

void getGedfile ()

ServiceClient &getInstance ( $id)

void getRemoteRecord (string $remoteid)

string getServiceTitle ()

string getTitle ()

void getURL ()

void isError ( &$result)

void MergeForUpdateFamily ( $Family1, $Family2, $Familylist, &$FamilyListReturn)

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

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

void setSameId (string $local, string $remote)

void UpdateFamily ( $record1, $record2)

void _merge ( $record1, $record2)

object modified __change_encoding ( &$wsdl, object $wsdl)

Variables

mixed $data_type = "" (line 45)

mixed $DEBUG = false (line 46)

mixed $gedfile = "" (line 40)

mixed $password = "" (line 43)

mixed $SID = "" (line 39)

mixed $soapClient = null (line 38)

mixed $title = "" (line 41)

mixed $type = "" (line 44)

Redefinition of:

GedcomRecord::$type

mixed $url = "" (line 37)

mixed $username = "" (line 42)

Inherited Variables

Inherited from GedcomRecord

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

Methods

Constructor ServiceClient (line 52)

contstructor to create a new ServiceClient object

ServiceClient ServiceClient (string $gedrec)

string $gedrec: the SERV gedcom record

authenticate (line 105)

authenticate the client

void authenticate ()

Redefined in descendants as:

LocalClient::authenticate() : authenticate the client

checkIds (line 767)

check if any there are any stub records with RFN tags that match the

ids in the gedcom record

string checkIds (string $gedrec)

string $gedrec

CompairForUpdateFamily (line 544)

Compairs familys and then returns true if the have 50% or more chance of being the same family.

Other wise it returns false.

void CompairForUpdateFamily ( $family1, $family2)

$family1
$family2

ComparePeople (line 691)

Compares to see if two people are the same, and it returns true if they are, but

false if they are not. It only compares the name, sex birthdate, and deathdate of the person

void ComparePeople ( &$Person1, &$Person2)

&$Person1
&$Person2

getGedfile (line 98)

get the gedcom file

void getGedfile ()

getInstance (line 971)

get a singleton instance of this client

ServiceClient &getInstance ( $id)

$id

Redefinition of:

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

getRemoteRecord (line 139)

Get a record from the remote site

void getRemoteRecord (string $remoteid)

string $remoteid: the id of the record to get

Redefined in descendants as:

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

getServiceTitle (line 155)

get the title for this service

string getServiceTitle ()

getTitle (line 84)

get the title of this source record

string getTitle ()

getURL (line 91)

void getURL ()

isError (line 73)

check if the service returned an error

void isError ( &$result)

&$result

MergeForUpdateFamily (line 395)

This mergest the the two familys together

void MergeForUpdateFamily ( $Family1, $Family2, $Familylist, &$FamilyListReturn)

$Family1
$Family2
$Familylist
&$FamilyListReturn

mergeGedcomRecord (line 785)

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

Redefined in descendants as:

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

search (line 940)

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

Redefined in descendants as:

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

setSameId (line 647)

set two ids in the same person

void setSameId (string $local, string $remote)

string $local: The local id
string $remote: the remote id that matches the $local id

UpdateFamily (line 261)

Updates Family Records such as children, spouse, and parents

void UpdateFamily ( $record1, $record2)

$record1
$record2

_merge (line 173)

Merge people together.

void _merge ( $record1, $record2)

$record1
$record2

__change_encoding (line 953)

* Change encoding style to literal used when calling a java service

return: wsdl object

object modified __change_encoding ( &$wsdl, object $wsdl)

object $wsdl: SOAP_WSDL object
&$wsdl

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