Docs For Class Domain

Description

Registry-side domain object

Located in /modules/registries/class.Domain.php (line 19)

Variable Summary

string $AuthCode

time $CreateDate

int $DaysBeforeExpiration

int $DeleteStatus

time $ExpireDate

string $Extension

array $ExtraFields

integer $ID

string $IncompleteOrderOperation

bool $IsLocked

bool $IsManagedDNSEnabled

string $Name

bool $OutgoingTransferStatus

int $Period

string $Protocol

string $RegistryStatus

string $RemoteCLID

string $RemoteCRID

bool $RenewDisabled

string $Status

time $TransferDate

int $UserID

Method Summary

Domain __construct ( $config_xml)

void AddFlag (string $flag)

void AddPendingOperation (string $operation_type)

SimpleXMLElement GetConfig ()

Contact GetContact (string $contact_type)

Contact[] GetContactList ()

Changelist GetFlagChangelist ()

string[] GetFlagList ()

unknown GetHostName ()

IChangelist GetNameserverChangelist ()

void GetNameserverHostList ()

Nameserver[] GetNameserverList ()

array GetPendingOperationList ()

bool HasFlag (string $flag)

bool HasPendingOperation (string $operation_type)

bool IsActive ()

void MarkAsExpired (Domain $Domain)

void RemoveFlag (string $flag)

void SetContact ([Contact $contact = null], $type)

void SetExtraData ( $extra)

void SetExtraField ( $name, $value)

void SetFlagList (string[] $flag_list)

void SetNameserverList ( $nslist)

array ToArray ()

Variables

string $AuthCode (line 90)

Domain auth code (password)

access: public

time $CreateDate (line 54)

Domain Creation date

access: public

int $DaysBeforeExpiration (line 69)

Days before expiration

access: public

int $DeleteStatus (line 118)

Domain

access: public

time $ExpireDate (line 47)

Expiration date

access: public

string $Extension (line 40)

Domain Extension

access: public

array $ExtraFields (line 214)

Domain Extra fields

access: public

integer $ID (line 26)

Domain ID in database

access: public

string $IncompleteOrderOperation = false (line 187)

Incomplete order operation (Transfer or Register)

access: public

bool $IsLocked (line 62)

Is domain locked

access: public

bool $IsManagedDNSEnabled = false (line 180)

Managed DNS enabled for this domain

access: public

string $Name (line 33)

Domain name without extension

access: public

bool $OutgoingTransferStatus = false (line 193)

Outgoing transfer status for this domain.

access: public

int $Period (line 83)

Domain delegation period, years

access: public

string $Protocol (line 97)

Domain Application protocol

access: public

string $RegistryStatus (line 112)

Registry domain status

access: public

string $RemoteCLID (line 140)

Domain clID in registry

access: public

string $RemoteCRID (line 133)

Domain crID in registry

access: public

bool $RenewDisabled (line 145)

access: public

string $Status (line 105)

Domain status

see: DOMAIN_STATUS constants
access: public

time $TransferDate (line 76)

Transfer request date

access: public

int $UserID (line 125)

Owner user of this domain

access: public

Methods

Constructor __construct (line 216)

access: public

Domain __construct ( $config_xml)

$config_xml

AddFlag (line 366)

Adds new flag to domain

access: public

void AddFlag (string $flag)

string $flag

AddPendingOperation (line 446)

Add pending operation type to domain

access: public

void AddPendingOperation (string $operation_type)

string $operation_type

GetConfig (line 227)

Return domain section from module manifest

access: public

SimpleXMLElement GetConfig ()

GetContact (line 248)

Must return domain contact of $contact_type

return: If contact exists, NULL otherwise
access: public

Contact GetContact (string $contact_type)

string $contact_type

GetContactList (line 283)

Must return list of domain contacts

access: public

Contact[] GetContactList ()

GetFlagChangelist (line 419)

Returns flags list wrapped into Changelist

access: public

Changelist GetFlagChangelist ()

GetFlagList (line 409)

Returns list of domain flags

access: public

string[] GetFlagList ()

GetHostName (line 237)

Return domain name with extension

access: public

unknown GetHostName ()

GetNameserverChangelist (line 337)

Returns domain nameservers list wrapped into IChangelist

access: public

IChangelist GetNameserverChangelist ()

GetNameserverHostList (line 342)

access: public

void GetNameserverHostList ()

GetNameserverList (line 293)

Must return list of domain nameservers

access: public

Nameserver[] GetNameserverList ()

GetPendingOperationList (line 467)

Returns domain pending operation types list

access: public

array GetPendingOperationList ()

HasFlag (line 389)

Returns True when domain has flag $flag set

return: True if domain has such flag, false otherwise
access: public

bool HasFlag (string $flag)

string $flag

HasPendingOperation (line 457)

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

access: public

bool HasPendingOperation (string $operation_type)

string $operation_type

IsActive (line 429)

Returns true if domain is in active state

access: public

bool IsActive ()

MarkAsExpired (line 485)

access: public

void MarkAsExpired (Domain $Domain)

Domain $Domain

RemoveFlag (line 377)

Removes flag from domain

access: public

void RemoveFlag (string $flag)

string $flag

SetContact (line 260)

Set domain contact

throws: Exception on contact has no type
access: public

void SetContact ([Contact $contact = null], $type)

Contact $contact
$type

SetExtraData (line 478)

access: public

void SetExtraData ( $extra)

$extra

SetExtraField (line 472)

access: public

void SetExtraField ( $name, $value)

$name
$value

SetFlagList (line 399)

Set new list of flags for this domain

access: public

void SetFlagList (string[] $flag_list)

string[] $flag_list

SetNameserverList (line 304)

Set new list of domain nameservers

throws: Exception on argument is not an array of Nameserver objects
access: public

void SetNameserverList ( $nslist)

Nameserver[] $nslist

ToArray (line 570)

Convert Domain to array

access: public

array ToArray ()