SDK for PHP V3

RangeGetMultipartDownloader extends AbstractMultipartDownloader
in package

FinalYes

Table of Contents

Constants

GET_OBJECT_COMMAND  = "GetObject"
PART_GET_MULTIPART_DOWNLOADER  = "part"
RANGED_GET_MULTIPART_DOWNLOADER  = "ranged"

Methods

__construct()  : mixed
chooseDownloaderClass()  : string
download()  : DownloadResult
getConfig()  : array<string|int, mixed>
getCurrentPartNo()  : int
getCurrentSnapshot()  : TransferProgressSnapshot
getObjectPartsCount()  : int
getObjectSizeInBytes()  : int
promise()  : PromiseInterface
Returns that resolves a multipart download operation, or to a rejection in case of any failures.

Constants

GET_OBJECT_COMMAND

public mixed GET_OBJECT_COMMAND = "GetObject"

PART_GET_MULTIPART_DOWNLOADER

public mixed PART_GET_MULTIPART_DOWNLOADER = "part"

RANGED_GET_MULTIPART_DOWNLOADER

public mixed RANGED_GET_MULTIPART_DOWNLOADER = "ranged"

Methods

__construct()

public __construct(S3ClientInterface $s3Client, array<string|int, mixed> $downloadRequestArgs[, array<string|int, mixed> $config = [] ][, AbstractDownloadHandler|null $downloadHandler = null ][, int $currentPartNo = 0 ][, int $objectPartsCount = 0 ][, int $objectSizeInBytes = 0 ][, string|null $eTag = null ][, TransferProgressSnapshot|null $currentSnapshot = null ][, TransferListenerNotifier|null $listenerNotifier = null ]) : mixed
Parameters
$s3Client : S3ClientInterface
$downloadRequestArgs : array<string|int, mixed>
$config : array<string|int, mixed> = []
$downloadHandler : AbstractDownloadHandler|null = null
$currentPartNo : int = 0
$objectPartsCount : int = 0
$objectSizeInBytes : int = 0
$eTag : string|null = null
$currentSnapshot : TransferProgressSnapshot|null = null
$listenerNotifier : TransferListenerNotifier|null = null

chooseDownloaderClass()

public static chooseDownloaderClass(mixed $multipartDownloadType) : string
Parameters
$multipartDownloadType : mixed
Return values
string

getConfig()

public getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCurrentPartNo()

public getCurrentPartNo() : int
Return values
int

getObjectPartsCount()

public getObjectPartsCount() : int
Return values
int

getObjectSizeInBytes()

public getObjectSizeInBytes() : int
Return values
int

promise()

Returns that resolves a multipart download operation, or to a rejection in case of any failures.

public promise() : PromiseInterface
Return values
PromiseInterface
<-- modeled_exceptions -->
On this page