Documentation

UploadId extends AbstractUploadId
in package

An object that encapsulates the identification for a Glacier upload part

Tags
codeCoverageIgnore

Table of Contents

Properties

$data  : array<string|int, mixed>
$expectedValues  : array<string|int, mixed>

Methods

fromParams()  : self
Create an UploadId from an array
serialize()  : mixed
{@inheritdoc}
toParams()  : array<string|int, mixed>
Returns the array form of the upload identification for use as command params
unserialize()  : mixed
{@inheritdoc}
loadData()  : mixed
Loads an array of data into the UploadId by extracting only the needed keys

Properties

$data

protected array<string|int, mixed> $data = array()

Params representing the identifying information

$expectedValues

protected static array<string|int, mixed> $expectedValues = array('Bucket' => false, 'Key' => false, 'UploadId' => false)

Expected values (with defaults)

Methods

fromParams()

Create an UploadId from an array

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

Data representing the upload identification

Return values
self

toParams()

Returns the array form of the upload identification for use as command params

public toParams() : 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 UploadId by extracting only the needed keys

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

Data to load

Tags
throws
InvalidArgumentException

if a required key is missing


        
On this page

Search results