Documentation

UploadPart extends AbstractUploadPart
in package

An object that encapsulates the data for a Glacier upload operation

Table of Contents

Properties

$eTag  : string
$keyMap  : array<string|int, mixed>
$lastModified  : string
$partNumber  : int
$size  : int

Methods

fromArray()  : self
Create an upload part from an array
getETag()  : string
getLastModified()  : string
getPartNumber()  : int
Returns the part number of the upload part which is used as an identifier
getSize()  : int
serialize()  : mixed
{@inheritdoc}
toArray()  : array<string|int, mixed>
Returns the array form of the upload part
unserialize()  : mixed
{@inheritdoc}
loadData()  : mixed
Loads an array of data into the upload part by extracting only the needed keys

Properties

$eTag

protected string $eTag

The ETag for this part

$keyMap

protected static array<string|int, mixed> $keyMap = array('PartNumber' => 'partNumber', 'ETag' => 'eTag', 'LastModified' => 'lastModified', 'Size' => 'size')

A map of external array keys to internal property names

$lastModified

protected string $lastModified

The last modified date

$partNumber

protected int $partNumber

The number of the upload part representing its order in the overall upload

$size

protected int $size

The size (or content-length) in bytes of the upload body

Methods

fromArray()

Create an upload part from an array

public static fromArray(mixed $data) : self
Parameters
$data : mixed

Data representing the upload part

Return values
self

getETag()

public getETag() : string
Return values
string

getLastModified()

public getLastModified() : string
Return values
string

getPartNumber()

Returns the part number of the upload part which is used as an identifier

public getPartNumber() : int
Return values
int

getSize()

public getSize() : int
Return values
int

toArray()

Returns the array form of the upload part

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

unserialize()

{@inheritdoc}

public unserialize(mixed $serialized) : mixed
Parameters
$serialized : mixed

loadData()

Loads an array of data into the upload part by extracting only the needed keys

protected loadData(array<string|int, mixed>|Traversable $data) : mixed
Parameters
$data : array<string|int, mixed>|Traversable

Data to load into the upload part value object

Tags
throws
InvalidArgumentException

if a required key is missing


        
On this page

Search results