include/SugarSearchEngine/Elastic/Elastica/Response.php
Show:
inherited
inherited
Classes
Elastica Response object
Stores query time, and result array -> is given to resultset, returned by ...
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Package
- Elastica
\Elastica_Response
Package: Elastica
Elastica Response object
Stores query time, and result array -> is given to resultset, returned by ...
- Author
- Nicolas Ruflin
- Category
- Xodoa
Properties
$_error= 'false'
Default value
falseDetails- Type
- n/a
$_queryTime= 'null'
Default value
nullDetails- Type
- n/a
$_response= 'null'
Default value
nullDetails- Type
- n/a
$_responseString= ''''
Default value
''Details- Type
- n/a
$_transferInfo= 'array()'
Default value
array()Details- Type
- n/a
Methods
__construct(
string $responseString
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $responseString | string | Response string (json) |
getData(
)
:
array
Returns
| Type | Description |
|---|---|
| array | Response data array |
getEngineTime(
)
:
int
Returns
| Type | Description |
|---|---|
| int | Time request took |
getError(
)
:
string
Returns
| Type | Description |
|---|---|
| string | Error message |
getQueryTime(
)
:
floatThis is only available if DEBUG constant is set to true
Returns
| Type | Description |
|---|---|
| float | Query time |
getShardsStatistics(
)
:
arrayGet the _shard statistics for the response
Returns
| Type | Description |
|---|---|
| array |
getTransferInfo(
)
:
arrayGets the transfer information if in DEBUG mode.
Returns
| Type | Description |
|---|---|
| array | Information about the curl request. |
hasError(
)
:
bool
Returns
| Type | Description |
|---|---|
| bool | True if response has error |
setQueryTime(
float $queryTime
)
:
\Elastica_ResponseSets the query time
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $queryTime | float | Query time |
| Type | Description |
|---|---|
| \Elastica_Response | Current object |
setTransferInfo(
array $transferInfo
)
:
\Elastica_ResponseSets the transfer info of the curl request. This function is called from the Elastica_Client::_callService only in debug mode.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $transferInfo | array | The curl transfer information. |
| Type | Description |
|---|---|
| \Elastica_Response | Current object |