BatchTransferException
extends Exception
in package
implements
GuzzleException
Exception thrown during a batch transfer
Table of Contents
Interfaces
- GuzzleException
- Guzzle exception
Properties
- $batch : array<string|int, mixed>
- $divisorStrategy : BatchDivisorInterface
- $transferredItems : array<string|int, mixed>
- $transferStrategy : BatchTransferInterface
Methods
- __construct() : mixed
- getBatch() : array<string|int, mixed>
- Get the batch that we being sent when the exception occurred
- getDivisorStrategy() : BatchDivisorInterface
- Get the divisor strategy
- getTransferredItems() : array<string|int, mixed>
- Get the items transferred at the point in which the exception was encountered
- getTransferStrategy() : BatchTransferInterface
- Get the transfer strategy
Properties
$batch
protected
array<string|int, mixed>
$batch
The batch being sent when the exception occurred
$divisorStrategy
protected
BatchDivisorInterface
$divisorStrategy
The divisor strategy in use when the exception occurred
$transferredItems
protected
array<string|int, mixed>
$transferredItems
Items transferred at the point in which the exception was encountered
$transferStrategy
protected
BatchTransferInterface
$transferStrategy
The transfer strategy in use when the exception occurred
Methods
__construct()
public
__construct(array<string|int, mixed> $batch, array<string|int, mixed> $transferredItems, Exception $exception[, BatchTransferInterface $transferStrategy = null ][, BatchDivisorInterface $divisorStrategy = null ]) : mixed
Parameters
- $batch : array<string|int, mixed>
-
The batch being sent when the exception occurred
- $transferredItems : array<string|int, mixed>
-
Items transferred at the point in which the exception was encountered
- $exception : Exception
-
Exception encountered
- $transferStrategy : BatchTransferInterface = null
-
The transfer strategy in use when the exception occurred
- $divisorStrategy : BatchDivisorInterface = null
-
The divisor strategy in use when the exception occurred
getBatch()
Get the batch that we being sent when the exception occurred
public
getBatch() : array<string|int, mixed>
Return values
array<string|int, mixed>getDivisorStrategy()
Get the divisor strategy
public
getDivisorStrategy() : BatchDivisorInterface
Return values
BatchDivisorInterfacegetTransferredItems()
Get the items transferred at the point in which the exception was encountered
public
getTransferredItems() : array<string|int, mixed>
Return values
array<string|int, mixed>getTransferStrategy()
Get the transfer strategy
public
getTransferStrategy() : BatchTransferInterface