Référence de la classe ProgressBar

Fonctions membres publiques
	__construct (OutputInterface $output, int $max=0, float $minSecondsBetweenRedraws=1/25)
	setMessage (string $message, string $name='message')
	getMessage (string $name='message')
	getStartTime ()
	getMaxSteps ()
	getProgress ()
	getProgressPercent ()
	getBarOffset ()
	getEstimated ()
	getRemaining ()
	setBarWidth (int $size)
	getBarWidth ()
	setBarCharacter (string $char)
	getBarCharacter ()
	setEmptyBarCharacter (string $char)
	getEmptyBarCharacter ()
	setProgressCharacter (string $char)
	getProgressCharacter ()
	setFormat (string $format)
	setRedrawFrequency (?int $freq)
	minSecondsBetweenRedraws (float $seconds)
	maxSecondsBetweenRedraws (float $seconds)
	iterate (iterable $iterable, int $max=null)
	start (int $max=null)
	advance (int $step=1)
	setOverwrite (bool $overwrite)
	setProgress (int $step)
	setMaxSteps (int $max)
	finish ()
	display ()
	clear ()

Fonctions membres publiques statiques
static	setPlaceholderFormatterDefinition (string $name, callable $callable)
static	getPlaceholderFormatterDefinition (string $name)
static	setFormatDefinition (string $name, string $format)
static	getFormatDefinition (string $name)

Champs de données
const	FORMAT_VERBOSE = 'verbose'
const	FORMAT_VERY_VERBOSE = 'very_verbose'
const	FORMAT_DEBUG = 'debug'
const	FORMAT_NORMAL = 'normal'

Fonctions membres privées
	getStepWidth ()
	setRealFormat (string $format)
	overwrite (string $message)
	determineBestFormat ()
	buildLine ()

Fonctions membres privées statiques
static	initPlaceholderFormatters ()
static	initFormats ()

Attributs privés
const	FORMAT_VERBOSE_NOMAX = 'verbose_nomax'
const	FORMAT_VERY_VERBOSE_NOMAX = 'very_verbose_nomax'
const	FORMAT_DEBUG_NOMAX = 'debug_nomax'
const	FORMAT_NORMAL_NOMAX = 'normal_nomax'
	$barWidth = 28
	$barChar
	$emptyBarChar = '-'
	$progressChar = '>'
	$format
	$internalFormat
	$redrawFreq = 1
	$writeCount
	$lastWriteTime
	$minSecondsBetweenRedraws = 0
	$maxSecondsBetweenRedraws = 1
	$output
	$step = 0
	$max
	$startTime
	$stepWidth
	$percent = 0.0
	$formatLineCount
	$messages = []
	$overwrite = true
	$terminal
	$previousMessage
	$cursor

Attributs privés statiques
static	$formatters
static	$formats

Description détaillée

The ProgressBar provides helpers to display progress output.

Auteur

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

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

Documentation des constructeurs et destructeur

__construct()

__construct	(	OutputInterface	$output,
		int	$max = 0,
		float	$minSecondsBetweenRedraws = 1 / 25
	)

Paramètres

int

$max

Maximum steps (0 if unknown)

Références ProgressBar\$max, ProgressBar\$minSecondsBetweenRedraws, ProgressBar\$output, ProgressBar\minSecondsBetweenRedraws(), null, ProgressBar\overwrite(), et ProgressBar\setMaxSteps().

Documentation des fonctions membres

advance()

advance

(

int

$step = 1

)

Advances the progress output X steps.

Paramètres

int

$step

Number of steps to advance

Références ProgressBar\$step, et ProgressBar\setProgress().

Référencé par ProgressBar\iterate().

buildLine()

buildLine ( )

private

Références $text, $this, elseif, Helper\removeDecoration(), ProgressBar\setBarWidth(), et Helper\width().

Référencé par ProgressBar\display().

clear()

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.

Références ProgressBar\determineBestFormat(), null, ProgressBar\overwrite(), et ProgressBar\setRealFormat().

determineBestFormat()

determineBestFormat ( )

private

Références OutputInterface\VERBOSITY_DEBUG, OutputInterface\VERBOSITY_VERBOSE, et OutputInterface\VERBOSITY_VERY_VERBOSE.

Référencé par ProgressBar\clear(), et ProgressBar\display().

display()

display

(

)

Outputs the current progress string.

Références ProgressBar\buildLine(), ProgressBar\determineBestFormat(), null, ProgressBar\overwrite(), ProgressBar\setRealFormat(), et OutputInterface\VERBOSITY_QUIET.

Référencé par ProgressBar\setProgress(), et ProgressBar\start().

