Open Journal Systems  3.3.0
Guzzle\Batch\ExceptionBufferingBatch Class Reference
Inheritance diagram for Guzzle\Batch\ExceptionBufferingBatch:
Guzzle\Batch\AbstractBatchDecorator Guzzle\Batch\BatchInterface

Public Member Functions

 clearExceptions ()
 
 flush ()
 
 getExceptions ()
 
- Public Member Functions inherited from Guzzle\Batch\AbstractBatchDecorator
 __call ($method, array $args)
 
 __construct (BatchInterface $decoratedBatch)
 
 add ($item)
 
 getDecorators ()
 
 isEmpty ()
 

Protected Attributes

 $exceptions = array()
 
- Protected Attributes inherited from Guzzle\Batch\AbstractBatchDecorator
 $decoratedBatch
 

Detailed Description

BatchInterface decorator used to buffer exceptions encountered during a transfer. The exceptions can then later be processed after a batch flush has completed.

Definition at line 11 of file ExceptionBufferingBatch.php.

Member Function Documentation

◆ clearExceptions()

Guzzle\Batch\ExceptionBufferingBatch::clearExceptions ( )

Clear the buffered exceptions

Definition at line 49 of file ExceptionBufferingBatch.php.

◆ flush()

Guzzle\Batch\ExceptionBufferingBatch::flush ( )

Flush the batch and transfer the items

Returns
array Returns an array flushed items

Reimplemented from Guzzle\Batch\AbstractBatchDecorator.

Definition at line 19 of file ExceptionBufferingBatch.php.

References Guzzle\Batch\Exception\BatchTransferException\getTransferredItems().

◆ getExceptions()

Guzzle\Batch\ExceptionBufferingBatch::getExceptions ( )

Get the buffered exceptions

Returns
array Array of BatchTransferException objects

Definition at line 41 of file ExceptionBufferingBatch.php.

References Guzzle\Batch\ExceptionBufferingBatch\$exceptions.

Field Documentation

◆ $exceptions

array Guzzle\Batch\ExceptionBufferingBatch::$exceptions = array()
protected

Array of BatchTransferException exceptions

Definition at line 17 of file ExceptionBufferingBatch.php.

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


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