SDK for PHP V3
StreamDownloadHandler
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() : bool
- getHandlerResult() : StreamInterface
- Returns the handler result.
- isConcurrencySupported() : bool
- To control whether the download handler supports concurrency.
- priority() : int
- 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([StreamInterface|null $stream = null ]) : mixed
Parameters
- $stream : StreamInterface|null = null
bytesTransferred()
public
bytesTransferred(array<string|int, mixed> $context) : bool
Parameters
- $context : array<string|int, mixed>
Tags
Return values
boolgetHandlerResult()
Returns the handler result.
public
getHandlerResult() : StreamInterface
Tags
Return values
StreamInterfaceisConcurrencySupported()
To control whether the download handler supports concurrency.
public
isConcurrencySupported() : bool
Tags
Return values
boolpriority()
public
priority() : int
Return values
inttransferComplete()
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>
-
- request_args: (array) The request arguments that will be provided as part of the request initialization.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.