TransferStateInterface
extends
Countable, IteratorAggregate, Serializable
in
State of a multipart upload
Table of Contents
Methods
- addPart() : self
- Add a part to the transfer state
- fromUploadId() : self
- Create the transfer state from the results of list parts request
- getPart() : UploadPartInterface
- Get the part information of a specific part
- getPartNumbers() : array<string|int, mixed>
- Get a list of all of the uploaded part numbers
- getUploadId() : UploadIdInterface
- Get the params used to identify an upload part
- hasPart() : bool
- Check if a specific part has been uploaded
- isAborted() : bool
- Check if the transfer has been marked as aborted
- setAborted() : self
- Set whether or not the transfer has been aborted
Methods
addPart()
Add a part to the transfer state
public
addPart(UploadPartInterface $part) : self
Parameters
- $part : UploadPartInterface
-
The part to add
Return values
selffromUploadId()
Create the transfer state from the results of list parts request
public
static fromUploadId(AwsClientInterface $client, UploadIdInterface $uploadId) : self
Parameters
- $client : AwsClientInterface
-
Client used to send the request
- $uploadId : UploadIdInterface
-
Params needed to identify the upload and form the request
Return values
selfgetPart()
Get the part information of a specific part
public
getPart(int $partNumber) : UploadPartInterface
Parameters
- $partNumber : int
-
Part to retrieve
Return values
UploadPartInterfacegetPartNumbers()
Get a list of all of the uploaded part numbers
public
getPartNumbers() : array<string|int, mixed>
Return values
array<string|int, mixed>getUploadId()
Get the params used to identify an upload part
public
getUploadId() : UploadIdInterface
Return values
UploadIdInterfacehasPart()
Check if a specific part has been uploaded
public
hasPart(int $partNumber) : bool
Parameters
- $partNumber : int
-
Part to check
Return values
boolisAborted()
Check if the transfer has been marked as aborted
public
isAborted() : bool
Return values
boolsetAborted()
Set whether or not the transfer has been aborted
public
setAborted(bool $aborted) : self
Parameters
- $aborted : bool
-
Set to true to mark the transfer as aborted