-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ProgressHelper.php
163 lines (145 loc) · 4.32 KB
/
ProgressHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP Project
* @since 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Command\Helper;
use Cake\Console\Helper;
use InvalidArgumentException;
/**
* Create a progress bar using a supplied callback.
*
* ## Usage
*
* The ProgressHelper can be accessed from shells using the helper() method
*
* ```
* $this->helper('Progress')->output(['callback' => function ($progress) {
* // Do work
* $progress->increment();
* });
* ```
*/
class ProgressHelper extends Helper
{
/**
* Default value for progress bar total value.
* Percent completion is derived from progress/total
*/
protected const DEFAULT_TOTAL = 100;
/**
* Default value for progress bar width
*/
protected const DEFAULT_WIDTH = 80;
/**
* The current progress.
*
* @var float|int
*/
protected float|int $_progress = 0;
/**
* The total number of 'items' to progress through.
*
* @var int
*/
protected int $_total = self::DEFAULT_TOTAL;
/**
* The width of the bar.
*
* @var int
*/
protected int $_width = self::DEFAULT_WIDTH;
/**
* Output a progress bar.
*
* Takes a number of options to customize the behavior:
*
* - `total` The total number of items in the progress bar. Defaults
* to 100.
* - `width` The width of the progress bar. Defaults to 80.
* - `callback` The callback that will be called in a loop to advance the progress bar.
*
* @param array $args The arguments/options to use when outputting the progress bar.
* @return void
*/
public function output(array $args): void
{
$args += ['callback' => null];
if (isset($args[0])) {
$args['callback'] = $args[0];
}
if (!$args['callback'] || !is_callable($args['callback'])) {
throw new InvalidArgumentException('Callback option must be a callable.');
}
$this->init($args);
$callback = $args['callback'];
$this->_io->out('', 0);
while ($this->_progress < $this->_total) {
$callback($this);
$this->draw();
}
$this->_io->out('');
}
/**
* Initialize the progress bar for use.
*
* - `total` The total number of items in the progress bar. Defaults
* to 100.
* - `width` The width of the progress bar. Defaults to 80.
*
* @param array<string, mixed> $args The initialization data.
* @return $this
*/
public function init(array $args = [])
{
$args += ['total' => self::DEFAULT_TOTAL, 'width' => self::DEFAULT_WIDTH];
$this->_progress = 0;
$this->_width = $args['width'];
$this->_total = $args['total'];
return $this;
}
/**
* Increment the progress bar.
*
* @param float|int $num The amount of progress to advance by.
* @return $this
*/
public function increment(float|int $num = 1)
{
$this->_progress = min(max(0, $this->_progress + $num), $this->_total);
return $this;
}
/**
* Render the progress bar based on the current state.
*
* @return $this
*/
public function draw()
{
$numberLen = strlen(' 100%');
$complete = round($this->_progress / $this->_total, 2);
$barLen = ($this->_width - $numberLen) * $this->_progress / $this->_total;
$bar = '';
if ($barLen > 1) {
$bar = str_repeat('=', (int)$barLen - 1) . '>';
}
$pad = ceil($this->_width - $numberLen - $barLen);
if ($pad > 0) {
$bar .= str_repeat(' ', (int)$pad);
}
$percent = ($complete * 100) . '%';
$bar .= str_pad($percent, $numberLen, ' ', STR_PAD_LEFT);
$this->_io->overwrite($bar, 0);
return $this;
}
}