__construct() __construct( raw, mixed|string|int cmd = null) : Constructor Parameters raw API plain response mixed|string|int cmd API command used within this request Returns
getHash() getHash() : mixed|string|int Get API response as Hash Returns mixed|string|int — API response hash
isError() isError() : Check if current API response represents an error case API response code is an 5xx code Returns — boolean result
isSuccess() isSuccess() : Check if current API response represents a success case API response code is an 2xx code Returns — boolean result
isTmpError() isTmpError() : Check if current API response represents a temporary error case API response code is an 4xx code Returns — result
addColumn() addColumn( key, string|string|int data) : Add a column to the column list Parameters key column name string|string|int data array of column data Returns —
addRecord() addRecord(mixed|string|int h) : Add a record to the record list Parameters mixed|string|int h row hash data Returns —
getColumn() getColumn( key) : \HEXONET\Column|null Get column by column name Parameters key column name Returns \HEXONET\Column|null — column instance or null if column does not exist
getColumnIndex() getColumnIndex( colkey, index) : string|null Get Data by Column Name and Index Parameters colkey column name index column data index Returns string|null — column data at index or null if not found
getColumnKeys() getColumnKeys() : string|string|int Get Column Names Returns string|string|int — Array of Column Names
getColumns() getColumns() : \HEXONET\Column|string|int Get List of Columns Returns \HEXONET\Column|string|int — Array of Columns
getCommand() getCommand() : mixed|string|int Get Command used in this request Returns mixed|string|int — command
getCurrentPageNumber() getCurrentPageNumber() : int|null Get Page Number of current List Query Returns int|null — page number or null in case of a non-list response
getCurrentRecord() getCurrentRecord() : \HEXONET\Record|null Get Record of current record index Returns \HEXONET\Record|null — Record or null in case of a non-list response
getFirstRecordIndex() getFirstRecordIndex() : int|null Get Index of first row in this response Returns int|null — first row index
getLastRecordIndex() getLastRecordIndex() : int|null Get last record index of the current list query Returns int|null — record index or null for a non-list response
getListHash() getListHash() : mixed|string|int Get Response as List Hash including useful meta data for tables Returns mixed|string|int — hash including list meta data and array of rows in hash notation
getNextRecord() getNextRecord() : \HEXONET\Record|null Get next record in record list Returns \HEXONET\Record|null — Record or null in case there's no further record
getNextPageNumber() getNextPageNumber() : int|null Get Page Number of next list query Returns int|null — page number or null if there's no next page
getNumberOfPages() getNumberOfPages() : Get the number of pages available for this list query Returns — number of pages
getPagination() getPagination() : mixed|string|int Get object containing all paging data Returns mixed|string|int — paginator data
getPreviousPageNumber() getPreviousPageNumber() : int|null Get Page Number of previous list query Returns int|null — page number or null if there's no previous page
getPreviousRecord() getPreviousRecord() : \HEXONET\Record|null Get previous record in record list Returns \HEXONET\Record|null — Record or null if there's no previous record
getRecord() getRecord( idx) : \HEXONET\Record|null Get Record at given index Parameters idx record index Returns \HEXONET\Record|null — Record or null if index does not exist
getRecords() getRecords() : \HEXONET\Record|string|int Get all Records Returns \HEXONET\Record|string|int — array of records
getRecordsTotalCount() getRecordsTotalCount() : Get total count of records available for the list query Returns — total count of records or count of records for a non-list response
getRecordsLimitation() getRecordsLimitation() : Get limit(ation) setting of the current list query This is the count of requested rows Returns — limit setting or count requested rows
hasPreviousPage() hasPreviousPage() : Check if this list query has a previous page Returns — boolean result