S3ClientTrait
A trait providing S3-specific functionality. This is meant to be used in classes implementing \Aws\S3\S3ClientInterface
Table of Contents
- copy() : mixed
- copyAsync() : mixed
- deleteMatchingObjects() : mixed
- deleteMatchingObjectsAsync() : mixed
- determineBucketRegion() : mixed
- determineBucketRegionAsync() : PromiseInterface
- doesBucketExist() : mixed
- doesObjectExist() : mixed
- downloadBucket() : mixed
- downloadBucketAsync() : mixed
- execute() : mixed
- getCommand() : mixed
- getHandlerList() : HandlerList
- getIterator() : Iterator
- registerStreamWrapper() : mixed
- upload() : mixed
- uploadAsync() : mixed
- uploadDirectory() : mixed
- uploadDirectoryAsync() : mixed
- checkExistenceWithCommand() : bool
- Determines whether or not a resource exists using a command
- determineBucketRegionFromExceptionBody() : 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
Return values
mixed —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
Return values
mixed —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
Return values
mixed —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
Return values
mixed —determineBucketRegion()
public
determineBucketRegion(mixed $bucketName) : mixed
Parameters
- $bucketName : mixed
Tags
Return values
mixed —determineBucketRegionAsync()
public
determineBucketRegionAsync(string $bucketName) : PromiseInterface
Parameters
- $bucketName : string
Tags
Return values
PromiseInterface —doesBucketExist()
public
doesBucketExist(mixed $bucket) : mixed
Parameters
- $bucket : mixed
Tags
Return values
mixed —doesObjectExist()
public
doesObjectExist(mixed $bucket, mixed $key[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $bucket : mixed
- $key : mixed
- $options : array<string|int, mixed> = []
Tags
Return values
mixed —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
Return values
mixed —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
Return values
mixed —execute()
public
abstract execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Tags
Return values
mixed —getCommand()
public
abstract getCommand(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Tags
Return values
mixed —getHandlerList()
public
abstract getHandlerList() : HandlerList
Tags
Return values
HandlerList —getIterator()
public
abstract getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : Iterator
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Tags
Return values
Iterator —registerStreamWrapper()
public
registerStreamWrapper() : mixed
Tags
Return values
mixed —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
Return values
mixed —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
Return values
mixed —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
Return values
mixed —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
Return values
mixed —checkExistenceWithCommand()
Determines whether or not a resource exists using a command
private
checkExistenceWithCommand(CommandInterface $command) : bool
Parameters
- $command : CommandInterface
-
Command used to poll for the resource
Tags
Return values
bool —determineBucketRegionFromExceptionBody()
private
determineBucketRegionFromExceptionBody(ResponseInterface $response) : mixed
Parameters
- $response : ResponseInterface