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

# Class DeleteObjectsBatch

The DeleteObjectsBatch is a BatchDecorator for Guzzle that implements a queue for deleting keys from an Amazon S3 bucket. You can add DeleteObject or an array of [Key => %s, VersionId => %s] and call flush when the objects should be deleted.

  Guzzle\Batch\AbstractBatchDecorator implements Guzzle\Batch\BatchInterface
  Aws\S3\Model\DeleteObjectsBatch

Namespace: Aws\S3\Model
Located at Aws/S3/Model/DeleteObjectsBatch.php

## Methods summary

- `public static` `factory ( Aws\Common\Client\AwsClientInterface $client, string $bucket, string $mfa = null )`

  Factory for creating a DeleteObjectsBatch

- `public` `addKey ( string $key, string $versionId = null )`

  Add an object to be deleted

- `public` `add ( mixed $item )`

  Add an item to the queue

## Methods detail

# `public static static`
`factory( `Aws\Common\Client\AwsClientInterface` $client, string $bucket, string $mfa = null )`

Factory for creating a DeleteObjectsBatch

#### Parameters

$client
  ``Aws\Common\Client\AwsClientInterface``
  $client Client used to transfer requests
$bucket
  `string`
  $bucket Bucket that contains the objects to delete
$mfa
  `string`
  $mfa MFA token to use with the request

#### Returns

`static`
# `public mixed`
`addKey( string $key, string $versionId = null )`

Add an object to be deleted

#### Parameters

$key
  `string`
  $key Key of the object
$versionId
  `string`
  $versionId VersionID of the object

#### Returns

`mixed`
$this
# `public `Aws\S3\Model\DeleteObjectsBatch``
`add( mixed $item )`

Add an item to the queue

#### Parameters

$item
  `mixed`
  $item Item to add

#### Returns

``Aws\S3\Model\DeleteObjectsBatch``

#### Overrides

`Guzzle\Batch\AbstractBatchDecorator::add`

### Methods inherited from Guzzle\Batch\AbstractBatchDecorator

`__call()`, `__construct()`, `flush()`, `getDecorators()`, `isEmpty()`

### Magic methods summary

## Properties summary

### Properties inherited from Guzzle\Batch\AbstractBatchDecorator

`$decoratedBatch`