1 | <?php |
||
46 | class Table extends Widget |
||
47 | { |
||
48 | const CHAR_TOP = 'top'; |
||
49 | const CHAR_TOP_MID = 'top-mid'; |
||
50 | const CHAR_TOP_LEFT = 'top-left'; |
||
51 | const CHAR_TOP_RIGHT = 'top-right'; |
||
52 | const CHAR_BOTTOM = 'bottom'; |
||
53 | const CHAR_BOTTOM_MID = 'bottom-mid'; |
||
54 | const CHAR_BOTTOM_LEFT = 'bottom-left'; |
||
55 | const CHAR_BOTTOM_RIGHT = 'bottom-right'; |
||
56 | const CHAR_LEFT = 'left'; |
||
57 | const CHAR_LEFT_MID = 'left-mid'; |
||
58 | const CHAR_MID = 'mid'; |
||
59 | const CHAR_MID_MID = 'mid-mid'; |
||
60 | const CHAR_RIGHT = 'right'; |
||
61 | const CHAR_RIGHT_MID = 'right-mid'; |
||
62 | const CHAR_MIDDLE = 'middle'; |
||
63 | |||
64 | /** |
||
65 | * @var array table headers |
||
66 | */ |
||
67 | private $_headers = []; |
||
68 | /** |
||
69 | * @var array table rows |
||
70 | */ |
||
71 | private $_rows = []; |
||
72 | /** |
||
73 | * @var array table chars |
||
74 | */ |
||
75 | private $_chars = [ |
||
76 | self::CHAR_TOP => '═', |
||
77 | self::CHAR_TOP_MID => '╤', |
||
78 | self::CHAR_TOP_LEFT => '╔', |
||
79 | self::CHAR_TOP_RIGHT => '╗', |
||
80 | self::CHAR_BOTTOM => '═', |
||
81 | self::CHAR_BOTTOM_MID => '╧', |
||
82 | self::CHAR_BOTTOM_LEFT => '╚', |
||
83 | self::CHAR_BOTTOM_RIGHT => '╝', |
||
84 | self::CHAR_LEFT => '║', |
||
85 | self::CHAR_LEFT_MID => '╟', |
||
86 | self::CHAR_MID => '─', |
||
87 | self::CHAR_MID_MID => '┼', |
||
88 | self::CHAR_RIGHT => '║', |
||
89 | self::CHAR_RIGHT_MID => '╢', |
||
90 | self::CHAR_MIDDLE => '│', |
||
91 | ]; |
||
92 | /** |
||
93 | * @var array table column widths |
||
94 | */ |
||
95 | private $_columnWidths = []; |
||
96 | /** |
||
97 | * @var int screen width |
||
98 | */ |
||
99 | private $_screenWidth; |
||
100 | /** |
||
101 | * @var string list prefix |
||
102 | */ |
||
103 | private $_listPrefix = '• '; |
||
104 | |||
105 | /** |
||
106 | * Set table headers. |
||
107 | * |
||
108 | * @param array $headers table headers |
||
109 | * @return $this |
||
110 | */ |
||
111 | 8 | public function setHeaders(array $headers) |
|
112 | { |
||
113 | 8 | $this->_headers = $headers; |
|
114 | 8 | return $this; |
|
115 | } |
||
116 | |||
117 | /** |
||
118 | * Set table rows. |
||
119 | * |
||
120 | * @param array $rows table rows |
||
121 | * @return $this |
||
122 | */ |
||
123 | 8 | public function setRows(array $rows) |
|
124 | { |
||
125 | 8 | $this->_rows = $rows; |
|
126 | 8 | return $this; |
|
127 | } |
||
128 | |||
129 | /** |
||
130 | * Set table chars. |
||
131 | * |
||
132 | * @param array $chars table chars |
||
133 | * @return $this |
||
134 | */ |
||
135 | 1 | public function setChars(array $chars) |
|
136 | { |
||
137 | 1 | $this->_chars = $chars; |
|
138 | 1 | return $this; |
|
139 | } |
||
140 | |||
141 | /** |
||
142 | * Set screen width. |
||
143 | * |
||
144 | * @param int $width screen width |
||
145 | * @return $this |
||
146 | */ |
||
147 | 8 | public function setScreenWidth($width) |
|
148 | { |
||
149 | 8 | $this->_screenWidth = $width; |
|
150 | 8 | return $this; |
|
151 | } |
||
152 | |||
153 | /** |
||
154 | * Set list prefix. |
||
155 | * |
||
156 | * @param string $listPrefix list prefix |
||
157 | * @return $this |
||
158 | */ |
||
159 | 1 | public function setListPrefix($listPrefix) |
|
160 | { |
||
161 | 1 | $this->_listPrefix = $listPrefix; |
|
162 | 1 | return $this; |
|
163 | } |
||
164 | |||
165 | /** |
||
166 | * @return string the rendered table |
||
167 | */ |
||
168 | 8 | public function run() |
|
169 | { |
||
170 | 8 | $this->calculateRowsSize(); |
|
171 | 8 | $buffer = $this->renderSeparator( |
|
172 | 8 | $this->_chars[self::CHAR_TOP_LEFT], |
|
173 | 8 | $this->_chars[self::CHAR_TOP_MID], |
|
174 | 8 | $this->_chars[self::CHAR_TOP], |
|
175 | 8 | $this->_chars[self::CHAR_TOP_RIGHT] |
|
176 | ); |
||
177 | // Header |
||
178 | 8 | $buffer .= $this->renderRow($this->_headers, |
|
179 | 8 | $this->_chars[self::CHAR_LEFT], |
|
180 | 8 | $this->_chars[self::CHAR_MIDDLE], |
|
181 | 8 | $this->_chars[self::CHAR_RIGHT] |
|
182 | ); |
||
183 | |||
184 | // Content |
||
185 | 8 | foreach ($this->_rows as $row) { |
|
186 | 8 | $buffer .= $this->renderSeparator( |
|
187 | 8 | $this->_chars[self::CHAR_LEFT_MID], |
|
188 | 8 | $this->_chars[self::CHAR_MID_MID], |
|
189 | 8 | $this->_chars[self::CHAR_MID], |
|
190 | 8 | $this->_chars[self::CHAR_RIGHT_MID] |
|
191 | ); |
||
192 | 8 | $buffer .= $this->renderRow($row, |
|
193 | 8 | $this->_chars[self::CHAR_LEFT], |
|
194 | 8 | $this->_chars[self::CHAR_MIDDLE], |
|
195 | 8 | $this->_chars[self::CHAR_RIGHT]); |
|
196 | } |
||
197 | |||
198 | 8 | $buffer .= $this->renderSeparator( |
|
199 | 8 | $this->_chars[self::CHAR_BOTTOM_LEFT], |
|
200 | 8 | $this->_chars[self::CHAR_BOTTOM_MID], |
|
201 | 8 | $this->_chars[self::CHAR_BOTTOM], |
|
202 | 8 | $this->_chars[self::CHAR_BOTTOM_RIGHT] |
|
203 | ); |
||
204 | |||
205 | 8 | return $buffer; |
|
206 | } |
||
207 | |||
208 | /** |
||
209 | * Renders a row of data into a string. |
||
210 | * |
||
211 | * @param array $row row of data |
||
212 | * @param string $spanLeft character for left border |
||
213 | * @param string $spanMiddle character for middle border |
||
214 | * @param string $spanRight character for right border |
||
215 | * @return string |
||
216 | * @see \yii\console\widgets\Table::render() |
||
217 | */ |
||
218 | 8 | protected function renderRow(array $row, $spanLeft, $spanMiddle, $spanRight) |
|
219 | { |
||
220 | 8 | $size = $this->_columnWidths; |
|
221 | |||
222 | 8 | $buffer = ''; |
|
223 | 8 | $arrayPointer = []; |
|
224 | 8 | for ($i = 0, ($max = $this->calculateRowHeight($row)) ?: $max = 1; $i < $max; $i++) { |
|
225 | 8 | $buffer .= $spanLeft . ' '; |
|
226 | 8 | foreach ($size as $index => $cellSize) { |
|
227 | 8 | $cell = isset($row[$index]) ? $row[$index] : null; |
|
228 | 8 | $prefix = ''; |
|
229 | 8 | if ($index !== 0) { |
|
230 | 8 | $buffer .= $spanMiddle . ' '; |
|
231 | } |
||
232 | 8 | if (is_array($cell)) { |
|
233 | 2 | if (empty($finalChunk[$index])) { |
|
234 | 2 | $finalChunk[$index] = ''; |
|
|
|||
235 | 2 | $start = 0; |
|
236 | 2 | $prefix = $this->_listPrefix; |
|
237 | 2 | if (!isset($arrayPointer[$index])) { |
|
238 | 2 | $arrayPointer[$index] = 0; |
|
239 | } |
||
240 | } else { |
||
241 | $start = mb_strwidth($finalChunk[$index], Yii::$app->charset); |
||
242 | } |
||
243 | 2 | $chunk = mb_substr($cell[$arrayPointer[$index]], $start, $cellSize - 4, Yii::$app->charset); |
|
244 | 2 | $finalChunk[$index] .= $chunk; |
|
245 | 2 | if (isset($cell[$arrayPointer[$index] + 1]) && $finalChunk[$index] === $cell[$arrayPointer[$index]]) { |
|
246 | 2 | $arrayPointer[$index]++; |
|
247 | 2 | $finalChunk[$index] = ''; |
|
248 | } |
||
249 | } else { |
||
250 | 8 | $chunk = mb_substr($cell, ($cellSize * $i) - ($i * 2), $cellSize - 2, Yii::$app->charset); |
|
251 | } |
||
252 | 8 | $chunk = $prefix . $chunk; |
|
253 | 8 | $repeat = $cellSize - mb_strwidth($chunk, Yii::$app->charset) - 1; |
|
254 | 8 | $buffer .= $chunk; |
|
255 | 8 | if ($repeat >= 0) { |
|
256 | 8 | $buffer .= str_repeat(' ', $repeat); |
|
257 | } |
||
258 | } |
||
259 | 8 | $buffer .= "$spanRight\n"; |
|
260 | } |
||
261 | |||
262 | 8 | return $buffer; |
|
263 | } |
||
264 | |||
265 | /** |
||
266 | * Renders separator. |
||
267 | * |
||
268 | * @param string $spanLeft character for left border |
||
269 | * @param string $spanMid character for middle border |
||
270 | * @param string $spanMidMid character for middle-middle border |
||
271 | * @param string $spanRight character for right border |
||
272 | * @return string the generated separator row |
||
273 | * @see \yii\console\widgets\Table::render() |
||
274 | */ |
||
275 | 8 | protected function renderSeparator($spanLeft, $spanMid, $spanMidMid, $spanRight) |
|
287 | |||
288 | /** |
||
289 | * Calculate the size of rows to draw anchor of columns in console. |
||
290 | * |
||
291 | * @see \yii\console\widgets\Table::render() |
||
292 | */ |
||
293 | 8 | protected function calculateRowsSize() |
|
294 | { |
||
329 | |||
330 | /** |
||
331 | * Calculate the height of a row. |
||
332 | * |
||
333 | * @param array $row |
||
334 | * @return int maximum row per cell |
||
335 | * @see \yii\console\widgets\Table::render() |
||
336 | */ |
||
337 | 8 | protected function calculateRowHeight($row) |
|
362 | |||
363 | /** |
||
364 | * Getting screen width. |
||
365 | * |
||
366 | * @return int screen width |
||
367 | */ |
||
368 | 8 | protected function getScreenWidth() |
|
379 | } |
||
380 |
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArray
is initialized the first time when the foreach loop is entered. You can also see that the value of thebar
key is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.