PHP Class Metaregistrar\EPP\eppConnection

Afficher le fichier Open project: metaregistrar/php-epp-client Class Usage Examples

Protected Properties

Свойство Type Description
$allow_self_signed boolean Allow/Deny self signed certificates
$checktransactionids
$connected Is the client connected to the server
$connection resource
$defaultnamespace string Default namespace
$exturi Object extensions
$hostname string Hostname of this connection
$language language for epp
$launchphase
$local_cert_path string Path to certificate file
$local_cert_pwd string Password of certificate file
$logentries
$loggedin Is the client logged in to the server
$logging boolean
$newpassword * New password for password change procedure
$objuri Base objects
$password string Password to be used in the connection
$port string Port of the connection
$responses array Commands and equivalent responses
$retry * Number of times read operations will be retried
$rootspace These namespaces are needed in the root of the EPP object
$timeout integer Time-out value for the server connection
$username string Username to be used in the connection
$version version for epp
$xpathuri Base objects

Méthodes publiques

Méthode Description
HandleXmlError ( integer $errno, string $errstr, string $errfile, string $errline ) : boolean Error handler for loadxml() so that a nice exception is thrown
__construct ( $logging = false, $settingsfile = null )
__destruct ( )
addCommandResponse ( $command, $response )
addDefaultNamespace ( $xmlns, $namespace )
addExtension ( string $xmlns, string $namespace )
addService ( string $xmlns, string $namespace ) Add a service to the list of services
connect ( null $hostname = null, integer $port = null ) : boolean Connect to the address and port
create ( string $configfile, boolean | false $debug = false ) : mixed
createResponse ( $request )
disableCertification ( )
disableDnssec ( )
disableRgp ( )
disconnect ( ) : boolean Disconnects if connected
enableCertification ( string $certificatepath, string | null $certificatepassword, boolean $selfsigned = false )
enableDnssec ( )
enableLaunchphase ( $launchphase )
enableRgp ( )
getCheckTransactionIds ( )
getDefaultNamespaces ( )
getExtensions ( )
getHostname ( )
getLanguage ( )
getLaunchphase ( )
getNewPassword ( )
getPassword ( )
getPort ( )
getResponses ( )
getRetry ( )
getServices ( ) : array Get all supported services
getTimeout ( )
getUsername ( )
getVersion ( )
getXpathExtensions ( )
isConnected ( ) : boolean Returns if the session is still open
isLoggedin ( ) : boolean Return if the system is still logged in
login ( ) : boolean Performs an EPP login request and checks the result
logout ( ) : boolean Performs an EPP logout and checks the result
read ( boolean $nonBlocking = false ) : string This will read 1 response from the connection if there is one
readResponse ( ) : eppResponse Reads a response asynchronously.
removeExtension ( $namespace )
request ( eppRequest $eppRequest ) : eppResponse | null
setCheckTransactionIds ( $value )
setConnectionDetails ( $settingsfile )
setExtensions ( array $extensions ) Set all extensions in one call
setHostname ( $hostname )
setLanguage ( $language )
setNewPassword ( $password )
setPassword ( $password )
setPort ( $port )
setRetry ( $retry )
setServices ( array $services ) Set service list with one call
setTimeout ( $timeout )
setUsername ( $username )
setVersion ( $version )
setXpathExtensions ( $extensions )
write ( string $content ) : boolean Write stuff over the EPP connection
writeRequest ( eppRequest $content ) : boolean Writes a request object to the stream
writeandread ( eppRequest $content ) : eppResponse Write the content domDocument to the stream Read the answer Load the answer in a response domDocument return the reponse

Méthodes protégées

Méthode Description
loadSettings ( $directory, $settingsfile )
writeLog ( $text, $action )

Private Methods

Méthode Description
addInteger ( string $content ) : string This adds the content-length to the content that is about to be written over the EPP Protocol
enableLogging ( )
readInteger ( string $content ) : integer This parses the first 4 bytes into an integer for use to compare content-length
showLog ( )

Method Details

HandleXmlError() public méthode

Error handler for loadxml() so that a nice exception is thrown
public HandleXmlError ( integer $errno, string $errstr, string $errfile, string $errline ) : boolean
$errno integer
$errstr string
$errfile string
$errline string
Résultat boolean

__construct() public méthode

public __construct ( $logging = false, $settingsfile = null )

__destruct() public méthode

public __destruct ( )

addCommandResponse() public méthode

public addCommandResponse ( $command, $response )

addDefaultNamespace() public méthode

public addDefaultNamespace ( $xmlns, $namespace )

addExtension() public méthode

public addExtension ( string $xmlns, string $namespace )
$xmlns string
$namespace string

addService() public méthode

Add a service to the list of services
public addService ( string $xmlns, string $namespace )
$xmlns string
$namespace string

connect() public méthode

Connect to the address and port
public connect ( null $hostname = null, integer $port = null ) : boolean
$hostname null
$port integer
Résultat boolean

create() static public méthode

static public create ( string $configfile, boolean | false $debug = false ) : mixed
$configfile string
$debug boolean | false
Résultat mixed

createResponse() public méthode

public createResponse ( $request )

disableCertification() public méthode

public disableCertification ( )

disableDnssec() public méthode

public disableDnssec ( )

disableRgp() public méthode

public disableRgp ( )

disconnect() public méthode

Disconnects if connected
public disconnect ( ) : boolean
Résultat boolean

enableCertification() public méthode

public enableCertification ( string $certificatepath, string | null $certificatepassword, boolean $selfsigned = false )
$certificatepath string
$certificatepassword string | null
$selfsigned boolean

enableDnssec() public méthode

