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

Public Member Functions

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

Protected Attributes

 $callable
 
- Protected Attributes inherited from Guzzle\Batch\AbstractBatchDecorator
 $decoratedBatch
 

Detailed Description

BatchInterface decorator used to call a method each time flush is called

Definition at line 10 of file NotifyingBatch.php.

Constructor & Destructor Documentation

◆ __construct()

Guzzle\Batch\NotifyingBatch::__construct ( BatchInterface  $decoratedBatch,
  $callable 
)
Parameters
BatchInterface$decoratedBatchBatch object to decorate
mixed$callableCallable to call
Exceptions
InvalidArgumentException

Definition at line 24 of file NotifyingBatch.php.

References Guzzle\Batch\NotifyingBatch\$callable, and Guzzle\Batch\AbstractBatchDecorator\$decoratedBatch.

Member Function Documentation

◆ flush()

Guzzle\Batch\NotifyingBatch::flush ( )

Flush the batch and transfer the items

Returns
array Returns an array flushed items

Reimplemented from Guzzle\Batch\AbstractBatchDecorator.

Definition at line 34 of file NotifyingBatch.php.

Field Documentation

◆ $callable

mixed Guzzle\Batch\NotifyingBatch::$callable
protected

Callable to call

Definition at line 16 of file NotifyingBatch.php.

Referenced by Guzzle\Batch\NotifyingBatch\__construct().


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