SimilarDocumentsSearchResult
in package
implements
Countable, IteratorAggregate
FinalYes
Tags
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 : int|non-empty-string
- $limit : int
- $offset : int
- $performanceDetails : array<string, string>|null
- $processingTimeMs : int
- $raw : array<string, mixed>
Methods
- __construct() : mixed
- count() : int
- getEstimatedTotalHits() : int
- getHit() : array<string, mixed>|TDefault
- getHits() : array<int, array<string, mixed>>
- getHitsCount() : int
- getId() : int|non-empty-string
- getIterator() : ArrayIterator
- getLimit() : int
- getOffset() : int
- getPerformanceDetails() : array<string, string>|null
- getProcessingTimeMs() : int
- getRaw() : array<string, mixed>
- toArray() : array<string|int, 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
non-negative-int
$id
private
int|non-empty-string
$id
$limit
private
int
$limit
non-negative-int
$offset
private
int
$offset
non-negative-int
$performanceDetails
private
array<string, string>|null
$performanceDetails
$processingTimeMs
private
int
$processingTimeMs
non-negative-int
$raw
private
array<string, mixed>
$raw
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[, TDefault $default = null ]) : array<string, mixed>|TDefault
Parameters
- $key : int
- $default : TDefault = null
Tags
Return values
array<string, mixed>|TDefaultgetHits()
public
getHits() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>getHitsCount()
public
getHitsCount() : int
Return values
intgetId()
public
getId() : int|non-empty-string
Return values
int|non-empty-stringgetIterator()
public
getIterator() : ArrayIterator
Return values
ArrayIteratorgetLimit()
public
getLimit() : int
Return values
intgetOffset()
public
getOffset() : int
Return values
intgetPerformanceDetails()
public
getPerformanceDetails() : array<string, string>|null
Return values
array<string, string>|nullgetProcessingTimeMs()
public
getProcessingTimeMs() : int
Return values
intgetRaw()
public
getRaw() : array<string, mixed>
Return values
array<string, mixed>toArray()
Converts the SimilarDocumentsSearchResult to an array representation.
public
toArray() : array<string|int, mixed>