Response
class Response implements ResponseInterface (View source)
CNR Response
Properties
| protected string[] | $command | The API Command used within this request |
|
| protected string | $raw | plain API response |
|
| protected array<string, mixed> | $hash | hash representation of plain API response |
|
| protected non-empty-string | $paginationkeys | Regex for pagination related column keys |
|
| protected string[] | $columnkeys | Column names available in this response |
|
| protected Column[] | $columns | Container of Column Instances |
|
| protected int | $recordIndex | Record Index we currently point to in record list |
|
| protected Record[] | $records | Record List (List of rows) |
|
| protected array<string, mixed> | $context | Context data for the response |
|
| protected string | $requestUrl | API request url |
Methods
Constructor
Get context data for the response
Get Request URL
Get API response code
Get API response description
Get Plain API response
Get Queuetime of API response
Get API response as Hash
Get Runtime of API response
Check if current API response represents an error case API response code is an 5xx code
Check if current API response represents a success case API response code is an 2xx code
Check if current API response represents a temporary error case API response code is an 4xx code
Check if current operation is returned as pending
Add a column to the column list
Add a record to the record list
Get column by column name
Get Data by Column Name and Index
Get Column Names
Get List of Columns
Get Command used in this request
Get Command used in this request in plain text format
Get Page Number of current List Query
Get Record of current record index
Get Index of first row in this response
Get last record index of the current list query
Get Response as List Hash including useful meta data for tables
Get next record in record list
Get Page Number of next list query
Get the number of pages available for this list query
Get object containing all paging data
Get Page Number of previous list query
Get previous record in record list
Get Record at given index
Get all Records
Get count of rows in this response
Get total count of records available for the list query
Get limit(ation) setting of the current list query This is the count of requested rows
Check if this list query has a next page
Check if this list query has a previous page
Reset index in record list back to zero
Details
__construct(string $raw, array $cmd = [], array $ph = [], array $context = [])
Constructor
array
getContext()
Get context data for the response
string
getRequestURL()
Get Request URL
int
getCode()
Get API response code
string
getDescription()
Get API response description
string
getPlain()
Get Plain API response
float
getQueuetime()
Get Queuetime of API response
array
getHash()
Get API response as Hash
float
getRuntime()
Get Runtime of API response
bool
isError()
Check if current API response represents an error case API response code is an 5xx code
bool
isSuccess()
Check if current API response represents a success case API response code is an 2xx code
bool
isTmpError()
Check if current API response represents a temporary error case API response code is an 4xx code
bool
isPending()
Check if current operation is returned as pending
ResponseInterface
addColumn(string $key, array $data)
Add a column to the column list
ResponseInterface
addRecord(array $h)
Add a record to the record list
ColumnInterface|null
getColumn(string $key)
Get column by column name
mixed
getColumnIndex(string $colkey, int $index)
Get Data by Column Name and Index
array
getColumnKeys(bool $filterPaginationKeys = false)
Get Column Names
array
getColumns()
Get List of Columns
array
getCommand()
Get Command used in this request
string
getCommandPlain()
Get Command used in this request in plain text format
int|null
getCurrentPageNumber()
Get Page Number of current List Query
RecordInterface|null
getCurrentRecord()
Get Record of current record index
int|null
getFirstRecordIndex()
Get Index of first row in this response
int|null
getLastRecordIndex()
Get last record index of the current list query
array
getListHash()
Get Response as List Hash including useful meta data for tables
RecordInterface|null
getNextRecord()
Get next record in record list
int|null
getNextPageNumber()
Get Page Number of next list query
int
getNumberOfPages()
Get the number of pages available for this list query
array
getPagination()
Get object containing all paging data
int|null
getPreviousPageNumber()
Get Page Number of previous list query
RecordInterface|null
getPreviousRecord()
Get previous record in record list
RecordInterface|null
getRecord(int $idx)
Get Record at given index
array
getRecords()
Get all Records
int
getRecordsCount()
Get count of rows in this response
int
getRecordsTotalCount()
Get total count of records available for the list query
int
getRecordsLimitation()
Get limit(ation) setting of the current list query This is the count of requested rows
bool
hasNextPage()
Check if this list query has a next page
bool
hasPreviousPage()
Check if this list query has a previous page
ResponseInterface
rewindRecordList()
Reset index in record list back to zero