Class Guzzle\Batch\Exception\BatchTransferException

InheritanceGuzzle\Batch\Exception\BatchTransferException » Exception
ImplementsGuzzle\Common\Exception\GuzzleException

Exception thrown during a batch transfer

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$batch array The batch being sent when the exception occurred Guzzle\Batch\Exception\BatchTransferException
$divisorStrategy Guzzle\Batch\BatchDivisorInterface The divisor strategy in use when the exception occurred Guzzle\Batch\Exception\BatchTransferException
$transferStrategy Guzzle\Batch\BatchTransferInterface The transfer strategy in use when the exception occurred Guzzle\Batch\Exception\BatchTransferException
$transferredItems array Items transferred at the point in which the exception was encountered Guzzle\Batch\Exception\BatchTransferException

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Guzzle\Batch\Exception\BatchTransferException
getBatch() Get the batch that we being sent when the exception occurred Guzzle\Batch\Exception\BatchTransferException
getDivisorStrategy() Get the divisor strategy Guzzle\Batch\Exception\BatchTransferException
getTransferStrategy() Get the transfer strategy Guzzle\Batch\Exception\BatchTransferException
getTransferredItems() Get the items transferred at the point in which the exception was encountered Guzzle\Batch\Exception\BatchTransferException

Property Details

$batch protected property

The batch being sent when the exception occurred

protected array $batch null
$divisorStrategy protected property

The divisor strategy in use when the exception occurred

$transferStrategy protected property

The transfer strategy in use when the exception occurred

$transferredItems protected property

Items transferred at the point in which the exception was encountered

protected array $transferredItems null

Method Details

__construct() public method

public void __construct ( array $batch, array $transferredItems, Exception $exception, Guzzle\Batch\BatchTransferInterface $transferStrategy null, Guzzle\Batch\BatchDivisorInterface $divisorStrategy null )
$batch array

The batch being sent when the exception occurred

$transferredItems array

Items transferred at the point in which the exception was encountered

$exception Exception

Exception encountered

$transferStrategy Guzzle\Batch\BatchTransferInterface

The transfer strategy in use when the exception occurred

$divisorStrategy Guzzle\Batch\BatchDivisorInterface

The divisor strategy in use when the exception occurred

getBatch() public method

Get the batch that we being sent when the exception occurred

public array getBatch ( )
getDivisorStrategy() public method

Get the divisor strategy

public Guzzle\Batch\BatchDivisorInterface getDivisorStrategy ( )
getTransferStrategy() public method

Get the transfer strategy

public Guzzle\Batch\BatchTransferInterface getTransferStrategy ( )
getTransferredItems() public method

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

public array getTransferredItems ( )