Guzzle\Batch\BatchInterface Interface Reference
Inheritance diagram for Guzzle\Batch\BatchInterface:
Public Member Functions | |
| add ($item) | |
| flush () | |
| isEmpty () | |
Detailed Description
Interface for efficiently transferring items in a queue using batches
Definition at line 8 of file BatchInterface.php.
Member Function Documentation
◆ add()
| Guzzle\Batch\BatchInterface::add | ( | $item | ) |
Add an item to the queue
- Parameters
-
mixed $item Item to add
- Returns
- self
Implemented in Guzzle\Batch\FlushingBatch, Guzzle\Batch\Batch, Guzzle\Batch\AbstractBatchDecorator, and Guzzle\Batch\HistoryBatch.
◆ flush()
| Guzzle\Batch\BatchInterface::flush | ( | ) |
Flush the batch and transfer the items
- Returns
- array Returns an array flushed items
Implemented in Guzzle\Batch\Batch, Guzzle\Batch\AbstractBatchDecorator, Guzzle\Batch\NotifyingBatch, and Guzzle\Batch\ExceptionBufferingBatch.
◆ isEmpty()
| Guzzle\Batch\BatchInterface::isEmpty | ( | ) |
Check if the batch is empty and has further items to transfer
- Returns
- bool
Implemented in Guzzle\Batch\Batch, and Guzzle\Batch\AbstractBatchDecorator.
The documentation for this interface was generated from the following file:
