Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • 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
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

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

Interfaces

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

Class BatchClosureDivisor

Divides batches using a callable

Guzzle\Batch\BatchClosureDivisor implements Guzzle\Batch\BatchDivisorInterface
Namespace: Guzzle\Batch
Located at Guzzle/Batch/BatchClosureDivisor.php
Methods summary
public
# __construct( callable $callable, mixed $context = null )

Parameters

$callable
callable
$callable Method used to divide the batches. The method must accept an \SplQueue and return an array of arrays containing the divided items.
$context
mixed
$context Optional context to pass to the batch divisor

Throws

Guzzle\Common\Exception\InvalidArgumentException
if the callable is not callable
public array|Traversable
# createBatches( SplQueue $queue )

Divide a queue of items into an array batches

Divide a queue of items into an array batches

Parameters

$queue
SplQueue
$queue Queue of items to divide into batches. Items are removed as they are iterated.

Returns

array|Traversable
Returns an array or Traversable object that contains arrays of items to transfer

Implementation of

Guzzle\Batch\BatchDivisorInterface::createBatches()
Properties summary
protected callable $callable
#

Method used to divide the batches

Method used to divide the batches

protected mixed $context
#

$context Context passed to the callable

$context Context passed to the callable

php-coveralls API documentation generated by ApiGen 2.8.0