UploadState
in package
Representation of the multipart upload.
This object keeps track of the state of the upload, including the status and which parts have been uploaded.
Table of Contents
- COMPLETED = 2
- CREATED = 0
- INITIATED = 1
- $id : array<string|int, mixed>
- $partSize : int
- $status : int
- $uploadedParts : array<string|int, mixed>
- __construct() : mixed
- getId() : array<string|int, mixed>
- Get the upload's ID, which is a tuple of parameters that can uniquely identify the upload.
- getPartSize() : int
- Get the part size.
- getUploadedParts() : array<string|int, mixed>
- Returns a sorted list of all the uploaded parts.
- hasPartBeenUploaded() : bool
- Returns whether a part has been uploaded.
- isCompleted() : bool
- Determines whether the upload state is in the COMPLETED status.
- isInitiated() : bool
- Determines whether the upload state is in the INITIATED status.
- markPartAsUploaded() : mixed
- Marks a part as being uploaded.
- setPartSize() : mixed
- Set the part size.
- setStatus() : mixed
- Set the status of the upload.
- setUploadId() : mixed
- Set's the "upload_id", or 3rd part of the upload's ID. This typically only needs to be done after initiating an upload.
Constants
COMPLETED
public
mixed
COMPLETED
= 2
CREATED
public
mixed
CREATED
= 0
INITIATED
public
mixed
INITIATED
= 1
Properties
$id
private
array<string|int, mixed>
$id
Params used to identity the upload.
$partSize
private
int
$partSize
Part size being used by the upload.
$status
private
int
$status
= self::CREATED
Identifies the status the upload.
$uploadedParts
private
array<string|int, mixed>
$uploadedParts
= []
Parts that have been uploaded.
Methods
__construct()
public
__construct(array<string|int, mixed> $id) : mixed
Parameters
- $id : array<string|int, mixed>
-
Params used to identity the upload.
Return values
mixed —getId()
Get the upload's ID, which is a tuple of parameters that can uniquely identify the upload.
public
getId() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPartSize()
Get the part size.
public
getPartSize() : int
Return values
int —getUploadedParts()
Returns a sorted list of all the uploaded parts.
public
getUploadedParts() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasPartBeenUploaded()
Returns whether a part has been uploaded.
public
hasPartBeenUploaded(int $partNumber) : bool
Parameters
- $partNumber : int
-
The part number.
Return values
bool —isCompleted()
Determines whether the upload state is in the COMPLETED status.
public
isCompleted() : bool
Return values
bool —isInitiated()
Determines whether the upload state is in the INITIATED status.
public
isInitiated() : bool
Return values
bool —markPartAsUploaded()
Marks a part as being uploaded.
public
markPartAsUploaded(int $partNumber[, array<string|int, mixed> $partData = [] ]) : mixed
Parameters
- $partNumber : int
-
The part number.
- $partData : array<string|int, mixed> = []
-
Data from the upload operation that needs to be recalled during the complete operation.
Return values
mixed —setPartSize()
Set the part size.
public
setPartSize( $partSize) : mixed
Parameters
Return values
mixed —setStatus()
Set the status of the upload.
public
setStatus(int $status) : mixed
Parameters
- $status : int
-
Status is an integer code defined by the constants CREATED, INITIATED, and COMPLETED on this class.
Return values
mixed —setUploadId()
Set's the "upload_id", or 3rd part of the upload's ID. This typically only needs to be done after initiating an upload.
public
setUploadId(string $key, string $value) : mixed
Parameters
- $key : string
-
The param key of the upload_id.
- $value : string
-
The param value of the upload_id.