Docs For Class GenericEPPRegistryModule

GenericEPPRegistryModule

Description

Implements interfaces:

IRegistryModule

Generic EPP Registry Module.

You can extend this class instead of AbstractrgistryModule to produce basic fully-functional RFC-compliant EPP registry module.

author: Marat Komarov <http://webta.net/company.html>
author: Igor Savchenko <http://webta.net/company.html>
abstract:
name: GenericEPPRegistryModule

Located in /modules/registries/class.GenericEPPRegistryModule.php (line 16)

Module
   |
   --AbstractRegistryModule
      |
      --GenericEPPRegistryModule

Class Constant Summary

TRANSFER_CLIENT_APPROVED = "clientApproved"

TRANSFER_CLIENT_CANCELLED = "clientCancelled"

TRANSFER_CLIENT_REJECTED = "clientRejected"

TRANSFER_PENDING = "pending"

TRANSFER_SERVER_APPROVED = "serverApproved"

TRANSFER_SERVER_CANCELLED = "serverCancelled"

Variable Summary

static mixed $EPPFlags

mixed $XmlNamespaces

Method Summary

static void GetConfigurationForm ()

static true ValidateConfigurationFormData (array $post_values)

void AcknowledgeMessage (PendingOperationResponse $resp_message)

void BeforeRequest ( $command, &$data, $method)

bool ChangeDomainOwner (Domain $domain, [integer $period = null], [array $extra = array()])

TRANSFER_STATUS CheckTransferStatus (Domain $domain, string $password)

bool ContactCanBeCreated (Contact $contact)

Contact CreateContact (Contact $contact, [ $extra = array()])

CreateDomainResponse CreateDomain (Domain $domain, integer $period, [array $extra = array()], array $owner_contact, array $admin_contact, array $tech_contact, array $billing_contact, array $nameservers)

CreateNameserverResponse CreateNameserver (Nameserver $ns)

CreateNameserverHostResponse CreateNameserverHost (NameserverHost $ns, NameserverHost $nshost)

void DeleteContact (Contact $contact, [array $extra = array()])

DeleteDomainResponse DeleteDomain (Domain $domain, [int $executeDate = null])

bool DeleteNameserverHost (NameserverHost $ns, Host $host)

bool DomainCanBeRegistered (Domain $domain)

void DomainCanBeTransferred (Domain $domain)

void GetDiscloseXML ( $disclose_list, $flag)

void GetFlagsXML ( $flags)

string GetHostIpAddress ( $hostname)

void GetNSXML ( $nslist, [ $nsprefix = "domain"])

string GetRegistrarID ()

array GetRemoteContact (Contact $contact, string $CLID)

GetRemoteDomainResponse GetRemoteDomain (Domain $domain)

void GetResponseStatusFromEPPResponse ( $response)

LockDomainResponse LockDomain (Domain $domain, [array $extra = array()])

int NameserverCanBeCreated (Nameserver $ns, string $hostname)

PendingOperationResponse ReadMessage ()

void RenewDomain (Domain $domain, [ $extra = array()], array $extradata)

void StrToTime ( $str)

bool TransferApprove (Domain $domain, [ $extra = array()], array $extradata)

bool TransferReject (Domain $domain, [ $extra = array()], array $extradata)

TransferRequestResponse TransferRequest (Domain $domain, [ $extra = array()], array $extradata)

UnLockDomainResponse UnlockDomain (Domain $domain, [array $extra = array()])

bool UpdateContact (Contact $contact, string $contact_id)

UpdateDomainAuthCodeResponse UpdateDomainAuthCode (Domain $domain, $authCode, string $authcode)

UpdateDomainContactResponse UpdateDomainContact (Domain $domain, string $contactType, Contact $oldContact, Contact $newContact)

void UpdateDomainFlags (Domain $domain, $changes)

UpdateDomainNameserversResponse UpdateDomainNameservers (Domain $domain, $changelist)

bool UpdateNameserverHost (NameserverHost $ns, Host $host)

