Documentation

BatchInterface

Interface for efficiently transferring items in a queue using batches

Table of Contents

Methods

add()  : self
Add an item to the queue
flush()  : array<string|int, mixed>
Flush the batch and transfer the items
isEmpty()  : bool
Check if the batch is empty and has further items to transfer

Methods

add()

Add an item to the queue

public add(mixed $item) : self
Parameters
$item : mixed

Item to add

Return values
self

flush()

Flush the batch and transfer the items

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

Returns an array flushed items

isEmpty()

Check if the batch is empty and has further items to transfer

public isEmpty() : bool
Return values
bool

        
On this page

Search results