1. class
  2. CNIC
  3. \
  4. IBS
  5. \
  6. Client

Client

class Client extends AbstractClient (View source)

IBS API Client

Constants

private VERSION

Current module version.

Kept in sync automatically by semantic-release — see .releaserc.json.

Properties

protected array<string, mixed> $context

context data for the client

 from  AbstractClient
protected string $socketURL

API connection url

 from  AbstractClient
protected AbstractSocketConfig $socketConfig

Object covering API connection data

 from  AbstractClient
protected bool $debugMode

activity flag for debug mode

 from  AbstractClient
protected string $ua

user agent

 from  AbstractClient
protected array<int, mixed> $curlopts

additional curl options to use

 from  AbstractClient
protected LoggerInterface $logger

logger instance for debug mode

 from  AbstractClient
protected bool $isOTE

is connected to OT&E

 from  AbstractClient
protected HttpTransport $transport

HTTP transport layer

 from  AbstractClient

Methods

__construct()

Constructor

from  AbstractClient
ResponseInterface
request(array $cmd = [], string $path = "")

Perform API request using the given command

AbstractSocketConfig
newSocketConfig()

Instantiate IBS SocketConfig

AbstractClient
setDefaultLogger()

Set default IBS logger

AbstractClient
setCustomLogger(LoggerInterface $customLogger)

Set custom logger to use instead of the default one.

from  AbstractClient
AbstractClient
enableDebugMode()

Enable debug output to STDOUT

from  AbstractClient
AbstractClient
disableDebugMode()

Disable debug output

from  AbstractClient
string
getPOSTData(array $cmd, bool $secured = false)

Serialize given command for POST request including connection configuration data

from  AbstractClient
string|null
getSession()

Get the API Session ID that is currently set Note: not supported.

string
getURL()

Get the API connection url that is currently set

from  AbstractClient
AbstractClient
setUserAgent(string $str, string $rv, array $modules = [])

Set a custom user agent (for platforms that use this SDK)

from  AbstractClient
string
getUserAgent()

Get the user agent string

from  AbstractClient
AbstractClient
setProxy(string $proxy = "")

Set proxy to use for API communication

from  AbstractClient
string|null
getProxy()

Get proxy configuration for API communication

from  AbstractClient
AbstractClient
setReferer(string $referer = "")

Set Referer to use for API communication

from  AbstractClient
string|null
getReferer()

Get Referer configuration for API communication

from  AbstractClient
string
getVersion()

Get the current module version

from  AbstractClient
AbstractClient
setURL(string $value)

Set another connection url to be used for API communication

from  AbstractClient
AbstractClient
setSession(string $value = "")

Set an API session id to be used for API communication

AbstractClient
setCredentials(string $uid = "", string $pw = "")

Set Credentials to be used for API communication

from  AbstractClient
AbstractClient
setRoleCredentials(string $uid = "", string $role = "", string $pw = "")

Set Role Credentials to be used for API communication Note: not supported.

AbstractClient
useHighPerformanceConnectionSetup()

Activate High Performance Setup Note: not supported.

array
IDNConvert(array $domains)

Convert domain names to idn + punycode if necessary

from  AbstractClient
array
autoIDNConvert(array $cmd)

Auto convert API command parameters to punycode, if necessary.

array
executeCurl(string $data, array $cfg, array $extraCurlOpts = [])

Delegate cURL execution to the transport layer.

from  AbstractClient
void
close()

Close all cURL connections

from  AbstractClient
string
getLiveUrl()

Get LIVE system URL

from  AbstractClient
bool
isOTE()

Check whether the client is connected to the OT&E system

from  AbstractClient
AbstractClient
useOTESystem()

Set OT&E System for API communication

from  AbstractClient
AbstractClient
useLIVESystem()

Set LIVE System for API communication (this is the default setting)

from  AbstractClient
AbstractClient
setContext(array $context)

Set context data for the client

from  AbstractClient

Details

in AbstractClient at line 84
__construct()

Constructor

at line 100
ResponseInterface request(array $cmd = [], string $path = "")

Perform API request using the given command

Parameters

array $cmd

API command
string $path

Path to the API endpoint

Return Value

ResponseInterface

at line 28
protected AbstractSocketConfig newSocketConfig()

Instantiate IBS SocketConfig

Return Value

AbstractSocketConfig

at line 38
AbstractClient setDefaultLogger()

Set default IBS logger

Return Value

AbstractClient

in AbstractClient at line 117
AbstractClient setCustomLogger(LoggerInterface $customLogger)