finish()

finish

(

)

Finishes the progress output.

Références ProgressBar\$step, ProgressBar\overwrite(), et ProgressBar\setProgress().

Référencé par ProgressBar\iterate().

getBarCharacter()

getBarCharacter

(

)

Références ProgressBar\$emptyBarChar.

getBarOffset()

getBarOffset

(

)

Références null.

getBarWidth()

getBarWidth

(

)

Références ProgressBar\$barWidth.

Référencé par ProgressBar\initPlaceholderFormatters().

getEmptyBarCharacter()

getEmptyBarCharacter

(

)

Références ProgressBar\$emptyBarChar.

getEstimated()

getEstimated

(

)

getFormatDefinition()

static getFormatDefinition ( string  $name )

static

Gets the format for a given name.

Paramètres

string

$name

The format name

Références $name, et null.

getMaxSteps()

getMaxSteps

(

)

Références ProgressBar\$max.

getMessage()

getMessage

(

string

$name = 'message'

)

Références $name.

getPlaceholderFormatterDefinition()

static getPlaceholderFormatterDefinition ( string  $name )

static

Gets the placeholder formatter for a given name.

Paramètres

string

$name

The placeholder name (including the delimiter char like %)

Références $name, et null.

getProgress()

getProgress

(

)

Références ProgressBar\$step.

getProgressCharacter()

getProgressCharacter

(

)

Références ProgressBar\$progressChar.

getProgressPercent()

getProgressPercent

(

)

Références ProgressBar\$percent.

getRemaining()

getRemaining

(

)

getStartTime()

getStartTime

(

)

Références ProgressBar\$startTime.

getStepWidth()

getStepWidth ( )

private

Références ProgressBar\$stepWidth.

initFormats()

static initFormats ( )

staticprivate

initPlaceholderFormatters()

static initPlaceholderFormatters ( )

staticprivate

Références $display, ProgressBar\$output, Helper\formatMemory(), Helper\formatTime(), ProgressBar\getBarWidth(), Helper\length(), et Helper\removeDecoration().

iterate()

iterate	(	iterable	$iterable,
		int	$max = null
	)

Returns an iterator that will automatically update the progress bar when iterated.

Paramètres

int | null

$max

Number of steps to complete the bar (0 if indeterminate), if null it will be inferred from $iterable

Références $key, ProgressBar\$max, $value, ProgressBar\advance(), ProgressBar\finish(), et ProgressBar\start().

maxSecondsBetweenRedraws()

maxSecondsBetweenRedraws

(

float

$seconds

)

Référencé par ProgressBar\setProgress().

minSecondsBetweenRedraws()

minSecondsBetweenRedraws

(

float

$seconds

)

Référencé par ProgressBar\__construct(), et ProgressBar\setProgress().

overwrite()

overwrite ( string  $message )

private

Overwrites a previous message to the output.

Références ProgressBar\$formatLineCount, $i, $message, ProgressBar\$writeCount, elseif, null, Helper\removeDecoration(), et Helper\width().

Référencé par ProgressBar\__construct(), ProgressBar\clear(), ProgressBar\display(), ProgressBar\finish(), et ProgressBar\setOverwrite().

setBarCharacter()

setBarCharacter

(

string

$char

)

setBarWidth()

setBarWidth

(

int

$size

)

Références $size.

Référencé par ProgressBar\buildLine().

setEmptyBarCharacter()

setEmptyBarCharacter

(

string

$char

)

setFormat()

setFormat

(

string

$format

)

Références ProgressBar\$format, et null.

setFormatDefinition()

static setFormatDefinition ( string  $name, string  $format  )

static

Sets a format for a given name.

This method also allow you to override an existing format.

Paramètres

string	$name	The format name
string	$format	A format string

Références ProgressBar\$format, et $name.

Référencé par UpdateCoreCommand\configureIO().

setMaxSteps()

setMaxSteps

(

int

$max

)

Références ProgressBar\$max, null, et Helper\width().

Référencé par ProgressBar\__construct(), et ProgressBar\start().

setMessage()

setMessage	(	string	$message,
		string	$name = 'message'
	)

Associates a text with a named placeholder.

The text is displayed when the progress bar is rendered but only when the corresponding placeholder is part of the custom format line (by wrapping the name with %).

Paramètres

string	$message	The text to associate with the placeholder
string	$name	The name of the placeholder

Références $message, et $name.

setOverwrite()

setOverwrite

(

bool

$overwrite

)

Sets whether to overwrite the progressbar, false for new line.

Références ProgressBar\$overwrite, et ProgressBar\overwrite().

setPlaceholderFormatterDefinition()

