\HEXONETResponse

__construct()

__construct(\HEXONET\Response  response) : 

Constructor

Parameters

Returns

asString()

asString() : 

Returns the response as a string

Returns

The response as a sting

asHash()

asHash() : mixed|string|int

Returns the response as a hash

Returns

The response as a hash

asListHash()

asListHash() : mixed|string|int

Returns the response as a list hash

Returns

The response as a list hash

asList()

asList() : mixed|string|int

Returns the response as a list

Returns

The response as a list

code()

code() : 

Returns the response code

Returns

The response code

description()

description() : 

Returns the response description

Returns

The response description

properties()

properties() : mixed|string|int

Returns the response properties

Returns

The response properties

runtime()

runtime() : 

Returns the response runtime

Returns

The response runtime

queuetime()

queuetime() : 

Returns the response queutime

Returns

The response queutime

property()

property(  index = null) : mixed|string|int

Returns the property for a given index If no index given, the complete property list is returned

Parameters

Returns

A proterty

isSuccess()

isSuccess() : 

Returns true if the results is a success Success = response code starting with 2

Returns

isTmpError()

isTmpError() : 

Returns true if the results is a tmp error tmp error = response code starting with 4

Returns

__get()

__get(  name) : 

Operator overloading Example: __get("code") == $response->code

Parameters

Returns

offsetSet()

offsetSet(  offset,   value) : 

ArrayAccess : offsetSet not implemented

Parameters

Returns

offsetExists()

offsetExists(  offset) : 

ArrayAccess : offsetExists Return true if the array key exists

Parameters

Returns

offsetUnset()

offsetUnset(  offset) : 

ArrayAcess : offsetUnset not implemented

Parameters

Returns

offsetGet()

offsetGet(  offset) : 

ArrayAccess : offsetGet Return the array for the given offset

Parameters

Returns

columns()

columns() : mixed|string|int

Returns the columns

Returns

The columns

first()

first() : 

Returns the index of the first element

Returns

The index of the first element

last()

last() : 

Returns the index of the last element

Returns

The index of the last element

count()

count() : 

Returns the number of list elements returned (= last - first + 1)

Returns

The number of list elements returned

limit()

limit() : 

Returns the limit of the response

Returns

The limit

total()

total() : 

Returns the total number of elements found (!= count)

Returns

The total number of elements found

pages()

pages() : 

Returns the number of pages

Returns

The number of pages

page()

page() : 

Returns the number of the current page (starts with 1)

Returns

The number of the current page

prevpage()

prevpage() : 

Returns the number of the previous page

Returns

The number of the previous page

prevpagefirst()

prevpagefirst() : 

Returns the first index for the previous page

Returns

The first index of the previous page

nextpage()

nextpage() : 

Returns the number of the next page

Returns

The number of the next page

nextpagefirst()

nextpagefirst() : 

Returns the first index for the next page

Returns

The first index of the next page

lastpagefirst()

lastpagefirst() : 

Returns the first index for the last page

Returns

The first index of the last page

rewind()

rewind() : mixed|string|int

Iterator : rewind Set the iterator to 0

Returns

The first element of the list

current()

current() : mixed|string|int

Iterator : current Returns the current element of the list

Returns

The current element of the list

key()

key() : 

Iterator : key Returns the key of the current element

Returns

The key of the current element

next()

next() : 

Iterator : next Returns the key of the next element

Returns

The key of the next element

valid()

valid() : mixed|string|int

Iterator : valid Returns the element if it exists

Returns

The element if it exists