Class ProgressHelper

The Progress class provides 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
Deprecated:

since version 2.5, to be removed in 3.0 Use Symfony\Component\Console\Helper\ProgressBar instead.

Author: Chris Jones leeked@gmail.com
Author: Fabien Potencier fabien@symfony.com
Located at Helper/ProgressHelper.php

Methods summary
`public`	# `__construct( $triggerDeprecationError = true )`
`public`	# `setBarWidth( integer $size )` Sets the progress bar width. Sets the progress bar width. Parameters `$size` The progress bar size
`public`	# `setBarCharacter( string $char )` Sets the bar character. Sets the bar character. Parameters `$char` A character
`public`	# `setEmptyBarCharacter( string $char )` Sets the empty bar character. Sets the empty bar character. Parameters `$char` A character
`public`	# `setProgressCharacter( string $char )` Sets the progress bar character. Sets the progress bar character. Parameters `$char` A character
`public`	# `setFormat( string $format )` Sets the progress bar format. Sets the progress bar format. Parameters `$format` The format
`public`	# `setRedrawFrequency( integer $freq )` Sets the redraw frequency. Sets the redraw frequency. Parameters `$freq` The frequency in steps
`public`	# `start( Symfony\Component\Console\Output\OutputInterface $output, integer\|null $max = null )` Starts the progress output. Starts the progress output. Parameters `$output` An Output instance `$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` Number of steps to advance `$redraw` Whether to redraw or not Throws `Symfony\Component\Console\Exception\LogicException`
`public`	# `setCurrent( integer $current, boolean $redraw = false )` Sets the current progress. Sets the current progress. Parameters `$current` The current progress `$redraw` Whether to redraw or not Throws `Symfony\Component\Console\Exception\LogicException`
`public`	# `display( boolean $finish = false )` Outputs the current progress string. Outputs the current progress string. Parameters `$finish` Forces the end result Throws `Symfony\Component\Console\Exception\LogicException`
`public`	# `clear( )` Removes the progress bar from the current line. Removes the progress bar from the current line. This is useful if you wish to write some output while a progress bar is running. Call display() to show the progress bar again.
`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
`formatMemory(), formatTime(), getHelperSet(), setHelperSet(), strlen(), strlenWithoutDecoration()`

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

Parameters

Throws

Returns