AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

  • AbstractTransfer
  • AbstractTransferState
  • AbstractUploadBuilder
  • AbstractUploadId
  • AbstractUploadPart

Interfaces

  • TransferInterface
  • TransferStateInterface
  • UploadIdInterface
  • UploadPartInterface
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class AbstractTransferState

State of a multipart upload

Aws\Common\Model\MultipartUpload\AbstractTransferState implements Aws\Common\Model\MultipartUpload\TransferStateInterface

Direct known subclasses

Aws\Glacier\Model\MultipartUpload\TransferState, Aws\S3\Model\MultipartUpload\TransferState

Abstract
Namespace: Aws\Common\Model\MultipartUpload
Located at Aws/Common/Model/MultipartUpload/AbstractTransferState.php

Methods summary

  • public __construct ( Aws\Common\Model\MultipartUpload\UploadIdInterface $uploadId )

    Construct a new transfer state object

  • public getUploadId ( )

    Get the params used to identify an upload part

  • public getFromId ( string $key )

    Get a data value from the transfer state's uploadId

  • public getPart ( int $partNumber )

    Get the part information of a specific part

  • public addPart ( Aws\Common\Model\MultipartUpload\UploadPartInterface $part )

    Add a part to the transfer state

  • public hasPart ( int $partNumber )

    Check if a specific part has been uploaded

  • public getPartNumbers ( )

    Get a list of all of the uploaded part numbers

  • public setAborted ( bool $aborted )

    Set whether or not the transfer has been aborted

  • public isAborted ( )

    Check if the transfer has been marked as aborted

  • public count ( )
  • public getIterator ( )
  • public serialize ( )
  • public unserialize ( mixed $serialized )

Methods detail

# public
__construct( Aws\Common\Model\MultipartUpload\UploadIdInterface $uploadId )

Construct a new transfer state object

Parameters

$uploadId
Aws\Common\Model\MultipartUpload\UploadIdInterface
$uploadId Upload identifier object
# public Aws\Common\Model\MultipartUpload\UploadIdInterface
getUploadId( )

Get the params used to identify an upload part

Returns

Aws\Common\Model\MultipartUpload\UploadIdInterface

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::getUploadId()
# public string|null
getFromId( string $key )

Get a data value from the transfer state's uploadId

Parameters

$key
string
$key Key to retrieve (e.g. Bucket, Key, UploadId, etc)

Returns

string|null
# public Aws\Common\Model\MultipartUpload\UploadPartInterface
getPart( integer $partNumber )

Get the part information of a specific part

Parameters

$partNumber
integer
$partNumber Part to retrieve

Returns

Aws\Common\Model\MultipartUpload\UploadPartInterface

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::getPart()
# public Aws\Common\Model\MultipartUpload\AbstractTransferState
addPart( Aws\Common\Model\MultipartUpload\UploadPartInterface $part )

Add a part to the transfer state

Parameters

$part
Aws\Common\Model\MultipartUpload\UploadPartInterface
$part The part to add

Returns

Aws\Common\Model\MultipartUpload\AbstractTransferState

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::addPart()
# public boolean
hasPart( integer $partNumber )

Check if a specific part has been uploaded

Parameters

$partNumber
integer
$partNumber Part to check

Returns

boolean

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::hasPart()
# public array
getPartNumbers( )

Get a list of all of the uploaded part numbers

Returns

array

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::getPartNumbers()
# public Aws\Common\Model\MultipartUpload\AbstractTransferState
setAborted( boolean $aborted )

Set whether or not the transfer has been aborted

Parameters

$aborted
boolean
$aborted Set to true to mark the transfer as aborted

Returns

Aws\Common\Model\MultipartUpload\AbstractTransferState

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::setAborted()
# public boolean
isAborted( )

Check if the transfer has been marked as aborted

Returns

boolean

Implementation of

Aws\Common\Model\MultipartUpload\TransferStateInterface::isAborted()
# public
count( )

Implementation of

Countable::count()
# public
getIterator( )

Implementation of

IteratorAggregate::getIterator()
# public
serialize( )

Implementation of

Serializable::serialize()
# public
unserialize( mixed $serialized )

Implementation of

Serializable::unserialize()

Methods inherited from Aws\Common\Model\MultipartUpload\TransferStateInterface

fromUploadId()

Magic methods summary

Properties summary

protected Aws\Common\Model\MultipartUpload\UploadIdInterface $uploadId
#

Object holding params used to identity the upload part
protected array $parts
#

Array of parts where the part number is the index
protected boolean $aborted
#

Whether or not the transfer was aborted
AWS SDK for PHP API documentation generated by ApiGen 2.8.0