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

  • AbstractResourceIteratorFactory
  • CompositeResourceIteratorFactory
  • MapResourceIteratorFactory
  • Model
  • ResourceIterator
  • ResourceIteratorApplyBatched
  • ResourceIteratorClassFactory

Interfaces

  • ResourceIteratorFactoryInterface
  • ResourceIteratorInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class ResourceIteratorApplyBatched

Apply a callback to the contents of a Guzzle\Service\Resource\ResourceIteratorInterface

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
Extended by Guzzle\Service\Resource\ResourceIteratorApplyBatched
Namespace: Guzzle\Service\Resource
Located at Guzzle/Service/Resource/ResourceIteratorApplyBatched.php
Methods summary
public static array
# getAllEvents( )

Get a list of all of the events emitted from the class

Get a list of all of the events emitted from the class

Returns

array

Overrides

Guzzle\Common\AbstractHasDispatcher::getAllEvents()
public
# __construct( Guzzle\Service\Resource\ResourceIteratorInterface $iterator, array|callable $callback )

Constructor

Constructor

Parameters

$iterator
Guzzle\Service\Resource\ResourceIteratorInterface
$iterator Resource iterator to apply a callback to
$callback
array|callable
$callback Callback method accepting the resource iterator and an array of the iterator's current resources
public integer
# apply( integer $perBatch = 50 )

Apply the callback to the contents of the resource iterator

Apply the callback to the contents of the resource iterator

Parameters

$perBatch
integer
$perBatch The number of records to group per batch transfer

Returns

integer
Returns the number of iterated resources
public integer
# getBatchCount( )

Get the total number of batches sent

Get the total number of batches sent

Returns

integer
public integer
# getIteratedCount( )

Get the total number of iterated resources

Get the total number of iterated resources

Returns

integer
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(), dispatch(), getEventDispatcher(), setEventDispatcher()
Properties summary
protected callable|array $callback
#
protected Guzzle\Service\Resource\ResourceIteratorInterface $iterator
#
protected integer $batches 0
#

Total number of sent batches

Total number of sent batches

protected integer $iterated 0
#

Total number of iterated resources

Total number of iterated resources

Properties inherited from Guzzle\Common\AbstractHasDispatcher
$eventDispatcher
php-coveralls API documentation generated by ApiGen 2.8.0