Interface Guzzle\Batch\BatchInterface

Implemented byGuzzle\Batch\AbstractBatchDecorator, Guzzle\Batch\Batch, Guzzle\Batch\ExceptionBufferingBatch, Guzzle\Batch\FlushingBatch, Guzzle\Batch\HistoryBatch, Guzzle\Batch\NotifyingBatch

Interface for efficiently transferring items in a queue using batches

Public Methods

Hide inherited methods

MethodDescriptionDefined By
add() Add an item to the queue Guzzle\Batch\BatchInterface
flush() Flush the batch and transfer the items Guzzle\Batch\BatchInterface
isEmpty() Check if the batch is empty and has further items to transfer Guzzle\Batch\BatchInterface

Method Details

add() public abstract method

Add an item to the queue

public abstract self add ( $item )
$item mixed

Item to add

flush() public abstract method

Flush the batch and transfer the items

public abstract array flush ( )
return array

Returns an array flushed items

isEmpty() public abstract method

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

public abstract bool isEmpty ( )