Set custom logger to use instead of the default one.

Create your own class implementing \CNIC\LoggerInterface.

Parameters

LoggerInterface $customLogger

Return Value

AbstractClient

in AbstractClient at line 127
AbstractClient enableDebugMode()

Enable debug output to STDOUT

Return Value

AbstractClient

in AbstractClient at line 137
AbstractClient disableDebugMode()

Disable debug output

Return Value

AbstractClient

in AbstractClient at line 148
string getPOSTData(array $cmd, bool $secured = false)

Serialize given command for POST request including connection configuration data

Parameters

array $cmd

API command to encode
bool $secured

secure password (when used for output)

Return Value

string

at line 51
string|null getSession()

Get the API Session ID that is currently set Note: not supported.

Return Value

string|null

Exceptions

Exception

in AbstractClient at line 165
string getURL()

Get the API connection url that is currently set

Return Value

string

in AbstractClient at line 177
AbstractClient setUserAgent(string $str, string $rv, array $modules = [])

Set a custom user agent (for platforms that use this SDK)

Parameters

string $str

user agent label
string $rv

user agent revision
array $modules

further modules to add to user agent string

Return Value

AbstractClient

in AbstractClient at line 187
string getUserAgent()

Get the user agent string

Return Value

string

in AbstractClient at line 200
AbstractClient setProxy(string $proxy = "")

Set proxy to use for API communication

Parameters

string $proxy

proxy to use (optional, for reset)

Return Value

AbstractClient

in AbstractClient at line 213
string|null getProxy()

Get proxy configuration for API communication

Return Value

string|null

in AbstractClient at line 226
AbstractClient setReferer(string $referer = "")

Set Referer to use for API communication

Parameters

string $referer

Referer (optional, for reset)

Return Value

AbstractClient

in AbstractClient at line 239
string|null getReferer()

Get Referer configuration for API communication

Return Value

string|null

in AbstractClient at line 250
string getVersion()

Get the current module version

Return Value

string

in AbstractClient at line 260
AbstractClient setURL(string $value)

Set another connection url to be used for API communication

Parameters

string $value

API connection url to set

Return Value

AbstractClient

at line 63
AbstractClient setSession(string $value = "")

Set an API session id to be used for API communication

Parameters

string $value

API session id (optional, for reset)

Return Value

AbstractClient

Exceptions

Exception

in AbstractClient at line 283
AbstractClient setCredentials(string $uid = "", string $pw = "")

Set Credentials to be used for API communication

Parameters

string $uid

account name (optional, for reset)
string $pw

account password (optional, for reset)

Return Value

AbstractClient

at line 75
AbstractClient setRoleCredentials(string $uid = "", string $role = "", string $pw = "")

Set Role Credentials to be used for API communication Note: not supported.

Parameters

string $uid

account name (optional, for reset)
string $role

role user id (optional, for reset)
string $pw

role user password (optional, for reset)

Return Value

AbstractClient

Exceptions

Exception

at line 121
AbstractClient useHighPerformanceConnectionSetup()

Activate High Performance Setup Note: not supported.

Return Value

AbstractClient

Exceptions

Exception

in AbstractClient at line 334
array IDNConvert(array $domains)

Convert domain names to idn + punycode if necessary

Parameters

array $domains

list of domain names (or tlds)

Return Value

array

at line 88
protected array autoIDNConvert(array $cmd)

Auto convert API command parameters to punycode, if necessary.

Note: IBS handles IDN conversion server-side.

Parameters

array $cmd

API command

Return Value

array

in AbstractClient at line 393
protected array executeCurl(string $data, array $cfg, array $extraCurlOpts = [])

Delegate cURL execution to the transport layer.

Parameters

string $data

serialized POST payload
array $cfg

connection config
array $extraCurlOpts

additional cURL options merged over the defaults

Return Value

array

[rawResponse, errorMessage|null]

in AbstractClient at line 407
void close()

Close all cURL connections

Return Value

void

in AbstractClient at line 415
string getLiveUrl()

Get LIVE system URL

Return Value

string

in AbstractClient at line 423
bool isOTE()

Check whether the client is connected to the OT&E system

Return Value

bool

in AbstractClient at line 432
AbstractClient useOTESystem()

Set OT&E System for API communication

Return Value

AbstractClient

in AbstractClient at line 442
AbstractClient useLIVESystem()

Set LIVE System for API communication (this is the default setting)

Return Value

AbstractClient

in AbstractClient at line 453
AbstractClient setContext(array $context)

Set context data for the client

Parameters

array $context

Return Value

AbstractClient