|
1 <?php |
|
2 /** |
|
3 * LICENSE |
|
4 * |
|
5 * This source file is subject to the new BSD license that is bundled |
|
6 * with this package in the file LICENSE.txt. |
|
7 * It is also available through the world-wide-web at this URL: |
|
8 * http://framework.zend.com/license/new-bsd |
|
9 * If you did not receive a copy of the license and are unable to |
|
10 * obtain it through the world-wide-web, please send an email |
|
11 * to license@zend.com so we can send you a copy immediately. |
|
12 * |
|
13 * @category Zend |
|
14 * @package Zend_ProgressBar |
|
15 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
16 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
17 * @version $Id: ProgressBar.php 20096 2010-01-06 02:05:09Z bkarwin $ |
|
18 */ |
|
19 |
|
20 /** |
|
21 * Zend_ProgressBar offers an interface for multiple enviroments. |
|
22 * |
|
23 * @category Zend |
|
24 * @package Zend_ProgressBar |
|
25 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
26 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
27 */ |
|
28 class Zend_ProgressBar |
|
29 { |
|
30 /** |
|
31 * Min value |
|
32 * |
|
33 * @var float |
|
34 */ |
|
35 protected $_min; |
|
36 |
|
37 /** |
|
38 * Max value |
|
39 * |
|
40 * @var float |
|
41 */ |
|
42 protected $_max; |
|
43 |
|
44 /** |
|
45 * Current value |
|
46 * |
|
47 * @var float |
|
48 */ |
|
49 protected $_current; |
|
50 |
|
51 /** |
|
52 * Start time of the progressbar, required for ETA |
|
53 * |
|
54 * @var integer |
|
55 */ |
|
56 protected $_startTime; |
|
57 |
|
58 /** |
|
59 * Current status text |
|
60 * |
|
61 * @var string |
|
62 */ |
|
63 protected $_statusText = null; |
|
64 |
|
65 /** |
|
66 * Adapter for the output |
|
67 * |
|
68 * @var Zend_ProgressBar_Adapter |
|
69 */ |
|
70 protected $_adapter; |
|
71 |
|
72 /** |
|
73 * Namespace for keeping the progressbar persistent |
|
74 * |
|
75 * @var string |
|
76 */ |
|
77 protected $_persistenceNamespace = null; |
|
78 |
|
79 /** |
|
80 * Create a new progressbar backend. |
|
81 * |
|
82 * @param Zend_ProgressBar_Adapter $adapter |
|
83 * @param float $min |
|
84 * @param float $max |
|
85 * @param string $persistenceNamespace |
|
86 * @throws Zend_ProgressBar_Exception When $min is greater than $max |
|
87 */ |
|
88 public function __construct(Zend_ProgressBar_Adapter $adapter, $min = 0, $max = 100, $persistenceNamespace = null) |
|
89 { |
|
90 // Check min/max values and set them |
|
91 if ($min > $max) { |
|
92 require_once 'Zend/ProgressBar/Exception.php'; |
|
93 throw new Zend_ProgressBar_Exception('$max must be greater than $min'); |
|
94 } |
|
95 |
|
96 $this->_min = (float) $min; |
|
97 $this->_max = (float) $max; |
|
98 $this->_current = (float) $min; |
|
99 |
|
100 // See if we have to open a session namespace |
|
101 if ($persistenceNamespace !== null) { |
|
102 require_once 'Zend/Session/Namespace.php'; |
|
103 |
|
104 $this->_persistenceNamespace = new Zend_Session_Namespace($persistenceNamespace); |
|
105 } |
|
106 |
|
107 // Set adapter |
|
108 $this->_adapter = $adapter; |
|
109 |
|
110 // Track the start time |
|
111 $this->_startTime = time(); |
|
112 |
|
113 // See If a persistenceNamespace exists and handle accordingly |
|
114 if ($this->_persistenceNamespace !== null) { |
|
115 if (isset($this->_persistenceNamespace->isSet)) { |
|
116 $this->_startTime = $this->_persistenceNamespace->startTime; |
|
117 $this->_current = $this->_persistenceNamespace->current; |
|
118 $this->_statusText = $this->_persistenceNamespace->statusText; |
|
119 } else { |
|
120 $this->_persistenceNamespace->isSet = true; |
|
121 $this->_persistenceNamespace->startTime = $this->_startTime; |
|
122 $this->_persistenceNamespace->current = $this->_current; |
|
123 $this->_persistenceNamespace->statusText = $this->_statusText; |
|
124 } |
|
125 } else { |
|
126 $this->update(); |
|
127 } |
|
128 } |
|
129 |
|
130 /** |
|
131 * Get the current adapter |
|
132 * |
|
133 * @return Zend_ProgressBar_Adapter |
|
134 */ |
|
135 public function getAdapter() |
|
136 { |
|
137 return $this->_adapter; |
|
138 } |
|
139 |
|
140 /** |
|
141 * Update the progressbar |
|
142 * |
|
143 * @param float $value |
|
144 * @param string $text |
|
145 * @return void |
|
146 */ |
|
147 public function update($value = null, $text = null) |
|
148 { |
|
149 // Update value if given |
|
150 if ($value !== null) { |
|
151 $this->_current = min($this->_max, max($this->_min, $value)); |
|
152 } |
|
153 |
|
154 // Update text if given |
|
155 if ($text !== null) { |
|
156 $this->_statusText = $text; |
|
157 } |
|
158 |
|
159 // See if we have to update a namespace |
|
160 if ($this->_persistenceNamespace !== null) { |
|
161 $this->_persistenceNamespace->current = $this->_current; |
|
162 $this->_persistenceNamespace->statusText = $this->_statusText; |
|
163 } |
|
164 |
|
165 // Calculate percent |
|
166 if ($this->_min === $this->_max) { |
|
167 $percent = false; |
|
168 } else { |
|
169 $percent = (float) ($this->_current - $this->_min) / ($this->_max - $this->_min); |
|
170 } |
|
171 |
|
172 // Calculate ETA |
|
173 $timeTaken = time() - $this->_startTime; |
|
174 |
|
175 if ($percent === .0 || $percent === false) { |
|
176 $timeRemaining = null; |
|
177 } else { |
|
178 $timeRemaining = round(((1 / $percent) * $timeTaken) - $timeTaken); |
|
179 } |
|
180 |
|
181 // Poll the adapter |
|
182 $this->_adapter->notify($this->_current, $this->_max, $percent, $timeTaken, $timeRemaining, $this->_statusText); |
|
183 } |
|
184 |
|
185 /** |
|
186 * Update the progressbar to the next value |
|
187 * |
|
188 * @param string $text |
|
189 * @return void |
|
190 */ |
|
191 public function next($diff = 1, $text = null) |
|
192 { |
|
193 $this->update(max($this->_min, min($this->_max, $this->_current + $diff)), $text); |
|
194 } |
|
195 |
|
196 /** |
|
197 * Call the adapters finish() behaviour |
|
198 * |
|
199 * @return void |
|
200 */ |
|
201 public function finish() |
|
202 { |
|
203 if ($this->_persistenceNamespace !== null) { |
|
204 unset($this->_persistenceNamespace->isSet); |
|
205 } |
|
206 |
|
207 $this->_adapter->finish(); |
|
208 } |
|
209 } |