Class AbstractRegistryModule

Description
Description | Descendents | Vars (details) | Methods (details)

Base class to be extended by all registry modules.

If you override any methods, its a good idea to call a parent::__construct() in your code, to be sure that all needed properties are set.

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

Module
   |
   --AbstractRegistryModule
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Abstract class GenericEPPRegistryModule Generic EPP Registry Module.
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
unknown_type $CodebaseName
DataForm $Config
string $Extension
RegistryManifest $Manifest
string $ModuleName
RegistryAccessible $RegistryAccessible
A $Transport
Method Summary
Description | Descendants | Vars (details) | Methods (details)
void __construct (RegistryManifest $Manifest)
void CloseSession ()
string EscapeXML (string $str)
void GeneratePassword ([ $length = 9])
void GetTransport ()
void InitializeModule (string $extension,  $config)
void MakeNameIDNCompatible ( $name)
void OnBeforeChangeDomainOwner (Domain $newDomain, Domain $oldDomain, int $period, Domain $domain)
void OnBeforeCreateContact (Contact $contact)
void OnBeforeCreateDomain (Domain $domain)
void OnBeforeCreateNameserverHost (NameserverHost $nshost)
void OnBeforeDeleteContact (Contact $contact)
void OnBeforeDeleteDomain (Domain $domain)
void OnBeforeDeleteNameserverHost (NameserverHost $nshost)
void OnBeforeLockDomain (Domain $domain)
void OnBeforeRenewDomain (Domain $domain)
void OnBeforeTransferRequest (Domain $domain)
void OnBeforeUnlockDomain (Domain $domain)
void OnBeforeUpdateContact (Contact $newContact, Contact $oldContact, Contact $contact)
void OnBeforeUpdateDomain (Domain $newDomain, Domain $oldDomain, Domain $domain)
void OnBeforeUpdateDomainContact (Domain $domain, string $contactType, [Contact $oldContact = null], [Contact $newContact = null])
void OnBeforeUpdateDomainFlags (Domain $domain,  $changes)
void OnBeforeUpdateDomainNameservers (Domain $domain,  $changes)
void OnBeforeUpdateNameserverHost (NameserverHost $newNSHost, NameserverHost $oldNSHost, NameserverHost $nshost)
void OnContactCreated (Contact $contact)
void OnContactDeleted (Contact $contact)
void OnContactUpdated (Contact $contact)
void OnDomainCreated (Domain $domain)
void OnDomainDeleted (Domain $domain)
void OnDomainLocked (Domain $domain)
void OnDomainOutgoingTransferRequested (Domain $domain)
void OnDomainOwnerChanged (Domain $domain, int $period)
void OnDomainRenewed (Domain $domain)
void OnDomainTransferApproved (Domain $domain)
void OnDomainTransferDeclined (Domain $domain)
void OnDomainTransferFailed (Domain $domain)
void OnDomainTransferredAway (Domain $domain)
void OnDomainTransferRequested (Domain $domain)
void OnDomainUnlocked (Domain $domain)
void OnDomainUpdated (Domain $domain)
void OnNameserverHostCreated (NameserverHost $nshost)
void OnNameserverHostDeleted (NameserverHost $nshost)
void OnNameserverHostUpdated (NameserverHost $nshost)
void PunycodeDecodeIf ( $hostname)
TransportResponse Request (string $command, [array $data = array()])
void SetRegistryAccessible (RegistryAccessible $ra)
void SetTransport ( $Transport)
string __toString ()
Variables
Description | Descendents | Vars (details) | Methods (details)
unknown_type $CodebaseName (line 50)

Code that implements module, defined in manifest

  • access: protected
DataForm $Config (line 64)

Configuration data form

  • access: public
string $Extension (line 36)

The extension of domain currently being proccessed, without dot.

  • access: public
RegistryManifest $Manifest (line 29)

Module manifest.

A map of the XML manifest file.

  • access: public
string $ModuleName (line 43)

Module name

  • access: public
RegistryAccessible $RegistryAccessible (line 71)

