| [ Index ] |
PHP Cross Reference of phpBB-3.3.12-deutsch |
[Source view] [Print] [Project Stats]
The ProgressBar provides helpers to display progress output.
| Author: | Fabien Potencier <fabien@symfony.com> |
| Author: | Chris Jones <leeked@gmail.com> |
| File Size: | 614 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct(OutputInterface $output, $max = 0) X-Ref |
param: OutputInterface $output An OutputInterface instance param: int $max Maximum steps (0 if unknown) |
| setPlaceholderFormatterDefinition($name, callable $callable) X-Ref |
| Sets a placeholder formatter for a given name. This method also allow you to override an existing placeholder. param: string $name The placeholder name (including the delimiter char like %) param: callable $callable A PHP callable |
| getPlaceholderFormatterDefinition($name) X-Ref |
| Gets the placeholder formatter for a given name. return: callable|null A PHP callable param: string $name The placeholder name (including the delimiter char like %) |
| setFormatDefinition($name, $format) X-Ref |
| Sets a format for a given name. This method also allow you to override an existing format. param: string $name The format name param: string $format A format string |
| getFormatDefinition($name) X-Ref |
| Gets the format for a given name. return: string|null A format string param: string $name The format name |
| setMessage($message, $name = 'message') X-Ref |
| 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: string $message The text to associate with the placeholder param: string $name The name of the placeholder |
| getMessage($name = 'message') X-Ref |
| No description |
| getStartTime() X-Ref |
| Gets the progress bar start time. return: int The progress bar start time |
| getMaxSteps() X-Ref |
| Gets the progress bar maximal steps. return: int The progress bar max steps |
| getProgress() X-Ref |
| Gets the current step position. return: int The progress bar step |
| getStepWidth() X-Ref |
| Gets the progress bar step width. return: int The progress bar step width |
| getProgressPercent() X-Ref |
| Gets the current progress bar percent. return: float The current progress bar percent |
| setBarWidth($size) X-Ref |
| Sets the progress bar width. param: int $size The progress bar size |
| getBarWidth() X-Ref |
| Gets the progress bar width. return: int The progress bar size |
| setBarCharacter($char) X-Ref |
| Sets the bar character. param: string $char A character |
| getBarCharacter() X-Ref |
| Gets the bar character. return: string A character |
| setEmptyBarCharacter($char) X-Ref |
| Sets the empty bar character. param: string $char A character |
| getEmptyBarCharacter() X-Ref |
| Gets the empty bar character. return: string A character |
| setProgressCharacter($char) X-Ref |
| Sets the progress bar character. param: string $char A character |
| getProgressCharacter() X-Ref |
| Gets the progress bar character. return: string 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|float $freq The frequency in steps |
| start($max = null) X-Ref |
| Starts the progress output. param: int|null $max Number of steps to complete the bar (0 if indeterminate), null to leave unchanged |
| advance($step = 1) X-Ref |
| Advances the progress output X steps. param: int $step Number of steps to advance |
| setOverwrite($overwrite) X-Ref |
| Sets whether to overwrite the progressbar, false for new line. param: bool $overwrite |
| setProgress($step) X-Ref |
| Sets the current progress. param: int $step The current progress |
| finish() X-Ref |
| Finishes the progress output. |
| display() X-Ref |
| Outputs the current progress string. |
| 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. |
| setRealFormat($format) X-Ref |
| Sets the progress bar format. param: string $format The format |
| setMaxSteps($max) X-Ref |
| Sets the progress bar maximal steps. param: int $max The progress bar max steps |
| overwrite($message) X-Ref |
| Overwrites a previous message to the output. param: string $message The message |
| determineBestFormat() X-Ref |
| No description |
| initPlaceholderFormatters() X-Ref |
| No description |
| initFormats() X-Ref |
| No description |
| buildLine() X-Ref |
return: string |
| Generated: Sun Jun 23 12:25:44 2024 | Cross-referenced by PHPXref 0.7.1 |