SDK for PHP V3

FileDownloadHandler extends AbstractDownloadHandler
in package

FinalYes

Table of Contents

Constants

PROGRESS_SNAPSHOT_KEY  = 'progress_snapshot'
REASON_KEY  = 'reason'
REQUEST_ARGS_KEY  = 'request_args'

Methods

__construct()  : mixed
bytesTransferred()  : void
getDestination()  : string
getHandlerResult()  : string
Returns the handler result.
isFailsWhenDestinationExists()  : bool
transferComplete()  : void
transferFail()  : void
transferInitiated()  : void

Constants

PROGRESS_SNAPSHOT_KEY

public mixed PROGRESS_SNAPSHOT_KEY = 'progress_snapshot'

REASON_KEY

public mixed REASON_KEY = 'reason'

REQUEST_ARGS_KEY

public mixed REQUEST_ARGS_KEY = 'request_args'

Methods

__construct()

public __construct(string $destination, bool $failsWhenDestinationExists) : mixed
Parameters
$destination : string
$failsWhenDestinationExists : bool

bytesTransferred()

public bytesTransferred(array<string|int, mixed> $context) : void
Parameters
$context : array<string|int, mixed>

getDestination()

public getDestination() : string
Return values
string

getHandlerResult()

Returns the handler result.

public getHandlerResult() : string
Return values
string

isFailsWhenDestinationExists()

public isFailsWhenDestinationExists() : bool
Return values
bool

transferComplete()

public transferComplete(array<string|int, mixed> $context) : void
Parameters
$context : array<string|int, mixed>

transferFail()

public transferFail(array<string|int, mixed> $context) : void
Parameters
$context : array<string|int, mixed>

transferInitiated()

public transferInitiated(array<string|int, mixed> $context) : void
Parameters
$context : array<string|int, mixed>
<-- modeled_exceptions -->
On this page