A reference to global Registry object.

  • access: protected
A $Transport (line 57)

Module transport

  • var: reference to your Transport object that is implementing ITransport.
  • access: protected
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor __construct (line 78)

Base module constructor.

Loads XML manifest. Normalizes ModuleName property.

  • access: public
void __construct (RegistryManifest $Manifest)
CloseSession (line 222)

Close registry session

  • access: public
void CloseSession ()
EscapeXML (line 234)

Helper method for XML special chars escaping

  • access: protected
string EscapeXML (string $str)
  • string $str
GeneratePassword (line 239)
  • access: public
void GeneratePassword ([ $length = 9])
  • $length
GetTransport (line 136)
  • access: public
void GetTransport ()
InitializeModule (line 94)

Called by the system during module initialization for specific domain extension.

Initializes transport and sets Transport and Config properties.

  • access: public
void InitializeModule (string $extension,  $config)
MakeNameIDNCompatible (line 121)
  • access: protected
void MakeNameIDNCompatible ( $name)
  • $name
OnBeforeChangeDomainOwner (line 404)

Method is called before ChangeDomainOwner request

  • access: public
void OnBeforeChangeDomainOwner (Domain $newDomain, Domain $oldDomain, int $period, Domain $domain)
OnBeforeCreateContact (line 463)

Method is called before CreateContact request

  • access: public
void OnBeforeCreateContact (Contact $contact)
OnBeforeCreateDomain (line 292)

Method is called before CreateDomain request

  • access: public
void OnBeforeCreateDomain (Domain $domain)
OnBeforeCreateNameserverHost (line 507)

Method is called before CreateNamserverHost request

  • access: public
void OnBeforeCreateNameserverHost (NameserverHost $nshost)
OnBeforeDeleteContact (line 491)

Method is called before DeleteContact request

  • access: public
void OnBeforeDeleteContact (Contact $contact)
OnBeforeDeleteDomain (line 447)

Method is called before DeleteDomain request

  • access: public
void OnBeforeDeleteDomain (Domain $domain)
OnBeforeDeleteNameserverHost (line 535)

Method is called before DeleteNamserverHost request

  • access: public
void OnBeforeDeleteNameserverHost (NameserverHost $nshost)
OnBeforeLockDomain (line 433)

Method is called before LockDomain request

  • access: public
void OnBeforeLockDomain (Domain $domain)
OnBeforeRenewDomain (line 347)

Method is called before RenewDomain request

  • access: public
void OnBeforeRenewDomain (Domain $domain)
OnBeforeTransferRequest (line 361)

Method is called before TransferRequest request

  • access: public
void OnBeforeTransferRequest (Domain $domain)
OnBeforeUnlockDomain (line 419)

Method is called before UnlockDomain request

  • access: public
void OnBeforeUnlockDomain (Domain $domain)
OnBeforeUpdateContact (line 477)

Method is called before UpdateContact request

  • access: public
void OnBeforeUpdateContact (Contact $newContact, Contact $oldContact, Contact $contact)
OnBeforeUpdateDomain (line 306)

Method is called before UpdateDomainContact, UpdateDomainNamservers, UpdateDomainNameservers requests

  • access: public
void OnBeforeUpdateDomain (Domain $newDomain, Domain $oldDomain, Domain $domain)
OnBeforeUpdateDomainContact (line 316)

Method is called before UpdateDomainContact request

  • access: public
void OnBeforeUpdateDomainContact (Domain $domain, string $contactType, [Contact $oldContact = null], [Contact $newContact = null])
OnBeforeUpdateDomainFlags (line 332)

Method is called before UpdateDomainFlags request

  • access: public
void OnBeforeUpdateDomainFlags (Domain $domain,  $changes)
OnBeforeUpdateDomainNameservers (line 324)

Method is called before UpdateDomainNamservers request

  • access: public
void OnBeforeUpdateDomainNameservers (Domain $domain,  $changes)
OnBeforeUpdateNameserverHost (line 521)

Method is called before UpdateNamserverHost request

  • access: public
