Meilisearch PHP | Documentation

ExportIndexOptions
in package
implements JsonSerializable

FinalYes

Options applied to the indexes matching one pattern of an export.

Tags
phpstan-type

RawExportIndexOptions array{ filter?: string|list<string|list>, overrideSettings?: bool }

Table of Contents

Interfaces

JsonSerializable

Properties

$filter  : string|array<int, string|array<int, string>>|null
$overrideSettings  : bool|null

Methods

jsonSerialize()  : object
setFilter()  : $this
setOverrideSettings()  : $this
toArray()  : RawExportIndexOptions

Properties

$filter

private string|array<int, string|array<int, string>>|null $filter = null

Methods

setFilter()

public setFilter(string|array<int, string|array<int, string>>|null $filter) : $this
Parameters
$filter : string|array<int, string|array<int, string>>|null

a filter expression, as a string or an array of strings

Return values
$this

setOverrideSettings()

public setOverrideSettings(bool $overrideSettings) : $this
Parameters
$overrideSettings : bool

whether to overwrite the settings of indexes that already exist on the target instance

Return values
$this

toArray()

public toArray() : RawExportIndexOptions
Return values
RawExportIndexOptions
On this page

Search results