Variables

static mixed $EPPFlags = array(
'clientHold',
'inactive',
'clientUpdateProhibited',
'clientDeleteProhibited',
'clientTransferProhibited',
'clientRenewProhibited'
) (line 218)

access: protected

mixed $XmlNamespaces = array
(
'domain' => 'urn:ietf:params:xml:ns:domain-1.0',
'contact' => 'urn:ietf:params:xml:ns:contact-1.0',
'host' => 'urn:ietf:params:xml:ns:host-1.0'
) (line 18)

access: protected

Inherited Variables

Inherited from AbstractRegistryModule

AbstractRegistryModule::$CodebaseName
AbstractRegistryModule::$Config
AbstractRegistryModule::$Extension
AbstractRegistryModule::$Manifest
AbstractRegistryModule::$ModuleName
AbstractRegistryModule::$RegistryAccessible
AbstractRegistryModule::$Transport

Methods

static GetConfigurationForm (line 37)

access: public

static void GetConfigurationForm ()

static ValidateConfigurationFormData (line 32)

This method is called to validate either user filled all fields of your configuration form properly.

If you return true, all configuration data will be stored in database. If you return array, user will be presented with values of this array as errors.

return: or array of error messages.
access: public

static true ValidateConfigurationFormData (array $post_values)

array $post_values

Implementation of:

IRegistryModule::ValidateConfigurationFormData(): Called by he core to check either user filled all fields of your configuration form properly.

AcknowledgeMessage (line 1211)

Send message acknowledgement to server

access: public

void AcknowledgeMessage (PendingOperationResponse $resp_message)

PendingOperationResponse $resp_message

BeforeRequest (line 1112)

access: protected

void BeforeRequest ( $command, &$data, $method)

$command
&$data
$method

ChangeDomainOwner (line 127)

Send Domain Trade request (Change owner)

version: v1000
access: public

bool ChangeDomainOwner (Domain $domain, [integer $period = null], [array $extra = array()])

Domain $domain: Domain must have contacts and nameservers
integer $period
array $extra

Implementation of:

IRegistryModule::ChangeDomainOwner(): Send domain trade (change of the owner) request.

CheckTransferStatus (line 743)

Check domain transfer status

return: codes
access: public

TRANSFER_STATUS CheckTransferStatus (Domain $domain, string $password)

string $domain: Domain name without TLD
string $password: Domain password

ContactCanBeCreated (line 905)

Check contact availability

access: public

bool ContactCanBeCreated (Contact $contact)

Contact $contact: Contact registry ID

Implementation of:

IRegistryModule::ContactCanBeCreated(): Called to check either specific contact can be created

CreateContact (line 933)

Create contact

access: public

Contact CreateContact (Contact $contact, [ $extra = array()])

Contact $contact
$extra

Implementation of:

IRegistryModule::CreateContact(): Create contact

CreateDomain (line 274)

Create domain and return transaction status

Domain info is an array of the following structure: Fill domain Data with this values

"crDate" => string Creation DateTime, "exDate" => Expiration DateTime, "status" => string Status code, "pw" => string Password generated by registry, "protocol" => string Protocol

access: public

Domain $domain: Domain name without TLD
array $owner_contact: Domain Owner contact array
array $admin_contact: Domain Admin contact array
array $tech_contact: Domain Tech contact array
array $billing_contact: Domain Billing contact array
array $extra: Domain Billing contact array
integer $period: Registration period, years
array $nameservers: Array of strings containing nameservers hostnames

Implementation of:

IRegistryModule::CreateDomain(): Register domain.

CreateNameserver (line 809)

This method request registry to create namserver

access: public

CreateNameserverResponse CreateNameserver (Nameserver $ns)

Nameserver $ns

Implementation of:

IRegistryModule::CreateNameserver(): Create namserver

CreateNameserverHost (line 831)

This method request registry to create namserver host

access: public

CreateNameserverHostResponse CreateNameserverHost (NameserverHost $ns, NameserverHost $nshost)

