Class ProgressHelper
Create a progress bar using a supplied callback.
Usage
The ProgressHelper can be accessed from shells using the helper() method
$this->helper('Progress')->output(['callback' => function ($progress) {
// Do work
$progress->increment();
});Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default config for this helper.
-
$_io protected
Cake\Console\ConsoleIoConsoleIo instance.
-
$_progress protected
float|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
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
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.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
increment() public
Increment the progress bar.
-
init() public
Initialize the progress bar for use.
-
output() public
Output a progress bar.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])Constructor.
Parameters
-
Cake\Console\ConsoleIo$io The ConsoleIo instance to use.
-
array<string, mixed>$config optional The settings for this helper.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
array<string, mixed>|string$key Key to write to.
-
mixed$value Value to write.
-
string|bool$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
configShallow() ¶ public
configShallow(array<string, mixed>|string $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->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns the config.
Usage
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Reading with default value:
$this->getConfig('some-key', 'default-value');Parameters
-
string|null$key optional The key to get or null for the whole config.
-
mixed$default optional The return value when the key does not exist.
Returns
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptionincrement() ¶ public
increment(float|int $num = 1): $thisIncrement the progress bar.
Parameters
-
float|int$num optional The amount of progress to advance by.
Returns
$thisinit() ¶ public
init(array $args = []): $thisInitialize 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
$thisoutput() ¶ 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
voidsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to 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
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool