Meilisearch PHP | Documentation

Network extends Endpoint
in package

Tags
phpstan-import-type

RemoteConfig from NetworkResults

phpstan-type

ShardConfig array{ remotes?: list, addRemotes?: list, removeRemotes?: list }

Table of Contents

Constants

PATH  = '/network'

Properties

$apiKey  : string|null
$http  : Http

Methods

__construct()  : mixed
addRemote()  : Task
Add a remote to the network.
addRemotesToShard()  : Task
get()  : RemoteConfig|null>, shards?: array}>}
initialize()  : Task
removeRemote()  : Task
Remove a remote from the network.
removeRemotesFromShard()  : Task
show()  : array<string|int, mixed>|null
dispatchPatch()  : Task

Constants

PATH

protected mixed PATH = '/network'

Properties

Methods

__construct()

public __construct(Http $http[, string|null $apiKey = null ]) : mixed
Parameters
$http : Http
$apiKey : string|null = null

addRemote()

Add a remote to the network.

public addRemote(non-empty-string $name, RemoteConfig $remote) : Task
Parameters
$name : non-empty-string
$remote : RemoteConfig
Return values
Task

addRemotesToShard()

public addRemotesToShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
$shardName : non-empty-string
$remoteNames : array<int, non-empty-string>
Return values
Task

get()

public get() : RemoteConfig|null>, shards?: array}>}
Return values
RemoteConfig|null>, shards?: array}>}

initialize()

public initialize(ShardConfig>} $options) : Task
Parameters
$options : ShardConfig>}
Return values
Task

removeRemote()

Remove a remote from the network.

public removeRemote(non-empty-string $name) : Task
Parameters
$name : non-empty-string
Return values
Task

removeRemotesFromShard()

public removeRemotesFromShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
$shardName : non-empty-string
$remoteNames : array<int, non-empty-string>
Return values
Task

show()

public show() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

dispatchPatch()

private dispatchPatch(array<string|int, mixed> $body) : Task
Parameters
$body : array<string|int, mixed>
Return values
Task 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results