Create a progress bar using a supplied callback.
The ProgressHelper can be accessed from shells using the helper() method
$this->helper('Progress')->output(['callback' => function ($progress) { // Do work $progress->increment(); });
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this helper.
Cake\Console\ConsoleIo
ConsoleIo instance.
float|int
The current progress.
int
The total number of 'items' to progress through.
int
The width of the bar.
Constructor.
Deletes a single config key.
Reads a config key.
Writes a config key.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Render the progress bar based on the current state.
Returns the config.
Returns the config for this specific key.
Increment the progress bar.
Initialize the progress bar for use.
Output a progress bar.
Sets the config.
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])
Constructor.
Cake\Console\ConsoleIo
$io The ConsoleIo instance to use.
array<string, mixed>
$config optional The settings for this helper.
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
void
Cake\Core\Exception\CakeException
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
Merge 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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
draw(): $this
Render the progress bar based on the current state.
$this
getConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
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');
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.
mixed
getConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
InvalidArgumentException
increment(float|int $num = 1): $this
Increment the progress bar.
float|int
$num optional The amount of progress to advance by.
$this
init(array $args = []): $this
Initialize the progress bar for use.
total
The total number of items in the progress bar. Defaults to 100.width
The width of the progress bar. Defaults to 80.array
$args optional The initialization data.
$this
output(array $args): void
Output a progress bar.
Takes a number of options to customize the behavior:
total
The total number of items in the progress bar. Defaults to 100.width
The width of the progress bar. Defaults to 80.callback
The callback that will be called in a loop to advance the progress bar.array
$args The arguments/options to use when outputing the progress bar.
void
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
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']);
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.
$this
Cake\Core\Exception\CakeException
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Default config for this helper.
array<string, mixed>
ConsoleIo instance.
Cake\Console\ConsoleIo
The current progress.
float|int
The total number of 'items' to progress through.
int
The width of the bar.
int
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Shell.Helper.ProgressHelper.html