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

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

Interfaces

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

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
Deprecated: Will be removed in a future version and is no longer maintained. Use the Batch\ abstractions instead.
Codecoverageignore
Located at src/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 )

Parameters

$iterator
Resource iterator to apply a callback to
$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
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

Total number of sent batches

Total number of sent batches

# 0
protected integer $iterated

Total number of iterated resources

Total number of iterated resources

# 0
Properties inherited from Guzzle\Common\AbstractHasDispatcher
$eventDispatcher
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen