Meilisearch PHP | Documentation

DocumentDeletionDetails
in package
implements TaskDetails

FinalYes
Tags
implements

TaskDetails<array{ providedIds?: non-negative-int, originalFilter?: string|null, deletedDocuments?: non-negative-int|null }>

Table of Contents

Interfaces

TaskDetails

Properties

$deletedDocuments  : int|null
$originalFilter  : string|null
$providedIds  : int|null

Methods

__construct()  : mixed
fromArray()  : self

Properties

Methods

__construct()

public __construct(int|null $providedIds, string|null $originalFilter, int|null $deletedDocuments) : mixed
Parameters
$providedIds : int|null
$originalFilter : string|null

The filter used to delete documents. Null if it was not specified.

$deletedDocuments : int|null

Number of documents deleted. null while the task status is enqueued or processing.

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

        
On this page

Search results