| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
The ProgressBar provides helpers to display progress output.
| Author: | Fabien Potencier <[email protected]> |
| Author: | Chris Jones <[email protected]> |
| File Size: | 611 lines (19 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct(OutputInterface $output, int $max = 0, float $minSecondsBetweenRedraws = 1 / 25) X-Ref |
param: int $max Maximum steps (0 if unknown) |
| setPlaceholderFormatterDefinition(string $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(string $name) X-Ref |
| Gets the placeholder formatter for a given name. param: string $name The placeholder name (including the delimiter char like %) |
| setFormatDefinition(string $name, string $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(string $name) X-Ref |
| Gets the format for a given name. param: string $name The format name |
| setMessage(string $message, string $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(string $name = 'message') X-Ref |
| No description |
| getStartTime() X-Ref |
| No description |
| getMaxSteps() X-Ref |
| No description |
| getProgress() X-Ref |
| No description |
| getStepWidth() X-Ref |
| No description |
| getProgressPercent() X-Ref |
| No description |
| getBarOffset() X-Ref |
| No description |
| getEstimated() X-Ref |
| No description |
| getRemaining() X-Ref |
| No description |
| setBarWidth(int $size) X-Ref |
| No description |
| getBarWidth() X-Ref |
| No description |
| setBarCharacter(string $char) X-Ref |
| No description |
| getBarCharacter() X-Ref |
| No description |
| setEmptyBarCharacter(string $char) X-Ref |
| No description |
| getEmptyBarCharacter() X-Ref |
| No description |
| setProgressCharacter(string $char) X-Ref |
| No description |
| getProgressCharacter() X-Ref |
| No description |
| setFormat(string $format) X-Ref |
| No description |
| setRedrawFrequency(?int $freq) X-Ref |
| Sets the redraw frequency. param: int|null $freq The frequency in steps |
| minSecondsBetweenRedraws(float $seconds) X-Ref |
| No description |
| maxSecondsBetweenRedraws(float $seconds) X-Ref |
| No description |
| iterate(iterable $iterable, int $max = null) X-Ref |
| Returns an iterator that will automatically update the progress bar when iterated. param: int|null $max Number of steps to complete the bar (0 if indeterminate), if null it will be inferred from $iterable |
| start(int $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(int $step = 1) X-Ref |
| Advances the progress output X steps. param: int $step Number of steps to advance |
| setOverwrite(bool $overwrite) X-Ref |
| Sets whether to overwrite the progressbar, false for new line. |
| setProgress(int $step) X-Ref |
| No description |
| setMaxSteps(int $max) X-Ref |
| No description |
| 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(string $format) X-Ref |
| No description |
| overwrite(string $message) X-Ref |
| Overwrites a previous message to the output. |
| determineBestFormat() X-Ref |
| No description |
| initPlaceholderFormatters() X-Ref |
| No description |
| initFormats() X-Ref |
| No description |
| buildLine() X-Ref |
| No description |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |