Meilisearch PHP | Documentation

DynamicSearchRule

in package

• Application

Tags

phpstan-type

SearchRuleSelector array{ indexUid?: non-empty-string|null, id: non-empty-string }

SearchRulePinAction array{ type: 'pin', position: int }

SearchRuleAction array{ selector: SearchRuleSelector, action: SearchRulePinAction }

QueryCondition array{ isEmpty?: bool|null, words?: non-empty-string|null }

TimeCondition array{ start?: non-empty-string|null, end?: non-empty-string|null }

SearchRuleConditions array{ query?: QueryCondition|null, time?: TimeCondition|null }

RawDynamicSearchRule array{ uid: non-empty-string, description?: string|null, precedence?: non-negative-int|null, active?: bool, conditions?: SearchRuleConditions|null, actions: list<SearchRuleAction> }

Table of Contents

Properties

$actions  : array<int, SearchRuleAction>

$active  : bool|null

$conditions  : SearchRuleConditions|null

$description  : string|null

$precedence  : int|null

$raw  : array<string|int, mixed>

$uid  : non-empty-string

Methods

__construct()  : mixed

fromArray()  : self

getActions()  : array<int, SearchRuleAction>

getConditions()  : SearchRuleConditions|null

getDescription()  : string|null

getPrecedence()  : int|null

getRaw()  : RawDynamicSearchRule

Return the original dynamic search rule.

getUid()  : string

isActive()  : bool|null

toArray()  : RawDynamicSearchRule