SDK for PHP V3
TransferProgressBarFormat
extends AbstractProgressBarFormat
in package
FinalYes
Defines a progress bar format.
Table of Contents
Constants
- FORMAT_PARAMETERS = ['object_name', 'progress_bar', 'percent', 'transferred', 'to_be_transferred', 'unit']
- FORMAT_TEMPLATE = "|object_name|:\n[|progress_bar|]" . " |percent|% |transferred|/|to_be_transferred| |unit|"
Methods
- __construct() : mixed
- format() : string
- getArgs() : array<string|int, mixed>
- getFormatParameters() : array<string|int, mixed>
- getFormatTemplate() : string
- setArg() : void
- setArgs() : void
- To set multiple arguments at once.
Constants
FORMAT_PARAMETERS
public
mixed
FORMAT_PARAMETERS
= ['object_name', 'progress_bar', 'percent', 'transferred', 'to_be_transferred', 'unit']
FORMAT_TEMPLATE
public
mixed
FORMAT_TEMPLATE
= "|object_name|:\n[|progress_bar|]" . " |percent|% |transferred|/|to_be_transferred| |unit|"
Methods
__construct()
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
format()
public
format() : string
Return values
stringgetArgs()
public
getArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getFormatParameters()
public
getFormatParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getFormatTemplate()
public
getFormatTemplate() : string
Tags
Return values
stringsetArg()
public
setArg(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
setArgs()
To set multiple arguments at once.
public
setArgs(array<string|int, mixed> $args) : void
It does not override all the values, instead it adds the arguments individually and if a value already exists then that value will be overridden.
Parameters
- $args : array<string|int, mixed>