AbstractSocketConfig
abstract class AbstractSocketConfig (View source)
Shared base for all registrar SocketConfig implementations.
Concrete subclasses provide getPOSTDataParams() and their own $parameters array shaped to the API they target.
Properties
| protected string | $login | account name |
|
| protected string | $pw | account password |
|
| protected string | $oteUrl | API OT&E endpoint URL |
|
| protected string | $liveUrl | API LIVE endpoint URL |
|
| protected int | $socketTimeout | API socket timeout in seconds |
|
| protected bool | $needsIDNConvert | Whether API command values need IDN conversion |
|
| protected string | $roleSeparator | Separator character for role credentials |
Methods
Set account name to use
Get current login
Set account password to use
Get API Session ID in use
Set API Session ID to use
Add persistent parameter to request (request API session)
Get persistent parameter
Get OT&E endpoint URL
Get LIVE endpoint URL
Get socket timeout in seconds
Get whether IDN conversion is needed
Get role separator character
Get POST data container of connection data
Create POST data string out of connection data
Details
AbstractSocketConfig
setLogin(string $value)
Set account name to use
string
getLogin()
Get current login
AbstractSocketConfig
setPassword(string $value)
Set account password to use
string
getSession()
Get API Session ID in use
AbstractSocketConfig
setSession(string $value = "")
Set API Session ID to use
AbstractSocketConfig
setPersistent(bool $value = false)
Add persistent parameter to request (request API session)
bool
getPersistent()
Get persistent parameter
string
getOTEUrl()
Get OT&E endpoint URL
string
getLiveUrl()
Get LIVE endpoint URL
int
getSocketTimeout()
Get socket timeout in seconds
bool
getNeedsIDNConvert()
Get whether IDN conversion is needed
string
getRoleSeparator()
Get role separator character
abstract protected array
getPOSTDataParams(array $command, bool $secured)
Get POST data container of connection data
string
getPOSTData(array $command = [], bool $secured = false)
Create POST data string out of connection data