ClassInterface IRegistryModule

Description
Description | Descendents | Methods (details)

Each registry module must implement IRegistryModule and one of pollable interfaces:

IRegistryModuleServerPollable or IRegistryModuleClientPollable

Located in /modules/registries/interface.IRegistryModule.php (line 22) 

IConfigurable
   |
   --IRegistryModule
Direct descendents
Description | Descendents | Methods (details)
Class Description
class IRegistryModuleServerPollable Your module must implement this interface if registry does support automated polling.
class IRegistryModuleClientPollable Your module must implement this interface if registry does not support automated polling.
Method Summary
Description | Descendants | Methods (details)
static True ValidateConfigurationFormData (array $post_values)
ChangeDomainOwnerResponse ChangeDomainOwner (Domain $domain, [integer $period = null], [array $extra = array()])
ContactCanBeCreatedResponse ContactCanBeCreated (Contact $contact)
CreateContactResponse CreateContact (Contact $contact, [ $extra = array()])
CreateDomainResponse CreateDomain (Domain $domain, int $period, [array $extra = array()])
CreateNameserverResponse CreateNameserver (Nameserver $ns)
CreateNameserverHostResponse CreateNameserverHost (NameserverHost $nshost)
DeleteContactResponse DeleteContact (Contact $contact, [array $extra = array()])
DeleteDomainResponse DeleteDomain (Domain $domain, [int $executeDate = null])
DeleteNameserverHostResponse DeleteNameserverHost (NameserverHost $ns)
DomainCanBeRegisteredResponse DomainCanBeRegistered (Domain $domain)
DomainCanBeTransferredResponse DomainCanBeTransferred (Domain $domain)
string GetRegistrarID ()
void GetRemoteContact (Contact $contact)
GetRemoteDomainResponse GetRemoteDomain (Domain $domain)
LockDomainResponse LockDomain (Domain $domain, [array $extra = array()])
NameserverCanBeCreatedResponse NameserverCanBeCreated (Nameserver $ns)
void OnModuleDisabled ()
void OnModuleEnabled ()
RenewDomainResponse RenewDomain (Domain $domain, [ $extra = array()], array $extradata)
TransferApproveResponse TransferApprove (Domain $domain, [ $extra = array()], array $extradata)
TransferRejectResponse TransferReject (Domain $domain, [ $extra = array()], array $extradata)
TransferRequestResponse TransferRequest (Domain $domain, [ $extra = array()], array $extradata)
UnLockDomainResponse UnlockDomain (Domain $domain, [array $extra = array()])
UpdateContactResponse UpdateContact (Contact $contact)
UpdateDomainAuthCodeResponse UpdateDomainAuthCode (Domain $domain,  $authCode, string $authcode)
UpdateDomainContactResponse UpdateDomainContact (Domain $domain, string $contactType, Contact $oldContact, Contact $newContact)
UpdateDomainFlagsResponse UpdateDomainFlags (Domain $domain,  $changes)
UpdateDomainNameserversResponse UpdateDomainNameservers (Domain $domain,  $changelist)
UpdateNameserverHostResponse UpdateNameserverHost (NameserverHost $ns)
Methods
Description | Descendents | Methods (details)
static ValidateConfigurationFormData (line 44)

Called by he core to check either user filled all fields of your configuration form properly.

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

  • return: or array of error messages.
  • access: public
static True ValidateConfigurationFormData (array $post_values)
  • array $post_values
ChangeDomainOwner (line 73)

Send domain trade (change of the owner) request.

This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll.

  • access: public
ChangeDomainOwnerResponse ChangeDomainOwner (Domain $domain, [integer $period = null], [array $extra = array()])
  • Domain $domain: Domain must have contacts and nameservers
  • integer $period: Domain delegation period
  • array $extra: Some registry specific fields
ContactCanBeCreated (line 266)

Called to check either specific contact can be created

  • access: public
ContactCanBeCreatedResponse ContactCanBeCreated (Contact $contact)
CreateContact (line 274)

Create contact

  • access: public
CreateContactResponse CreateContact (Contact $contact, [ $extra = array()])
CreateDomain (line 124)

Register 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. See IRegistryModuleClientPollable::PollCreateDomain().

  • access: public
CreateDomainResponse CreateDomain (Domain $domain, int $period, [array $extra = array()])
  • Domain $domain
  • int $period: Domain registration period
  • array $extra: Extra fields
CreateNameserver (line 231)

Create namserver

  • access: public
CreateNameserverResponse CreateNameserver (Nameserver $ns)
CreateNameserverHost (line 239)

Create nameserver host (Nameserver derived from our own domain)

  • access: public
CreateNameserverHostResponse CreateNameserverHost (NameserverHost $nshost)
DeleteContact (line 303)

Delete contact

This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll. See IRegistryModuleClientPollable::PollDeleteContact().

  • throws: ProhibitedTransformException
  • access: public
