SearchResult
This class represents a search result.
Properties¶
$aggregations
¶
|
|
|
$facets
¶
The facets for this search.
|
|
|
Tags
$maxScore
¶
The maximum score of this query.
|
|
|
$searchHits
¶
The value objects found for the query.
|
|
|
$spellcheck
¶
|
|
|
$spellSuggestion
¶
If spellcheck is on this field contains a collated query suggestion where in the appropriate criterions the wrong spelled value is replaced by a corrected one (TBD).
|
|
|
Tags
$time
¶
The duration of the search processing in ms.
|
|
|
$timedOut
¶
Indicates if the search has timed out.
|
|
|
$totalCount
¶
The total number of searchHits.
|
|
|
null if Query->performCount was set to false and search engine avoids search lookup.
Methods¶
__construct()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they are not writable anymore after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getAggregations()
¶
|
|
|
Return values
AggregationResultCollection|null
getIterator()
¶
|
|
|
Return values
Iterator
getSpellcheck()
¶
|
|
|
Return values
SpellcheckResult|null
getProperties()
¶
Function where list of properties are returned.
|
|
|
Used by attributes(), override to add dynamic properties
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<string|int, mixed> | [] |
Additional dynamic properties exposed on the object |
Return values
array<string|int, mixed>