Class AbstractBatchDecorator
Abstract decorator used when decorating a BatchInterface
- Guzzle\Batch\AbstractBatchDecorator implements Guzzle\Batch\BatchInterface
Direct known subclasses
Aws\DynamoDb\Model\BatchRequest\WriteRequestBatch
,
Aws\S3\Model\DeleteObjectsBatch
,
Guzzle\Batch\ExceptionBufferingBatch
,
Guzzle\Batch\FlushingBatch
,
Guzzle\Batch\HistoryBatch
,
Guzzle\Batch\NotifyingBatch
Methods summary
-
public
__construct ( Guzzle\Batch\BatchInterface $decoratedBatch )
-
public
__call ( string $method, array $args )
Allow decorators to implement custom methods
-
public
add ( mixed $item )
Add an item to the queue
-
public
flush ( )
Flush the batch and transfer the items
-
public
isEmpty ( )
Check if the batch is empty and has further items to transfer
-
public
getDecorators ( )
Trace the decorators associated with the batch
Methods detail
Parameters
- $decoratedBatch
Guzzle\Batch\BatchInterface
$decoratedBatch BatchInterface that is being decorated
Allow decorators to implement custom methods
Parameters
- $method
string
$method Missing method name- $args
array
$args Method arguments
Returns
mixed
CodeCoverageIgnore
Add an item to the queue
Parameters
- $item
mixed
$item Item to add
Returns
Implementation of
Flush the batch and transfer the items
Returns
array
Returns an array flushed items
Implementation of
Check if the batch is empty and has further items to transfer
Returns
boolean
Implementation of
Trace the decorators associated with the batch
Returns
array
Magic methods summary
Properties summary
protected
|
$decoratedBatch |
#
Decorated batch object |