AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • 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
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

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

Interfaces

  • BatchDivisorInterface
  • BatchInterface
  • BatchTransferInterface
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class AbstractBatchDecorator

Abstract decorator used when decorating a BatchInterface

Guzzle\Batch\AbstractBatchDecorator implements Guzzle\Batch\BatchInterface

Direct known subclasses

Aws\DynamoDb\Model\BatchRequest\WriteRequestBatch, Aws\S3\Model\DeleteObjectsBatch, Guzzle\Batch\ExceptionBufferingBatch, Guzzle\Batch\FlushingBatch, Guzzle\Batch\HistoryBatch, Guzzle\Batch\NotifyingBatch

Abstract
Namespace: Guzzle\Batch
Located at Guzzle/Batch/AbstractBatchDecorator.php

Methods summary

  • public __construct ( Guzzle\Batch\BatchInterface $decoratedBatch )
  • public __call ( string $method, array $args )

    Allow decorators to implement custom methods

  • public add ( mixed $item )

    Add an item to the queue

  • public flush ( )

    Flush the batch and transfer the items

  • public isEmpty ( )

    Check if the batch is empty and has further items to transfer

  • public getDecorators ( )

    Trace the decorators associated with the batch

Methods detail

# public
__construct( Guzzle\Batch\BatchInterface $decoratedBatch )

Parameters

$decoratedBatch
Guzzle\Batch\BatchInterface
$decoratedBatch BatchInterface that is being decorated
# public mixed
__call( string $method, array $args )

Allow decorators to implement custom methods

Parameters

$method
string
$method Missing method name
$args
array
$args Method arguments

Returns

mixed

CodeCoverageIgnore

# public Guzzle\Batch\AbstractBatchDecorator
add( mixed $item )

Add an item to the queue

Parameters

$item
mixed
$item Item to add

Returns

Guzzle\Batch\AbstractBatchDecorator

Implementation of

Guzzle\Batch\BatchInterface::add()
# public array
flush( )

Flush the batch and transfer the items

Returns

array
Returns an array flushed items

Implementation of

Guzzle\Batch\BatchInterface::flush()
# public boolean
isEmpty( )

Check if the batch is empty and has further items to transfer

Returns

boolean

Implementation of

Guzzle\Batch\BatchInterface::isEmpty()
# public array
getDecorators( )

Trace the decorators associated with the batch

Returns

array

Magic methods summary

Properties summary

protected Guzzle\Batch\BatchInterface $decoratedBatch
#

Decorated batch object

AWS SDK for PHP API documentation generated by ApiGen 2.8.0