Flow PHP

SearchParams

FinalYes

Methods

__construct() : mixed
asArray() : array{q: string, limit: ?int, offset: ?int, attributesToRetrieve: ?string[], sort: ?string[]}
getLimit() : int
getOffset() : int
getQuery() : string
set() : self

__construct()


    public
                    __construct(array{q: string, limit: ?int, offset: ?int, attributesToRetrieve: ?string[], sort: ?string[]} $params) : mixed

Parameters

$params : array{q: string, limit: ?int, offset: ?int, attributesToRetrieve: ?string[], sort: ?string[]}: See: https://www.meilisearch.com/docs/reference/api/search#search-parameters

asArray()


    public
                    asArray() : array{q: string, limit: ?int, offset: ?int, attributesToRetrieve: ?string[], sort: ?string[]}

Return values

array{q: string, limit: ?int, offset: ?int, attributesToRetrieve: ?string[], sort: ?string[]}

getLimit()


    public
                    getLimit() : int

Return values

int

getOffset()


    public
                    getOffset() : int

Return values

int

getQuery()


    public
                    getQuery() : string

Return values

string

set()


    public
                    set(string $key, mixed $value) : self

Parameters

$key : string
$value : mixed

Return values

self