TransferInterface
extends
HasDispatcherInterface
in
Interface for transferring the contents of a data source to an AWS service via a multipart upload interface
Table of Contents
Methods
- abort() : Model
- Abort the upload
- addSubscriber() : self
- Add an event subscriber to the dispatcher
- dispatch() : Event
- Helper to dispatch Guzzle events and set the event name on the event
- getAllEvents() : array<string|int, mixed>
- Get a list of all of the events emitted from the class
- getEventDispatcher() : EventDispatcherInterface
- Get the EventDispatcher of the request
- getState() : TransferStateInterface
- Get the current state of the upload
- setEventDispatcher() : self
- Set the EventDispatcher of the request
- setOption() : self
- Set an option on the transfer object
- stop() : TransferStateInterface
- Stop the transfer and retrieve the current state.
- upload() : Model|null
- Upload the source to using a multipart upload
Methods
abort()
Abort the upload
public
abort() : Model
Return values
Model —Returns the result of the abort multipart upload command
addSubscriber()
Add an event subscriber to the dispatcher
public
addSubscriber(EventSubscriberInterface $subscriber) : self
Parameters
- $subscriber : EventSubscriberInterface
-
Event subscriber
Return values
selfdispatch()
Helper to dispatch Guzzle events and set the event name on the event
public
dispatch(string $eventName[, array<string|int, mixed> $context = array() ]) : Event
Parameters
- $eventName : string
-
Name of the event to dispatch
- $context : array<string|int, mixed> = array()
-
Context of the event
Return values
Event —Returns the created event object
getAllEvents()
Get a list of all of the events emitted from the class
public
static getAllEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>getEventDispatcher()
Get the EventDispatcher of the request
public
getEventDispatcher() : EventDispatcherInterface
Return values
EventDispatcherInterfacegetState()
Get the current state of the upload
public
getState() : TransferStateInterface
Return values
TransferStateInterfacesetEventDispatcher()
Set the EventDispatcher of the request
public
setEventDispatcher(EventDispatcherInterface $eventDispatcher) : self
Parameters
- $eventDispatcher : EventDispatcherInterface
Return values
selfsetOption()
Set an option on the transfer object
public
setOption(string $option, mixed $value) : self
Parameters
- $option : string
-
Option to set
- $value : mixed
-
The value to set
Return values
selfstop()
Stop the transfer and retrieve the current state.
public
stop() : TransferStateInterface
This allows you to stop and later resume a long running transfer if needed.
Return values
TransferStateInterfaceupload()
Upload the source to using a multipart upload
public
upload() : Model|null
Return values
Model|null —Result of the complete multipart upload command or null if uploading was stopped