SDK for PHP V3
MultiProgressTracker
extends AbstractTransferListener
in package
implements
ProgressTrackerInterface
FinalYes
Table of Contents
Interfaces
Constants
- PROGRESS_SNAPSHOT_KEY = 'progress_snapshot'
- REASON_KEY = 'reason'
- REQUEST_ARGS_KEY = 'request_args'
Methods
- __construct() : mixed
- bytesTransferred() : bool
- getCompleted() : int
- getFailed() : int
- getOutput() : mixed
- getProgressBarFactory() : ProgressBarFactoryInterface|Closure|null
- getSingleProgressTrackers() : array<string|int, mixed>
- getTransferCount() : int
- showProgress() : void
- To show the progress being tracked.
- 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([array<string|int, mixed> $singleProgressTrackers = [] ][, mixed|false|resource $output = STDOUT ][, int $transferCount = 0 ][, int $completed = 0 ][, int $failed = 0 ][, ProgressBarFactoryInterface|Closure|null $progressBarFactory = null ]) : mixed
Parameters
- $singleProgressTrackers : array<string|int, mixed> = []
- $output : mixed|false|resource = STDOUT
- $transferCount : int = 0
- $completed : int = 0
- $failed : int = 0
- $progressBarFactory : ProgressBarFactoryInterface|Closure|null = null
bytesTransferred()
public
bytesTransferred(array<string|int, mixed> $context) : bool
Parameters
- $context : array<string|int, mixed>
-
- request_args: (array) The request arguments that will be provided as part of the operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
Tags
Return values
boolgetCompleted()
public
getCompleted() : int
Return values
intgetFailed()
public
getFailed() : int
Return values
intgetOutput()
public
getOutput() : mixed
getProgressBarFactory()
public
getProgressBarFactory() : ProgressBarFactoryInterface|Closure|null
Return values
ProgressBarFactoryInterface|Closure|nullgetSingleProgressTrackers()
public
getSingleProgressTrackers() : array<string|int, mixed>
Return values
array<string|int, mixed>getTransferCount()
public
getTransferCount() : int
Return values
intshowProgress()
To show the progress being tracked.
public
showProgress() : void
Tags
transferComplete()
public
transferComplete(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 operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
Tags
transferFail()
public
transferFail(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 operation that originated the bytes transferred event.
- progress_snapshot: (TransferProgressSnapshot) The transfer snapshot holder.
- reason: (Throwable) The exception originated by the transfer failure.
Tags
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.