SDK for PHP 3.x

S3ClientTrait

A trait providing S3-specific functionality. This is meant to be used in classes implementing \Aws\S3\S3ClientInterface

Table of Contents

Methods

copy()  : mixed
copyAsync()  : mixed
deleteMatchingObjects()  : mixed
deleteMatchingObjectsAsync()  : mixed
determineBucketRegion()  : mixed
determineBucketRegionAsync()  : PromiseInterface
doesBucketExist()  : mixed
doesBucketExistV2()  : mixed
doesObjectExist()  : mixed
doesObjectExistV2()  : mixed
downloadBucket()  : mixed
downloadBucketAsync()  : mixed
execute()  : mixed
getCommand()  : mixed
getHandlerList()  : HandlerList
getIterator()  : Iterator
registerStreamWrapper()  : mixed
registerStreamWrapperV2()  : mixed
upload()  : mixed
uploadAsync()  : mixed
uploadDirectory()  : mixed
uploadDirectoryAsync()  : mixed

Methods

copy()

public copy(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []
Tags
see
S3ClientInterface::copy()

copyAsync()

public copyAsync(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []
Tags
see
S3ClientInterface::copyAsync()

deleteMatchingObjects()

public deleteMatchingObjects(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::deleteMatchingObjects()

deleteMatchingObjectsAsync()

public deleteMatchingObjectsAsync(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::deleteMatchingObjectsAsync()

doesBucketExistV2()

public doesBucketExistV2(mixed $bucket[, mixed $accept403 = false ]) : mixed
Parameters
$bucket : mixed
$accept403 : mixed = false
Tags
see
S3ClientInterface::doesBucketExistV2()

doesObjectExist()

public doesObjectExist(mixed $bucket, mixed $key[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::doesObjectExist()

doesObjectExistV2()

public doesObjectExistV2(mixed $bucket, mixed $key[, mixed $includeDeleteMarkers = false ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$includeDeleteMarkers : mixed = false
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::doesObjectExistV2()

downloadBucket()

public downloadBucket(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::downloadBucket()

downloadBucketAsync()

public downloadBucketAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::downloadBucketAsync()

getCommand()

public abstract getCommand(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Tags
see
S3ClientInterface::getCommand()

getHandlerList()

public abstract getHandlerList() : HandlerList
Tags
see
S3ClientInterface::getHandlerList()
Return values
HandlerList

getIterator()

public abstract getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : Iterator
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Tags
see
S3ClientInterface::getIterator()
Return values
Iterator

upload()

public upload(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::upload()

uploadAsync()

public uploadAsync(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadAsync()

uploadDirectory()

public uploadDirectory(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadDirectory()

uploadDirectoryAsync()

public uploadDirectoryAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::uploadDirectoryAsync()
On this page