PHP 클래스 opensrs\Base

부터: 3.4
파일 보기 프로젝트 열기: opensrs/osrs-toolkit-php 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$defaultTlds
$requiredFields classes that don't have any fields

보호된 프로퍼티들

프로퍼티 타입 설명
$_opsHandler seconds
$protocol

공개 메소드들

메소드 설명
__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 )

비공개 메소드들

메소드 설명
_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).

메소드 상세

__construct() 공개 메소드

Closes an existing socket connection, if we have one
부터: 3.1
public __construct ( )

__destruct() 공개 메소드

Closes an existing socket connection, if we have one
부터: 3.4
public __destruct ( )

_validateObject() 공개 메소드

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!
public _validateObject ( $dataObject, $requiredFields = null )

convertArray2Formatted() 공개 메소드

public convertArray2Formatted ( $type = '', $data = '' )

getConfiguredTlds() 공개 메소드

.. 1. selected tlds 2. supplied default tlds 3. included default tlds.
public getConfiguredTlds ( ) : array
리턴 array tlds

getDomain() 공개 메소드

Get the domain from the dataObject.
public getDomain ( )

hasDomain() 공개 메소드

Does the dataObject have a domain set?
public hasDomain ( ) : boolean
리턴 boolean

isValidField() 공개 메소드

statement in _validateObject
public isValidField ( $value )

is_connected() 공개 메소드

Method to check if a socket connection exists.
부터: 3.4
public is_connected ( ) : boolean
리턴 boolean True if connected

send() 공개 메소드

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.
public send ( $dataObject, $returnFullResponse = true )

send_cmd() 공개 메소드

Method to send a command to the server.
부터: 3.1
public send_cmd ( string $request ) : string
$request string Raw XML request
리턴 string $data Raw XML response

setDataObject() 공개 메소드

public setDataObject ( $format, $dataObject )

프로퍼티 상세

$_opsHandler 보호되어 있는 프로퍼티

seconds
protected $_opsHandler

$defaultTlds 공개적으로 프로퍼티

public $defaultTlds

$protocol 보호되어 있는 프로퍼티

protected $protocol

$requiredFields 공개적으로 프로퍼티

classes that don't have any fields
public $requiredFields