display(bool $finish = false) Outputs the current progress string. Parameters bool $finish Forces the end result Exceptions LogicException

setProgressCharacter(string $char) Sets the progress bar character. Parameters string $char A character

setRedrawFrequency(int|float $freq) Sets the redraw frequency. Parameters int|float $freq The frequency in steps

start(int|null $max = null) Starts the progress output. Parameters int|null $max Number of steps to complete the bar (0 if indeterminate), null to leave unchanged

setEmptyBarCharacter(string $char) Sets the empty bar character. Parameters string $char A character

static setPlaceholderFormatterDefinition(string $name, callable $callable) Sets a placeholder formatter for a given name. This method also allow you to override an existing placeholder. Parameters string $name The placeholder name (including the delimiter char like %) callable $callable A PHP callable

static setFormatDefinition(string $name, string $format) Sets a format for a given name. This method also allow you to override an existing format. Parameters string $name The format name string $format A format string

setProgress(int $step) Sets the current progress. Parameters int $step The current progress Exceptions LogicException

setFormat(string $format) Sets the progress bar format. Parameters string $format The format

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 %). Parameters string $message The text to associate with the placeholder string $name The name of the placeholder