include/SugarSearchEngine/Elastic/Elastica/Result.php
inherited
Classes
Elastica result item
Stores all information from a result
- Author
- Nicolas Ruflin
- Category
- Xodoa
- Package
- Elastica
\Elastica_Result
Elastica result item
Stores all information from a result
- Author
- Nicolas Ruflin
- Category
- Xodoa
Properties
Methods
__construct(
array $hit
)
:
voidConstructs a single results object
| Name | Type | Description |
|---|---|---|
| $hit | array | Hit data |
__get(
string $key
)
:
mixedMagic function to directly access keys inside the result
Returns null if key does not exist
| Name | Type | Description |
|---|---|---|
| $key | string | Key name |
| Type | Description |
|---|---|
| mixed | Key value |
getData(
)
:
arrayReturns result data
Checks for partial result data with getFields, falls back to getSource
| Type | Description |
|---|---|
| array | Result data array |
getExplanation(
)
:
arrayReturns explanation on how its score was computed.
| Type | Description |
|---|---|
| array | explanations |
getFields(
)
:
arrayReturns list of fields
| Type | Description |
|---|---|
| array | Fields list |
getHighlights(
)
:
arrayReturns result data
| Type | Description |
|---|---|
| array | Result data array |
getHit(
)
:
arrayReturns the raw hit array
| Type | Description |
|---|---|
| array | Hit array |
getId(
)
:
stringReturns the hit id.
| Type | Description |
|---|---|
| string | Hit id |
getIndex(
)
:
stringReturns the index name of the result
| Type | Description |
|---|---|
| string | Index name |
getParam(
string $name
)
:
arrayReturns a param from the result hit array
This function can be used to retriev all data for which not a specific function exists. If the param does not exists and empty array is retured
| Name | Type | Description |
|---|---|---|
| $name | string | Param name |
| Type | Description |
|---|---|
| array | Result data |
getScore(
)
:
floatReturns the score of the result
| Type | Description |
|---|---|
| float | Results score |
getSource(
)
:
arrayReturns the result source
| Type | Description |
|---|---|
| array | Source data array |
getType(
)
:
stringReturns results type
| Type | Description |
|---|---|
| string | Result type |
getVersion(
)
:
string | intReturns the version information from the hit
| Type | Description |
|---|---|
| string | int | Document version |