Class AbstractTransfer
Abstract class for transfer commonalities
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
-
Aws\Common\Model\MultipartUpload\AbstractTransfer
implements
Aws\Common\Model\MultipartUpload\TransferInterface
Direct known subclasses
Aws\Glacier\Model\MultipartUpload\AbstractTransfer,
Aws\S3\Model\MultipartUpload\AbstractTransfer
Indirect known subclasses
Aws\Glacier\Model\MultipartUpload\ParallelTransfer,
Aws\Glacier\Model\MultipartUpload\SerialTransfer,
Aws\S3\Model\MultipartUpload\ParallelTransfer,
Aws\S3\Model\MultipartUpload\SerialTransfer
Namespace: Aws\Common\Model\MultipartUpload
Located at Aws/Common/Model/MultipartUpload/AbstractTransfer.php
Methods summary
-
public__construct ( Aws\Common\Client\AwsClientInterface $client, Aws\Common\Model\MultipartUpload\TransferStateInterface $state, Guzzle\Http\EntityBody $source, array $options = array() )Construct a new transfer object
-
public__invoke ( ) -
public staticgetAllEvents ( )Get a list of all of the events emitted from the class
-
publicabort ( )Abort the upload
-
publicstop ( )Stop the transfer and retrieve the current state.
-
publicgetState ( )Get the current state of the upload
-
publicgetOptions ( )Get the array of options associated with the transfer
-
publicsetOption ( string $option, mixed $value )Set an option on the transfer
-
publicgetSource ( )Get the source body of the upload
-
publicupload ( )Upload the source to using a multipart upload
-
protectedgetEventData ( Guzzle\Service\Command\OperationCommand $command = null )Get an array used for event notifications
-
protectedinit ( )Hook to initialize the transfer
-
abstract protectedcalculatePartSize ( )Determine the upload part size based on the size of the source data and taking into account the acceptable minimum and maximum part sizes.
-
abstract protectedcomplete ( )Complete the multipart upload
-
abstract protectedtransfer ( )Hook to implement in subclasses to perform the actual transfer
-
abstract protectedgetAbortCommand ( )Fetches the abort command fom the concrete implementation
Methods detail
public
__construct( Aws\Common\Client\AwsClientInterface $client, Aws\Common\Model\MultipartUpload\TransferStateInterface $state, Guzzle\Http\EntityBody $source, array $options = array() )
Construct a new transfer object
Parameters
- $client
Aws\Common\Client\AwsClientInterface
$client Client used for the transfers- $state
Aws\Common\Model\MultipartUpload\TransferStateInterface
$state State used to track transfer- $source
Guzzle\Http\EntityBody
$source Data source of the transfer- $options
array
$options Array of options to apply
Get a list of all of the events emitted from the class
Returns
arrayOverrides
Implementation of
Abort the upload
Returns
Implementation of
Stop the transfer and retrieve the current state.
Returns
Implementation of
Get the current state of the upload
Returns
Implementation of
Get the array of options associated with the transfer
Returns
array
public
Aws\Common\Model\MultipartUpload\AbstractTransfer
setOption( string $option, mixed $value )
Set an option on the transfer
Parameters
- $option
string
$option Name of the option- $value
mixed
$value Value to set
Returns
Implementation of
Upload the source to using a multipart upload
Returns
Guzzle\Service\Resource\Model|nullResult of the complete multipart upload command or null if uploading was stopped
Throws
Aws\Common\Exception\MultipartUploadExceptionwhen an error is encountered. Use getLastException() to get more information.
Aws\Common\Exception\RuntimeExceptionwhen attempting to upload an aborted transfer
Implementation of
Get an array used for event notifications
Parameters
- $command
Guzzle\Service\Command\OperationCommand
$command Command to include in event data
Returns
arrayHook to initialize the transfer
Determine the upload part size based on the size of the source data and taking into account the acceptable minimum and maximum part sizes.
Returns
integerThe part size
Complete the multipart upload
Returns
Hook to implement in subclasses to perform the actual transfer
Fetches the abort command fom the concrete implementation
Returns
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(),
dispatch(),
getEventDispatcher(),
setEventDispatcher()
Magic methods summary
Constants summary
string |
BEFORE_UPLOAD |
'multipart_upload.before_upload' |
|
string |
AFTER_UPLOAD |
'multipart_upload.after_upload' |
|
string |
BEFORE_PART_UPLOAD |
'multipart_upload.before_part_upload' |
|
string |
AFTER_PART_UPLOAD |
'multipart_upload.after_part_upload' |
|
string |
AFTER_ABORT |
'multipart_upload.after_abort' |
|
string |
AFTER_COMPLETE |
'multipart_upload.after_complete' |
Properties summary
protected
|
$client |
#
Client used for the transfers |
protected
|
$state |
#
State of the transfer |
protected
|
$source |
#
Data source of the transfer |
protected
array
|
$options |
#
Associative array of options |
protected
integer
|
$partSize |
#
Size of each part to upload |
protected
boolean
|
$stopped |
#
Whether or not the transfer has been stopped |