Meilisearch PHP | Documentation

NetworkResults extends Data
in package

Tags
phpstan-type

RemoteConfig array{url: non-empty-string|null, searchApiKey: non-empty-string|null, writeApiKey: non-empty-string|null}

ShardConfig array{remotes: list|null}

Table of Contents

Properties

$data  : array<string|int, mixed>
$leader  : non-empty-string|null
$remotes  : array<non-empty-string, RemoteConfig|null>
$self  : non-empty-string|null
$shards  : array<non-empty-string, ShardConfig>

Methods

__construct()  : mixed
count()  : int
getIterator()  : ArrayIterator
getLeader()  : non-empty-string|null
getRemotes()  : array<non-empty-string, RemoteConfig|null>
getSelf()  : non-empty-string|null
getShards()  : array<non-empty-string, ShardConfig>
toArray()  : array<string|int, mixed>

Properties

$data

protected array<string|int, mixed> $data = []

$leader

private non-empty-string|null $leader

the identifier for the leader node

$remotes

private array<non-empty-string, RemoteConfig|null> $remotes

a mapping of remote node IDs to their connection details

$self

private non-empty-string|null $self

the identifier for the local node

$shards

private array<non-empty-string, ShardConfig> $shards

a mapping of shard names to their remote owners

Methods

__construct()

public __construct(ShardConfig>} $params) : mixed
Parameters
$params : ShardConfig>}

count()

public count() : int
Return values
int

getIterator()

public getIterator() : ArrayIterator
Return values
ArrayIterator

getLeader()

public getLeader() : non-empty-string|null
Return values
non-empty-string|null —

the identifier for the leader node

getRemotes()

public getRemotes() : array<non-empty-string, RemoteConfig|null>
Return values
array<non-empty-string, RemoteConfig|null>

getSelf()

public getSelf() : non-empty-string|null
Return values
non-empty-string|null —

the identifier for the local node

getShards()

public getShards() : array<non-empty-string, ShardConfig>
Return values
array<non-empty-string, ShardConfig>

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>
On this page

Search results