Class ProgressHelper
Create a progress bar using a supplied callback.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this helper.
-
$_io protected
Cake\Console\ConsoleIoConsoleIo instance.
-
$_progress protected
intThe current progress.
-
$_total protected
intThe total number of 'items' to progress through.
-
$_width protected
intThe width of the bar.
Method Summary
-
__construct() public
Constructor.
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
draw() public
Render the progress bar based on the current state.
-
increment() public
Increment the progress bar.
-
init() public
Initialize the progress bar for use.
-
output() public
Output a progress bar.
Method Detail
__construct() ¶ public
__construct(Cake\Console\ConsoleIo $io, array $config = [])Constructor.
Parameters
-
Cake\Console\ConsoleIo$io The ConsoleIo instance to use.
-
array$config optional The settings for this helper.
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisincrement() ¶ public
increment(int $num = 1): voidIncrement the progress bar.
Parameters
-
int$num optional The amount of progress to advance by.
Returns
voidinit() ¶ public
init(array $args = []): voidInitialize the progress bar for use.
totalThe total number of items in the progress bar. Defaults to 100.widthThe width of the progress bar. Defaults to 80.
Parameters
-
array$args optional The initialization data.
Returns
voidoutput() ¶ public
output(array $args): voidOutput a progress bar.
Takes a number of options to customize the behavior:
totalThe total number of items in the progress bar. Defaults to 100.widthThe width of the progress bar. Defaults to 80.callbackThe callback that will be called in a loop to advance the progress bar.
Parameters
-
array$args The arguments/options to use when outputing the progress bar.
Returns
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool