W3cubDocs

/CakePHP 3.4

Class ProgressHelper

Create a progress bar using a supplied callback.

Cake\Console\Helper uses Cake\Core\InstanceConfigTrait
Extended by Cake\Shell\Helper\ProgressHelper

Properties summary

  • $_progress protected
    integer
    The current progress.
  • $_total protected
    integer
    The total number of 'items' to progress through.
  • $_width protected
    integer
    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

draw()source public

draw( )

Render the progress bar based on the current state.

increment()source public

increment( integer $num 1 )

Increment the progress bar.

Parameters

integer $num optional 1
The amount of progress to advance by.

init()source 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.

output()source 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()source 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()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source 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

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source 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

3.4.0 use setConfig()/getConfig() instead.

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

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source 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->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 null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key 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');

Parameters

string|null $key optional null
The key to get or null for the whole config.

Returns

mixed
Config value being read.

setConfig()source 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

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

$_progresssource

protected integer

The current progress.

$_totalsource

protected integer

The total number of 'items' to progress through.

$_widthsource

protected integer

The width of the bar.

© 2005–2017 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/3.4/class-Cake.Shell.Helper.ProgressHelper.html