Documentation

MultipartCopy extends AbstractUploadManager
in package
Uses MultipartUploadingTrait

Table of Contents

$source  : string
$sourceMetadata  : ResultInterface
__construct()  : mixed
Creates a multipart upload for copying an S3 object.
copy()  : mixed
An alias of the self::upload method.
getStateFromService()  : UploadState
Creates an UploadState object for a multipart upload by querying the service for the specified upload's information.
determinePartSize()  : mixed
extractETag()  : mixed
getCompleteParams()  : mixed
getConfig()  : array<string|int, mixed>
getInitiateParams()  : mixed
getSourceMimeType()  : mixed
getSourceSize()  : mixed
getState()  : UploadState
getUploadCommands()  : mixed
handleResult()  : mixed
loadUploadWorkflowInfo()  : mixed
createPart()  : mixed
fetchSourceMetadata()  : mixed
getSourceMetadata()  : mixed

Properties

Methods

__construct()

Creates a multipart upload for copying an S3 object.

public __construct(S3ClientInterface $client, string $source[, array<string|int, mixed> $config = [] ]) : mixed

The valid configuration options are as follows:

  • acl: (string) ACL to set on the object being upload. Objects are private by default.
  • before_complete: (callable) Callback to invoke before the CompleteMultipartUpload operation. The callback should have a function signature like function (Aws\Command $command) {...}.
  • before_initiate: (callable) Callback to invoke before the CreateMultipartUpload operation. The callback should have a function signature like function (Aws\Command $command) {...}.
  • before_upload: (callable) Callback to invoke before UploadPartCopy operations. The callback should have a function signature like function (Aws\Command $command) {...}.
  • bucket: (string, required) Name of the bucket to which the object is being uploaded.
  • concurrency: (int, default=int(5)) Maximum number of concurrent UploadPart operations allowed during the multipart upload.
  • key: (string, required) Key to use for the object being uploaded.
  • params: (array) An array of key/value parameters that will be applied to each of the sub-commands run by the uploader as a base. Auto-calculated options will override these parameters. If you need more granularity over parameters to each sub-command, use the before_* options detailed above to update the commands directly.
  • part_size: (int, default=int(5242880)) Part size, in bytes, to use when doing a multipart upload. This must between 5 MB and 5 GB, inclusive.
  • state: (Aws\Multipart\UploadState) An object that represents the state of the multipart upload and that is used to resume a previous upload. When this option is provided, the bucket, key, and part_size options are ignored.
  • source_metadata: (Aws\ResultInterface) An object that represents the result of executing a HeadObject command on the copy source.
Parameters
$client : S3ClientInterface

Client used for the upload.

$source : string

Location of the data to be copied (in the form //).

$config : array<string|int, mixed> = []

Configuration used to perform the upload.

Return values
mixed —

copy()

An alias of the self::upload method.

public copy() : mixed
Tags
see
self::upload
Return values
mixed —

getStateFromService()

Creates an UploadState object for a multipart upload by querying the service for the specified upload's information.

public static getStateFromService(S3ClientInterface $client, string $bucket, string $key, string $uploadId) : UploadState
Parameters
$client : S3ClientInterface

S3Client used for the upload.

$bucket : string

Bucket for the multipart upload.

$key : string

Object key for the multipart upload.

$uploadId : string

Upload ID for the multipart upload.

Return values
UploadState —

getConfig()

protected abstract getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getSourceMimeType()

protected getSourceMimeType() : mixed
Return values
mixed —

getSourceSize()

protected getSourceSize() : mixed
Return values
mixed —

getUploadCommands()

protected getUploadCommands(callable $resultHandler) : mixed
Parameters
$resultHandler : callable
Return values
mixed —

loadUploadWorkflowInfo()

protected loadUploadWorkflowInfo() : mixed
Return values
mixed —

createPart()

private createPart(mixed $partNumber, mixed $partsCount) : mixed
Parameters
$partNumber : mixed
$partsCount : mixed
Return values
mixed —

fetchSourceMetadata()

private fetchSourceMetadata() : mixed
Return values
mixed —

getSourceMetadata()

private getSourceMetadata() : mixed
Return values
mixed —

Search results