SimilarDocumentsSearchResult
in package
implements
Countable, IteratorAggregate
Table of Contents
Interfaces
- Countable
- IteratorAggregate
Properties
- $estimatedTotalHits : int
- `estimatedTotalHits` is the attributes returned by the Meilisearch server and its value will not be modified by the methods in this class.
- $hits : array<int, array<string, mixed>>
- $hitsCount : int
- $id : string
- $limit : int
- $offset : int
- $processingTimeMs : int
Methods
- __construct() : mixed
- count() : int
- getEstimatedTotalHits() : int
- getHit() : array<string, mixed>|null
- getHits() : array<int, array<string, mixed>>
- getHitsCount() : int
- getId() : string
- getIterator() : ArrayIterator
- getLimit() : int
- getOffset() : int
- getProcessingTimeMs() : int
- toArray() : array<string, mixed>
- Converts the SimilarDocumentsSearchResult to an array representation.
Properties
$estimatedTotalHits
`estimatedTotalHits` is the attributes returned by the Meilisearch server and its value will not be modified by the methods in this class.
private
int
$estimatedTotalHits
Please, use hitsCount
if you want to know the real size of the hits
array at any time.
$hits
private
array<int, array<string, mixed>>
$hits
$hitsCount
private
int
$hitsCount
$id
private
string
$id
$limit
private
int
$limit
$offset
private
int
$offset
$processingTimeMs
private
int
$processingTimeMs
Methods
__construct()
public
__construct(array<string|int, mixed> $body) : mixed
Parameters
- $body : array<string|int, mixed>
count()
public
count() : int
Return values
intgetEstimatedTotalHits()
public
getEstimatedTotalHits() : int
Return values
intgetHit()
public
getHit(int $key) : array<string, mixed>|null
Parameters
- $key : int
Return values
array<string, mixed>|nullgetHits()
public
getHits() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>getHitsCount()
public
getHitsCount() : int
Return values
intgetId()
public
getId() : string
Return values
stringgetIterator()
public
getIterator() : ArrayIterator
Return values
ArrayIteratorgetLimit()
public
getLimit() : int
Return values
intgetOffset()
public
getOffset() : int
Return values
intgetProcessingTimeMs()
public
getProcessingTimeMs() : int
Return values
inttoArray()
Converts the SimilarDocumentsSearchResult to an array representation.
public
toArray() : array<string, mixed>