Meilisearch PHP | Documentation

BatchesQuery
in package
uses TasksQueryTrait

Table of Contents

Properties

$afterEnqueuedAt  : DateTimeInterface|null
$afterFinishedAt  : DateTimeInterface|null
$afterStartedAt  : DateTimeInterface|null
$beforeEnqueuedAt  : DateTimeInterface|null
$beforeFinishedAt  : DateTimeInterface|null
$beforeStartedAt  : DateTimeInterface|null
$from  : int|null
$indexUids  : array<int, non-empty-string>
$limit  : int|null
$reverse  : bool|null
$statuses  : array<int, non-empty-string>
$types  : array<int, non-empty-string>
$uids  : array<int, int>

Methods

getIndexUids()  : array<int, non-empty-string>
setAfterEnqueuedAt()  : $this
setAfterFinishedAt()  : $this
setAfterStartedAt()  : $this
setBeforeEnqueuedAt()  : $this
setBeforeFinishedAt()  : $this
setBeforeStartedAt()  : $this
setFrom()  : $this
setIndexUids()  : $this
setLimit()  : $this
setReverse()  : $this
setStatuses()  : $this
setTypes()  : $this
setUids()  : $this
toArray()  : array<string|int, mixed>
baseArray()  : array<string|int, mixed>
formatArray()  : string|null
formatDate()  : string|null

Properties

$afterEnqueuedAt

private DateTimeInterface|null $afterEnqueuedAt = null

$afterFinishedAt

private DateTimeInterface|null $afterFinishedAt = null

$afterStartedAt

private DateTimeInterface|null $afterStartedAt = null

$beforeEnqueuedAt

private DateTimeInterface|null $beforeEnqueuedAt = null

$beforeFinishedAt

private DateTimeInterface|null $beforeFinishedAt = null

$beforeStartedAt

private DateTimeInterface|null $beforeStartedAt = null

$limit

private int|null $limit = null

non-negative-int|null

Methods

getIndexUids()

public getIndexUids() : array<int, non-empty-string>
Return values
array<int, non-empty-string>

setAfterEnqueuedAt()

public setAfterEnqueuedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setAfterFinishedAt()

public setAfterFinishedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setAfterStartedAt()

public setAfterStartedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setBeforeEnqueuedAt()

public setBeforeEnqueuedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setBeforeFinishedAt()

public setBeforeFinishedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setBeforeStartedAt()

public setBeforeStartedAt(DateTimeInterface|null $date) : $this
Parameters
$date : DateTimeInterface|null
Return values
$this

setFrom()

public setFrom(int $from) : $this
Parameters
$from : int
Return values
$this

setIndexUids()

public setIndexUids(array<int, non-empty-string>|null $indexUids) : $this
Parameters
$indexUids : array<int, non-empty-string>|null
Return values
$this

setLimit()

public setLimit(int $limit) : $this
Parameters
$limit : int
Return values
$this

setReverse()

public setReverse(bool $reverse) : $this
Parameters
$reverse : bool
Return values
$this

setStatuses()

public setStatuses(array<int, non-empty-string>|null $statuses) : $this
Parameters
$statuses : array<int, non-empty-string>|null
Return values
$this

setTypes()

public setTypes(array<int, non-empty-string>|null $types) : $this
Parameters
$types : array<int, non-empty-string>|null
Return values
$this

setUids()

public setUids(array<int, int>|null $uids) : $this
Parameters
$uids : array<int, int>|null
Return values
$this

toArray()

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

baseArray()

protected baseArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

formatArray()

private formatArray(array<string|int, mixed>|null $array) : string|null
Parameters
$array : array<string|int, mixed>|null
Return values
string|null

formatDate()

private formatDate(DateTimeInterface|null $date) : string|null
Parameters
$date : DateTimeInterface|null
Return values
string|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results