Guzzle\Batch\Exception\BatchTransferException Class Reference

Inheritance diagram for Guzzle\Batch\Exception\BatchTransferException:

Public Member Functions
	__construct (array $batch, array $transferredItems, \Exception $exception, TransferStrategy $transferStrategy=null, DivisorStrategy $divisorStrategy=null)
	getBatch ()
	getDivisorStrategy ()
	getTransferredItems ()
	getTransferStrategy ()

Protected Attributes
	$batch
	$divisorStrategy
	$transferredItems
	$transferStrategy

Detailed Description

Exception thrown during a batch transfer

Definition at line 12 of file BatchTransferException.php.

Constructor & Destructor Documentation

__construct()

Guzzle\Batch\Exception\BatchTransferException::__construct	(	array	$batch,
		array	$transferredItems,
		\Exception	$exception,
		TransferStrategy	$transferStrategy = null,
		DivisorStrategy	$divisorStrategy = null
	)

Parameters

array	$batch	The batch being sent when the exception occurred
array	$transferredItems	Items transferred at the point in which the exception was encountered
\Exception	$exception	Exception encountered
TransferStrategy	$transferStrategy	The transfer strategy in use when the exception occurred
DivisorStrategy	$divisorStrategy	The divisor strategy in use when the exception occurred

Definition at line 45 of file BatchTransferException.php.

References Guzzle\Batch\Exception\BatchTransferException\$batch, Guzzle\Batch\Exception\BatchTransferException\$divisorStrategy, Guzzle\Batch\Exception\BatchTransferException\$transferredItems, and Guzzle\Batch\Exception\BatchTransferException\$transferStrategy.

Member Function Documentation

getBatch()

Guzzle\Batch\Exception\BatchTransferException::getBatch

(

)

Get the batch that we being sent when the exception occurred

Returns

array

Definition at line 68 of file BatchTransferException.php.

References Guzzle\Batch\Exception\BatchTransferException\$batch.

Referenced by Guzzle\Tests\Batch\BatchTest\testThrowsExceptionContainingTheFailedBatch().

getDivisorStrategy()

Guzzle\Batch\Exception\BatchTransferException::getDivisorStrategy

(

)

Get the divisor strategy

Returns

DivisorStrategy

Definition at line 98 of file BatchTransferException.php.

References Guzzle\Batch\Exception\BatchTransferException\$divisorStrategy.

getTransferredItems()

Guzzle\Batch\Exception\BatchTransferException::getTransferredItems

(

)

Get the items transferred at the point in which the exception was encountered

Returns

array

Definition at line 78 of file BatchTransferException.php.

References Guzzle\Batch\Exception\BatchTransferException\$transferredItems.

Referenced by Guzzle\Batch\ExceptionBufferingBatch\flush().

getTransferStrategy()

Guzzle\Batch\Exception\BatchTransferException::getTransferStrategy

(

)

Get the transfer strategy

Returns

TransferStrategy

Definition at line 88 of file BatchTransferException.php.

References Guzzle\Batch\Exception\BatchTransferException\$transferStrategy.

Field Documentation

$batch

array Guzzle\Batch\Exception\BatchTransferException::$batch

protected

The batch being sent when the exception occurred

Definition at line 18 of file BatchTransferException.php.

Referenced by Guzzle\Batch\Exception\BatchTransferException\__construct(), and Guzzle\Batch\Exception\BatchTransferException\getBatch().

$divisorStrategy

DivisorStrategy Guzzle\Batch\Exception\BatchTransferException::$divisorStrategy

protected

The divisor strategy in use when the exception occurred

Definition at line 30 of file BatchTransferException.php.

Referenced by Guzzle\Batch\Exception\BatchTransferException\__construct(), and Guzzle\Batch\Exception\BatchTransferException\getDivisorStrategy().

$transferredItems

array Guzzle\Batch\Exception\BatchTransferException::$transferredItems

protected

Items transferred at the point in which the exception was encountered

Definition at line 36 of file BatchTransferException.php.

Referenced by Guzzle\Batch\Exception\BatchTransferException\__construct(), and Guzzle\Batch\Exception\BatchTransferException\getTransferredItems().

$transferStrategy

TransferStrategy Guzzle\Batch\Exception\BatchTransferException::$transferStrategy

protected

The transfer strategy in use when the exception occurred

Definition at line 24 of file BatchTransferException.php.

Referenced by Guzzle\Batch\Exception\BatchTransferException\__construct(), and Guzzle\Batch\Exception\BatchTransferException\getTransferStrategy().

---

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

• BatchTransferException.php