SearchResult
SearchResult.php
:
23
Extends ValueObject
Implements
IteratorAggregate, AggregationResultAwareInterface
This class represents a search result.
Properties¶
$aggregations
¶
SearchResult.php
:
25
|
|
|
$maxScore
¶
SearchResult.php
:
49
The maximum score of this query.
|
|
|
$searchHits
¶
SearchResult.php
:
32
The value objects found for the query.
|
|
|
$spellcheck
¶
SearchResult.php
:
34
|
|
|
$time
¶
SearchResult.php
:
39
The duration of the search processing in ms.
|
|
|
$timedOut
¶
SearchResult.php
:
44
Indicates if the search has timed out.
|
|
|
$totalCount
¶
SearchResult.php
:
58
The total number of searchHits.
|
|
|
null if Query->performCount was set to false and search engine avoids search lookup.
Methods¶
__construct()
¶
SearchResult.php
:
60
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getAggregations()
¶
SearchResult.php
:
74
|
|
|
Return values
AggregationResultCollection|null
getIterator()
¶
SearchResult.php
:
79
|
|
|
Return values
Iterator
getSpellcheck()
¶
SearchResult.php
:
69
|
|
|
Return values
SpellcheckResult|null
getProperties()
¶
ValueObject.php
:
53
Returns list of available properties' names.
|
|
|
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] |
Additional dynamic properties exposed on the object |
Return values
array<int, string>
Attributes
- #[Ignore]