SDK for PHP V3
DirectoryProgressTracker
extends AbstractTransferListener
in package
implements
ProgressTrackerInterface
FinalYes
Progress tracker for directory-level transfers using directory snapshots.
Table of Contents
Interfaces
Constants
- PROGRESS_SNAPSHOT_KEY = 'progress_snapshot'
- REASON_KEY = 'reason'
- REQUEST_ARGS_KEY = 'request_args'
Methods
- __construct() : mixed
- bytesTransferred() : bool
- getProgressBar() : ProgressBarInterface
- priority() : int
- To provide an order on which listener is notified first.
- 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([ProgressBarInterface $progressBar = new ConsoleProgressBar() ][, mixed $output = STDOUT ][, bool $clear = true ][, DirectoryTransferProgressSnapshot|null $currentSnapshot = null ][, bool $showProgressOnUpdate = true ]) : mixed
Parameters
- $progressBar : ProgressBarInterface = new ConsoleProgressBar()
- $output : mixed = STDOUT
- $clear : bool = true
- $currentSnapshot : DirectoryTransferProgressSnapshot|null = null
- $showProgressOnUpdate : bool = true
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.
Return values
bool —true to notify successful handling otherwise false.
getProgressBar()
public
getProgressBar() : ProgressBarInterface
Return values
ProgressBarInterfacepriority()
To provide an order on which listener is notified first.
public
priority() : int
By default, it will provide a neutral value.
Return values
intshowProgress()
To show the progress being tracked.
public
showProgress() : void
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.
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.
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.