DeleteContactResponse DeleteContact (Contact $contact, [array $extra = array()])
  • Contact $contact
  • array $extra: Extra fields
DeleteDomain (line 176)

Completely delete domain from registry if it is delegated or recall domain name application if it was not yet delegated.

  • throws: ProhibitedTransformException
  • access: public
DeleteDomainResponse DeleteDomain (Domain $domain, [int $executeDate = null])
  • Domain $domain: Domain
  • int $executeDate: Unix timestamp for scheduled delete. Null for immediate delete.
DeleteNameserverHost (line 258)

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.

See IRegistryModuleClientPollable::PollDeleteNameserverHost().

  • throws: ProhibitedTransformException
  • access: public
DeleteNameserverHostResponse DeleteNameserverHost (NameserverHost $ns)
DomainCanBeRegistered (line 164)

Called to check either domain can be registered

  • access: public
DomainCanBeRegisteredResponse DomainCanBeRegistered (Domain $domain)
DomainCanBeTransferred (line 61)

Called to check either domain can be transferred at this time.

  • access: public
DomainCanBeTransferredResponse DomainCanBeTransferred (Domain $domain)
GetRegistrarID (line 52)

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

Used in transfer and some contact operations to determine either object belongs to current registrar.

  • access: public
string GetRegistrarID ()
GetRemoteContact (line 282)

Must return detailed information about contact from registry

  • version: GetRemoteContactResponse
  • access: public
void GetRemoteContact (Contact $contact)
GetRemoteDomain (line 132)

Obtain information about specific domain from registry

  • access: public
GetRemoteDomainResponse GetRemoteDomain (Domain $domain)
LockDomain (line 83)

Lock Domain

  • access: public
LockDomainResponse LockDomain (Domain $domain, [array $extra = array()])
  • Domain $domain
  • array $extra: Some registry specific fields
NameserverCanBeCreated (line 223)

Check either this nameserver is a valid nameserver.

  • access: public
NameserverCanBeCreatedResponse NameserverCanBeCreated (Nameserver $ns)
OnModuleDisabled (line 35)
  • access: public
void OnModuleDisabled ()
OnModuleEnabled (line 29)

Called when module enabled in admin interface.

  • access: public
void OnModuleEnabled ()
RenewDomain (line 185)

Send renew domain request

  • access: public
RenewDomainResponse RenewDomain (Domain $domain, [ $extra = array()], array $extradata)
  • string $domain: Domain
  • array $extradata: Extra fields
  • $extra
TransferApprove (line 206)

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

  • access: public
TransferApproveResponse TransferApprove (Domain $domain, [ $extra = array()], array $extradata)
  • string $domain: Domain
  • array $extradata: Extra fields
  • $extra
TransferReject (line 215)

Reject domain transfer

  • access: public
TransferRejectResponse TransferReject (Domain $domain, [ $extra = array()], array $extradata)
  • string $domain: Domain
  • array $extradata: Extra fields
  • $extra
TransferRequest (line 196)

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.

See IRegistryModuleClientPollable::PollTransfer().

  • access: public
TransferRequestResponse TransferRequest (Domain $domain, [ $extra = array()], array $extradata)
  • string $domain: Domain
  • array $extradata: Extra fields
  • $extra
UnlockDomain (line 92)

Unlock Domain

  • access: public
UnLockDomainResponse UnlockDomain (Domain $domain, [array $extra = array()])
  • Domain $domain
  • array $extra: Some extra data
UpdateContact (line 290)

Update contact fields

  • access: public
UpdateContactResponse UpdateContact (Contact $contact)
UpdateDomainAuthCode (line 112)

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
UpdateDomainContact (line 145)

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.

See IRegistryModuleClientPollable::PollCreateDomain().

  • access: public
UpdateDomainContactResponse UpdateDomainContact (Domain $domain, string $contactType, Contact $oldContact, Contact $newContact)
  • Domain $domain: Domain
  • string $contactType: contact type. Should be one of CONTACT_TYPE members.
  • Contact $oldContact: Old contact or NULL
  • Contact $newContact
UpdateDomainFlags (line 103)

Update domain flags.

This operation supports pending status. If you return response object with Status = REGISTRY_RESPONSE_STATUS.PENDING, you must return response later during a poll. See IRegistryModuleClientPollable::PollUpdateDomain().

  • access: public
UpdateDomainFlagsResponse UpdateDomainFlags (Domain $domain,  $changes)
  • Domain $domain
  • IChangelist $changes: A list of changes in domain flags for the domain
UpdateDomainNameservers (line 156)

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.

See IRegistryModuleClientPollable::PollUpdateDomain().

  • access: public
UpdateDomainNameserversResponse UpdateDomainNameservers (Domain $domain,  $changelist)
UpdateNameserverHost (line 247)

Update nameserver host

  • access: public
UpdateNameserverHostResponse UpdateNameserverHost (NameserverHost $ns)

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