Meilisearch PHP | Documentation

DocumentsResults extends Data
in package

Table of Contents

Properties

$data  : mixed
$limit  : int
$offset  : int
$total  : int

Methods

__construct()  : mixed
count()  : int
getIterator()  : ArrayIterator
getLimit()  : int
getOffset()  : int
getResults()  : array<int, array<string|int, mixed>>
getTotal()  : int
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
toArray()  : array<string|int, mixed>

Properties

$data

protected mixed $data = []

Methods

__construct()

public __construct(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

getIterator()

public getIterator() : ArrayIterator
Return values
ArrayIterator

getResults()

public getResults() : array<int, array<string|int, mixed>>
Return values
array<int, array<string|int, mixed>>

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

On this page

Search results