Total Complexity | 215 |
Total Lines | 1164 |
Duplicated Lines | 0 % |
Coverage | 89.73% |
Changes | 0 |
Complex classes like Worksheet often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Worksheet, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
22 | class Worksheet extends WriterPart |
||
23 | { |
||
24 | /** |
||
25 | * Write worksheet to XML format. |
||
26 | * |
||
27 | * @param PhpspreadsheetWorksheet $pSheet |
||
28 | * @param string[] $pStringTable |
||
29 | * @param bool $includeCharts Flag indicating if we should write charts |
||
30 | * |
||
31 | * @throws WriterException |
||
32 | * |
||
33 | * @return string XML Output |
||
34 | */ |
||
35 | 73 | public function writeWorksheet(PhpspreadsheetWorksheet $pSheet, $pStringTable = null, $includeCharts = false) |
|
121 | } |
||
122 | |||
123 | /** |
||
124 | * Write SheetPr. |
||
125 | * |
||
126 | * @param XMLWriter $objWriter XML Writer |
||
127 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
128 | */ |
||
129 | 73 | private function writeSheetPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
130 | { |
||
131 | // sheetPr |
||
132 | 73 | $objWriter->startElement('sheetPr'); |
|
133 | 73 | if ($pSheet->getParent()->hasMacros()) { |
|
134 | //if the workbook have macros, we need to have codeName for the sheet |
||
135 | if ($pSheet->hasCodeName() == false) { |
||
136 | $pSheet->setCodeName($pSheet->getTitle()); |
||
137 | } |
||
138 | $objWriter->writeAttribute('codeName', $pSheet->getCodeName()); |
||
139 | } |
||
140 | 73 | $autoFilterRange = $pSheet->getAutoFilter()->getRange(); |
|
141 | 73 | if (!empty($autoFilterRange)) { |
|
142 | 3 | $objWriter->writeAttribute('filterMode', 1); |
|
143 | 3 | $pSheet->getAutoFilter()->showHideRows(); |
|
144 | } |
||
145 | |||
146 | // tabColor |
||
147 | 73 | if ($pSheet->isTabColorSet()) { |
|
148 | 6 | $objWriter->startElement('tabColor'); |
|
149 | 6 | $objWriter->writeAttribute('rgb', $pSheet->getTabColor()->getARGB()); |
|
150 | 6 | $objWriter->endElement(); |
|
151 | } |
||
152 | |||
153 | // outlinePr |
||
154 | 73 | $objWriter->startElement('outlinePr'); |
|
155 | 73 | $objWriter->writeAttribute('summaryBelow', ($pSheet->getShowSummaryBelow() ? '1' : '0')); |
|
156 | 73 | $objWriter->writeAttribute('summaryRight', ($pSheet->getShowSummaryRight() ? '1' : '0')); |
|
157 | 73 | $objWriter->endElement(); |
|
158 | |||
159 | // pageSetUpPr |
||
160 | 73 | if ($pSheet->getPageSetup()->getFitToPage()) { |
|
161 | $objWriter->startElement('pageSetUpPr'); |
||
162 | $objWriter->writeAttribute('fitToPage', '1'); |
||
163 | $objWriter->endElement(); |
||
164 | } |
||
165 | |||
166 | 73 | $objWriter->endElement(); |
|
167 | 73 | } |
|
168 | |||
169 | /** |
||
170 | * Write Dimension. |
||
171 | * |
||
172 | * @param XMLWriter $objWriter XML Writer |
||
173 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
174 | */ |
||
175 | 73 | private function writeDimension(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
176 | { |
||
177 | // dimension |
||
178 | 73 | $objWriter->startElement('dimension'); |
|
179 | 73 | $objWriter->writeAttribute('ref', $pSheet->calculateWorksheetDimension()); |
|
180 | 73 | $objWriter->endElement(); |
|
181 | 73 | } |
|
182 | |||
183 | /** |
||
184 | * Write SheetViews. |
||
185 | * |
||
186 | * @param XMLWriter $objWriter XML Writer |
||
187 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
188 | * |
||
189 | * @throws WriterException |
||
190 | */ |
||
191 | 73 | private function writeSheetViews(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
192 | { |
||
193 | // sheetViews |
||
194 | 73 | $objWriter->startElement('sheetViews'); |
|
195 | |||
196 | // Sheet selected? |
||
197 | 73 | $sheetSelected = false; |
|
198 | 73 | if ($this->getParentWriter()->getSpreadsheet()->getIndex($pSheet) == $this->getParentWriter()->getSpreadsheet()->getActiveSheetIndex()) { |
|
199 | 73 | $sheetSelected = true; |
|
200 | } |
||
201 | |||
202 | // sheetView |
||
203 | 73 | $objWriter->startElement('sheetView'); |
|
204 | 73 | $objWriter->writeAttribute('tabSelected', $sheetSelected ? '1' : '0'); |
|
205 | 73 | $objWriter->writeAttribute('workbookViewId', '0'); |
|
206 | |||
207 | // Zoom scales |
||
208 | 73 | if ($pSheet->getSheetView()->getZoomScale() != 100) { |
|
209 | $objWriter->writeAttribute('zoomScale', $pSheet->getSheetView()->getZoomScale()); |
||
210 | } |
||
211 | 73 | if ($pSheet->getSheetView()->getZoomScaleNormal() != 100) { |
|
212 | $objWriter->writeAttribute('zoomScaleNormal', $pSheet->getSheetView()->getZoomScaleNormal()); |
||
213 | } |
||
214 | |||
215 | // View Layout Type |
||
216 | 73 | if ($pSheet->getSheetView()->getView() !== SheetView::SHEETVIEW_NORMAL) { |
|
217 | 1 | $objWriter->writeAttribute('view', $pSheet->getSheetView()->getView()); |
|
218 | } |
||
219 | |||
220 | // Gridlines |
||
221 | 73 | if ($pSheet->getShowGridlines()) { |
|
222 | 73 | $objWriter->writeAttribute('showGridLines', 'true'); |
|
223 | } else { |
||
224 | $objWriter->writeAttribute('showGridLines', 'false'); |
||
225 | } |
||
226 | |||
227 | // Row and column headers |
||
228 | 73 | if ($pSheet->getShowRowColHeaders()) { |
|
229 | 73 | $objWriter->writeAttribute('showRowColHeaders', '1'); |
|
230 | } else { |
||
231 | $objWriter->writeAttribute('showRowColHeaders', '0'); |
||
232 | } |
||
233 | |||
234 | // Right-to-left |
||
235 | 73 | if ($pSheet->getRightToLeft()) { |
|
236 | $objWriter->writeAttribute('rightToLeft', 'true'); |
||
237 | } |
||
238 | |||
239 | 73 | $activeCell = $pSheet->getActiveCell(); |
|
240 | |||
241 | // Pane |
||
242 | 73 | $pane = ''; |
|
243 | 73 | if ($pSheet->getFreezePane()) { |
|
244 | 4 | list($xSplit, $ySplit) = Coordinate::coordinateFromString($pSheet->getFreezePane()); |
|
245 | 4 | $xSplit = Coordinate::columnIndexFromString($xSplit); |
|
246 | 4 | --$xSplit; |
|
247 | 4 | --$ySplit; |
|
248 | |||
249 | 4 | $topLeftCell = $pSheet->getTopLeftCell(); |
|
250 | 4 | $activeCell = $topLeftCell; |
|
251 | |||
252 | // pane |
||
253 | 4 | $pane = 'topRight'; |
|
254 | 4 | $objWriter->startElement('pane'); |
|
255 | 4 | if ($xSplit > 0) { |
|
256 | 1 | $objWriter->writeAttribute('xSplit', $xSplit); |
|
257 | } |
||
258 | 4 | if ($ySplit > 0) { |
|
259 | 4 | $objWriter->writeAttribute('ySplit', $ySplit); |
|
260 | 4 | $pane = ($xSplit > 0) ? 'bottomRight' : 'bottomLeft'; |
|
261 | } |
||
262 | 4 | $objWriter->writeAttribute('topLeftCell', $topLeftCell); |
|
263 | 4 | $objWriter->writeAttribute('activePane', $pane); |
|
264 | 4 | $objWriter->writeAttribute('state', 'frozen'); |
|
265 | 4 | $objWriter->endElement(); |
|
266 | |||
267 | 4 | if (($xSplit > 0) && ($ySplit > 0)) { |
|
268 | // Write additional selections if more than two panes (ie both an X and a Y split) |
||
269 | 1 | $objWriter->startElement('selection'); |
|
270 | 1 | $objWriter->writeAttribute('pane', 'topRight'); |
|
271 | 1 | $objWriter->endElement(); |
|
272 | 1 | $objWriter->startElement('selection'); |
|
273 | 1 | $objWriter->writeAttribute('pane', 'bottomLeft'); |
|
274 | 1 | $objWriter->endElement(); |
|
275 | } |
||
276 | } |
||
277 | |||
278 | // Selection |
||
279 | // Only need to write selection element if we have a split pane |
||
280 | // We cheat a little by over-riding the active cell selection, setting it to the split cell |
||
281 | 73 | $objWriter->startElement('selection'); |
|
282 | 73 | if ($pane != '') { |
|
283 | 4 | $objWriter->writeAttribute('pane', $pane); |
|
284 | } |
||
285 | 73 | $objWriter->writeAttribute('activeCell', $activeCell); |
|
286 | 73 | $objWriter->writeAttribute('sqref', $activeCell); |
|
287 | 73 | $objWriter->endElement(); |
|
288 | |||
289 | 73 | $objWriter->endElement(); |
|
290 | |||
291 | 73 | $objWriter->endElement(); |
|
292 | 73 | } |
|
293 | |||
294 | /** |
||
295 | * Write SheetFormatPr. |
||
296 | * |
||
297 | * @param XMLWriter $objWriter XML Writer |
||
298 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
299 | */ |
||
300 | 73 | private function writeSheetFormatPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
301 | { |
||
302 | // sheetFormatPr |
||
303 | 73 | $objWriter->startElement('sheetFormatPr'); |
|
304 | |||
305 | // Default row height |
||
306 | 73 | if ($pSheet->getDefaultRowDimension()->getRowHeight() >= 0) { |
|
307 | 2 | $objWriter->writeAttribute('customHeight', 'true'); |
|
308 | 2 | $objWriter->writeAttribute('defaultRowHeight', StringHelper::formatNumber($pSheet->getDefaultRowDimension()->getRowHeight())); |
|
309 | } else { |
||
310 | 71 | $objWriter->writeAttribute('defaultRowHeight', '14.4'); |
|
311 | } |
||
312 | |||
313 | // Set Zero Height row |
||
314 | 73 | if ((string) $pSheet->getDefaultRowDimension()->getZeroHeight() == '1' || |
|
315 | 73 | strtolower((string) $pSheet->getDefaultRowDimension()->getZeroHeight()) == 'true') { |
|
316 | $objWriter->writeAttribute('zeroHeight', '1'); |
||
317 | } |
||
318 | |||
319 | // Default column width |
||
320 | 73 | if ($pSheet->getDefaultColumnDimension()->getWidth() >= 0) { |
|
321 | 1 | $objWriter->writeAttribute('defaultColWidth', StringHelper::formatNumber($pSheet->getDefaultColumnDimension()->getWidth())); |
|
322 | } |
||
323 | |||
324 | // Outline level - row |
||
325 | 73 | $outlineLevelRow = 0; |
|
326 | 73 | foreach ($pSheet->getRowDimensions() as $dimension) { |
|
327 | 11 | if ($dimension->getOutlineLevel() > $outlineLevelRow) { |
|
328 | 11 | $outlineLevelRow = $dimension->getOutlineLevel(); |
|
329 | } |
||
330 | } |
||
331 | 73 | $objWriter->writeAttribute('outlineLevelRow', (int) $outlineLevelRow); |
|
332 | |||
333 | // Outline level - column |
||
334 | 73 | $outlineLevelCol = 0; |
|
335 | 73 | foreach ($pSheet->getColumnDimensions() as $dimension) { |
|
336 | 21 | if ($dimension->getOutlineLevel() > $outlineLevelCol) { |
|
337 | 21 | $outlineLevelCol = $dimension->getOutlineLevel(); |
|
338 | } |
||
339 | } |
||
340 | 73 | $objWriter->writeAttribute('outlineLevelCol', (int) $outlineLevelCol); |
|
341 | |||
342 | 73 | $objWriter->endElement(); |
|
343 | 73 | } |
|
344 | |||
345 | /** |
||
346 | * Write Cols. |
||
347 | * |
||
348 | * @param XMLWriter $objWriter XML Writer |
||
349 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
350 | */ |
||
351 | 73 | private function writeCols(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
352 | { |
||
353 | // cols |
||
354 | 73 | if (count($pSheet->getColumnDimensions()) > 0) { |
|
355 | 21 | $objWriter->startElement('cols'); |
|
356 | |||
357 | 21 | $pSheet->calculateColumnWidths(); |
|
358 | |||
359 | // Loop through column dimensions |
||
360 | 21 | foreach ($pSheet->getColumnDimensions() as $colDimension) { |
|
361 | // col |
||
362 | 21 | $objWriter->startElement('col'); |
|
363 | 21 | $objWriter->writeAttribute('min', Coordinate::columnIndexFromString($colDimension->getColumnIndex())); |
|
364 | 21 | $objWriter->writeAttribute('max', Coordinate::columnIndexFromString($colDimension->getColumnIndex())); |
|
365 | |||
366 | 21 | if ($colDimension->getWidth() < 0) { |
|
367 | // No width set, apply default of 10 |
||
368 | 2 | $objWriter->writeAttribute('width', '9.10'); |
|
369 | } else { |
||
370 | // Width set |
||
371 | 21 | $objWriter->writeAttribute('width', StringHelper::formatNumber($colDimension->getWidth())); |
|
372 | } |
||
373 | |||
374 | // Column visibility |
||
375 | 21 | if ($colDimension->getVisible() == false) { |
|
376 | 3 | $objWriter->writeAttribute('hidden', 'true'); |
|
377 | } |
||
378 | |||
379 | // Auto size? |
||
380 | 21 | if ($colDimension->getAutoSize()) { |
|
381 | 8 | $objWriter->writeAttribute('bestFit', 'true'); |
|
382 | } |
||
383 | |||
384 | // Custom width? |
||
385 | 21 | if ($colDimension->getWidth() != $pSheet->getDefaultColumnDimension()->getWidth()) { |
|
386 | 21 | $objWriter->writeAttribute('customWidth', 'true'); |
|
387 | } |
||
388 | |||
389 | // Collapsed |
||
390 | 21 | if ($colDimension->getCollapsed() == true) { |
|
391 | 1 | $objWriter->writeAttribute('collapsed', 'true'); |
|
392 | } |
||
393 | |||
394 | // Outline level |
||
395 | 21 | if ($colDimension->getOutlineLevel() > 0) { |
|
396 | 1 | $objWriter->writeAttribute('outlineLevel', $colDimension->getOutlineLevel()); |
|
397 | } |
||
398 | |||
399 | // Style |
||
400 | 21 | $objWriter->writeAttribute('style', $colDimension->getXfIndex()); |
|
401 | |||
402 | 21 | $objWriter->endElement(); |
|
403 | } |
||
404 | |||
405 | 21 | $objWriter->endElement(); |
|
406 | } |
||
407 | 73 | } |
|
408 | |||
409 | /** |
||
410 | * Write SheetProtection. |
||
411 | * |
||
412 | * @param XMLWriter $objWriter XML Writer |
||
413 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
414 | */ |
||
415 | 73 | private function writeSheetProtection(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
416 | { |
||
417 | // sheetProtection |
||
418 | 73 | $objWriter->startElement('sheetProtection'); |
|
419 | |||
420 | 73 | if ($pSheet->getProtection()->getPassword() != '') { |
|
421 | 1 | $objWriter->writeAttribute('password', $pSheet->getProtection()->getPassword()); |
|
422 | } |
||
423 | |||
424 | 73 | $objWriter->writeAttribute('sheet', ($pSheet->getProtection()->getSheet() ? 'true' : 'false')); |
|
425 | 73 | $objWriter->writeAttribute('objects', ($pSheet->getProtection()->getObjects() ? 'true' : 'false')); |
|
426 | 73 | $objWriter->writeAttribute('scenarios', ($pSheet->getProtection()->getScenarios() ? 'true' : 'false')); |
|
427 | 73 | $objWriter->writeAttribute('formatCells', ($pSheet->getProtection()->getFormatCells() ? 'true' : 'false')); |
|
428 | 73 | $objWriter->writeAttribute('formatColumns', ($pSheet->getProtection()->getFormatColumns() ? 'true' : 'false')); |
|
429 | 73 | $objWriter->writeAttribute('formatRows', ($pSheet->getProtection()->getFormatRows() ? 'true' : 'false')); |
|
430 | 73 | $objWriter->writeAttribute('insertColumns', ($pSheet->getProtection()->getInsertColumns() ? 'true' : 'false')); |
|
431 | 73 | $objWriter->writeAttribute('insertRows', ($pSheet->getProtection()->getInsertRows() ? 'true' : 'false')); |
|
432 | 73 | $objWriter->writeAttribute('insertHyperlinks', ($pSheet->getProtection()->getInsertHyperlinks() ? 'true' : 'false')); |
|
433 | 73 | $objWriter->writeAttribute('deleteColumns', ($pSheet->getProtection()->getDeleteColumns() ? 'true' : 'false')); |
|
434 | 73 | $objWriter->writeAttribute('deleteRows', ($pSheet->getProtection()->getDeleteRows() ? 'true' : 'false')); |
|
435 | 73 | $objWriter->writeAttribute('selectLockedCells', ($pSheet->getProtection()->getSelectLockedCells() ? 'true' : 'false')); |
|
436 | 73 | $objWriter->writeAttribute('sort', ($pSheet->getProtection()->getSort() ? 'true' : 'false')); |
|
437 | 73 | $objWriter->writeAttribute('autoFilter', ($pSheet->getProtection()->getAutoFilter() ? 'true' : 'false')); |
|
438 | 73 | $objWriter->writeAttribute('pivotTables', ($pSheet->getProtection()->getPivotTables() ? 'true' : 'false')); |
|
439 | 73 | $objWriter->writeAttribute('selectUnlockedCells', ($pSheet->getProtection()->getSelectUnlockedCells() ? 'true' : 'false')); |
|
440 | 73 | $objWriter->endElement(); |
|
441 | 73 | } |
|
442 | |||
443 | /** |
||
444 | * Write ConditionalFormatting. |
||
445 | * |
||
446 | * @param XMLWriter $objWriter XML Writer |
||
447 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
448 | * |
||
449 | * @throws WriterException |
||
450 | */ |
||
451 | 73 | private function writeConditionalFormatting(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
452 | { |
||
453 | // Conditional id |
||
454 | 73 | $id = 1; |
|
455 | |||
456 | // Loop through styles in the current worksheet |
||
457 | 73 | foreach ($pSheet->getConditionalStylesCollection() as $cellCoordinate => $conditionalStyles) { |
|
458 | 3 | foreach ($conditionalStyles as $conditional) { |
|
459 | // WHY was this again? |
||
460 | // if ($this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode()) == '') { |
||
461 | // continue; |
||
462 | // } |
||
463 | 3 | if ($conditional->getConditionType() != Conditional::CONDITION_NONE) { |
|
464 | // conditionalFormatting |
||
465 | 3 | $objWriter->startElement('conditionalFormatting'); |
|
466 | 3 | $objWriter->writeAttribute('sqref', $cellCoordinate); |
|
467 | |||
468 | // cfRule |
||
469 | 3 | $objWriter->startElement('cfRule'); |
|
470 | 3 | $objWriter->writeAttribute('type', $conditional->getConditionType()); |
|
471 | 3 | $objWriter->writeAttribute('dxfId', $this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode())); |
|
472 | 3 | $objWriter->writeAttribute('priority', $id++); |
|
473 | |||
474 | 3 | if (($conditional->getConditionType() == Conditional::CONDITION_CELLIS || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT) |
|
475 | 3 | && $conditional->getOperatorType() != Conditional::OPERATOR_NONE) { |
|
476 | 3 | $objWriter->writeAttribute('operator', $conditional->getOperatorType()); |
|
477 | } |
||
478 | |||
479 | 3 | if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
480 | 3 | && $conditional->getText() !== null) { |
|
481 | $objWriter->writeAttribute('text', $conditional->getText()); |
||
482 | } |
||
483 | |||
484 | 3 | if ($conditional->getStopIfTrue()) { |
|
485 | 1 | $objWriter->writeAttribute('stopIfTrue', '1'); |
|
486 | } |
||
487 | |||
488 | 3 | if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
489 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_CONTAINSTEXT |
|
490 | 3 | && $conditional->getText() !== null) { |
|
491 | $objWriter->writeElement('formula', 'NOT(ISERROR(SEARCH("' . $conditional->getText() . '",' . $cellCoordinate . ')))'); |
||
492 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
493 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_BEGINSWITH |
|
494 | 3 | && $conditional->getText() !== null) { |
|
495 | $objWriter->writeElement('formula', 'LEFT(' . $cellCoordinate . ',' . strlen($conditional->getText()) . ')="' . $conditional->getText() . '"'); |
||
496 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
497 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_ENDSWITH |
|
498 | 3 | && $conditional->getText() !== null) { |
|
499 | $objWriter->writeElement('formula', 'RIGHT(' . $cellCoordinate . ',' . strlen($conditional->getText()) . ')="' . $conditional->getText() . '"'); |
||
500 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
501 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_NOTCONTAINS |
|
502 | 3 | && $conditional->getText() !== null) { |
|
503 | $objWriter->writeElement('formula', 'ISERROR(SEARCH("' . $conditional->getText() . '",' . $cellCoordinate . '))'); |
||
504 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CELLIS |
|
505 | 1 | || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
506 | 3 | || $conditional->getConditionType() == Conditional::CONDITION_EXPRESSION) { |
|
507 | 3 | foreach ($conditional->getConditions() as $formula) { |
|
508 | // Formula |
||
509 | 3 | $objWriter->writeElement('formula', $formula); |
|
510 | } |
||
511 | } |
||
512 | |||
513 | 3 | $objWriter->endElement(); |
|
514 | |||
515 | 3 | $objWriter->endElement(); |
|
516 | } |
||
517 | } |
||
518 | } |
||
519 | 73 | } |
|
520 | |||
521 | /** |
||
522 | * Write DataValidations. |
||
523 | * |
||
524 | * @param XMLWriter $objWriter XML Writer |
||
525 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
526 | */ |
||
527 | 73 | private function writeDataValidations(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
528 | { |
||
529 | // Datavalidation collection |
||
530 | 73 | $dataValidationCollection = $pSheet->getDataValidationCollection(); |
|
531 | |||
532 | // Write data validations? |
||
533 | 73 | if (!empty($dataValidationCollection)) { |
|
534 | 2 | $dataValidationCollection = Coordinate::mergeRangesInCollection($dataValidationCollection); |
|
535 | 2 | $objWriter->startElement('dataValidations'); |
|
536 | 2 | $objWriter->writeAttribute('count', count($dataValidationCollection)); |
|
537 | |||
538 | 2 | foreach ($dataValidationCollection as $coordinate => $dv) { |
|
539 | 2 | $objWriter->startElement('dataValidation'); |
|
540 | |||
541 | 2 | if ($dv->getType() != '') { |
|
542 | 2 | $objWriter->writeAttribute('type', $dv->getType()); |
|
543 | } |
||
544 | |||
545 | 2 | if ($dv->getErrorStyle() != '') { |
|
546 | 2 | $objWriter->writeAttribute('errorStyle', $dv->getErrorStyle()); |
|
547 | } |
||
548 | |||
549 | 2 | if ($dv->getOperator() != '') { |
|
550 | 2 | $objWriter->writeAttribute('operator', $dv->getOperator()); |
|
551 | } |
||
552 | |||
553 | 2 | $objWriter->writeAttribute('allowBlank', ($dv->getAllowBlank() ? '1' : '0')); |
|
554 | 2 | $objWriter->writeAttribute('showDropDown', (!$dv->getShowDropDown() ? '1' : '0')); |
|
555 | 2 | $objWriter->writeAttribute('showInputMessage', ($dv->getShowInputMessage() ? '1' : '0')); |
|
556 | 2 | $objWriter->writeAttribute('showErrorMessage', ($dv->getShowErrorMessage() ? '1' : '0')); |
|
557 | |||
558 | 2 | if ($dv->getErrorTitle() !== '') { |
|
559 | 2 | $objWriter->writeAttribute('errorTitle', $dv->getErrorTitle()); |
|
560 | } |
||
561 | 2 | if ($dv->getError() !== '') { |
|
562 | 2 | $objWriter->writeAttribute('error', $dv->getError()); |
|
563 | } |
||
564 | 2 | if ($dv->getPromptTitle() !== '') { |
|
565 | 2 | $objWriter->writeAttribute('promptTitle', $dv->getPromptTitle()); |
|
566 | } |
||
567 | 2 | if ($dv->getPrompt() !== '') { |
|
568 | 2 | $objWriter->writeAttribute('prompt', $dv->getPrompt()); |
|
569 | } |
||
570 | |||
571 | 2 | $objWriter->writeAttribute('sqref', $coordinate); |
|
572 | |||
573 | 2 | if ($dv->getFormula1() !== '') { |
|
574 | 2 | $objWriter->writeElement('formula1', $dv->getFormula1()); |
|
575 | } |
||
576 | 2 | if ($dv->getFormula2() !== '') { |
|
577 | 1 | $objWriter->writeElement('formula2', $dv->getFormula2()); |
|
578 | } |
||
579 | |||
580 | 2 | $objWriter->endElement(); |
|
581 | } |
||
582 | |||
583 | 2 | $objWriter->endElement(); |
|
584 | } |
||
585 | 73 | } |
|
586 | |||
587 | /** |
||
588 | * Write Hyperlinks. |
||
589 | * |
||
590 | * @param XMLWriter $objWriter XML Writer |
||
591 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
592 | */ |
||
593 | 73 | private function writeHyperlinks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
594 | { |
||
595 | // Hyperlink collection |
||
596 | 73 | $hyperlinkCollection = $pSheet->getHyperlinkCollection(); |
|
597 | |||
598 | // Relation ID |
||
599 | 73 | $relationId = 1; |
|
600 | |||
601 | // Write hyperlinks? |
||
602 | 73 | if (!empty($hyperlinkCollection)) { |
|
603 | 10 | $objWriter->startElement('hyperlinks'); |
|
604 | |||
605 | 10 | foreach ($hyperlinkCollection as $coordinate => $hyperlink) { |
|
606 | 10 | $objWriter->startElement('hyperlink'); |
|
607 | |||
608 | 10 | $objWriter->writeAttribute('ref', $coordinate); |
|
609 | 10 | if (!$hyperlink->isInternal()) { |
|
610 | 10 | $objWriter->writeAttribute('r:id', 'rId_hyperlink_' . $relationId); |
|
611 | 10 | ++$relationId; |
|
612 | } else { |
||
613 | 7 | $objWriter->writeAttribute('location', str_replace('sheet://', '', $hyperlink->getUrl())); |
|
614 | } |
||
615 | |||
616 | 10 | if ($hyperlink->getTooltip() != '') { |
|
617 | 6 | $objWriter->writeAttribute('tooltip', $hyperlink->getTooltip()); |
|
618 | } |
||
619 | |||
620 | 10 | $objWriter->endElement(); |
|
621 | } |
||
622 | |||
623 | 10 | $objWriter->endElement(); |
|
624 | } |
||
625 | 73 | } |
|
626 | |||
627 | /** |
||
628 | * Write ProtectedRanges. |
||
629 | * |
||
630 | * @param XMLWriter $objWriter XML Writer |
||
631 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
632 | */ |
||
633 | 73 | private function writeProtectedRanges(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
634 | { |
||
635 | 73 | if (count($pSheet->getProtectedCells()) > 0) { |
|
636 | // protectedRanges |
||
637 | 6 | $objWriter->startElement('protectedRanges'); |
|
638 | |||
639 | // Loop protectedRanges |
||
640 | 6 | foreach ($pSheet->getProtectedCells() as $protectedCell => $passwordHash) { |
|
641 | // protectedRange |
||
642 | 6 | $objWriter->startElement('protectedRange'); |
|
643 | 6 | $objWriter->writeAttribute('name', 'p' . md5($protectedCell)); |
|
644 | 6 | $objWriter->writeAttribute('sqref', $protectedCell); |
|
645 | 6 | if (!empty($passwordHash)) { |
|
646 | 6 | $objWriter->writeAttribute('password', $passwordHash); |
|
647 | } |
||
648 | 6 | $objWriter->endElement(); |
|
649 | } |
||
650 | |||
651 | 6 | $objWriter->endElement(); |
|
652 | } |
||
653 | 73 | } |
|
654 | |||
655 | /** |
||
656 | * Write MergeCells. |
||
657 | * |
||
658 | * @param XMLWriter $objWriter XML Writer |
||
659 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
660 | */ |
||
661 | 73 | private function writeMergeCells(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
662 | { |
||
663 | 73 | if (count($pSheet->getMergeCells()) > 0) { |
|
664 | // mergeCells |
||
665 | 13 | $objWriter->startElement('mergeCells'); |
|
666 | |||
667 | // Loop mergeCells |
||
668 | 13 | foreach ($pSheet->getMergeCells() as $mergeCell) { |
|
669 | // mergeCell |
||
670 | 13 | $objWriter->startElement('mergeCell'); |
|
671 | 13 | $objWriter->writeAttribute('ref', $mergeCell); |
|
672 | 13 | $objWriter->endElement(); |
|
673 | } |
||
674 | |||
675 | 13 | $objWriter->endElement(); |
|
676 | } |
||
677 | 73 | } |
|
678 | |||
679 | /** |
||
680 | * Write PrintOptions. |
||
681 | * |
||
682 | * @param XMLWriter $objWriter XML Writer |
||
683 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
684 | */ |
||
685 | 73 | private function writePrintOptions(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
686 | { |
||
687 | // printOptions |
||
688 | 73 | $objWriter->startElement('printOptions'); |
|
689 | |||
690 | 73 | $objWriter->writeAttribute('gridLines', ($pSheet->getPrintGridlines() ? 'true' : 'false')); |
|
691 | 73 | $objWriter->writeAttribute('gridLinesSet', 'true'); |
|
692 | |||
693 | 73 | if ($pSheet->getPageSetup()->getHorizontalCentered()) { |
|
694 | $objWriter->writeAttribute('horizontalCentered', 'true'); |
||
695 | } |
||
696 | |||
697 | 73 | if ($pSheet->getPageSetup()->getVerticalCentered()) { |
|
698 | $objWriter->writeAttribute('verticalCentered', 'true'); |
||
699 | } |
||
700 | |||
701 | 73 | $objWriter->endElement(); |
|
702 | 73 | } |
|
703 | |||
704 | /** |
||
705 | * Write PageMargins. |
||
706 | * |
||
707 | * @param XMLWriter $objWriter XML Writer |
||
708 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
709 | */ |
||
710 | 73 | private function writePageMargins(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
711 | { |
||
712 | // pageMargins |
||
713 | 73 | $objWriter->startElement('pageMargins'); |
|
714 | 73 | $objWriter->writeAttribute('left', StringHelper::formatNumber($pSheet->getPageMargins()->getLeft())); |
|
715 | 73 | $objWriter->writeAttribute('right', StringHelper::formatNumber($pSheet->getPageMargins()->getRight())); |
|
716 | 73 | $objWriter->writeAttribute('top', StringHelper::formatNumber($pSheet->getPageMargins()->getTop())); |
|
717 | 73 | $objWriter->writeAttribute('bottom', StringHelper::formatNumber($pSheet->getPageMargins()->getBottom())); |
|
718 | 73 | $objWriter->writeAttribute('header', StringHelper::formatNumber($pSheet->getPageMargins()->getHeader())); |
|
719 | 73 | $objWriter->writeAttribute('footer', StringHelper::formatNumber($pSheet->getPageMargins()->getFooter())); |
|
720 | 73 | $objWriter->endElement(); |
|
721 | 73 | } |
|
722 | |||
723 | /** |
||
724 | * Write AutoFilter. |
||
725 | * |
||
726 | * @param XMLWriter $objWriter XML Writer |
||
727 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
728 | */ |
||
729 | 73 | private function writeAutoFilter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
812 | } |
||
813 | 73 | } |
|
814 | |||
815 | /** |
||
816 | * Write PageSetup. |
||
817 | * |
||
818 | * @param XMLWriter $objWriter XML Writer |
||
819 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
820 | */ |
||
821 | 73 | private function writePageSetup(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
847 | 73 | } |
|
848 | |||
849 | /** |
||
850 | * Write Header / Footer. |
||
851 | * |
||
852 | * @param XMLWriter $objWriter XML Writer |
||
853 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
854 | */ |
||
855 | 73 | private function writeHeaderFooter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
856 | { |
||
857 | // headerFooter |
||
858 | 73 | $objWriter->startElement('headerFooter'); |
|
859 | 73 | $objWriter->writeAttribute('differentOddEven', ($pSheet->getHeaderFooter()->getDifferentOddEven() ? 'true' : 'false')); |
|
860 | 73 | $objWriter->writeAttribute('differentFirst', ($pSheet->getHeaderFooter()->getDifferentFirst() ? 'true' : 'false')); |
|
861 | 73 | $objWriter->writeAttribute('scaleWithDoc', ($pSheet->getHeaderFooter()->getScaleWithDocument() ? 'true' : 'false')); |
|
862 | 73 | $objWriter->writeAttribute('alignWithMargins', ($pSheet->getHeaderFooter()->getAlignWithMargins() ? 'true' : 'false')); |
|
863 | |||
864 | 73 | $objWriter->writeElement('oddHeader', $pSheet->getHeaderFooter()->getOddHeader()); |
|
865 | 73 | $objWriter->writeElement('oddFooter', $pSheet->getHeaderFooter()->getOddFooter()); |
|
866 | 73 | $objWriter->writeElement('evenHeader', $pSheet->getHeaderFooter()->getEvenHeader()); |
|
867 | 73 | $objWriter->writeElement('evenFooter', $pSheet->getHeaderFooter()->getEvenFooter()); |
|
868 | 73 | $objWriter->writeElement('firstHeader', $pSheet->getHeaderFooter()->getFirstHeader()); |
|
869 | 73 | $objWriter->writeElement('firstFooter', $pSheet->getHeaderFooter()->getFirstFooter()); |
|
870 | 73 | $objWriter->endElement(); |
|
871 | 73 | } |
|
872 | |||
873 | /** |
||
874 | * Write Breaks. |
||
875 | * |
||
876 | * @param XMLWriter $objWriter XML Writer |
||
877 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
878 | */ |
||
879 | 73 | private function writeBreaks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
880 | { |
||
881 | // Get row and column breaks |
||
882 | 73 | $aRowBreaks = []; |
|
883 | 73 | $aColumnBreaks = []; |
|
884 | 73 | foreach ($pSheet->getBreaks() as $cell => $breakType) { |
|
885 | 1 | if ($breakType == PhpspreadsheetWorksheet::BREAK_ROW) { |
|
886 | 1 | $aRowBreaks[] = $cell; |
|
887 | } elseif ($breakType == PhpspreadsheetWorksheet::BREAK_COLUMN) { |
||
888 | 1 | $aColumnBreaks[] = $cell; |
|
889 | } |
||
890 | } |
||
891 | |||
892 | // rowBreaks |
||
893 | 73 | if (!empty($aRowBreaks)) { |
|
894 | 1 | $objWriter->startElement('rowBreaks'); |
|
895 | 1 | $objWriter->writeAttribute('count', count($aRowBreaks)); |
|
896 | 1 | $objWriter->writeAttribute('manualBreakCount', count($aRowBreaks)); |
|
897 | |||
898 | 1 | foreach ($aRowBreaks as $cell) { |
|
899 | 1 | $coords = Coordinate::coordinateFromString($cell); |
|
900 | |||
901 | 1 | $objWriter->startElement('brk'); |
|
902 | 1 | $objWriter->writeAttribute('id', $coords[1]); |
|
903 | 1 | $objWriter->writeAttribute('man', '1'); |
|
904 | 1 | $objWriter->endElement(); |
|
905 | } |
||
906 | |||
907 | 1 | $objWriter->endElement(); |
|
908 | } |
||
909 | |||
910 | // Second, write column breaks |
||
911 | 73 | if (!empty($aColumnBreaks)) { |
|
912 | $objWriter->startElement('colBreaks'); |
||
913 | $objWriter->writeAttribute('count', count($aColumnBreaks)); |
||
914 | $objWriter->writeAttribute('manualBreakCount', count($aColumnBreaks)); |
||
915 | |||
916 | foreach ($aColumnBreaks as $cell) { |
||
917 | $coords = Coordinate::coordinateFromString($cell); |
||
918 | |||
919 | $objWriter->startElement('brk'); |
||
920 | $objWriter->writeAttribute('id', Coordinate::columnIndexFromString($coords[0]) - 1); |
||
921 | $objWriter->writeAttribute('man', '1'); |
||
922 | $objWriter->endElement(); |
||
923 | } |
||
924 | |||
925 | $objWriter->endElement(); |
||
926 | } |
||
927 | 73 | } |
|
928 | |||
929 | /** |
||
930 | * Write SheetData. |
||
931 | * |
||
932 | * @param XMLWriter $objWriter XML Writer |
||
933 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
934 | * @param string[] $pStringTable String table |
||
935 | * |
||
936 | * @throws WriterException |
||
937 | */ |
||
938 | 73 | private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, array $pStringTable) |
|
1014 | 73 | } |
|
1015 | |||
1016 | /** |
||
1017 | * Write Cell. |
||
1018 | * |
||
1019 | * @param XMLWriter $objWriter XML Writer |
||
1020 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1021 | * @param Cell $pCellAddress Cell Address |
||
1022 | * @param string[] $pFlippedStringTable String table (flipped), for faster index searching |
||
1023 | * |
||
1024 | * @throws WriterException |
||
1025 | */ |
||
1026 | 68 | private function writeCell(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, $pCellAddress, array $pFlippedStringTable) |
|
1136 | 68 | } |
|
1137 | |||
1138 | /** |
||
1139 | * Write Drawings. |
||
1140 | * |
||
1141 | * @param XMLWriter $objWriter XML Writer |
||
1142 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1143 | * @param bool $includeCharts Flag indicating if we should include drawing details for charts |
||
1144 | */ |
||
1145 | 73 | private function writeDrawings(XMLWriter $objWriter = null, PhpspreadsheetWorksheet $pSheet = null, $includeCharts = false) |
|
1146 | { |
||
1147 | 73 | $chartCount = ($includeCharts) ? $pSheet->getChartCollection()->count() : 0; |
|
1 ignored issue
–
show
|
|||
1148 | // If sheet contains drawings, add the relationships |
||
1149 | 73 | if (($pSheet->getDrawingCollection()->count() > 0) || |
|
1150 | 73 | ($chartCount > 0)) { |
|
1151 | 22 | $objWriter->startElement('drawing'); |
|
1 ignored issue
–
show
|
|||
1152 | 22 | $objWriter->writeAttribute('r:id', 'rId1'); |
|
1153 | 22 | $objWriter->endElement(); |
|
1154 | } |
||
1155 | 73 | } |
|
1156 | |||
1157 | /** |
||
1158 | * Write LegacyDrawing. |
||
1159 | * |
||
1160 | * @param XMLWriter $objWriter XML Writer |
||
1161 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1162 | */ |
||
1163 | 73 | private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
1164 | { |
||
1165 | // If sheet contains comments, add the relationships |
||
1166 | 73 | if (count($pSheet->getComments()) > 0) { |
|
1167 | 9 | $objWriter->startElement('legacyDrawing'); |
|
1168 | 9 | $objWriter->writeAttribute('r:id', 'rId_comments_vml1'); |
|
1169 | 9 | $objWriter->endElement(); |
|
1170 | } |
||
1171 | 73 | } |
|
1172 | |||
1173 | /** |
||
1174 | * Write LegacyDrawingHF. |
||
1175 | * |
||
1176 | * @param XMLWriter $objWriter XML Writer |
||
1177 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1178 | */ |
||
1179 | 73 | private function writeLegacyDrawingHF(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
1186 | } |
||
1187 | 73 | } |
|
1188 | } |
||
1189 |