SocketConfig
class SocketConfig (View source)
CNR SocketConfig
Properties
| protected string | $login | account name |
|
| protected string | $pw | account password |
|
| protected string | $remoteaddr | remote ip address (ip filter) |
|
| protected string | $session | API session id |
|
| protected string | $user | subuser account name (subuser specific data view) |
|
| protected string[] | $parameters | list of http request parameters |
Methods
Constructor
Get POST data container of connection data
Create POST data string out of connection data
Add persistent parameter to request (request API session)
Get persistent parameter returned
Get API Session ID in use
Set account name to use
Get current login (including role)
Set account password to use
Set Remote IP Address to use
Set API Session ID to use
Set subuser account name (for subuser data view)
Details
__construct(array $parameters)
Constructor
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
$this
setPersistent(bool $value = false)
Add persistent parameter to request (request API session)
bool
getPersistent()
Get persistent parameter returned
string
getSession()
Get API Session ID in use
$this
setLogin(string $value)
Set account name to use
string
getLogin()
Get current login (including role)
$this
setPassword(string $value)
Set account password to use
$this
setRemoteAddress(string $value)
Set Remote IP Address to use
$this
setSession(string $value)
Set API Session ID to use
$this
setUser(string $value)
Set subuser account name (for subuser data view)