SettingsUpdateDetails
in package
implements
TaskDetails
FinalYes
Table of Contents
Interfaces
Properties
- $dictionary : array<string|int, mixed>|null
- $displayedAttributes : array<string|int, mixed>|null
- $distinctAttribute : string|null
- $embedders : array<string|int, mixed>|null
- $faceting : array<string|int, mixed>|null
- $facetSearch : bool|null
- $filterableAttributes : array<string|int, mixed>|null
- $localizedAttributes : array<string|int, mixed>|null
- $nonSeparatorTokens : array<string|int, mixed>|null
- $pagination : array<string|int, mixed>|null
- $prefixSearch : string|null
- $proximityPrecision : string|null
- $rankingRules : array<string|int, mixed>|null
- $searchableAttributes : array<string|int, mixed>|null
- $searchCutoffMs : int|null
- $separatorTokens : array<string|int, mixed>|null
- $sortableAttributes : array<string|int, mixed>|null
- $stopWords : array<string|int, mixed>|null
- $synonyms : array<string|int, mixed>|null
- $typoTolerance : array<string|int, mixed>|null
Methods
- __construct() : mixed
- fromArray() : self
Properties
$dictionary read-only
public
array<string|int, mixed>|null
$dictionary
$displayedAttributes read-only
public
array<string|int, mixed>|null
$displayedAttributes
$distinctAttribute read-only
public
string|null
$distinctAttribute
$embedders read-only
public
array<string|int, mixed>|null
$embedders
$faceting read-only
public
array<string|int, mixed>|null
$faceting
$facetSearch read-only
public
bool|null
$facetSearch
$filterableAttributes read-only
public
array<string|int, mixed>|null
$filterableAttributes
$localizedAttributes read-only
public
array<string|int, mixed>|null
$localizedAttributes
$nonSeparatorTokens read-only
public
array<string|int, mixed>|null
$nonSeparatorTokens
$pagination read-only
public
array<string|int, mixed>|null
$pagination
$prefixSearch read-only
public
string|null
$prefixSearch
$proximityPrecision read-only
public
string|null
$proximityPrecision
$rankingRules read-only
public
array<string|int, mixed>|null
$rankingRules
$searchableAttributes read-only
public
array<string|int, mixed>|null
$searchableAttributes
$searchCutoffMs read-only
public
int|null
$searchCutoffMs
$separatorTokens read-only
public
array<string|int, mixed>|null
$separatorTokens
$sortableAttributes read-only
public
array<string|int, mixed>|null
$sortableAttributes
$stopWords read-only
public
array<string|int, mixed>|null
$stopWords
$synonyms read-only
public
array<string|int, mixed>|null
$synonyms
$typoTolerance read-only
public
array<string|int, mixed>|null
$typoTolerance
Methods
__construct()
public
__construct(array<int, string>|null $dictionary, array<int, string>|null $displayedAttributes, string|null $distinctAttribute, array<string|int, mixed>|null $embedders, array<string|int, mixed>|null $faceting, bool|null $facetSearch, array<int, string|array{attributePatterns: list, features: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>|null $filterableAttributes, array<int, array{locales: list, attributePatterns: list}>|null $localizedAttributes, array<int, string>|null $nonSeparatorTokens, array<string|int, mixed>|null $pagination, "indexingTime"|"disabled"|null $prefixSearch, "byWord"|"byAttribute"|null $proximityPrecision, array<int, non-empty-string>|null $rankingRules, array<int, non-empty-string>|null $searchableAttributes, int|null $searchCutoffMs, array<int, string> $separatorTokens, array<int, non-empty-string>|null $sortableAttributes, array<int, string>|null $stopWords, array<string, array<int, string>>|null $synonyms, array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list, disableOnAttributes: list, disableOnNumbers: bool}|null $typoTolerance) : mixed
Parameters
- $dictionary : array<int, string>|null
- $displayedAttributes : array<int, string>|null
- $distinctAttribute : string|null
- $embedders : array<string|int, mixed>|null
- $faceting : array<string|int, mixed>|null
- $facetSearch : bool|null
-
$filterableAttributes
: array<int, string|array{attributePatterns: list
, features: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}}>|null -
$localizedAttributes
: array<int, array{locales: list
, attributePatterns: list }>|null - $nonSeparatorTokens : array<int, string>|null
- $pagination : array<string|int, mixed>|null
- $prefixSearch : "indexingTime"|"disabled"|null
- $proximityPrecision : "byWord"|"byAttribute"|null
- $rankingRules : array<int, non-empty-string>|null
- $searchableAttributes : array<int, non-empty-string>|null
- $searchCutoffMs : int|null
- $separatorTokens : array<int, string>
- $sortableAttributes : array<int, non-empty-string>|null
- $stopWords : array<int, string>|null
- $synonyms : array<string, array<int, string>>|null
-
$typoTolerance
: array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list
, disableOnAttributes: list , disableOnNumbers: bool}|null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>