NameserverHost $nshost
NameserverHost $ns

Implementation of:

IRegistryModule::CreateNameserverHost(): Create nameserver host (Nameserver derived from our own domain)

DeleteContact (line 1102)

Delete contact

access: public

void DeleteContact (Contact $contact, [array $extra = array()])

Contact $contact: Contact uniq CLID
array $extra: Extra fields

Implementation of:

IRegistryModule::DeleteContact(): Delete contact

DeleteDomain (line 629)

This method request registry to delete domain In order to pending delete or scheduled delete, response must have status REGISTRY_RESPONSE_STATUS::PENDING

access: public

DeleteDomainResponse DeleteDomain (Domain $domain, [int $executeDate = null])

Domain $domain: Domain
int $executeDate: Valid timestamp for scheduled delete. Null for immediately delete

Implementation of:

IRegistryModule::DeleteDomain(): Completely delete domain from registry if it is delegated or recall domain name application if it was not yet delegated.

DeleteNameserverHost (line 886)

Delete nameserver host

return: true on success of false on failure
version: v1000
access: public

bool DeleteNameserverHost (NameserverHost $ns, Host $host)

Host $host: Host
NameserverHost $ns

Implementation of:

IRegistryModule::DeleteNameserverHost(): Delete namserver host from registry This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll.

DomainCanBeRegistered (line 601)

Check domain availability

return: true when domain available for registration
version: v1000
access: public

bool DomainCanBeRegistered (Domain $domain)

Domain $domain: Domain

Implementation of:

IRegistryModule::DomainCanBeRegistered(): Called to check either domain can be registered

DomainCanBeTransferred (line 64)

access: public

void DomainCanBeTransferred (Domain $domain)

Domain $domain

Implementation of:

IRegistryModule::DomainCanBeTransferred(): Called to check either domain can be transferred at this time.

GetDiscloseXML (line 1019)

access: protected

void GetDiscloseXML ( $disclose_list, $flag)

$disclose_list
$flag

GetFlagsXML (line 227)

access: protected

void GetFlagsXML ( $flags)

$flags

GetHostIpAddress (line 473)

Performs epp host:info command. Returns host IP address

access: public

string GetHostIpAddress ( $hostname)

$hostname

GetNSXML (line 566)

access: protected

void GetNSXML ( $nslist, [ $nsprefix = "domain"])

$nslist
$nsprefix

GetRegistrarID (line 53)

This method must return current Registry CLID

access: public

string GetRegistrarID ()

Implementation of:

IRegistryModule::GetRegistrarID(): Must return current Registrar ID (CLID). Generally, you can return registrar login here.

GetRemoteContact (line 979)

Get contact info by ID

return: Contact info. See XML:config/contacts
version: v1000
access: public

array GetRemoteContact (Contact $contact, string $CLID)

string $CLID: Contact registry ID
Contact $contact

Implementation of:

IRegistryModule::GetRemoteContact(): Must return detailed information about contact from registry

GetRemoteDomain (line 333)

This method request registry for information about domain

access: public

GetRemoteDomainResponse GetRemoteDomain (Domain $domain)

Domain $domain

Implementation of:

IRegistryModule::GetRemoteDomain(): Obtain information about specific domain from registry

GetResponseStatusFromEPPResponse (line 238)

access: protected

void GetResponseStatusFromEPPResponse ( $response)

$response

LockDomain (line 139)

Lock Domain

access: public

LockDomainResponse LockDomain (Domain $domain, [array $extra = array()])

Domain $domain
array $extra

Implementation of:

IRegistryModule::LockDomain(): Lock Domain

NameserverCanBeCreated (line 780)

Check either nameserver needs to be registered

return: 1 - Avaiable for registration, 2 - Already registered, 3 - Cannot be used, False on falure
version: v1000
access: public

int NameserverCanBeCreated (Nameserver $ns, string $hostname)

string $hostname
Nameserver $ns

Implementation of:

