Meilisearch PHP | Documentation

DynamicSearchRule
in package

FinalYes
Tags
phpstan-type

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

phpstan-type

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

phpstan-type

SearchRuleAction array{ selector: SearchRuleSelector, action: SearchRulePinAction }

phpstan-type

SearchRuleQueryCondition array{ scope: 'query', isEmpty?: bool|null, contains?: non-empty-string|null }

phpstan-type

SearchRuleTimeCondition array{ scope: 'time', start?: non-empty-string|null, end?: non-empty-string|null }

phpstan-type

SearchRuleCondition SearchRuleQueryCondition|SearchRuleTimeCondition

phpstan-type

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

Table of Contents

Properties

$actions  : array<int, SearchRuleAction>
$active  : bool|null
$conditions  : array<int, SearchRuleCondition>|null
$description  : string|null
$priority  : int|null
$raw  : array<string|int, mixed>
$uid  : non-empty-string

Methods

__construct()  : mixed
fromArray()  : self
getActions()  : array<int, SearchRuleAction>
getConditions()  : array<int, SearchRuleCondition>|null
getDescription()  : string|null
getPriority()  : int|null
getRaw()  : RawDynamicSearchRule
Return the original dynamic search rule.
getUid()  : string
isActive()  : bool|null
toArray()  : RawDynamicSearchRule

Properties

$conditions read-only

private array<int, SearchRuleCondition>|null $conditions

Methods

__construct()

public __construct(RawDynamicSearchRule $raw) : mixed
Parameters
$raw : RawDynamicSearchRule

fromArray()

public static fromArray(RawDynamicSearchRule $data) : self
Parameters
$data : RawDynamicSearchRule
Return values
self

getActions()

public getActions() : array<int, SearchRuleAction>
Return values
array<int, SearchRuleAction>

getConditions()

public getConditions() : array<int, SearchRuleCondition>|null
Return values
array<int, SearchRuleCondition>|null

getDescription()

public getDescription() : string|null
Return values
string|null

getRaw()

Return the original dynamic search rule.

public getRaw() : RawDynamicSearchRule
Return values
RawDynamicSearchRule

toArray()

public toArray() : RawDynamicSearchRule
Return values
RawDynamicSearchRule

        
On this page

Search results