DeleteObjectsTransfer
in package
implements
BatchTransferInterface
Transfer logic for deleting multiple objects from an Amazon S3 bucket in a single request
Table of Contents
Interfaces
- BatchTransferInterface
- Interface used for transferring batches of items
Properties
- $bucket : string
- $client : AwsClientInterface
- $mfa : string
Methods
- __construct() : mixed
- Constructs a transfer using the injected client
- setMfa() : $this
- Set a new MFA token value
- transfer() : mixed
- Transfer an array of items
- processResponse() : mixed
- Process the response of the DeleteMultipleObjects request
Properties
$bucket
protected
string
$bucket
Bucket from which to delete the objects
$client
protected
AwsClientInterface
$client
The Amazon S3 client for doing transfers
$mfa
protected
string
$mfa
MFA token to apply to the request
Methods
__construct()
Constructs a transfer using the injected client
public
__construct(AwsClientInterface $client, string $bucket[, string $mfa = null ]) : mixed
Parameters
- $client : AwsClientInterface
-
Client used to transfer the requests
- $bucket : string
-
Name of the bucket that stores the objects
- $mfa : string = null
-
MFA token used when contacting the Amazon S3 API
setMfa()
Set a new MFA token value
public
setMfa(string $token) : $this
Parameters
- $token : string
-
MFA token
Return values
$thistransfer()
Transfer an array of items
public
transfer(array<string|int, mixed> $batch) : mixed
Parameters
- $batch : array<string|int, mixed>
-
Array of items to transfer
Tags
processResponse()
Process the response of the DeleteMultipleObjects request
protected
processResponse(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface