diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Console] added explanation of messages usage in a progress bar

Browse Source
This commit is contained in:
Fabien Potencier 2016-06-12 09:55:59 +02:00
parent a77431c85b
commit d92f3ea29e
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Symfony/Component/Console/Helper/ProgressBar.php
View File

@ -41,7 +41,7 @@ class ProgressBar
private $stepWidth; private $stepWidth;
private $percent = 0.0; private $percent = 0.0;
private $formatLineCount; private $formatLineCount;
private $messages; private $messages = array();
private $overwrite = true; private $overwrite = true;
private static $formatters; private static $formatters;
@ -139,6 +139,16 @@ class ProgressBar
return isset(self::$formats[$name]) ? self::$formats[$name] : null; return isset(self::$formats[$name]) ? self::$formats[$name] : null;
} }
/**
* 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
*/
public function setMessage($message, $name = 'message') public function setMessage($message, $name = 'message')
{ {
$this->messages[$name] = $message; $this->messages[$name] = $message;