SDK for PHP V3
S3TransferManager
in package
FinalYes
Table of Contents
Methods
- __construct() : mixed
- download() : PromiseInterface
- downloadDirectory() : PromiseInterface
- downloadFile() : PromiseInterface
- getConfig() : S3TransferManagerConfig
- getS3Client() : S3ClientInterface
- isValidS3URI() : bool
- Validates a string value is a valid S3 URI.
- s3UriAsBucketAndKey() : array<string|int, mixed>
- Converts a S3 URI into an array with a Bucket and Key properties set.
- upload() : PromiseInterface
- uploadDirectory() : PromiseInterface
Methods
__construct()
public
__construct([S3ClientInterface|null $s3Client = null ][, array<string|int, mixed>|S3TransferManagerConfig|null $config = null ]) : mixed
Parameters
- $s3Client : S3ClientInterface|null = null
-
If provided as null then, a default client will be created where its region will be the one resolved from either the default from the config or the provided.
- $config : array<string|int, mixed>|S3TransferManagerConfig|null = null
download()
public
download(DownloadRequest $downloadRequest) : PromiseInterface
Parameters
- $downloadRequest : DownloadRequest
Return values
PromiseInterfacedownloadDirectory()
public
downloadDirectory(DownloadDirectoryRequest $downloadDirectoryRequest) : PromiseInterface
Parameters
- $downloadDirectoryRequest : DownloadDirectoryRequest
Return values
PromiseInterfacedownloadFile()
public
downloadFile(DownloadFileRequest $downloadFileRequest) : PromiseInterface
Parameters
- $downloadFileRequest : DownloadFileRequest
Return values
PromiseInterfacegetConfig()
public
getConfig() : S3TransferManagerConfig
Return values
S3TransferManagerConfiggetS3Client()
public
getS3Client() : S3ClientInterface
Return values
S3ClientInterfaceisValidS3URI()
Validates a string value is a valid S3 URI.
public
static isValidS3URI(string $uri) : bool
Valid S3 URI Example: S3://mybucket.dev/myobject.txt
Parameters
- $uri : string
Return values
bools3UriAsBucketAndKey()
Converts a S3 URI into an array with a Bucket and Key properties set.
public
static s3UriAsBucketAndKey(string $uri) : array<string|int, mixed>
Parameters
- $uri : string
Return values
array<string|int, mixed>upload()
public
upload(UploadRequest $uploadRequest) : PromiseInterface
Parameters
- $uploadRequest : UploadRequest
Return values
PromiseInterfaceuploadDirectory()
public
uploadDirectory(UploadDirectoryRequest $uploadDirectoryRequest) : PromiseInterface
Parameters
- $uploadDirectoryRequest : UploadDirectoryRequest