Docs For Class Contact

Description

Contact object

author: Marat Komarov <http://webta.net/company.html>
author: Igor Savchenko <http://webta.net/company.html>
author: Alex Kovalyov <http://webta.net/company.html>
name: Contact

Located in /modules/registries/class.Contact.php (line 21)

Variable Summary

string $AuthCode

string $CLID

string $Extension

array $ExtraData

array $ExtraStoredData

string $FullName

string $GroupName

int $ID

mixed $ModuleName

string $ParentCLID

Registry $Registry

mixed $SectionName

bool $StrictlyValidated

mixed $TargetIndex

int $UserID

Method Summary

Contact __construct ( $contact_config)

void AddPendingOperation (string $operation_type)

string E164ToPhone (string $string)

SimpleXMLElement GetConfig ()

array GetDiscloseList ()

string[] GetEditableNames ()

string GetEmail ()

string GetField (string $fieldname)

array GetFieldList ()

string GetFullName ()

array GetPendingOperationList ()

array GetRegistryFormattedFieldList ()

void GetTargetExtensions ()

void GetTargetTitle ()

void GetTitle ()

bool HasPendingOperation (string $operation_type)

unknown PhoneToE164 (string $string)

void SetDiscloseList (array $disclose_list)

void SetDiscloseValue (string $field, bool $showIt)

void SetFieldList (array(key=>value) $data, [ $strict = true])

void SetFullName ( $full_name)

array ToArray ()

Variables

string $AuthCode (line 83)

Contact authentification code/password

access: public

string $CLID (line 35)

Registry contact ID

access: public

string $Extension (line 63)

deprecated:
access: public

array $ExtraData = array() (line 97)

Extra fields values (not stored in database)

access: public

array $ExtraStoredData = array() (line 104)

Extra fields, that stored in database

access: public

string $FullName (line 42)

Contact full name.

Usefull when contact cannot be syncronized.

access: public

string $GroupName (line 56)

Group name of this contact

access: public

int $ID (line 28)

EPP-DRS Contact ID (Database ID)

access: public

mixed $ModuleName (line 66)

access: public

string $ParentCLID (line 49)

Registry parent contact ID. Optional.

access: public

Registry $Registry (line 116)

access: public

mixed $SectionName (line 67)

access: public

bool $StrictlyValidated = true (line 111)

Associative

access: public

mixed $TargetIndex (line 68)

access: public

int $UserID (line 76)

Database ID of the client who owns this contact

access: public

Methods

Constructor __construct (line 139)

access: public

Contact __construct ( $contact_config)

$contact_config

AddPendingOperation (line 575)

Must add pending operation type to contact

access: public

void AddPendingOperation (string $operation_type)

string $operation_type

E164ToPhone (line 620)

Convert phone from E.164 (+XXX.XXXXXXXX) format to display format

access: public

string E164ToPhone (string $string)

string $string

GetConfig (line 289)

Must return contact section from module manifest

access: public

SimpleXMLElement GetConfig ()

GetDiscloseList (line 565)

This method must return list of contact fields discloses

return: Assoc array, where keys - field names, values - boolean flag
access: public

array GetDiscloseList ()

GetEditableNames (line 341)

Must return editable fields names

access: public

string[] GetEditableNames ()

GetEmail (line 194)

Must return email address of contact person

throws: Exception
access: public

string GetEmail ()

GetField (line 331)

Must return value of $fieldname contact field

access: public

string GetField (string $fieldname)

string $fieldname

GetFieldList (line 299)

Must return contact data

return: Array of fields, keys are equal to field names
access: public

array GetFieldList ()

GetFullName (line 162)

Must return full name of contact person

throws: Exception
access: public

string GetFullName ()

GetPendingOperationList (line 596)

Returns contact pending operation types list

access: public

array GetPendingOperationList ()

GetRegistryFormattedFieldList (line 309)

Must return registry formatted contact data

return: Array of fields, keys are equal to field names
access: public

array GetRegistryFormattedFieldList ()

GetTargetExtensions (line 245)

access: public

void GetTargetExtensions ()

GetTargetTitle (line 257)

access: public

void GetTargetTitle ()

GetTitle (line 217)

access: public

void GetTitle ()

HasPendingOperation (line 586)

Returns true when contact has such operation type in it's pending operation list

access: public

bool HasPendingOperation (string $operation_type)

string $operation_type

PhoneToE164 (line 638)

Convert display phone to e.164 (+XXX.XXXXXXXX)

access: public

unknown PhoneToE164 (string $string)

string $string

SetDiscloseList (line 554)

This method set list of disclose flags

access: public

void SetDiscloseList (array $disclose_list)

array $disclose_list: Assoc array, where keys - field names, values - boolean flag

SetDiscloseValue (line 543)

Set disclose flag to contact field.

Show/hide $field in WHOIS

access: public

void SetDiscloseValue (string $field, bool $showIt)

string $field
bool $showIt

SetFieldList (line 379)

Set contact data fields

throws: ErrorList
access: public

void SetFieldList (array(key=>value) $data, [ $strict = true])

array(key=>value) $data
$strict

SetFullName (line 183)

access: public

void SetFullName ( $full_name)

$full_name

ToArray (line 653)

Converts Contact to Array

access: public

array ToArray ()