PHP Class Metaregistrar\EPP\eppBase

Show file Open project: metaregistrar/php-epp-client

Protected Properties

Property Type Description
$connection resource
$logentries array Contains the log entries when $logging = true
$logging boolean Determines if a log is output after the end of the script or not
$timeout integer Time-out value for the server connection

Public Methods

Method Description
create ( string $configfile, boolean | false $debug = false ) : mixed
getTimeout ( )
read ( boolean $nonBlocking = false ) : string This will read 1 response from the connection if there is one
setTimeout ( $timeout )
write ( string $content ) : boolean Write stuff over the EPP connection

Protected Methods

Method Description
enableLogging ( ) Starts logging
showLog ( ) Shows the log when the script has ended
writeLog ( string $text, string $action ) Writes a new entry to the log

Private Methods

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

Method Details

create() static public method

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

enableLogging() protected method

Starts logging
protected enableLogging ( )

getTimeout() public method

public getTimeout ( )

read() public method

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
return string

setTimeout() public method

public setTimeout ( $timeout )

showLog() protected method

Shows the log when the script has ended
protected showLog ( )

write() public method

Write stuff over the EPP connection
public write ( string $content ) : boolean
$content string
return boolean

writeLog() protected method

Writes a new entry to the log
protected writeLog ( string $text, string $action )
$text string
$action string

Property Details

$connection protected property

protected resource $connection
return resource

$logentries protected property

Contains the log entries when $logging = true
protected array $logentries
return array

$logging protected property

Determines if a log is output after the end of the script or not
protected bool $logging
return boolean

$timeout protected property

Time-out value for the server connection
protected int $timeout
return integer