PHP Класс Metaregistrar\EPP\eppConnection

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
loadSettings ( $directory, $settingsfile )
writeLog ( $text, $action )

Приватные методы

Метод Описание
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 ( )

Описание методов

HandleXmlError() публичный Метод

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
Результат boolean

__construct() публичный Метод

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

__destruct() публичный Метод

public __destruct ( )

addCommandResponse() публичный Метод

public addCommandResponse ( $command, $response )

addDefaultNamespace() публичный Метод

public addDefaultNamespace ( $xmlns, $namespace )

addExtension() публичный Метод

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

addService() публичный Метод

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

connect() публичный Метод

Connect to the address and port
public connect ( null $hostname = null, integer $port = null ) : boolean
$hostname null
$port integer
Результат boolean

create() статический публичный Метод

static public create ( string $configfile, boolean | false $debug = false ) : mixed
$configfile string
$debug boolean | false
Результат mixed

createResponse() публичный Метод

public createResponse ( $request )

disableCertification() публичный Метод

public disableCertification ( )

disableDnssec() публичный Метод

public disableDnssec ( )

disableRgp() публичный Метод

public disableRgp ( )

disconnect() публичный Метод

Disconnects if connected
public disconnect ( ) : boolean
Результат boolean

enableCertification() публичный Метод

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

enableDnssec() публичный Метод

public enableDnssec ( )

enableLaunchphase() публичный Метод

public enableLaunchphase ( $launchphase )

enableRgp() публичный Метод

public enableRgp ( )

getCheckTransactionIds() публичный Метод

public getCheckTransactionIds ( )

getDefaultNamespaces() публичный Метод

public getDefaultNamespaces ( )

getExtensions() публичный Метод

public getExtensions ( )

getHostname() публичный Метод

public getHostname ( )

getLanguage() публичный Метод

public getLanguage ( )

getLaunchphase() публичный Метод

public getLaunchphase ( )

getNewPassword() публичный Метод

public getNewPassword ( )

getPassword() публичный Метод

public getPassword ( )

getPort() публичный Метод

public getPort ( )

getResponses() публичный Метод

public getResponses ( )

getRetry() публичный Метод

public getRetry ( )

getServices() публичный Метод

Get all supported services
public getServices ( ) : array
Результат array

getTimeout() публичный Метод

public getTimeout ( )

getUsername() публичный Метод

public getUsername ( )

getVersion() публичный Метод

public getVersion ( )

getXpathExtensions() публичный Метод

public getXpathExtensions ( )

isConnected() публичный Метод

Returns if the session is still open
public isConnected ( ) : boolean
Результат boolean

isLoggedin() публичный Метод

Return if the system is still logged in
public isLoggedin ( ) : boolean
Результат boolean

loadSettings() защищенный Метод

protected loadSettings ( $directory, $settingsfile )

login() публичный Метод

Performs an EPP login request and checks the result
public login ( ) : boolean
Результат boolean

logout() публичный Метод

Performs an EPP logout and checks the result
public logout ( ) : boolean
Результат boolean

read() публичный Метод

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
Результат string

readResponse() публичный Метод

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
Результат eppResponse

removeExtension() публичный Метод

public removeExtension ( $namespace )

request() публичный Метод

public request ( eppRequest $eppRequest ) : eppResponse | null
$eppRequest eppRequest
Результат eppResponse | null

setCheckTransactionIds() публичный Метод

public setCheckTransactionIds ( $value )

setConnectionDetails() публичный Метод

public setConnectionDetails ( $settingsfile )

setExtensions() публичный Метод

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

setHostname() публичный Метод

public setHostname ( $hostname )

setLanguage() публичный Метод

public setLanguage ( $language )

setNewPassword() публичный Метод

public setNewPassword ( $password )

setPassword() публичный Метод

public setPassword ( $password )

setPort() публичный Метод

public setPort ( $port )

setRetry() публичный Метод

public setRetry ( $retry )

setServices() публичный Метод

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

setTimeout() публичный Метод

public setTimeout ( $timeout )

setUsername() публичный Метод

public setUsername ( $username )

setVersion() публичный Метод

public setVersion ( $version )

setXpathExtensions() публичный Метод

public setXpathExtensions ( $extensions )

write() публичный Метод

Write stuff over the EPP connection
public write ( string $content ) : boolean
$content string
Результат boolean

writeLog() защищенный Метод

protected writeLog ( $text, $action )

writeRequest() публичный Метод

Writes a request object to the stream
public writeRequest ( eppRequest $content ) : boolean
$content eppRequest
Результат boolean

writeandread() публичный Метод

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
Результат eppResponse

Описание свойств

$allow_self_signed защищенное свойство

Allow/Deny self signed certificates
protected bool $allow_self_signed
Результат boolean

$checktransactionids защищенное свойство

protected $checktransactionids

$connected защищенное свойство

Is the client connected to the server
protected $connected

$connection защищенное свойство

protected resource $connection
Результат resource

$defaultnamespace защищенное свойство

Default namespace
protected string $defaultnamespace
Результат string

$exturi защищенное свойство

Object extensions
protected $exturi

$hostname защищенное свойство

Hostname of this connection
protected string $hostname
Результат string

$language защищенное свойство

language for epp
protected $language

$launchphase защищенное свойство

protected $launchphase

$local_cert_path защищенное свойство

Path to certificate file
protected string $local_cert_path
Результат string

$local_cert_pwd защищенное свойство

Password of certificate file
protected string $local_cert_pwd
Результат string

$logentries защищенное свойство

protected $logentries

$loggedin защищенное свойство

Is the client logged in to the server
protected $loggedin

$logging защищенное свойство

protected bool $logging
Результат boolean

$newpassword защищенное свойство

* New password for password change procedure
protected $newpassword

$objuri защищенное свойство

Base objects
protected $objuri

$password защищенное свойство

Password to be used in the connection
protected string $password
Результат string

$port защищенное свойство

Port of the connection
protected string $port
Результат string

$responses защищенное свойство

Commands and equivalent responses
protected array $responses
Результат array

$retry защищенное свойство

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

$rootspace защищенное свойство

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

$timeout защищенное свойство

Time-out value for the server connection
protected int $timeout
Результат integer

$username защищенное свойство

Username to be used in the connection
protected string $username
Результат string

$version защищенное свойство

version for epp
protected $version

$xpathuri защищенное свойство

Base objects
protected $xpathuri