include/SugarSearchEngine/Elastic/Elastica/ResultSet.php
inherited
Classes
Elastica result set
List of all hits that are returned for a search on elasticsearch Result set implents iterator
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Package
- Elastica
\Elastica_ResultSet
Elastica result set
List of all hits that are returned for a search on elasticsearch Result set implents iterator
- Parent(s)
- ?\Iterator\Countable
- Author
- Nicolas Ruflin
- Category
- Xodoa
Properties
$_position= '0'
0Details- Type
- n/a
$_response= 'null'
nullDetails- Type
- n/a
$_results= 'array()'
array()Details- Type
- n/a
$_took= '0'
0Details- Type
- n/a
Methods
__construct(
\Elastica_Response $response
)
:
voidConstructs ResultSet object
| Name | Type | Description |
|---|---|---|
| $response | \Elastica_Response | Response object |
_init(
\Elastica_Response $response
)
:
voidLoads all data into the results object (initalisation)
| Name | Type | Description |
|---|---|---|
| $response | \Elastica_Response | Response object |
count(
)
:
intReturns size of current set
| Type | Description |
|---|---|
| int | Size of set |
current(
)
:
mixed | boolReturns the current object of the set
| Type | Description |
|---|---|
| mixed | bool | Set object or false if not valid (no more entries) |
getFacets(
)
:
arrayReturns all facets results
| Type | Description |
|---|---|
| array | Facet results |
getResponse(
)
:
\Elastica_ResponseReturns response object
| Type | Description |
|---|---|
| \Elastica_Response | Response object |
getResults(
)
:
arrayReturns all results
| Type | Description |
|---|---|
| array | Results |
getTotalHits(
)
:
intReturns the total number of found hits
| Type | Description |
|---|---|
| int | Total hits |
getTotalTime(
)
:
intReturns the total number of ms for this search to complete
| Type | Description |
|---|---|
| int | Total time |
hasFacets(
)
:
booleanReturns whether facets exist
| Type | Description |
|---|---|
| boolean | Facet existence |
key(
)
:
intReturns the position of the current entry
| Type | Description |
|---|---|
| int | Current position |
next(
)
:
voidSets pointer (current) to the next item of the set
rewind(
)
:
voidResets position to 0, restarts iterator
valid(
)
:
boolCheck if an object exists at the current position
| Type | Description |
|---|---|
| bool | True if object exists |