static setPlaceholderFormatterDefinition ( string  $name, callable  $callable  )

static

Sets a placeholder formatter for a given name.

This method also allow you to override an existing placeholder.

Paramètres

string	$name	The placeholder name (including the delimiter char like %)
callable	$callable	A PHP callable

Références $name.

setProgress()

setProgress

(

int

$step

)

Références ProgressBar\$lastWriteTime, ProgressBar\$redrawFreq, ProgressBar\$step, ProgressBar\display(), elseif, ProgressBar\maxSecondsBetweenRedraws(), et ProgressBar\minSecondsBetweenRedraws().

Référencé par ProgressBar\advance(), et ProgressBar\finish().

setProgressCharacter()

setProgressCharacter

(

string

$char

)

setRealFormat()

setRealFormat ( string  $format )

private

Références ProgressBar\$format, elseif, et null.

Référencé par ProgressBar\clear(), et ProgressBar\display().

setRedrawFrequency()

setRedrawFrequency

(

?int

$freq

)

Sets the redraw frequency.

Paramètres

int | null

$freq

The frequency in steps

Références null.

start()

start

(

int

$max = null

)

Starts the progress output.

Paramètres

int | null

$max

Number of steps to complete the bar (0 if indeterminate), null to leave unchanged

Références ProgressBar\$max, ProgressBar\display(), null, et ProgressBar\setMaxSteps().

Référencé par ProgressBar\iterate().

Documentation des champs

$barChar

$barChar

private

$barWidth

$barWidth = 28

private

Référencé par ProgressBar\getBarWidth().

$cursor

$cursor

private

$emptyBarChar

$emptyBarChar = '-'

private

Référencé par ProgressBar\getBarCharacter(), et ProgressBar\getEmptyBarCharacter().

$format

$format

private

Référencé par ProgressBar\setFormat(), ProgressBar\setFormatDefinition(), et ProgressBar\setRealFormat().

$formatLineCount

$formatLineCount

private

Référencé par ProgressBar\overwrite().

$formats

$formats

staticprivate

$formatters

$formatters

staticprivate

$internalFormat

$internalFormat

private

$lastWriteTime

$lastWriteTime

private

Référencé par ProgressBar\setProgress().

$max

$max

private

Référencé par ProgressBar\__construct(), ProgressBar\getMaxSteps(), ProgressBar\iterate(), ProgressBar\setMaxSteps(), et ProgressBar\start().

$maxSecondsBetweenRedraws

$maxSecondsBetweenRedraws = 1

private

$messages

$messages = []

private

$minSecondsBetweenRedraws

$minSecondsBetweenRedraws = 0

private

Référencé par ProgressBar\__construct().

$output

$output

private

Référencé par ProgressBar\__construct(), et ProgressBar\initPlaceholderFormatters().

$overwrite

$overwrite = true

private

Référencé par ProgressBar\setOverwrite().

$percent

$percent = 0.0

private

Référencé par ProgressBar\getProgressPercent().

$previousMessage

$previousMessage

private

$progressChar

$progressChar = '>'

private

Référencé par ProgressBar\getProgressCharacter().

$redrawFreq

$redrawFreq = 1

private

Référencé par ProgressBar\setProgress().

$startTime

$startTime

private

Référencé par ProgressBar\getStartTime().

$step

$step = 0

private

Référencé par ProgressBar\advance(), ProgressBar\finish(), ProgressBar\getProgress(), et ProgressBar\setProgress().

$stepWidth

$stepWidth

private

Référencé par ProgressBar\getStepWidth().

$terminal

$terminal

private

$writeCount

$writeCount

private

Référencé par ProgressBar\overwrite().

FORMAT_DEBUG

const FORMAT_DEBUG = 'debug'

FORMAT_DEBUG_NOMAX

const FORMAT_DEBUG_NOMAX = 'debug_nomax'

private

FORMAT_NORMAL

const FORMAT_NORMAL = 'normal'

FORMAT_NORMAL_NOMAX

const FORMAT_NORMAL_NOMAX = 'normal_nomax'

private

FORMAT_VERBOSE

const FORMAT_VERBOSE = 'verbose'

FORMAT_VERBOSE_NOMAX

const FORMAT_VERBOSE_NOMAX = 'verbose_nomax'

private

FORMAT_VERY_VERBOSE

const FORMAT_VERY_VERBOSE = 'very_verbose'

FORMAT_VERY_VERBOSE_NOMAX

const FORMAT_VERY_VERBOSE_NOMAX = 'very_verbose_nomax'

private

---

La documentation de cette classe a été générée à partir du fichier suivant :

• ProgressBar.php