my-doc
\
HEXONET

\HEXONETAPIClient

HEXONET APIClient

Summary

Methods
Properties
Constants
__construct()
enableDebugMode()
disableDebugMode()
getPOSTData()
getSession()
getURL()
getVersion()
saveSession()
reuseSession()
setURL()
setOTP()
setSession()
setRemoteIPAddress()
setCredentials()
setRoleCredentials()
login()
loginExtended()
logout()
request()
requestNextResponsePage()
requestAllResponsePages()
setUserView()
resetUserView()
useOTESystem()
useLIVESystem()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct() :

Returns

enableDebugMode()

enableDebugMode() :

Enable Debug Output to STDOUT

Returns

—

disableDebugMode()

disableDebugMode() :

Disable Debug Output

Returns

—

getPOSTData()

getPOSTData(string|array  cmd) :

Serialize given command for POST request including connection configuration data

Parameters

string|array cmd

API command to encode

Returns

—

encoded POST data string

getSession()

getSession() : string|null

Get the API Session ID that is currently set

Returns

string|null —

API Session ID currently in use

getURL()

getURL() :

Get the API connection url that is currently set

Returns

—

API connection url currently in use

getVersion()

getVersion() :

Get the current module version

Returns

—

module version

saveSession()

saveSession(mixed|string|int  session) :

Apply session data (session id and system entity) to given php session object

Parameters

mixed|string|int session

php session instance ($_SESSION)

Returns

—

reuseSession()

reuseSession(mixed|string|int  session) :

Use existing configuration out of php session object to rebuild and reuse connection settings

Parameters

mixed|string|int session

php session object ($_SESSION)

Returns

—

setURL()

setURL(  value) :

Set another connection url to be used for API communication

Parameters

value

API connection url to set

Returns

—

setOTP()

setOTP(  value) :

Set one time password to be used for API communication

Parameters

value

one time password

Returns

—

setSession()

setSession(  value) :

Set an API session id to be used for API communication

Parameters

value

API session id

Returns

—

setRemoteIPAddress()

setRemoteIPAddress(  value) :

Set an Remote IP Address to be used for API communication To be used in case you have an active ip filter setting.

Parameters

value

Remote IP Address

Returns

—

setCredentials()

setCredentials(  uid,   pw) :

Set Credentials to be used for API communication

Parameters

uid

account name
pw

account password

Returns

—

setRoleCredentials()

setRoleCredentials(  uid,   role,   pw) :

Set Credentials to be used for API communication

Parameters

uid

account name
role

role user id
pw

role user password

Returns

—

login()

login(  otp) : \HEXONET\Response

Perform API login to start session-based communication

Parameters

otp

optional one time password

Returns

\HEXONET\Response —

Response

loginExtended()

loginExtended(mixed|string|int  params,   otp) : \HEXONET\Response

Perform API login to start session-based communication.

Use given specific command parameters.

Parameters

mixed|string|int params

given specific command parameters
otp

optional one time password

Returns

\HEXONET\Response —

Response

logout()

logout() : \HEXONET\Response

Perform API logout to close API session in use

Returns

\HEXONET\Response —

Response

request()

request(mixed|string|int  cmd) : \HEXONET\Response

Perform API request using the given command

Parameters

mixed|string|int cmd

API command to request

Returns

\HEXONET\Response —

Response

requestNextResponsePage()

requestNextResponsePage(\HEXONET\Response  rr) : \HEXONET\Response|null

Request the next page of list entries for the current list query Useful for tables

Parameters

\HEXONET\Response rr

API Response of current page

Returns

\HEXONET\Response|null —

Response or null in case there are no further list entries

requestAllResponsePages()

requestAllResponsePages(mixed|string|int  cmd) : \HEXONET\Response|string|int

Request all pages/entries for the given query command

Parameters

mixed|string|int cmd

API list command to use

Returns

\HEXONET\Response|string|int —

Responses

setUserView()

setUserView(  uid) :

Set a data view to a given subuser

Parameters

uid

subuser account name

Returns

—

resetUserView()

resetUserView() :

Reset data view back from subuser to user

Returns

—

useOTESystem()

useOTESystem() :

Set OT&E System for API communication

Returns

—

useLIVESystem()

useLIVESystem() :

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

Returns

—