[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/vendor/symfony/console/Helper/ -> ProgressHelper.php (summary)

(no description)

File Size: 469 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ProgressHelper:: (18 methods):
  __construct()
  setBarWidth()
  setBarCharacter()
  setEmptyBarCharacter()
  setProgressCharacter()
  setFormat()
  setRedrawFrequency()
  start()
  advance()
  setCurrent()
  display()
  clear()
  finish()
  initialize()
  generate()
  humaneTime()
  overwrite()
  getName()


Class: ProgressHelper  - X-Ref

The Progress class provides helpers to display progress output.

__construct($triggerDeprecationError = true)   X-Ref
No description

setBarWidth($size)   X-Ref
Sets the progress bar width.

param: int $size The progress bar size

setBarCharacter($char)   X-Ref
Sets the bar character.

param: string $char A character

setEmptyBarCharacter($char)   X-Ref
Sets the empty bar character.

param: string $char A character

setProgressCharacter($char)   X-Ref
Sets the progress bar character.

param: string $char A character

setFormat($format)   X-Ref
Sets the progress bar format.

param: string $format The format

setRedrawFrequency($freq)   X-Ref
Sets the redraw frequency.

param: int $freq The frequency in steps

start(OutputInterface $output, $max = null)   X-Ref
Starts the progress output.

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

advance($step = 1, $redraw = false)   X-Ref
Advances the progress output X steps.

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

setCurrent($current, $redraw = false)   X-Ref
Sets the current progress.

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

display($finish = false)   X-Ref
Outputs the current progress string.

param: bool $finish Forces the end result

clear()   X-Ref
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.

finish()   X-Ref
Finishes the progress output.


initialize()   X-Ref
Initializes the progress helper.


generate($finish = false)   X-Ref
Generates the array map of format variables to values.

param: bool $finish Forces the end result
return: array Array of format vars and values

humaneTime($secs)   X-Ref
Converts seconds into human-readable format.

param: int $secs Number of seconds
return: string Time in readable format

overwrite(OutputInterface $output, $message)   X-Ref
Overwrites a previous message to the output.

param: OutputInterface $output  An Output instance
param: string          $message The message

getName()   X-Ref
{@inheritdoc}




Generated: Sat Oct 26 11:28:42 2019 Cross-referenced by PHPXref 0.7.1