Inheritance diagram for Guzzle\Batch\HistoryBatch:

Public Member Functions
	add ($item)

	clearHistory ()

	getHistory ()

Public Member Functions inherited from Guzzle\Batch\AbstractBatchDecorator
	__call ($method, array $args)

	__construct (BatchInterface $decoratedBatch)

	flush ()

	getDecorators ()

	isEmpty ()

Protected Attributes
	$history = array()

Protected Attributes inherited from Guzzle\Batch\AbstractBatchDecorator
	$decoratedBatch

Detailed Description

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.

Definition at line 9 of file HistoryBatch.php.

Member Function Documentation

◆ add()

Guzzle\Batch\HistoryBatch::add ( $item )

Add an item to the queue

Parameters

mixed $item Item to add

Returns: self

Reimplemented from Guzzle\Batch\AbstractBatchDecorator.

Definition at line 17 of file HistoryBatch.php.

◆ clearHistory()

Guzzle\Batch\HistoryBatch::clearHistory ( )

Clear the batch history

Definition at line 38 of file HistoryBatch.php.

◆ getHistory()

Guzzle\Batch\HistoryBatch::getHistory ( )

Get the batch history

Returns: array

Definition at line 30 of file HistoryBatch.php.

References Guzzle\Batch\HistoryBatch\$history.

Field Documentation

◆ $history

array Guzzle\Batch\HistoryBatch::$history = array()

protected

Items in the history

Definition at line 15 of file HistoryBatch.php.

Referenced by Guzzle\Batch\HistoryBatch\getHistory().

The documentation for this class was generated from the following file:

HistoryBatch.php

Public Member Functions