SocketConfig
final class SocketConfig extends SocketConfig (View source)
Moniker SocketConfig — same API platform as IBS; only the endpoints differ.
Properties
| protected string | $login | account name |
from AbstractSocketConfig |
| protected string | $pw | account password |
from AbstractSocketConfig |
| protected string | $oteUrl | ||
| protected string | $liveUrl | ||
| protected int | $socketTimeout | from SocketConfig | |
| protected bool | $needsIDNConvert | from SocketConfig | |
| protected string | $roleSeparator | Separator character for role credentials |
from AbstractSocketConfig |
Methods
Set account password to use
Set API Session ID to use
Add persistent parameter to request (request API session)
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
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