Meilisearch PHP | Documentation

NetworkResults extends Data
in package

Tags
phpstan-type

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

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
$version  : non-empty-string|null

Methods

__construct()  : mixed
count()  : int
getIterator()  : ArrayIterator
getLeader()  : non-empty-string|null
getRemotes()  : array<non-empty-string, RemoteConfig|null>
getSelf()  : non-empty-string|null
getVersion()  : non-empty-string|null
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void

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

$version

private non-empty-string|null $version

the version of the network configuration

Methods

__construct()

public __construct(RemoteConfig|null>} $params) : mixed
Parameters
$params : RemoteConfig|null>}

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

getVersion()

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

the version of the network configuration

offsetExists()

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results