ProgressHelper Class Reference

Inheritance diagram for ProgressHelper:

Public Member Functions
	__construct ($triggerDeprecationError=true)
	setBarWidth ($size)
	setBarCharacter ($char)
	setEmptyBarCharacter ($char)
	setProgressCharacter ($char)
	setFormat ($format)
	setRedrawFrequency ($freq)
	start (OutputInterface $output, $max=null)
	advance ($step=1, $redraw=false)
	setCurrent ($current, $redraw=false)
	display ($finish=false)
	clear ()
	finish ()
	getName ()
Public Member Functions inherited from Helper
	setHelperSet (HelperSet $helperSet=null)
	getHelperSet ()

Public Attributes
const	FORMAT_QUIET = ' %percent%%'
const	FORMAT_NORMAL = ' %current%/%max% [%bar%] %percent%%'
const	FORMAT_VERBOSE = ' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%'
const	FORMAT_QUIET_NOMAX = ' %current%'
const	FORMAT_NORMAL_NOMAX = ' %current% [%bar%]'
const	FORMAT_VERBOSE_NOMAX = ' %current% [%bar%] Elapsed: %elapsed%'

Private Member Functions
	initialize ()
	generate ($finish=false)
	humaneTime ($secs)
	overwrite (OutputInterface $output, $message)

Private Attributes
	$barWidth = 28
	$barChar = '='
	$emptyBarChar = '-'
	$progressChar = '>'
	$format = null
	$redrawFreq = 1
	$lastMessagesLength
	$barCharOriginal
	$output
	$current
	$max
	$startTime
	$defaultFormatVars
	$formatVars
	$widths
	$timeFormats

Additional Inherited Members
Static Public Member Functions inherited from Helper
static	strlen ($string)
static	formatTime ($secs)
static	formatMemory ($memory)
static	strlenWithoutDecoration (OutputFormatterInterface $formatter, $string)
Protected Attributes inherited from Helper
	$helperSet = null

Detailed Description

The Progress class provides helpers to display progress output.

Author

Chris Jones leeke.nosp@m.d@gm.nosp@m.ail.c.nosp@m.om

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Deprecated:

since version 2.5, to be removed in 3.0 Use ProgressBar instead.

Definition at line 26 of file ProgressHelper.php.

Constructor & Destructor Documentation

__construct

(

$triggerDeprecationError = true

)

Definition at line 121 of file ProgressHelper.php.

Member Function Documentation

advance	(		$step = 1,
			$redraw = false
	)

Advances the progress output X steps.

Parameters

int	$step	Number of steps to advance
bool	$redraw	Whether to redraw or not

Exceptions

\LogicException

Definition at line 241 of file ProgressHelper.php.

References ProgressHelper\setCurrent().

clear

(

)

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.

Definition at line 307 of file ProgressHelper.php.

References ProgressHelper\overwrite().

display

(

$finish = false

)

Outputs the current progress string.

Parameters

bool

$finish

Forces the end result

Exceptions

\LogicException

Definition at line 287 of file ProgressHelper.php.

References ProgressHelper\$format, ProgressHelper\generate(), and ProgressHelper\overwrite().

Referenced by ProgressHelper\finish(), and ProgressHelper\setCurrent().

finish

(

)

Finishes the progress output.

Definition at line 315 of file ProgressHelper.php.

References ProgressHelper\$barCharOriginal, and ProgressHelper\display().

generate (   $finish = false )

private

Generates the array map of format variables to values.

Parameters

bool

$finish

Forces the end result

Returns

array Array of format vars and values

Definition at line 360 of file ProgressHelper.php.

References ProgressHelper\$barWidth, ProgressHelper\$max, ProgressHelper\$progressChar, ProgressHelper\$startTime, ProgressHelper\humaneTime(), and Helper\strlen().

Referenced by ProgressHelper\display().

getName

(

)

{Returns the canonical name of this helper.

Returns

string The canonical name

}

Implements HelperInterface.

Definition at line 461 of file ProgressHelper.php.

humaneTime (   $secs )

private

Converts seconds into human-readable format.

Parameters

int

$secs

Number of seconds

Returns

string Time in readable format

Definition at line 418 of file ProgressHelper.php.

References ProgressHelper\$format.

Referenced by ProgressHelper\generate().

initialize ( )

private

Initializes the progress helper.

Definition at line 335 of file ProgressHelper.php.

References ProgressHelper\$barChar, ProgressHelper\$emptyBarChar, and Helper\strlen().

Referenced by ProgressHelper\start().

overwrite ( OutputInterface  $output,   $message  )

private

Overwrites a previous message to the output.

Parameters

OutputInterface	$output	An Output instance
string	$message	The message

Definition at line 442 of file ProgressHelper.php.

References Helper\strlen(), and OutputInterface\write().

Referenced by ProgressHelper\clear(), and ProgressHelper\display().

setBarCharacter

(

$char

)

Sets the bar character.

