Property | Type | Description | |
---|---|---|---|
$defaultTlds | |||
$requiredFields | classes that don't have any fields |
Property | Type | Description | |
---|---|---|---|
$_opsHandler | seconds | ||
$protocol |
Method | Description | |
---|---|---|
__construct ( ) | openSRS_base object constructor. | |
__destruct ( ) | openSRS_base object destructor. | |
_validateObject ( $dataObject, $requiredFields = null ) | Method for any shared validation that is applicable to all API calls. Checks API call class for requiredFields array and checks all fields on $dataObject against it to make sure all fields in requiredFields are set and have a value THIS DOES NOT VALIDATE THAT THE VALUE IS VALID! | |
convertArray2Formatted ( $type = '', $data = '' ) | ||
getConfiguredTlds ( ) : array | Get configured tlds for domain call Will use (in order of preference). | |
getDomain ( ) | Get the domain from the dataObject. | |
hasDomain ( ) : boolean | Does the dataObject have a domain set? | |
isValidField ( $value ) | statement in _validateObject | |
is_connected ( ) : boolean | Method to check if a socket connection exists. | |
send ( $dataObject, $returnFullResponse = true ) | Send the oSRS API request, set action, object and protocol based on the call being made (so we don't have to set it in each call class), and run any custom response handling if the function 'customResponseHandling' exists on $obj, the class for that specific API call. | |
send_cmd ( string $request ) : string | Method to send a command to the server. | |
setDataObject ( $format, $dataObject ) |
Method | Description | |
---|---|---|
_verifySystemProperties ( ) | Method to check the PHP version and OpenSSL PHP lib installation. | |
close_socket ( ) | Method to close the socket connection. | |
init_socket ( ) : boolean | Method to initialize a socket connection to the OpenSRS server. | |
readData ( &$fh, $timeout = 5 ) : mixed | Reads data from a socket. | |
readHeader ( $fh, $timeout = 5 ) : hash | Reads header data. | |
read_data ( ) : string | Method to read data from the buffer stream. | |
send_data ( string $message ) : string | Method to send data. | |
writeData ( &$fh, string $msg ) | Writes a message to a socket (buffered IO). |
public __construct ( ) |
public __destruct ( ) |
public _validateObject ( $dataObject, $requiredFields = null ) |
public getConfiguredTlds ( ) : array | ||
return | array | tlds |
public is_connected ( ) : boolean | ||
return | boolean | True if connected |
public send ( $dataObject, $returnFullResponse = true ) |