void OnBeforeUpdateNameserverHost (NameserverHost $newNSHost, NameserverHost $oldNSHost, NameserverHost $nshost)
OnContactCreated (line 470)

Method is called when contact was created

  • access: public
void OnContactCreated (Contact $contact)
OnContactDeleted (line 498)

Method is called when contact was deleted

  • access: public
void OnContactDeleted (Contact $contact)
OnContactUpdated (line 484)

Method is called when contact was updated

  • access: public
void OnContactUpdated (Contact $contact)
OnDomainCreated (line 299)

Method is called when domain was created and become delegated

  • access: public
void OnDomainCreated (Domain $domain)
  • Domain $domain: Domain object
OnDomainDeleted (line 454)

Method is called when domain was deleted

  • access: public
void OnDomainDeleted (Domain $domain)
  • Domain $domain: Domain object
OnDomainLocked (line 440)

Method is called when domain was locked

  • access: public
void OnDomainLocked (Domain $domain)
  • Domain $domain: Domain object
OnDomainOutgoingTransferRequested (line 363)
  • access: public
void OnDomainOutgoingTransferRequested (Domain $domain)
OnDomainOwnerChanged (line 412)

Method is called when domain owner was changed (Trade request completed)

  • access: public
void OnDomainOwnerChanged (Domain $domain, int $period)
  • Domain $domain: Domain object
  • int $period: Domain delegation period
OnDomainRenewed (line 354)

Method is called when domain was renewed

  • access: public
void OnDomainRenewed (Domain $domain)
  • Domain $domain: Domain object
OnDomainTransferApproved (line 381)

Method is called when domain transfer was approved by registry

  • access: public
void OnDomainTransferApproved (Domain $domain)
  • Domain $domain: Domain object
OnDomainTransferDeclined (line 388)

Method is called when domain transfer was declined by registry

  • access: public
void OnDomainTransferDeclined (Domain $domain)
  • Domain $domain: Domain object
OnDomainTransferFailed (line 396)

Method is called when registry was unable to transfer domain or transfer timeout exceed

  • access: public
void OnDomainTransferFailed (Domain $domain)
  • Domain $domain: Domain object
OnDomainTransferredAway (line 365)
  • access: public
void OnDomainTransferredAway (Domain $domain)
OnDomainTransferRequested (line 372)

Method is called when domain transfer was requested

  • access: public
void OnDomainTransferRequested (Domain $domain)
  • Domain $domain: Domain object
OnDomainUnlocked (line 426)

Method is called when domain was unlocked

  • access: public
void OnDomainUnlocked (Domain $domain)
  • Domain $domain: Domain object
OnDomainUpdated (line 340)

Method is called when a piece of domain specific information was updated (contacts, nameserver, flags)

  • access: public
void OnDomainUpdated (Domain $domain)
  • Domain $domain: Domain object
OnNameserverHostCreated (line 514)

Method is called when namserver host was created

  • access: public
void OnNameserverHostCreated (NameserverHost $nshost)
OnNameserverHostDeleted (line 542)

Method is called when namserver host was deleted

  • access: public
void OnNameserverHostDeleted (NameserverHost $nshost)
OnNameserverHostUpdated (line 528)

Method is called when namserver host updated

  • access: public
void OnNameserverHostUpdated (NameserverHost $nshost)
PunycodeDecodeIf (line 266)
  • access: protected
void PunycodeDecodeIf ( $hostname)
  • $hostname
Request (line 153)

Perform request to registry server

  • access: public
TransportResponse Request (string $command, [array $data = array()])
  • string $command
  • array $data
SetRegistryAccessible (line 116)

System calls this method to set the RegistryAccessible property.

  • access: public
void SetRegistryAccessible (RegistryAccessible $ra)
  • RegistryAccessible $ra
SetTransport (line 141)
  • access: public
void SetTransport ( $Transport)
  • $Transport
__toString (line 277)

Return module name

  • access: public
string __toString ()

Inherited Methods

Inherited From Module

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

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