Parameters

string

$char

A character

Definition at line 143 of file ProgressHelper.php.

setBarWidth

(

$size

)

Sets the progress bar width.

Parameters

int

$size

The progress bar size

Definition at line 133 of file ProgressHelper.php.

setCurrent	(		$current,
			$redraw = false
	)

Sets the current progress.

Parameters

int	$current	The current progress
bool	$redraw	Whether to redraw or not

Exceptions

\LogicException

Definition at line 254 of file ProgressHelper.php.

References ProgressHelper\$current, and ProgressHelper\display().

Referenced by ProgressHelper\advance().

setEmptyBarCharacter

(

$char

)

Sets the empty bar character.

Parameters

string

$char

A character

Definition at line 153 of file ProgressHelper.php.

setFormat

(

$format

)

Sets the progress bar format.

Parameters

string

$format

The format

Definition at line 173 of file ProgressHelper.php.

References ProgressHelper\$format.

setProgressCharacter

(

$char

)

Sets the progress bar character.

Parameters

string

$char

A character

Definition at line 163 of file ProgressHelper.php.

setRedrawFrequency

(

$freq

)

Sets the redraw frequency.

Parameters

int

$freq

The frequency in steps

Definition at line 183 of file ProgressHelper.php.

start	(	OutputInterface	$output,
			$max = null
	)

Starts the progress output.

Parameters

OutputInterface	$output	An Output instance
int | null	$max	Maximum steps

Definition at line 194 of file ProgressHelper.php.

References ProgressHelper\$max, OutputInterface\getVerbosity(), ProgressHelper\initialize(), OutputInterface\isDecorated(), OutputInterface\VERBOSITY_DEBUG, OutputInterface\VERBOSITY_QUIET, OutputInterface\VERBOSITY_VERBOSE, and OutputInterface\VERBOSITY_VERY_VERBOSE.

Member Data Documentation

$barChar = '='

private

Definition at line 37 of file ProgressHelper.php.

Referenced by ProgressHelper\initialize().

$barCharOriginal

private

Definition at line 44 of file ProgressHelper.php.

Referenced by ProgressHelper\finish().

$barWidth = 28

private

Definition at line 36 of file ProgressHelper.php.

Referenced by ProgressHelper\generate().

$current

private

Definition at line 56 of file ProgressHelper.php.

Referenced by ProgressHelper\setCurrent().

$defaultFormatVars

private

Initial value:

= array(
        'current',
        'max',
        'bar',
        'percent',
        'elapsed',
    )

Definition at line 77 of file ProgressHelper.php.

$emptyBarChar = '-'

private

Definition at line 38 of file ProgressHelper.php.

Referenced by ProgressHelper\initialize().

$format = null

private

Definition at line 40 of file ProgressHelper.php.

Referenced by ProgressHelper\display(), ProgressHelper\humaneTime(), and ProgressHelper\setFormat().

$formatVars

private

Definition at line 90 of file ProgressHelper.php.

$lastMessagesLength

private

Definition at line 43 of file ProgressHelper.php.

$max

private

Definition at line 63 of file ProgressHelper.php.

Referenced by ProgressHelper\generate(), and ProgressHelper\start().

$output

private

Definition at line 49 of file ProgressHelper.php.

$progressChar = '>'

private

Definition at line 39 of file ProgressHelper.php.

Referenced by ProgressHelper\generate().

$redrawFreq = 1

private

Definition at line 41 of file ProgressHelper.php.

$startTime

private

Definition at line 70 of file ProgressHelper.php.

Referenced by ProgressHelper\generate().

$timeFormats

private

Initial value:

= array(
        array(0, '???'),
        array(2, '1 sec'),
        array(59, 'secs', 1),
        array(60, '1 min'),
        array(3600, 'mins', 60),
        array(5400, '1 hr'),
        array(86400, 'hrs', 3600),
        array(129600, '1 day'),
        array(604800, 'days', 86400),
    )

Definition at line 109 of file ProgressHelper.php.

$widths

private

Initial value:

= array(
        'current' => 4,
        'max' => 4,
        'percent' => 3,
        'elapsed' => 6,
    )

Definition at line 97 of file ProgressHelper.php.

const FORMAT_NORMAL = ' %current%/%max% [%bar%] %percent%%'

Definition at line 29 of file ProgressHelper.php.

const FORMAT_NORMAL_NOMAX = ' %current% [%bar%]'

Definition at line 32 of file ProgressHelper.php.

const FORMAT_QUIET = ' %percent%%'

Definition at line 28 of file ProgressHelper.php.

const FORMAT_QUIET_NOMAX = ' %current%'

Definition at line 31 of file ProgressHelper.php.

const FORMAT_VERBOSE = ' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%'

Definition at line 30 of file ProgressHelper.php.

const FORMAT_VERBOSE_NOMAX = ' %current% [%bar%] Elapsed: %elapsed%'

Definition at line 33 of file ProgressHelper.php.