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(); });
- Cake\Console\Helper uses Cake\Core\InstanceConfigTrait
-
Cake\Shell\Helper\ProgressHelper
Properties summary
-
$_progress
protectedinteger
The current progress. -
$_total
protectedinteger
The total number of 'items' to progress through. -
$_width
protectedinteger
The width of the bar.
Inherited Properties
Method Summary
-
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
increment() public ¶
increment( integer $num 1 )
Increment the progress bar.
Parameters
- integer $num optional 1
- The amount of progress to advance by.
Returns
$this
init() public ¶
init( array $args [] )
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.
Parameters
- array $args optional []
- The initialization data.
Returns
$this
output() public ¶
output( array $args )
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.
Parameters
- array $args
- The arguments/options to use when outputing the progress bar.
Methods inherited from Cake\Console\Helper
__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.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default null )
Returns 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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets 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
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this