Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • AbstractBatchDecorator
  • Batch
  • BatchBuilder
  • BatchClosureDivisor
  • BatchClosureTransfer
  • BatchCommandTransfer
  • BatchRequestTransfer
  • BatchSizeDivisor
  • ExceptionBufferingBatch
  • FlushingBatch
  • HistoryBatch
  • NotifyingBatch

Interfaces

  • BatchDivisorInterface
  • BatchInterface
  • BatchTransferInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class FlushingBatch

BatchInterface decorator used to add automatic flushing of the queue when the size of the queue reaches a threshold.

Guzzle\Batch\AbstractBatchDecorator implements Guzzle\Batch\BatchInterface
Extended by Guzzle\Batch\FlushingBatch
Namespace: Guzzle\Batch
Located at src/Guzzle/Batch/FlushingBatch.php
Methods summary
public
# __construct( Guzzle\Batch\BatchInterface $decoratedBatch, integer $threshold )

Parameters

$decoratedBatch
BatchInterface that is being decorated
$threshold
Flush when the number in queue matches the threshold

Overrides

Guzzle\Batch\AbstractBatchDecorator::__construct()
public Guzzle\Batch\FlushingBatch
# setThreshold( integer $threshold )

Set the auto-flush threshold

Set the auto-flush threshold

Parameters

$threshold
The auto-flush threshold

Returns

Guzzle\Batch\FlushingBatch
public integer
# getThreshold( )

Get the auto-flush threshold

Get the auto-flush threshold

Returns

integer
public Guzzle\Batch\FlushingBatch
# add( mixed $item )

Add an item to the queue

Add an item to the queue

Parameters

$item
Item to add

Returns

Guzzle\Batch\FlushingBatch

Overrides

Guzzle\Batch\AbstractBatchDecorator::add()
Methods inherited from Guzzle\Batch\AbstractBatchDecorator
__call(), flush(), getDecorators(), isEmpty()
Properties summary
protected integer $threshold

The threshold for which to automatically flush

The threshold for which to automatically flush

#
protected integer $currentTotal

Current number of items known to be in the queue

Current number of items known to be in the queue

# 0
Properties inherited from Guzzle\Batch\AbstractBatchDecorator
$decoratedBatch
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen