SocketConfig
in package
HEXONET SocketConfig
Table of Contents
- $entity : string
- API system entity. "54cd" for LIVE system; "1234" for OT&E system
- $login : string
- account name
- $parameters : array<string|int, string>
- list of http request parameters
- $pw : string
- account password
- $remoteaddr : string
- remote ip address (ip filter)
- $session : string
- API session id
- $user : string
- subuser account name (subuser specific data view)
- $otp : string
- one time password (2FA)
- __construct() : mixed
- getPOSTData() : string
- Create POST data string out of connection data
- getSession() : string
- Get API Session ID in use
- getSystemEntity() : string
- Get API System Entity in use
- setLogin() : $this
- Set account name to use
- setOTP() : $this
- Set one time password to use
- setPassword() : $this
- Set account password to use
- setRemoteAddress() : $this
- Set Remote IP Address to use
- setSession() : $this
- Set API Session ID to use
- setSystemEntity() : $this
- Set API System Entity to use This is set to 54cd / LIVE System by default
- setUser() : $this
- Set subuser account name (for subuser data view)
- getPOSTDataParams() : array<string, string>
- Get POST data container of connection data
Properties
$entity
API system entity. "54cd" for LIVE system; "1234" for OT&E system
protected
string
$entity
$login
account name
protected
string
$login
$parameters
list of http request parameters
protected
array<string|int, string>
$parameters
$pw
account password
protected
string
$pw
$remoteaddr
remote ip address (ip filter)
protected
string
$remoteaddr
$session
API session id
protected
string
$session
$user
subuser account name (subuser specific data view)
protected
string
$user
$otp
one time password (2FA)
private
string
$otp
Methods
__construct()
public
__construct(array<string|int, mixed> $parameters) : mixed
Parameters
- $parameters : array<string|int, mixed>
Return values
mixed —getPOSTData()
Create POST data string out of connection data
public
getPOSTData([array<string|int, mixed> $command = [] ][, bool $secured = false ]) : string
Parameters
- $command : array<string|int, mixed> = []
-
API Command to request
- $secured : bool = false
-
if password has to be returned "hidden"
Return values
string —POST data string
getSession()
Get API Session ID in use
public
getSession() : string
Return values
string —API Session ID
getSystemEntity()
Get API System Entity in use
public
getSystemEntity() : string
Return values
string —API System Entity
setLogin()
Set account name to use
public
setLogin(string $value) : $this
Parameters
- $value : string
-
account name
Return values
$this —setOTP()
Set one time password to use
public
setOTP(string $value) : $this
Parameters
- $value : string
-
one time password
Return values
$this —setPassword()
Set account password to use
public
setPassword(string $value) : $this
Parameters
- $value : string
-
account password
Return values
$this —setRemoteAddress()
Set Remote IP Address to use
public
setRemoteAddress(string $value) : $this
Parameters
- $value : string
-
remote ip address
Return values
$this —setSession()
Set API Session ID to use
public
setSession(string $value) : $this
Parameters
- $value : string
-
API Session ID
Return values
$this —setSystemEntity()
Set API System Entity to use This is set to 54cd / LIVE System by default
public
setSystemEntity(string $value) : $this
Parameters
- $value : string
-
API System Entity
Return values
$this —setUser()
Set subuser account name (for subuser data view)
public
setUser(string $value) : $this
Parameters
- $value : string
-
subuser account name
Return values
$this —getPOSTDataParams()
Get POST data container of connection data
protected
getPOSTDataParams(array<string|int, mixed> $command, bool $secured) : array<string, string>
Parameters
- $command : array<string|int, mixed>
-
API Command to request
- $secured : bool
-
if password has to be returned "hidden"