Total Complexity | 214 |
Total Lines | 1198 |
Duplicated Lines | 0 % |
Coverage | 89.7% |
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 | 60 | public function writeWorksheet(PhpspreadsheetWorksheet $pSheet, $pStringTable = null, $includeCharts = false) |
|
36 | { |
||
37 | // Create XML writer |
||
38 | 60 | $objWriter = null; |
|
39 | 60 | if ($this->getParentWriter()->getUseDiskCaching()) { |
|
40 | $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory()); |
||
41 | } else { |
||
42 | 60 | $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY); |
|
43 | } |
||
44 | |||
45 | // XML header |
||
46 | 60 | $objWriter->startDocument('1.0', 'UTF-8', 'yes'); |
|
47 | |||
48 | // Worksheet |
||
49 | 60 | $objWriter->startElement('worksheet'); |
|
50 | 60 | $objWriter->writeAttribute('xml:space', 'preserve'); |
|
51 | 60 | $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'); |
|
52 | 60 | $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); |
|
53 | |||
54 | // sheetPr |
||
55 | 60 | $this->writeSheetPr($objWriter, $pSheet); |
|
56 | |||
57 | // Dimension |
||
58 | 60 | $this->writeDimension($objWriter, $pSheet); |
|
59 | |||
60 | // sheetViews |
||
61 | 60 | $this->writeSheetViews($objWriter, $pSheet); |
|
62 | |||
63 | // sheetFormatPr |
||
64 | 60 | $this->writeSheetFormatPr($objWriter, $pSheet); |
|
65 | |||
66 | // cols |
||
67 | 60 | $this->writeCols($objWriter, $pSheet); |
|
68 | |||
69 | // sheetData |
||
70 | 60 | $this->writeSheetData($objWriter, $pSheet, $pStringTable); |
|
1 ignored issue
–
show
|
|||
71 | |||
72 | // sheetProtection |
||
73 | 60 | $this->writeSheetProtection($objWriter, $pSheet); |
|
74 | |||
75 | // protectedRanges |
||
76 | 60 | $this->writeProtectedRanges($objWriter, $pSheet); |
|
77 | |||
78 | // autoFilter |
||
79 | 60 | $this->writeAutoFilter($objWriter, $pSheet); |
|
80 | |||
81 | // mergeCells |
||
82 | 60 | $this->writeMergeCells($objWriter, $pSheet); |
|
83 | |||
84 | // conditionalFormatting |
||
85 | 60 | $this->writeConditionalFormatting($objWriter, $pSheet); |
|
86 | |||
87 | // dataValidations |
||
88 | 60 | $this->writeDataValidations($objWriter, $pSheet); |
|
89 | |||
90 | // hyperlinks |
||
91 | 60 | $this->writeHyperlinks($objWriter, $pSheet); |
|
92 | |||
93 | // Print options |
||
94 | 60 | $this->writePrintOptions($objWriter, $pSheet); |
|
95 | |||
96 | // Page margins |
||
97 | 60 | $this->writePageMargins($objWriter, $pSheet); |
|
98 | |||
99 | // Page setup |
||
100 | 60 | $this->writePageSetup($objWriter, $pSheet); |
|
101 | |||
102 | // Header / footer |
||
103 | 60 | $this->writeHeaderFooter($objWriter, $pSheet); |
|
104 | |||
105 | // Breaks |
||
106 | 60 | $this->writeBreaks($objWriter, $pSheet); |
|
107 | |||
108 | // Drawings and/or Charts |
||
109 | 60 | $this->writeDrawings($objWriter, $pSheet, $includeCharts); |
|
110 | |||
111 | // LegacyDrawing |
||
112 | 60 | $this->writeLegacyDrawing($objWriter, $pSheet); |
|
113 | |||
114 | // LegacyDrawingHF |
||
115 | 60 | $this->writeLegacyDrawingHF($objWriter, $pSheet); |
|
116 | |||
117 | 60 | $objWriter->endElement(); |
|
118 | |||
119 | // Return |
||
120 | 60 | return $objWriter->getData(); |
|
121 | } |
||
122 | |||
123 | /** |
||
124 | * Write SheetPr. |
||
125 | * |
||
126 | * @param XMLWriter $objWriter XML Writer |
||
127 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
128 | * |
||
129 | * @throws WriterException |
||
130 | */ |
||
131 | 60 | private function writeSheetPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
132 | { |
||
133 | // sheetPr |
||
134 | 60 | $objWriter->startElement('sheetPr'); |
|
135 | 60 | if ($pSheet->getParent()->hasMacros()) { |
|
136 | //if the workbook have macros, we need to have codeName for the sheet |
||
137 | if ($pSheet->hasCodeName() == false) { |
||
138 | $pSheet->setCodeName($pSheet->getTitle()); |
||
139 | } |
||
140 | $objWriter->writeAttribute('codeName', $pSheet->getCodeName()); |
||
141 | } |
||
142 | 60 | $autoFilterRange = $pSheet->getAutoFilter()->getRange(); |
|
143 | 60 | if (!empty($autoFilterRange)) { |
|
144 | 3 | $objWriter->writeAttribute('filterMode', 1); |
|
145 | 3 | $pSheet->getAutoFilter()->showHideRows(); |
|
146 | } |
||
147 | |||
148 | // tabColor |
||
149 | 60 | if ($pSheet->isTabColorSet()) { |
|
150 | 6 | $objWriter->startElement('tabColor'); |
|
151 | 6 | $objWriter->writeAttribute('rgb', $pSheet->getTabColor()->getARGB()); |
|
152 | 6 | $objWriter->endElement(); |
|
153 | } |
||
154 | |||
155 | // outlinePr |
||
156 | 60 | $objWriter->startElement('outlinePr'); |
|
157 | 60 | $objWriter->writeAttribute('summaryBelow', ($pSheet->getShowSummaryBelow() ? '1' : '0')); |
|
158 | 60 | $objWriter->writeAttribute('summaryRight', ($pSheet->getShowSummaryRight() ? '1' : '0')); |
|
159 | 60 | $objWriter->endElement(); |
|
160 | |||
161 | // pageSetUpPr |
||
162 | 60 | if ($pSheet->getPageSetup()->getFitToPage()) { |
|
163 | $objWriter->startElement('pageSetUpPr'); |
||
164 | $objWriter->writeAttribute('fitToPage', '1'); |
||
165 | $objWriter->endElement(); |
||
166 | } |
||
167 | |||
168 | 60 | $objWriter->endElement(); |
|
169 | 60 | } |
|
170 | |||
171 | /** |
||
172 | * Write Dimension. |
||
173 | * |
||
174 | * @param XMLWriter $objWriter XML Writer |
||
175 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
176 | * |
||
177 | * @throws WriterException |
||
178 | */ |
||
179 | 60 | private function writeDimension(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
185 | 60 | } |
|
186 | |||
187 | /** |
||
188 | * Write SheetViews. |
||
189 | * |
||
190 | * @param XMLWriter $objWriter XML Writer |
||
191 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
192 | * |
||
193 | * @throws WriterException |
||
194 | */ |
||
195 | 60 | private function writeSheetViews(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
196 | { |
||
197 | // sheetViews |
||
198 | 60 | $objWriter->startElement('sheetViews'); |
|
199 | |||
200 | // Sheet selected? |
||
201 | 60 | $sheetSelected = false; |
|
202 | 60 | if ($this->getParentWriter()->getSpreadsheet()->getIndex($pSheet) == $this->getParentWriter()->getSpreadsheet()->getActiveSheetIndex()) { |
|
203 | 60 | $sheetSelected = true; |
|
204 | } |
||
205 | |||
206 | // sheetView |
||
207 | 60 | $objWriter->startElement('sheetView'); |
|
208 | 60 | $objWriter->writeAttribute('tabSelected', $sheetSelected ? '1' : '0'); |
|
209 | 60 | $objWriter->writeAttribute('workbookViewId', '0'); |
|
210 | |||
211 | // Zoom scales |
||
212 | 60 | if ($pSheet->getSheetView()->getZoomScale() != 100) { |
|
213 | $objWriter->writeAttribute('zoomScale', $pSheet->getSheetView()->getZoomScale()); |
||
214 | } |
||
215 | 60 | if ($pSheet->getSheetView()->getZoomScaleNormal() != 100) { |
|
216 | $objWriter->writeAttribute('zoomScaleNormal', $pSheet->getSheetView()->getZoomScaleNormal()); |
||
217 | } |
||
218 | |||
219 | // View Layout Type |
||
220 | 60 | if ($pSheet->getSheetView()->getView() !== SheetView::SHEETVIEW_NORMAL) { |
|
221 | 1 | $objWriter->writeAttribute('view', $pSheet->getSheetView()->getView()); |
|
222 | } |
||
223 | |||
224 | // Gridlines |
||
225 | 60 | if ($pSheet->getShowGridlines()) { |
|
226 | 60 | $objWriter->writeAttribute('showGridLines', 'true'); |
|
227 | } else { |
||
228 | $objWriter->writeAttribute('showGridLines', 'false'); |
||
229 | } |
||
230 | |||
231 | // Row and column headers |
||
232 | 60 | if ($pSheet->getShowRowColHeaders()) { |
|
233 | 60 | $objWriter->writeAttribute('showRowColHeaders', '1'); |
|
234 | } else { |
||
235 | $objWriter->writeAttribute('showRowColHeaders', '0'); |
||
236 | } |
||
237 | |||
238 | // Right-to-left |
||
239 | 60 | if ($pSheet->getRightToLeft()) { |
|
240 | $objWriter->writeAttribute('rightToLeft', 'true'); |
||
241 | } |
||
242 | |||
243 | 60 | $activeCell = $pSheet->getActiveCell(); |
|
244 | |||
245 | // Pane |
||
246 | 60 | $pane = ''; |
|
247 | 60 | if ($pSheet->getFreezePane()) { |
|
248 | 4 | list($xSplit, $ySplit) = Coordinate::coordinateFromString($pSheet->getFreezePane()); |
|
249 | 4 | $xSplit = Coordinate::columnIndexFromString($xSplit); |
|
250 | 4 | --$xSplit; |
|
251 | 4 | --$ySplit; |
|
252 | |||
253 | 4 | $topLeftCell = $pSheet->getTopLeftCell(); |
|
254 | 4 | $activeCell = $topLeftCell; |
|
255 | |||
256 | // pane |
||
257 | 4 | $pane = 'topRight'; |
|
258 | 4 | $objWriter->startElement('pane'); |
|
259 | 4 | if ($xSplit > 0) { |
|
260 | 1 | $objWriter->writeAttribute('xSplit', $xSplit); |
|
261 | } |
||
262 | 4 | if ($ySplit > 0) { |
|
263 | 4 | $objWriter->writeAttribute('ySplit', $ySplit); |
|
264 | 4 | $pane = ($xSplit > 0) ? 'bottomRight' : 'bottomLeft'; |
|
265 | } |
||
266 | 4 | $objWriter->writeAttribute('topLeftCell', $topLeftCell); |
|
267 | 4 | $objWriter->writeAttribute('activePane', $pane); |
|
268 | 4 | $objWriter->writeAttribute('state', 'frozen'); |
|
269 | 4 | $objWriter->endElement(); |
|
270 | |||
271 | 4 | if (($xSplit > 0) && ($ySplit > 0)) { |
|
272 | // Write additional selections if more than two panes (ie both an X and a Y split) |
||
273 | 1 | $objWriter->startElement('selection'); |
|
274 | 1 | $objWriter->writeAttribute('pane', 'topRight'); |
|
275 | 1 | $objWriter->endElement(); |
|
276 | 1 | $objWriter->startElement('selection'); |
|
277 | 1 | $objWriter->writeAttribute('pane', 'bottomLeft'); |
|
278 | 1 | $objWriter->endElement(); |
|
279 | } |
||
280 | } |
||
281 | |||
282 | // Selection |
||
283 | // Only need to write selection element if we have a split pane |
||
284 | // We cheat a little by over-riding the active cell selection, setting it to the split cell |
||
285 | 60 | $objWriter->startElement('selection'); |
|
286 | 60 | if ($pane != '') { |
|
287 | 4 | $objWriter->writeAttribute('pane', $pane); |
|
288 | } |
||
289 | 60 | $objWriter->writeAttribute('activeCell', $activeCell); |
|
290 | 60 | $objWriter->writeAttribute('sqref', $activeCell); |
|
291 | 60 | $objWriter->endElement(); |
|
292 | |||
293 | 60 | $objWriter->endElement(); |
|
294 | |||
295 | 60 | $objWriter->endElement(); |
|
296 | 60 | } |
|
297 | |||
298 | /** |
||
299 | * Write SheetFormatPr. |
||
300 | * |
||
301 | * @param XMLWriter $objWriter XML Writer |
||
302 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
303 | * |
||
304 | * @throws WriterException |
||
305 | */ |
||
306 | 60 | private function writeSheetFormatPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
307 | { |
||
308 | // sheetFormatPr |
||
309 | 60 | $objWriter->startElement('sheetFormatPr'); |
|
310 | |||
311 | // Default row height |
||
312 | 60 | if ($pSheet->getDefaultRowDimension()->getRowHeight() >= 0) { |
|
313 | 2 | $objWriter->writeAttribute('customHeight', 'true'); |
|
314 | 2 | $objWriter->writeAttribute('defaultRowHeight', StringHelper::formatNumber($pSheet->getDefaultRowDimension()->getRowHeight())); |
|
315 | } else { |
||
316 | 58 | $objWriter->writeAttribute('defaultRowHeight', '14.4'); |
|
317 | } |
||
318 | |||
319 | // Set Zero Height row |
||
320 | 60 | if ((string) $pSheet->getDefaultRowDimension()->getZeroHeight() == '1' || |
|
321 | 60 | strtolower((string) $pSheet->getDefaultRowDimension()->getZeroHeight()) == 'true') { |
|
322 | $objWriter->writeAttribute('zeroHeight', '1'); |
||
323 | } |
||
324 | |||
325 | // Default column width |
||
326 | 60 | if ($pSheet->getDefaultColumnDimension()->getWidth() >= 0) { |
|
327 | 1 | $objWriter->writeAttribute('defaultColWidth', StringHelper::formatNumber($pSheet->getDefaultColumnDimension()->getWidth())); |
|
328 | } |
||
329 | |||
330 | // Outline level - row |
||
331 | 60 | $outlineLevelRow = 0; |
|
332 | 60 | foreach ($pSheet->getRowDimensions() as $dimension) { |
|
333 | 11 | if ($dimension->getOutlineLevel() > $outlineLevelRow) { |
|
334 | 11 | $outlineLevelRow = $dimension->getOutlineLevel(); |
|
335 | } |
||
336 | } |
||
337 | 60 | $objWriter->writeAttribute('outlineLevelRow', (int) $outlineLevelRow); |
|
338 | |||
339 | // Outline level - column |
||
340 | 60 | $outlineLevelCol = 0; |
|
341 | 60 | foreach ($pSheet->getColumnDimensions() as $dimension) { |
|
342 | 21 | if ($dimension->getOutlineLevel() > $outlineLevelCol) { |
|
343 | 21 | $outlineLevelCol = $dimension->getOutlineLevel(); |
|
344 | } |
||
345 | } |
||
346 | 60 | $objWriter->writeAttribute('outlineLevelCol', (int) $outlineLevelCol); |
|
347 | |||
348 | 60 | $objWriter->endElement(); |
|
349 | 60 | } |
|
350 | |||
351 | /** |
||
352 | * Write Cols. |
||
353 | * |
||
354 | * @param XMLWriter $objWriter XML Writer |
||
355 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
356 | * |
||
357 | * @throws WriterException |
||
358 | */ |
||
359 | 60 | private function writeCols(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
414 | } |
||
415 | 60 | } |
|
416 | |||
417 | /** |
||
418 | * Write SheetProtection. |
||
419 | * |
||
420 | * @param XMLWriter $objWriter XML Writer |
||
421 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
422 | * |
||
423 | * @throws WriterException |
||
424 | */ |
||
425 | 60 | private function writeSheetProtection(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
451 | 60 | } |
|
452 | |||
453 | /** |
||
454 | * Write ConditionalFormatting. |
||
455 | * |
||
456 | * @param XMLWriter $objWriter XML Writer |
||
457 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
458 | * |
||
459 | * @throws WriterException |
||
460 | */ |
||
461 | 60 | private function writeConditionalFormatting(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
462 | { |
||
463 | // Conditional id |
||
464 | 60 | $id = 1; |
|
465 | |||
466 | // Loop through styles in the current worksheet |
||
467 | 60 | foreach ($pSheet->getConditionalStylesCollection() as $cellCoordinate => $conditionalStyles) { |
|
468 | 3 | foreach ($conditionalStyles as $conditional) { |
|
469 | // WHY was this again? |
||
470 | // if ($this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode()) == '') { |
||
471 | // continue; |
||
472 | // } |
||
473 | 3 | if ($conditional->getConditionType() != Conditional::CONDITION_NONE) { |
|
474 | // conditionalFormatting |
||
475 | 3 | $objWriter->startElement('conditionalFormatting'); |
|
476 | 3 | $objWriter->writeAttribute('sqref', $cellCoordinate); |
|
477 | |||
478 | // cfRule |
||
479 | 3 | $objWriter->startElement('cfRule'); |
|
480 | 3 | $objWriter->writeAttribute('type', $conditional->getConditionType()); |
|
481 | 3 | $objWriter->writeAttribute('dxfId', $this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode())); |
|
482 | 3 | $objWriter->writeAttribute('priority', $id++); |
|
483 | |||
484 | 3 | if (($conditional->getConditionType() == Conditional::CONDITION_CELLIS || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT) |
|
485 | 3 | && $conditional->getOperatorType() != Conditional::OPERATOR_NONE) { |
|
486 | 3 | $objWriter->writeAttribute('operator', $conditional->getOperatorType()); |
|
487 | } |
||
488 | |||
489 | 3 | if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
490 | 3 | && $conditional->getText() !== null) { |
|
491 | $objWriter->writeAttribute('text', $conditional->getText()); |
||
492 | } |
||
493 | |||
494 | 3 | if ($conditional->getStopIfTrue()) { |
|
495 | 1 | $objWriter->writeAttribute('stopIfTrue', '1'); |
|
496 | } |
||
497 | |||
498 | 3 | if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
499 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_CONTAINSTEXT |
|
500 | 3 | && $conditional->getText() !== null) { |
|
501 | $objWriter->writeElement('formula', 'NOT(ISERROR(SEARCH("' . $conditional->getText() . '",' . $cellCoordinate . ')))'); |
||
502 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
503 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_BEGINSWITH |
|
504 | 3 | && $conditional->getText() !== null) { |
|
505 | $objWriter->writeElement('formula', 'LEFT(' . $cellCoordinate . ',' . strlen($conditional->getText()) . ')="' . $conditional->getText() . '"'); |
||
506 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
507 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_ENDSWITH |
|
508 | 3 | && $conditional->getText() !== null) { |
|
509 | $objWriter->writeElement('formula', 'RIGHT(' . $cellCoordinate . ',' . strlen($conditional->getText()) . ')="' . $conditional->getText() . '"'); |
||
510 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
511 | 3 | && $conditional->getOperatorType() == Conditional::OPERATOR_NOTCONTAINS |
|
512 | 3 | && $conditional->getText() !== null) { |
|
513 | $objWriter->writeElement('formula', 'ISERROR(SEARCH("' . $conditional->getText() . '",' . $cellCoordinate . '))'); |
||
514 | 3 | } elseif ($conditional->getConditionType() == Conditional::CONDITION_CELLIS |
|
515 | 1 | || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT |
|
516 | 3 | || $conditional->getConditionType() == Conditional::CONDITION_EXPRESSION) { |
|
517 | 3 | foreach ($conditional->getConditions() as $formula) { |
|
518 | // Formula |
||
519 | 3 | $objWriter->writeElement('formula', $formula); |
|
520 | } |
||
521 | } |
||
522 | |||
523 | 3 | $objWriter->endElement(); |
|
524 | |||
525 | 3 | $objWriter->endElement(); |
|
526 | } |
||
527 | } |
||
528 | } |
||
529 | 60 | } |
|
530 | |||
531 | /** |
||
532 | * Write DataValidations. |
||
533 | * |
||
534 | * @param XMLWriter $objWriter XML Writer |
||
535 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
536 | * |
||
537 | * @throws WriterException |
||
538 | */ |
||
539 | 60 | private function writeDataValidations(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
540 | { |
||
541 | // Datavalidation collection |
||
542 | 60 | $dataValidationCollection = $pSheet->getDataValidationCollection(); |
|
543 | |||
544 | // Write data validations? |
||
545 | 60 | if (!empty($dataValidationCollection)) { |
|
546 | 2 | $dataValidationCollection = Coordinate::mergeRangesInCollection($dataValidationCollection); |
|
547 | 2 | $objWriter->startElement('dataValidations'); |
|
548 | 2 | $objWriter->writeAttribute('count', count($dataValidationCollection)); |
|
549 | |||
550 | 2 | foreach ($dataValidationCollection as $coordinate => $dv) { |
|
551 | 2 | $objWriter->startElement('dataValidation'); |
|
552 | |||
553 | 2 | if ($dv->getType() != '') { |
|
554 | 2 | $objWriter->writeAttribute('type', $dv->getType()); |
|
555 | } |
||
556 | |||
557 | 2 | if ($dv->getErrorStyle() != '') { |
|
558 | 2 | $objWriter->writeAttribute('errorStyle', $dv->getErrorStyle()); |
|
559 | } |
||
560 | |||
561 | 2 | if ($dv->getOperator() != '') { |
|
562 | 2 | $objWriter->writeAttribute('operator', $dv->getOperator()); |
|
563 | } |
||
564 | |||
565 | 2 | $objWriter->writeAttribute('allowBlank', ($dv->getAllowBlank() ? '1' : '0')); |
|
566 | 2 | $objWriter->writeAttribute('showDropDown', (!$dv->getShowDropDown() ? '1' : '0')); |
|
567 | 2 | $objWriter->writeAttribute('showInputMessage', ($dv->getShowInputMessage() ? '1' : '0')); |
|
568 | 2 | $objWriter->writeAttribute('showErrorMessage', ($dv->getShowErrorMessage() ? '1' : '0')); |
|
569 | |||
570 | 2 | if ($dv->getErrorTitle() !== '') { |
|
571 | 2 | $objWriter->writeAttribute('errorTitle', $dv->getErrorTitle()); |
|
572 | } |
||
573 | 2 | if ($dv->getError() !== '') { |
|
574 | 2 | $objWriter->writeAttribute('error', $dv->getError()); |
|
575 | } |
||
576 | 2 | if ($dv->getPromptTitle() !== '') { |
|
577 | 2 | $objWriter->writeAttribute('promptTitle', $dv->getPromptTitle()); |
|
578 | } |
||
579 | 2 | if ($dv->getPrompt() !== '') { |
|
580 | 2 | $objWriter->writeAttribute('prompt', $dv->getPrompt()); |
|
581 | } |
||
582 | |||
583 | 2 | $objWriter->writeAttribute('sqref', $coordinate); |
|
584 | |||
585 | 2 | if ($dv->getFormula1() !== '') { |
|
586 | 2 | $objWriter->writeElement('formula1', $dv->getFormula1()); |
|
587 | } |
||
588 | 2 | if ($dv->getFormula2() !== '') { |
|
589 | 1 | $objWriter->writeElement('formula2', $dv->getFormula2()); |
|
590 | } |
||
591 | |||
592 | 2 | $objWriter->endElement(); |
|
593 | } |
||
594 | |||
595 | 2 | $objWriter->endElement(); |
|
596 | } |
||
597 | 60 | } |
|
598 | |||
599 | /** |
||
600 | * Write Hyperlinks. |
||
601 | * |
||
602 | * @param XMLWriter $objWriter XML Writer |
||
603 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
604 | * |
||
605 | * @throws WriterException |
||
606 | */ |
||
607 | 60 | private function writeHyperlinks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
608 | { |
||
609 | // Hyperlink collection |
||
610 | 60 | $hyperlinkCollection = $pSheet->getHyperlinkCollection(); |
|
611 | |||
612 | // Relation ID |
||
613 | 60 | $relationId = 1; |
|
614 | |||
615 | // Write hyperlinks? |
||
616 | 60 | if (!empty($hyperlinkCollection)) { |
|
617 | 10 | $objWriter->startElement('hyperlinks'); |
|
618 | |||
619 | 10 | foreach ($hyperlinkCollection as $coordinate => $hyperlink) { |
|
620 | 10 | $objWriter->startElement('hyperlink'); |
|
621 | |||
622 | 10 | $objWriter->writeAttribute('ref', $coordinate); |
|
623 | 10 | if (!$hyperlink->isInternal()) { |
|
624 | 10 | $objWriter->writeAttribute('r:id', 'rId_hyperlink_' . $relationId); |
|
625 | 10 | ++$relationId; |
|
626 | } else { |
||
627 | 7 | $objWriter->writeAttribute('location', str_replace('sheet://', '', $hyperlink->getUrl())); |
|
628 | } |
||
629 | |||
630 | 10 | if ($hyperlink->getTooltip() != '') { |
|
631 | 6 | $objWriter->writeAttribute('tooltip', $hyperlink->getTooltip()); |
|
632 | } |
||
633 | |||
634 | 10 | $objWriter->endElement(); |
|
635 | } |
||
636 | |||
637 | 10 | $objWriter->endElement(); |
|
638 | } |
||
639 | 60 | } |
|
640 | |||
641 | /** |
||
642 | * Write ProtectedRanges. |
||
643 | * |
||
644 | * @param XMLWriter $objWriter XML Writer |
||
645 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
646 | * |
||
647 | * @throws WriterException |
||
648 | */ |
||
649 | 60 | private function writeProtectedRanges(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
650 | { |
||
651 | 60 | if (count($pSheet->getProtectedCells()) > 0) { |
|
652 | // protectedRanges |
||
653 | 6 | $objWriter->startElement('protectedRanges'); |
|
654 | |||
655 | // Loop protectedRanges |
||
656 | 6 | foreach ($pSheet->getProtectedCells() as $protectedCell => $passwordHash) { |
|
657 | // protectedRange |
||
658 | 6 | $objWriter->startElement('protectedRange'); |
|
659 | 6 | $objWriter->writeAttribute('name', 'p' . md5($protectedCell)); |
|
660 | 6 | $objWriter->writeAttribute('sqref', $protectedCell); |
|
661 | 6 | if (!empty($passwordHash)) { |
|
662 | 6 | $objWriter->writeAttribute('password', $passwordHash); |
|
663 | } |
||
664 | 6 | $objWriter->endElement(); |
|
665 | } |
||
666 | |||
667 | 6 | $objWriter->endElement(); |
|
668 | } |
||
669 | 60 | } |
|
670 | |||
671 | /** |
||
672 | * Write MergeCells. |
||
673 | * |
||
674 | * @param XMLWriter $objWriter XML Writer |
||
675 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
676 | * |
||
677 | * @throws WriterException |
||
678 | */ |
||
679 | 60 | private function writeMergeCells(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
680 | { |
||
681 | 60 | if (count($pSheet->getMergeCells()) > 0) { |
|
682 | // mergeCells |
||
683 | 13 | $objWriter->startElement('mergeCells'); |
|
684 | |||
685 | // Loop mergeCells |
||
686 | 13 | foreach ($pSheet->getMergeCells() as $mergeCell) { |
|
687 | // mergeCell |
||
688 | 13 | $objWriter->startElement('mergeCell'); |
|
689 | 13 | $objWriter->writeAttribute('ref', $mergeCell); |
|
690 | 13 | $objWriter->endElement(); |
|
691 | } |
||
692 | |||
693 | 13 | $objWriter->endElement(); |
|
694 | } |
||
695 | 60 | } |
|
696 | |||
697 | /** |
||
698 | * Write PrintOptions. |
||
699 | * |
||
700 | * @param XMLWriter $objWriter XML Writer |
||
701 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
702 | * |
||
703 | * @throws WriterException |
||
704 | */ |
||
705 | 60 | private function writePrintOptions(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
706 | { |
||
707 | // printOptions |
||
708 | 60 | $objWriter->startElement('printOptions'); |
|
709 | |||
710 | 60 | $objWriter->writeAttribute('gridLines', ($pSheet->getPrintGridlines() ? 'true' : 'false')); |
|
711 | 60 | $objWriter->writeAttribute('gridLinesSet', 'true'); |
|
712 | |||
713 | 60 | if ($pSheet->getPageSetup()->getHorizontalCentered()) { |
|
714 | $objWriter->writeAttribute('horizontalCentered', 'true'); |
||
715 | } |
||
716 | |||
717 | 60 | if ($pSheet->getPageSetup()->getVerticalCentered()) { |
|
718 | $objWriter->writeAttribute('verticalCentered', 'true'); |
||
719 | } |
||
720 | |||
721 | 60 | $objWriter->endElement(); |
|
722 | 60 | } |
|
723 | |||
724 | /** |
||
725 | * Write PageMargins. |
||
726 | * |
||
727 | * @param XMLWriter $objWriter XML Writer |
||
728 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
729 | * |
||
730 | * @throws WriterException |
||
731 | */ |
||
732 | 60 | private function writePageMargins(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
733 | { |
||
734 | // pageMargins |
||
735 | 60 | $objWriter->startElement('pageMargins'); |
|
736 | 60 | $objWriter->writeAttribute('left', StringHelper::formatNumber($pSheet->getPageMargins()->getLeft())); |
|
737 | 60 | $objWriter->writeAttribute('right', StringHelper::formatNumber($pSheet->getPageMargins()->getRight())); |
|
738 | 60 | $objWriter->writeAttribute('top', StringHelper::formatNumber($pSheet->getPageMargins()->getTop())); |
|
739 | 60 | $objWriter->writeAttribute('bottom', StringHelper::formatNumber($pSheet->getPageMargins()->getBottom())); |
|
740 | 60 | $objWriter->writeAttribute('header', StringHelper::formatNumber($pSheet->getPageMargins()->getHeader())); |
|
741 | 60 | $objWriter->writeAttribute('footer', StringHelper::formatNumber($pSheet->getPageMargins()->getFooter())); |
|
742 | 60 | $objWriter->endElement(); |
|
743 | 60 | } |
|
744 | |||
745 | /** |
||
746 | * Write AutoFilter. |
||
747 | * |
||
748 | * @param XMLWriter $objWriter XML Writer |
||
749 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
750 | * |
||
751 | * @throws WriterException |
||
752 | */ |
||
753 | 60 | private function writeAutoFilter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
754 | { |
||
755 | 60 | $autoFilterRange = $pSheet->getAutoFilter()->getRange(); |
|
756 | 60 | if (!empty($autoFilterRange)) { |
|
757 | // autoFilter |
||
758 | 3 | $objWriter->startElement('autoFilter'); |
|
759 | |||
760 | // Strip any worksheet reference from the filter coordinates |
||
761 | 3 | $range = Coordinate::splitRange($autoFilterRange); |
|
762 | 3 | $range = $range[0]; |
|
763 | // Strip any worksheet ref |
||
764 | 3 | if (strpos($range[0], '!') !== false) { |
|
765 | list($ws, $range[0]) = explode('!', $range[0]); |
||
766 | } |
||
767 | 3 | $range = implode(':', $range); |
|
768 | |||
769 | 3 | $objWriter->writeAttribute('ref', str_replace('$', '', $range)); |
|
770 | |||
771 | 3 | $columns = $pSheet->getAutoFilter()->getColumns(); |
|
772 | 3 | if (count($columns) > 0) { |
|
773 | 2 | foreach ($columns as $columnID => $column) { |
|
774 | 2 | $rules = $column->getRules(); |
|
775 | 2 | if (count($rules) > 0) { |
|
776 | 2 | $objWriter->startElement('filterColumn'); |
|
777 | 2 | $objWriter->writeAttribute('colId', $pSheet->getAutoFilter()->getColumnOffset($columnID)); |
|
778 | |||
779 | 2 | $objWriter->startElement($column->getFilterType()); |
|
780 | 2 | if ($column->getJoin() == Column::AUTOFILTER_COLUMN_JOIN_AND) { |
|
781 | 1 | $objWriter->writeAttribute('and', 1); |
|
782 | } |
||
783 | |||
784 | 2 | foreach ($rules as $rule) { |
|
785 | 2 | if (($column->getFilterType() === Column::AUTOFILTER_FILTERTYPE_FILTER) && |
|
786 | 2 | ($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_EQUAL) && |
|
787 | 2 | ($rule->getValue() === '')) { |
|
788 | // Filter rule for Blanks |
||
789 | 1 | $objWriter->writeAttribute('blank', 1); |
|
790 | 2 | } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER) { |
|
791 | // Dynamic Filter Rule |
||
792 | 1 | $objWriter->writeAttribute('type', $rule->getGrouping()); |
|
793 | 1 | $val = $column->getAttribute('val'); |
|
794 | 1 | if ($val !== null) { |
|
795 | 1 | $objWriter->writeAttribute('val', $val); |
|
796 | } |
||
797 | 1 | $maxVal = $column->getAttribute('maxVal'); |
|
798 | 1 | if ($maxVal !== null) { |
|
799 | 1 | $objWriter->writeAttribute('maxVal', $maxVal); |
|
800 | } |
||
801 | 2 | } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_TOPTENFILTER) { |
|
802 | // Top 10 Filter Rule |
||
803 | $objWriter->writeAttribute('val', $rule->getValue()); |
||
804 | $objWriter->writeAttribute('percent', (($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT) ? '1' : '0')); |
||
805 | $objWriter->writeAttribute('top', (($rule->getGrouping() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_TOP) ? '1' : '0')); |
||
806 | } else { |
||
807 | // Filter, DateGroupItem or CustomFilter |
||
808 | 2 | $objWriter->startElement($rule->getRuleType()); |
|
809 | |||
810 | 2 | if ($rule->getOperator() !== Rule::AUTOFILTER_COLUMN_RULE_EQUAL) { |
|
811 | 1 | $objWriter->writeAttribute('operator', $rule->getOperator()); |
|
812 | } |
||
813 | 2 | if ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DATEGROUP) { |
|
814 | // Date Group filters |
||
815 | 1 | foreach ($rule->getValue() as $key => $value) { |
|
816 | 1 | if ($value > '') { |
|
817 | 1 | $objWriter->writeAttribute($key, $value); |
|
818 | } |
||
819 | } |
||
820 | 1 | $objWriter->writeAttribute('dateTimeGrouping', $rule->getGrouping()); |
|
821 | } else { |
||
822 | 2 | $objWriter->writeAttribute('val', $rule->getValue()); |
|
823 | } |
||
824 | |||
825 | 2 | $objWriter->endElement(); |
|
826 | } |
||
827 | } |
||
828 | |||
829 | 2 | $objWriter->endElement(); |
|
830 | |||
831 | 2 | $objWriter->endElement(); |
|
832 | } |
||
833 | } |
||
834 | } |
||
835 | 3 | $objWriter->endElement(); |
|
836 | } |
||
837 | 60 | } |
|
838 | |||
839 | /** |
||
840 | * Write PageSetup. |
||
841 | * |
||
842 | * @param XMLWriter $objWriter XML Writer |
||
843 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
844 | * |
||
845 | * @throws WriterException |
||
846 | */ |
||
847 | 60 | private function writePageSetup(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
873 | 60 | } |
|
874 | |||
875 | /** |
||
876 | * Write Header / Footer. |
||
877 | * |
||
878 | * @param XMLWriter $objWriter XML Writer |
||
879 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
880 | * |
||
881 | * @throws WriterException |
||
882 | */ |
||
883 | 60 | private function writeHeaderFooter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
884 | { |
||
885 | // headerFooter |
||
886 | 60 | $objWriter->startElement('headerFooter'); |
|
887 | 60 | $objWriter->writeAttribute('differentOddEven', ($pSheet->getHeaderFooter()->getDifferentOddEven() ? 'true' : 'false')); |
|
888 | 60 | $objWriter->writeAttribute('differentFirst', ($pSheet->getHeaderFooter()->getDifferentFirst() ? 'true' : 'false')); |
|
889 | 60 | $objWriter->writeAttribute('scaleWithDoc', ($pSheet->getHeaderFooter()->getScaleWithDocument() ? 'true' : 'false')); |
|
890 | 60 | $objWriter->writeAttribute('alignWithMargins', ($pSheet->getHeaderFooter()->getAlignWithMargins() ? 'true' : 'false')); |
|
891 | |||
892 | 60 | $objWriter->writeElement('oddHeader', $pSheet->getHeaderFooter()->getOddHeader()); |
|
893 | 60 | $objWriter->writeElement('oddFooter', $pSheet->getHeaderFooter()->getOddFooter()); |
|
894 | 60 | $objWriter->writeElement('evenHeader', $pSheet->getHeaderFooter()->getEvenHeader()); |
|
895 | 60 | $objWriter->writeElement('evenFooter', $pSheet->getHeaderFooter()->getEvenFooter()); |
|
896 | 60 | $objWriter->writeElement('firstHeader', $pSheet->getHeaderFooter()->getFirstHeader()); |
|
897 | 60 | $objWriter->writeElement('firstFooter', $pSheet->getHeaderFooter()->getFirstFooter()); |
|
898 | 60 | $objWriter->endElement(); |
|
899 | 60 | } |
|
900 | |||
901 | /** |
||
902 | * Write Breaks. |
||
903 | * |
||
904 | * @param XMLWriter $objWriter XML Writer |
||
905 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
906 | * |
||
907 | * @throws WriterException |
||
908 | */ |
||
909 | 60 | private function writeBreaks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
910 | { |
||
911 | // Get row and column breaks |
||
912 | 60 | $aRowBreaks = []; |
|
913 | 60 | $aColumnBreaks = []; |
|
914 | 60 | foreach ($pSheet->getBreaks() as $cell => $breakType) { |
|
915 | 1 | if ($breakType == PhpspreadsheetWorksheet::BREAK_ROW) { |
|
916 | 1 | $aRowBreaks[] = $cell; |
|
917 | } elseif ($breakType == PhpspreadsheetWorksheet::BREAK_COLUMN) { |
||
918 | 1 | $aColumnBreaks[] = $cell; |
|
919 | } |
||
920 | } |
||
921 | |||
922 | // rowBreaks |
||
923 | 60 | if (!empty($aRowBreaks)) { |
|
924 | 1 | $objWriter->startElement('rowBreaks'); |
|
925 | 1 | $objWriter->writeAttribute('count', count($aRowBreaks)); |
|
926 | 1 | $objWriter->writeAttribute('manualBreakCount', count($aRowBreaks)); |
|
927 | |||
928 | 1 | foreach ($aRowBreaks as $cell) { |
|
929 | 1 | $coords = Coordinate::coordinateFromString($cell); |
|
930 | |||
931 | 1 | $objWriter->startElement('brk'); |
|
932 | 1 | $objWriter->writeAttribute('id', $coords[1]); |
|
933 | 1 | $objWriter->writeAttribute('man', '1'); |
|
934 | 1 | $objWriter->endElement(); |
|
935 | } |
||
936 | |||
937 | 1 | $objWriter->endElement(); |
|
938 | } |
||
939 | |||
940 | // Second, write column breaks |
||
941 | 60 | if (!empty($aColumnBreaks)) { |
|
942 | $objWriter->startElement('colBreaks'); |
||
943 | $objWriter->writeAttribute('count', count($aColumnBreaks)); |
||
944 | $objWriter->writeAttribute('manualBreakCount', count($aColumnBreaks)); |
||
945 | |||
946 | foreach ($aColumnBreaks as $cell) { |
||
947 | $coords = Coordinate::coordinateFromString($cell); |
||
948 | |||
949 | $objWriter->startElement('brk'); |
||
950 | $objWriter->writeAttribute('id', Coordinate::columnIndexFromString($coords[0]) - 1); |
||
951 | $objWriter->writeAttribute('man', '1'); |
||
952 | $objWriter->endElement(); |
||
953 | } |
||
954 | |||
955 | $objWriter->endElement(); |
||
956 | } |
||
957 | 60 | } |
|
958 | |||
959 | /** |
||
960 | * Write SheetData. |
||
961 | * |
||
962 | * @param XMLWriter $objWriter XML Writer |
||
963 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
964 | * @param string[] $pStringTable String table |
||
965 | * |
||
966 | * @throws WriterException |
||
967 | */ |
||
968 | 60 | private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, array $pStringTable) |
|
1044 | 60 | } |
|
1045 | |||
1046 | /** |
||
1047 | * Write Cell. |
||
1048 | * |
||
1049 | * @param XMLWriter $objWriter XML Writer |
||
1050 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1051 | * @param Cell $pCellAddress Cell Address |
||
1052 | * @param string[] $pFlippedStringTable String table (flipped), for faster index searching |
||
1053 | * |
||
1054 | * @throws WriterException |
||
1055 | */ |
||
1056 | 59 | private function writeCell(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, $pCellAddress, array $pFlippedStringTable) |
|
1164 | 59 | } |
|
1165 | |||
1166 | /** |
||
1167 | * Write Drawings. |
||
1168 | * |
||
1169 | * @param XMLWriter $objWriter XML Writer |
||
1170 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1171 | * @param bool $includeCharts Flag indicating if we should include drawing details for charts |
||
1172 | * |
||
1173 | * @throws WriterException |
||
1174 | */ |
||
1175 | 60 | private function writeDrawings(XMLWriter $objWriter = null, PhpspreadsheetWorksheet $pSheet = null, $includeCharts = false) |
|
1176 | { |
||
1177 | 60 | $chartCount = ($includeCharts) ? $pSheet->getChartCollection()->count() : 0; |
|
1 ignored issue
–
show
|
|||
1178 | // If sheet contains drawings, add the relationships |
||
1179 | 60 | if (($pSheet->getDrawingCollection()->count() > 0) || |
|
1180 | 60 | ($chartCount > 0)) { |
|
1181 | 22 | $objWriter->startElement('drawing'); |
|
1 ignored issue
–
show
|
|||
1182 | 22 | $objWriter->writeAttribute('r:id', 'rId1'); |
|
1183 | 22 | $objWriter->endElement(); |
|
1184 | } |
||
1185 | 60 | } |
|
1186 | |||
1187 | /** |
||
1188 | * Write LegacyDrawing. |
||
1189 | * |
||
1190 | * @param XMLWriter $objWriter XML Writer |
||
1191 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1192 | * |
||
1193 | * @throws WriterException |
||
1194 | */ |
||
1195 | 60 | private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
1196 | { |
||
1197 | // If sheet contains comments, add the relationships |
||
1198 | 60 | if (count($pSheet->getComments()) > 0) { |
|
1199 | 9 | $objWriter->startElement('legacyDrawing'); |
|
1200 | 9 | $objWriter->writeAttribute('r:id', 'rId_comments_vml1'); |
|
1201 | 9 | $objWriter->endElement(); |
|
1202 | } |
||
1203 | 60 | } |
|
1204 | |||
1205 | /** |
||
1206 | * Write LegacyDrawingHF. |
||
1207 | * |
||
1208 | * @param XMLWriter $objWriter XML Writer |
||
1209 | * @param PhpspreadsheetWorksheet $pSheet Worksheet |
||
1210 | * |
||
1211 | * @throws WriterException |
||
1212 | */ |
||
1213 | 60 | private function writeLegacyDrawingHF(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet) |
|
1220 | } |
||
1221 | 60 | } |
|
1222 | } |
||
1223 |