IRegistryModule::NameserverCanBeCreated(): Check either this nameserver is a valid nameserver.

ReadMessage (line 1134)

Read server message queue, and return first unprocessed item

return: False, when queue is empty
access: public

PendingOperationResponse ReadMessage ()

RenewDomain (line 648)

Renew domain

access: public

void RenewDomain (Domain $domain, [ $extra = array()], array $extradata)

string $domain: Domain name without TLD
array $extradata: Extra fields
$extra

Implementation of:

IRegistryModule::RenewDomain(): Send renew domain request

StrToTime (line 1222)

Parse datetime description into a Unix timestamp Ignores timezone

access: protected

void StrToTime ( $str)

$str

TransferApprove (line 701)

Send domain transfer approval

return: True on success of false on failure
access: public

bool TransferApprove (Domain $domain, [ $extra = array()], array $extradata)

string $domain: Domain required data: name, pw
array $extradata: Extra fields
$extra

Implementation of:

IRegistryModule::TransferApprove(): Approve domain transfer In order to pending operation, response must have status REGISTRY_RESPONSE_STATUS::PENDING

TransferReject (line 721)

Send domain transfer rejection

return: True on success of false on failure
access: public

bool TransferReject (Domain $domain, [ $extra = array()], array $extradata)

string $domain: Domain required data: name, pw
array $extradata: Extra fields
$extra

Implementation of:

IRegistryModule::TransferReject(): Reject domain transfer

TransferRequest (line 679)

Request domain transfer

access: public

TransferRequestResponse TransferRequest (Domain $domain, [ $extra = array()], array $extradata)

string $domain: Domain required data: name, pw
array $extradata: Extra fields
$extra

Implementation of:

IRegistryModule::TransferRequest(): Send a request for domain transfer This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll.

UnlockDomain (line 159)

Unlock Domain

access: public

UnLockDomainResponse UnlockDomain (Domain $domain, [array $extra = array()])

Domain $domain
array $extra: Some extra data

Implementation of:

IRegistryModule::UnlockDomain(): Unlock Domain

UpdateContact (line 1060)

Update contact

return: True on success of false on failure
access: public

bool UpdateContact (Contact $contact, string $contact_id)

string $contact_id: Contact registry ID
array $contact: Contact info. See XML:config/contacts

Implementation of:

IRegistryModule::UpdateContact(): Update contact fields

UpdateDomainAuthCode (line 99)

Update domain auth code.

access: public

UpdateDomainAuthCodeResponse UpdateDomainAuthCode (Domain $domain, $authCode, string $authcode)

Domain $domain
string $authcode: A list of changes in domain flags for the domain
$authCode

Implementation of:

IRegistryModule::UpdateDomainAuthCode(): Update domain auth code.

UpdateDomainContact (line 497)

This method request regsitry to change domain contact In order to pending operation, response must have status REGISTRY_RESPONSE_STATUS::PENDING

access: public

UpdateDomainContactResponse UpdateDomainContact (Domain $domain, string $contactType, Contact $oldContact, Contact $newContact)

Domain $domain: Domain
string $contactType: contact type @see CONTACT_TYPE::TYPE_*
Contact $oldContact: Old contact or NULL
Contact $newContact

Implementation of:

IRegistryModule::UpdateDomainContact(): Swap domain's existing contact with another one This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll.

UpdateDomainFlags (line 179)

Update domain flags (options such as clientUpdateProhibited, clientDeleteProhibited)

version: v1000
access: public

void UpdateDomainFlags (Domain $domain, $changes)

Domain $domain
IChangelist $changes: flags changes

Implementation of:

IRegistryModule::UpdateDomainFlags(): Update domain flags.

UpdateDomainNameservers (line 540)

Update nameservers for domain

version: v1000
access: public

UpdateDomainNameserversResponse UpdateDomainNameservers (Domain $domain, $changelist)

Domain $domain: Domain
IChangelist $changelist: nameservers changelist

Implementation of:

