1 | <?php |
||
5 | class Progress extends DynamicTerminalObject |
||
6 | { |
||
7 | /** |
||
8 | * The total number of items involved |
||
9 | * |
||
10 | * @var integer $total |
||
11 | */ |
||
12 | protected $total = 0; |
||
13 | |||
14 | /** |
||
15 | * The current item that the progress bar represents |
||
16 | * |
||
17 | * @var integer $current |
||
18 | */ |
||
19 | protected $current = 0; |
||
20 | |||
21 | /** |
||
22 | * The current percentage displayed |
||
23 | * |
||
24 | * @var string $current_percentage |
||
25 | */ |
||
26 | protected $current_percentage = ''; |
||
27 | |||
28 | /** |
||
29 | * The string length of the bar when at 100% |
||
30 | * |
||
31 | * @var integer $bar_str_len |
||
32 | */ |
||
33 | protected $bar_str_len; |
||
34 | |||
35 | /** |
||
36 | * Flag indicating whether we are writing the bar for the first time |
||
37 | * |
||
38 | * @var boolean $first_line |
||
39 | */ |
||
40 | protected $first_line = true; |
||
41 | |||
42 | /** |
||
43 | * Current status bar label |
||
44 | * |
||
45 | * @var string $label |
||
46 | */ |
||
47 | protected $label; |
||
48 | |||
49 | /** |
||
50 | * Force a redraw every time |
||
51 | * |
||
52 | * @var boolean $force_redraw |
||
53 | */ |
||
54 | protected $force_redraw = false; |
||
55 | |||
56 | /** |
||
57 | * If this progress bar ever displayed a label. |
||
58 | * |
||
59 | * @var boolean $has_label_line |
||
60 | */ |
||
61 | protected $has_label_line = false; |
||
62 | |||
63 | /** |
||
64 | * If they pass in a total, set the total |
||
65 | * |
||
66 | * @param integer $total |
||
67 | */ |
||
68 | 52 | public function __construct($total = null) |
|
74 | |||
75 | /** |
||
76 | * Set the total property |
||
77 | * |
||
78 | * @param integer $total |
||
79 | * |
||
80 | * @return Progress |
||
81 | */ |
||
82 | 48 | public function total($total) |
|
88 | |||
89 | /** |
||
90 | * Determines the current percentage we are at and re-writes the progress bar |
||
91 | * |
||
92 | * @param integer $current |
||
93 | * @param mixed $label |
||
94 | * @throws \Exception |
||
95 | */ |
||
96 | 52 | public function current($current, $label = null) |
|
112 | |||
113 | /** |
||
114 | * Increments the current position we are at and re-writes the progress bar |
||
115 | * |
||
116 | * @param integer $increment The number of items to increment by |
||
117 | * @param string $label |
||
118 | */ |
||
119 | 12 | public function advance($increment = 1, $label = null) |
|
123 | |||
124 | /** |
||
125 | * Force the progress bar to redraw every time regardless of whether it has changed or not |
||
126 | * |
||
127 | * @param boolean $force |
||
128 | * @return Progress |
||
129 | */ |
||
130 | 8 | public function forceRedraw($force = true) |
|
136 | |||
137 | /** |
||
138 | * Loop through the data and self manage the progress bar advancement |
||
139 | * |
||
140 | * @param mixed $data Array or any other iterable object |
||
141 | * @param callable $callback |
||
142 | */ |
||
143 | 4 | public function each($data, callable $callback) |
|
154 | |||
155 | /** |
||
156 | * Draw the progress bar, if necessary |
||
157 | * |
||
158 | * @param string $current |
||
159 | * @param string $label |
||
160 | */ |
||
161 | 44 | protected function drawProgressBar($current, $label) |
|
172 | |||
173 | /** |
||
174 | * Build the progress bar str and return it |
||
175 | * |
||
176 | * @param integer $current |
||
177 | * @param string $label |
||
178 | * |
||
179 | * @return string |
||
180 | */ |
||
181 | 44 | protected function getProgressBar($current, $label) |
|
205 | |||
206 | /** |
||
207 | * Get the progress bar string, basically: |
||
208 | * =============> 50% label |
||
209 | * |
||
210 | * @param integer $current |
||
211 | * @param string $label |
||
212 | * |
||
213 | * @return string |
||
214 | */ |
||
215 | 44 | protected function getProgressBarStr($current, $label) |
|
233 | |||
234 | /** |
||
235 | * Get the string for the actual bar based on the current length |
||
236 | * |
||
237 | * @param integer $length |
||
238 | * |
||
239 | * @return string |
||
240 | */ |
||
241 | 44 | protected function getBar($length) |
|
248 | |||
249 | /** |
||
250 | * Get the length of the bar string based on the width of the terminal window |
||
251 | * |
||
252 | * @return integer |
||
253 | */ |
||
254 | 44 | protected function getBarStrLen() |
|
263 | |||
264 | /** |
||
265 | * Format the percentage so it looks pretty |
||
266 | * |
||
267 | * @param integer $percentage |
||
268 | * @return float |
||
269 | */ |
||
270 | 44 | protected function percentageFormatted($percentage) |
|
274 | |||
275 | /** |
||
276 | * Format the label so it is positioned correctly |
||
277 | * |
||
278 | * @param string $label |
||
279 | * @return string |
||
280 | */ |
||
281 | 12 | protected function labelFormatted($label) |
|
285 | |||
286 | /** |
||
287 | * Determine whether the progress bar has changed and we need to redrew |
||
288 | * |
||
289 | * @param string $percentage |
||
290 | * @param string $label |
||
291 | * |
||
292 | * @return boolean |
||
293 | */ |
||
294 | 44 | protected function shouldRedraw($percentage, $label) |
|
298 | } |
||
299 |