|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Copyright (c) 2016-present Ganbaro Digital Ltd |
|
5
|
|
|
* All rights reserved. |
|
6
|
|
|
* |
|
7
|
|
|
* Redistribution and use in source and binary forms, with or without |
|
8
|
|
|
* modification, are permitted provided that the following conditions |
|
9
|
|
|
* are met: |
|
10
|
|
|
* |
|
11
|
|
|
* * Redistributions of source code must retain the above copyright |
|
12
|
|
|
* notice, this list of conditions and the following disclaimer. |
|
13
|
|
|
* |
|
14
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
|
15
|
|
|
* notice, this list of conditions and the following disclaimer in |
|
16
|
|
|
* the documentation and/or other materials provided with the |
|
17
|
|
|
* distribution. |
|
18
|
|
|
* |
|
19
|
|
|
* * Neither the names of the copyright holders nor the names of his |
|
20
|
|
|
* contributors may be used to endorse or promote products derived |
|
21
|
|
|
* from this software without specific prior written permission. |
|
22
|
|
|
* |
|
23
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
24
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
25
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|
26
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|
27
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
28
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|
29
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|
30
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
31
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
32
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
33
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
34
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
|
35
|
|
|
* |
|
36
|
|
|
* @category Libraries |
|
37
|
|
|
* @package MissingBits/ConsoleFunctions |
|
38
|
|
|
* @author Stuart Herbert <[email protected]> |
|
39
|
|
|
* @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com |
|
40
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
|
41
|
|
|
* @link http://ganbarodigital.github.io/php-the-missing-bits |
|
42
|
|
|
*/ |
|
43
|
|
|
|
|
44
|
|
|
use GanbaroDigital\MissingBits\ConsoleOutput\ShowProgress; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* echo a character for each item, along with '[x / y]' to show overall |
|
48
|
|
|
* progress |
|
49
|
|
|
* |
|
50
|
|
|
* @param string $progressChar |
|
51
|
|
|
* what should we output? |
|
52
|
|
|
* this should be a single character; ASCII codes are fine |
|
53
|
|
|
* as long as they only move the cursor 1 character to the |
|
54
|
|
|
* right after they have completed |
|
55
|
|
|
* @param int $currentProgress |
|
56
|
|
|
* how much progress has been made? |
|
57
|
|
|
* @param int $maxProgress |
|
58
|
|
|
* what is the maximum value of $currentProgress? |
|
59
|
|
|
* @param int $consoleWidth |
|
60
|
|
|
* how wide is the terminal display? |
|
61
|
|
|
* default assumes UNIX standard width of 80 chars |
|
62
|
|
|
* @param callback $printerFunc |
|
63
|
|
|
* what should we use to write to the console? |
|
64
|
|
|
* this needs to accept printf() arguments |
|
65
|
|
|
* @return string |
|
66
|
|
|
* anything returned by your $printerFunc |
|
67
|
|
|
*/ |
|
68
|
|
|
function show_progress($progressChar, $currentProgress, $maxProgress, $consoleWidth = 80, $printerFunc = 'printf') |
|
69
|
|
|
{ |
|
70
|
|
|
return ShowProgress::with($progressChar, $currentProgress, $maxProgress, $consoleWidth, $printerFunc); |
|
71
|
|
|
} |
ganbarodigital /
php-the-missing-bits