public enableDnssec ( )

enableLaunchphase() public méthode

public enableLaunchphase ( $launchphase )

enableRgp() public méthode

public enableRgp ( )

getCheckTransactionIds() public méthode

public getCheckTransactionIds ( )

getDefaultNamespaces() public méthode

public getDefaultNamespaces ( )

getExtensions() public méthode

public getExtensions ( )

getHostname() public méthode

public getHostname ( )

getLanguage() public méthode

public getLanguage ( )

getLaunchphase() public méthode

public getLaunchphase ( )

getNewPassword() public méthode

public getNewPassword ( )

getPassword() public méthode

public getPassword ( )

getPort() public méthode

public getPort ( )

getResponses() public méthode

public getResponses ( )

getRetry() public méthode

public getRetry ( )

getServices() public méthode

Get all supported services
public getServices ( ) : array
Résultat array

getTimeout() public méthode

public getTimeout ( )

getUsername() public méthode

public getUsername ( )

getVersion() public méthode

public getVersion ( )

getXpathExtensions() public méthode

public getXpathExtensions ( )

isConnected() public méthode

Returns if the session is still open
public isConnected ( ) : boolean
Résultat boolean

isLoggedin() public méthode

Return if the system is still logged in
public isLoggedin ( ) : boolean
Résultat boolean

loadSettings() protected méthode

protected loadSettings ( $directory, $settingsfile )

login() public méthode

Performs an EPP login request and checks the result
public login ( ) : boolean
Résultat boolean

logout() public méthode

Performs an EPP logout and checks the result
public logout ( ) : boolean
Résultat boolean

read() public méthode

This will read 1 response from the connection if there is one
public read ( boolean $nonBlocking = false ) : string
$nonBlocking boolean to prevent the blocking of the thread in case there is nothing to read and not wait for the timeout
Résultat string

readResponse() public méthode

Warning if you don't retrieve the read this before you disconnect your response may be lost please check if your object you are awaiting is supported in the eppResponse object by looking at the eppResponse object's array property named "matcher"
public readResponse ( ) : eppResponse
Résultat eppResponse

removeExtension() public méthode

public removeExtension ( $namespace )

request() public méthode

public request ( eppRequest $eppRequest ) : eppResponse | null
$eppRequest eppRequest
Résultat eppResponse | null

setCheckTransactionIds() public méthode

public setCheckTransactionIds ( $value )

setConnectionDetails() public méthode

public setConnectionDetails ( $settingsfile )

setExtensions() public méthode

Set all extensions in one call
public setExtensions ( array $extensions )
$extensions array

setHostname() public méthode

public setHostname ( $hostname )

setLanguage() public méthode

public setLanguage ( $language )

setNewPassword() public méthode

public setNewPassword ( $password )

setPassword() public méthode

public setPassword ( $password )

setPort() public méthode

public setPort ( $port )

setRetry() public méthode

public setRetry ( $retry )

setServices() public méthode

Set service list with one call
public setServices ( array $services )
$services array

setTimeout() public méthode

public setTimeout ( $timeout )

setUsername() public méthode

public setUsername ( $username )

setVersion() public méthode

public setVersion ( $version )

setXpathExtensions() public méthode

public setXpathExtensions ( $extensions )

write() public méthode

Write stuff over the EPP connection
public write ( string $content ) : boolean
$content string
Résultat boolean

writeLog() protected méthode

protected writeLog ( $text, $action )

writeRequest() public méthode

Writes a request object to the stream
public writeRequest ( eppRequest $content ) : boolean
$content eppRequest
Résultat boolean

writeandread() public méthode

Write the content domDocument to the stream Read the answer Load the answer in a response domDocument return the reponse
public writeandread ( eppRequest $content ) : eppResponse
$content eppRequest
Résultat eppResponse

Property Details

$allow_self_signed protected_oe property

Allow/Deny self signed certificates
protected bool $allow_self_signed
Résultat boolean

$checktransactionids protected_oe property

protected $checktransactionids

$connected protected_oe property

Is the client connected to the server
protected $connected

$connection protected_oe property

protected resource $connection
Résultat resource

$defaultnamespace protected_oe property

Default namespace
protected string $defaultnamespace
Résultat string

$exturi protected_oe property

Object extensions
protected $exturi

$hostname protected_oe property

Hostname of this connection
protected string $hostname
Résultat string

$language protected_oe property

language for epp
protected $language

$launchphase protected_oe property

protected $launchphase

$local_cert_path protected_oe property

Path to certificate file
protected string $local_cert_path
Résultat string

$local_cert_pwd protected_oe property

Password of certificate file
protected string $local_cert_pwd
Résultat string

$logentries protected_oe property

protected $logentries

$loggedin protected_oe property

Is the client logged in to the server
protected $loggedin

$logging protected_oe property

protected bool $logging
Résultat boolean

$newpassword protected_oe property

* New password for password change procedure
protected $newpassword

$objuri protected_oe property

Base objects
protected $objuri

$password protected_oe property

Password to be used in the connection
protected string $password
Résultat string

$port protected_oe property

Port of the connection
protected string $port
Résultat string

$responses protected_oe property

Commands and equivalent responses
protected array $responses
Résultat array

$retry protected_oe property

* Number of times read operations will be retried
protected $retry

$rootspace protected_oe property

These namespaces are needed in the root of the EPP object
protected $rootspace

$timeout protected_oe property

Time-out value for the server connection
protected int $timeout
Résultat integer

$username protected_oe property

Username to be used in the connection
protected string $username
Résultat string

$version protected_oe property

version for epp
protected $version

$xpathuri protected_oe property

Base objects
protected $xpathuri