Class ProgressHelper

The Progress class providers helpers to display progress output.

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface

Symfony\Component\Console\Helper\ProgressHelper

Namespace: Symfony\Component\Console\Helper
Author: Chris Jones <leeked@gmail.com>
Author: Fabien Potencier <fabien@symfony.com>
Located at console/Symfony/Component/Console/Helper/ProgressHelper.php

Methods summary
`public`	# `setBarWidth( integer $size )` Sets the progress bar width. Sets the progress bar width. Parameters `$size` `integer` $size The progress bar size
`public`	# `setBarCharacter( string $char )` Sets the bar character. Sets the bar character. Parameters `$char` `string` $char A character
`public`	# `setEmptyBarCharacter( string $char )` Sets the empty bar character. Sets the empty bar character. Parameters `$char` `string` $char A character
`public`	# `setProgressCharacter( string $char )` Sets the progress bar character. Sets the progress bar character. Parameters `$char` `string` $char A character
`public`	# `setFormat( string $format )` Sets the progress bar format. Sets the progress bar format. Parameters `$format` `string` $format The format
`public`	# `setRedrawFrequency( integer $freq )` Sets the redraw frequency. Sets the redraw frequency. Parameters `$freq` `integer` $freq The frequency in seconds
`public`	# `start( Symfony\Component\Console\Output\OutputInterface $output, integer $max = null )` Starts the progress output. Starts the progress output. Parameters `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance `$max` `integer` $max Maximum steps
`public`	# `advance( integer $step = 1, Boolean $redraw = false )` Advances the progress output X steps. Advances the progress output X steps. Parameters `$step` `integer` $step Number of steps to advance `$redraw` `Boolean` $redraw Whether to redraw or not Throws `LogicException`
`public`	# `display( Boolean $finish = false )` Outputs the current progress string. Outputs the current progress string. Parameters `$finish` `Boolean` $finish Forces the end result Throws `LogicException`
`public`	# `finish( )` Finishes the progress output. Finishes the progress output.
`public string`	# `getName( )` Returns the canonical name of this helper. Returns the canonical name of this helper. Returns `string` The canonical name

Methods inherited from Symfony\Component\Console\Helper\Helper
`getHelperSet(), setHelperSet()`

Constants summary
`string`	`FORMAT_QUIET`	`' %percent%%'`	#
`string`	`FORMAT_NORMAL`	`' %current%/%max% [%bar%] %percent%%'`	#
`string`	`FORMAT_VERBOSE`	`' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%'`	#
`string`	`FORMAT_QUIET_NOMAX`	`' %current%'`	#
`string`	`FORMAT_NORMAL_NOMAX`	`' %current% [%bar%]'`	#
`string`	`FORMAT_VERBOSE_NOMAX`	`' %current% [%bar%] Elapsed: %elapsed%'`	#

Properties inherited from Symfony\Component\Console\Helper\Helper
`$helperSet`

Namespaces

Classes

Interfaces

Class ProgressHelper

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Throws

Parameters

Throws

Returns