Référence de la classe ProgressIndicator

Fonctions membres publiques
	__construct (OutputInterface $output, string $format=null, int $indicatorChangeInterval=100, array $indicatorValues=null)
	setMessage (?string $message)
	start (string $message)
	advance ()
	finish (string $message)

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

Fonctions membres privées
	display ()
	determineBestFormat ()
	overwrite (string $message)
	getCurrentTimeInMilliseconds ()

Fonctions membres privées statiques
static	initPlaceholderFormatters ()

Attributs privés
const	FORMATS
const	$output
	$startTime
	$format
	$message
	$indicatorValues
	$indicatorCurrent
	$indicatorChangeInterval
	$indicatorUpdateTime
	$started = false

Attributs privés statiques
static	$formatters

Description détaillée

Auteur

Kevin Bond kevin.nosp@m.bond.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Documentation des constructeurs et destructeur

__construct()

__construct	(	OutputInterface	$output,
		string	$format = null,
		int	$indicatorChangeInterval = 100,
		array	$indicatorValues = null
	)

Paramètres

int	$indicatorChangeInterval	Change interval in milliseconds
array | null	$indicatorValues	Animated indicator characters

Références ProgressIndicator\$format, ProgressIndicator\$indicatorChangeInterval, ProgressIndicator\$indicatorValues, ProgressIndicator\$output, ProgressIndicator\determineBestFormat(), et null.

Documentation des fonctions membres

advance()

advance

(

)

Advances the indicator.

Références ProgressIndicator\$indicatorChangeInterval, ProgressIndicator\$indicatorCurrent, ProgressIndicator\display(), et ProgressIndicator\getCurrentTimeInMilliseconds().

determineBestFormat()

determineBestFormat ( )

private

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

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

display()

display ( )

private

Références $this, ProgressIndicator\overwrite(), et OutputInterface\VERBOSITY_QUIET.

Référencé par ProgressIndicator\advance(), ProgressIndicator\finish(), ProgressIndicator\setMessage(), et ProgressIndicator\start().

finish()

finish

(

string

$message

)

Finish the indicator with message.

Paramètres

$message

Références ProgressIndicator\$message, et ProgressIndicator\display().

getCurrentTimeInMilliseconds()

getCurrentTimeInMilliseconds ( )

private

Référencé par ProgressIndicator\advance(), et ProgressIndicator\start().

getFormatDefinition()

static getFormatDefinition ( string  $name )

static

Gets the format for a given name.

Renvoie

string|null

Références $name, et null.

getPlaceholderFormatterDefinition()

static getPlaceholderFormatterDefinition ( string  $name )

static

Gets the placeholder formatter for a given name (including the delimiter char like %).

Renvoie

callable|null

Références $name, et null.

initPlaceholderFormatters()

static initPlaceholderFormatters ( )

staticprivate

Références Helper\formatMemory(), et Helper\formatTime().

overwrite()

overwrite ( string  $message )

private

Overwrites a previous message to the output.

Références ProgressIndicator\$message.

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

setMessage()

setMessage

(

?string

$message

)

Sets the current indicator message.

Références ProgressIndicator\$message, et ProgressIndicator\display().

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.

Références $name.

start()

start

(

string

$message

)

Starts the indicator output.

Références ProgressIndicator\$indicatorChangeInterval, ProgressIndicator\$message, ProgressIndicator\display(), et ProgressIndicator\getCurrentTimeInMilliseconds().

Documentation des champs

$format

$format

private

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

$formatters

$formatters

staticprivate

$indicatorChangeInterval

$indicatorChangeInterval

private

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

$indicatorCurrent

$indicatorCurrent

private

Référencé par ProgressIndicator\advance().

$indicatorUpdateTime

$indicatorUpdateTime

private

$indicatorValues

$indicatorValues

private

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

$message

$message

private

Référencé par ProgressIndicator\finish(), ProgressIndicator\overwrite(), ProgressIndicator\setMessage(), et ProgressIndicator\start().

$output

const $output

private

Valeur initiale :

=> ' %message%',

        'verbose' => ' %indicator% %message% (%elapsed:6s%)',
        'verbose_no_ansi' => ' %message% (%elapsed:6s%)',

        'very_verbose' => ' %indicator% %message% (%elapsed:6s%, %memory:6s%)',
        'very_verbose_no_ansi' => ' %message% (%elapsed:6s%, %memory:6s%)',
    ]

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

$started

$started = false

private

$startTime

$startTime

private

FORMATS

const FORMATS

private

Valeur initiale :

= [
        'normal' => ' %indicator% %message%'

---

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

• ProgressIndicator.php