IRegistryModule::UpdateDomainNameservers(): Change nameservers for specific domain This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll.

UpdateNameserverHost (line 857)

Update nameserver host. update IP

return: true on success of false on failure
version: v1000
access: public

bool UpdateNameserverHost (NameserverHost $ns, Host $host)

Host $host: Host
NameserverHost $ns

Implementation of:

IRegistryModule::UpdateNameserverHost(): Update nameserver host

Inherited Methods

Inherited From AbstractRegistryModule

AbstractRegistryModule::__construct()
AbstractRegistryModule::CloseSession()
AbstractRegistryModule::EscapeXML()
AbstractRegistryModule::GeneratePassword()
AbstractRegistryModule::GetTransport()
AbstractRegistryModule::InitializeModule()
AbstractRegistryModule::MakeNameIDNCompatible()
AbstractRegistryModule::OnBeforeChangeDomainOwner()
AbstractRegistryModule::OnBeforeCreateContact()
AbstractRegistryModule::OnBeforeCreateDomain()
AbstractRegistryModule::OnBeforeCreateNameserverHost()
AbstractRegistryModule::OnBeforeDeleteContact()
AbstractRegistryModule::OnBeforeDeleteDomain()
AbstractRegistryModule::OnBeforeDeleteNameserverHost()
AbstractRegistryModule::OnBeforeLockDomain()
AbstractRegistryModule::OnBeforeRenewDomain()
AbstractRegistryModule::OnBeforeTransferRequest()
AbstractRegistryModule::OnBeforeUnlockDomain()
AbstractRegistryModule::OnBeforeUpdateContact()
AbstractRegistryModule::OnBeforeUpdateDomain()
AbstractRegistryModule::OnBeforeUpdateDomainContact()
AbstractRegistryModule::OnBeforeUpdateDomainFlags()
AbstractRegistryModule::OnBeforeUpdateDomainNameservers()
AbstractRegistryModule::OnBeforeUpdateNameserverHost()
AbstractRegistryModule::OnContactCreated()
AbstractRegistryModule::OnContactDeleted()
AbstractRegistryModule::OnContactUpdated()
AbstractRegistryModule::OnDomainCreated()
AbstractRegistryModule::OnDomainDeleted()
AbstractRegistryModule::OnDomainLocked()
AbstractRegistryModule::OnDomainOutgoingTransferRequested()
AbstractRegistryModule::OnDomainOwnerChanged()
AbstractRegistryModule::OnDomainRenewed()
AbstractRegistryModule::OnDomainTransferApproved()
AbstractRegistryModule::OnDomainTransferDeclined()
AbstractRegistryModule::OnDomainTransferFailed()
AbstractRegistryModule::OnDomainTransferredAway()
AbstractRegistryModule::OnDomainTransferRequested()
AbstractRegistryModule::OnDomainUnlocked()
AbstractRegistryModule::OnDomainUpdated()
AbstractRegistryModule::OnNameserverHostCreated()
AbstractRegistryModule::OnNameserverHostDeleted()
AbstractRegistryModule::OnNameserverHostUpdated()
AbstractRegistryModule::PunycodeDecodeIf()
AbstractRegistryModule::Request()
AbstractRegistryModule::SetRegistryAccessible()
AbstractRegistryModule::SetTransport()
AbstractRegistryModule::__toString()

Inherited From Module

Module::OnModuleDisabled()
Module::OnModuleEnabled()

Class Constants

TRANSFER_CLIENT_APPROVED = "clientApproved" (line 1117)

TRANSFER_CLIENT_CANCELLED = "clientCancelled" (line 1119)

TRANSFER_CLIENT_REJECTED = "clientRejected" (line 1121)

TRANSFER_PENDING = "pending" (line 1123)

TRANSFER_SERVER_APPROVED = "serverApproved" (line 1125)

TRANSFER_SERVER_CANCELLED = "serverCancelled" (line 1127)

Documentation generated on Thu, 22 Apr 2010 15:16:25 +0300 by phpDocumentor 1.4.1