Meilisearch PHP | Documentation

Batches extends Endpoint
in package

Tags
phpstan-import-type

RawBatch from Batch

phpstan-type

RawBatches array{ results: list<RawBatch>, from: non-negative-int|null, limit: non-negative-int, next: non-negative-int|null, total: non-negative-int }

BatchesResponse array{ results: list<Batch>, from: non-negative-int|null, limit: non-negative-int, next: non-negative-int|null, total: non-negative-int }

Table of Contents

Constants

PATH  : mixed = '/batches'

Properties

$apiKey  : string|null
$http  : Http

Methods

__construct()  : mixed
all()  : BatchesResponse
get()  : Batch
show()  : array<string|int, mixed>|null

Constants

PATH

protected mixed PATH = '/batches'

Properties

Methods

__construct()

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

all()

public all([array<string|int, mixed> $query = [] ]) : BatchesResponse
Parameters
$query : array<string|int, mixed> = []
Return values
BatchesResponse

get()

public get(int $batchUid) : Batch
Parameters
$batchUid : int
Return values
Batch

show()

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

Search results