\Guzzle\BatchHistoryBatch

BatchInterface decorator used to keep a history of items that were added to the batch. You must clear the history manually to remove items from the history.

Summary

Methods
Properties
Constants
__construct()
__call()
add()
flush()
isEmpty()
getDecorators()
getHistory()
clearHistory()
No public properties found
No constants found
No protected methods found
$decoratedBatch
$history
N/A
No private methods found
No private properties found
N/A

Properties

$history

$history : array

Type

array — Items in the history

Methods

__construct()

__construct(\Guzzle\Batch\BatchInterface  $decoratedBatch) 

Parameters

\Guzzle\Batch\BatchInterface $decoratedBatch

BatchInterface that is being decorated

__call()

__call(string  $method, array  $args) : mixed

Allow decorators to implement custom methods

Parameters

string $method

Missing method name

array $args

Method arguments

Returns

mixed

add()

add(mixed  $item) : self

Add an item to the queue

Parameters

mixed $item

Item to add

Returns

self

flush()

flush() : array

Flush the batch and transfer the items

Returns

array —

Returns an array flushed items

isEmpty()

isEmpty() : boolean

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

Returns

boolean

getDecorators()

getDecorators() : array

Trace the decorators associated with the batch

Returns

array

getHistory()

getHistory() : array

Get the batch history

Returns

array

clearHistory()

clearHistory() 

Clear the batch history