Completed
Push — master ( 414e56...4f6d4a )
by Adrien
09:01
created

Worksheet::writeSheetViews()   F

Complexity

Conditions 17
Paths 6656

Size

Total Lines 106
Code Lines 60

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 53
CRAP Score 17.3039

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 17
eloc 60
nc 6656
nop 2
dl 0
loc 106
ccs 53
cts 59
cp 0.8983
crap 17.3039
rs 1.0499
c 1
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
4
5
use PhpOffice\PhpSpreadsheet\Cell\Cell;
6
use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
7
use PhpOffice\PhpSpreadsheet\RichText\RichText;
8
use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
9
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
10
use PhpOffice\PhpSpreadsheet\Style\Conditional;
11
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
12
use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column\Rule;
13
use PhpOffice\PhpSpreadsheet\Worksheet\SheetView;
14
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet as PhpspreadsheetWorksheet;
15
16
/**
17
 * @category   PhpSpreadsheet
18
 *
19
 * @copyright  Copyright (c) 2006 - 2015 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
20
 */
21
class Worksheet extends WriterPart
22
{
23
    /**
24
     * Write worksheet to XML format.
25
     *
26
     * @param PhpspreadsheetWorksheet $pSheet
27
     * @param string[] $pStringTable
28
     * @param bool $includeCharts Flag indicating if we should write charts
29
     *
30
     * @return string XML Output
31
     */
32 106
    public function writeWorksheet(PhpspreadsheetWorksheet $pSheet, $pStringTable = null, $includeCharts = false)
33
    {
34
        // Create XML writer
35 106
        $objWriter = null;
36 106
        if ($this->getParentWriter()->getUseDiskCaching()) {
37
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
38
        } else {
39 106
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
40
        }
41
42
        // XML header
43 106
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');
44
45
        // Worksheet
46 106
        $objWriter->startElement('worksheet');
47 106
        $objWriter->writeAttribute('xml:space', 'preserve');
48 106
        $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main');
49 106
        $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');
50
51 106
        $objWriter->writeAttribute('xmlns:xdr', 'http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing');
52 106
        $objWriter->writeAttribute('xmlns:x14', 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/main');
53 106
        $objWriter->writeAttribute('xmlns:mc', 'http://schemas.openxmlformats.org/markup-compatibility/2006');
54 106
        $objWriter->writeAttribute('mc:Ignorable', 'x14ac');
55 106
        $objWriter->writeAttribute('xmlns:x14ac', 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac');
56
57
        // sheetPr
58 106
        $this->writeSheetPr($objWriter, $pSheet);
59
60
        // Dimension
61 106
        $this->writeDimension($objWriter, $pSheet);
62
63
        // sheetViews
64 106
        $this->writeSheetViews($objWriter, $pSheet);
65
66
        // sheetFormatPr
67 106
        $this->writeSheetFormatPr($objWriter, $pSheet);
68
69
        // cols
70 106
        $this->writeCols($objWriter, $pSheet);
71
72
        // sheetData
73 106
        $this->writeSheetData($objWriter, $pSheet, $pStringTable);
1 ignored issue
show
Bug introduced by
It seems like $pStringTable can also be of type null; however, parameter $pStringTable of PhpOffice\PhpSpreadsheet...sheet::writeSheetData() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

73
        $this->writeSheetData($objWriter, $pSheet, /** @scrutinizer ignore-type */ $pStringTable);
Loading history...
74
75
        // sheetProtection
76 106
        $this->writeSheetProtection($objWriter, $pSheet);
77
78
        // protectedRanges
79 106
        $this->writeProtectedRanges($objWriter, $pSheet);
80
81
        // autoFilter
82 106
        $this->writeAutoFilter($objWriter, $pSheet);
83
84
        // mergeCells
85 106
        $this->writeMergeCells($objWriter, $pSheet);
86
87
        // conditionalFormatting
88 106
        $this->writeConditionalFormatting($objWriter, $pSheet);
89
90
        // dataValidations
91 106
        $this->writeDataValidations($objWriter, $pSheet);
92
93
        // hyperlinks
94 106
        $this->writeHyperlinks($objWriter, $pSheet);
95
96
        // Print options
97 106
        $this->writePrintOptions($objWriter, $pSheet);
98
99
        // Page margins
100 106
        $this->writePageMargins($objWriter, $pSheet);
101
102
        // Page setup
103 106
        $this->writePageSetup($objWriter, $pSheet);
104
105
        // Header / footer
106 106
        $this->writeHeaderFooter($objWriter, $pSheet);
107
108
        // Breaks
109 106
        $this->writeBreaks($objWriter, $pSheet);
110
111
        // Drawings and/or Charts
112 106
        $this->writeDrawings($objWriter, $pSheet, $includeCharts);
113
114
        // LegacyDrawing
115 106
        $this->writeLegacyDrawing($objWriter, $pSheet);
116
117
        // LegacyDrawingHF
118 106
        $this->writeLegacyDrawingHF($objWriter, $pSheet);
119
120
        // AlternateContent
121 106
        $this->writeAlternateContent($objWriter, $pSheet);
122
123 106
        $objWriter->endElement();
124
125
        // Return
126 106
        return $objWriter->getData();
127
    }
128
129
    /**
130
     * Write SheetPr.
131
     *
132
     * @param XMLWriter $objWriter XML Writer
133
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
134
     */
135 106
    private function writeSheetPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
136
    {
137
        // sheetPr
138 106
        $objWriter->startElement('sheetPr');
139 106
        if ($pSheet->getParent()->hasMacros()) {
140
            //if the workbook have macros, we need to have codeName for the sheet
141 1
            if (!$pSheet->hasCodeName()) {
142
                $pSheet->setCodeName($pSheet->getTitle());
143
            }
144 1
            $objWriter->writeAttribute('codeName', $pSheet->getCodeName());
145
        }
146 106
        $autoFilterRange = $pSheet->getAutoFilter()->getRange();
147 106
        if (!empty($autoFilterRange)) {
148 3
            $objWriter->writeAttribute('filterMode', 1);
149 3
            $pSheet->getAutoFilter()->showHideRows();
150
        }
151
152
        // tabColor
153 106
        if ($pSheet->isTabColorSet()) {
154 6
            $objWriter->startElement('tabColor');
155 6
            $objWriter->writeAttribute('rgb', $pSheet->getTabColor()->getARGB());
156 6
            $objWriter->endElement();
157
        }
158
159
        // outlinePr
160 106
        $objWriter->startElement('outlinePr');
161 106
        $objWriter->writeAttribute('summaryBelow', ($pSheet->getShowSummaryBelow() ? '1' : '0'));
162 106
        $objWriter->writeAttribute('summaryRight', ($pSheet->getShowSummaryRight() ? '1' : '0'));
163 106
        $objWriter->endElement();
164
165
        // pageSetUpPr
166 106
        if ($pSheet->getPageSetup()->getFitToPage()) {
167
            $objWriter->startElement('pageSetUpPr');
168
            $objWriter->writeAttribute('fitToPage', '1');
169
            $objWriter->endElement();
170
        }
171
172 106
        $objWriter->endElement();
173 106
    }
174
175
    /**
176
     * Write Dimension.
177
     *
178
     * @param XMLWriter $objWriter XML Writer
179
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
180
     */
181 106
    private function writeDimension(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
182
    {
183
        // dimension
184 106
        $objWriter->startElement('dimension');
185 106
        $objWriter->writeAttribute('ref', $pSheet->calculateWorksheetDimension());
186 106
        $objWriter->endElement();
187 106
    }
188
189
    /**
190
     * Write SheetViews.
191
     *
192
     * @param XMLWriter $objWriter XML Writer
193
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
194
     */
195 106
    private function writeSheetViews(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
196
    {
197
        // sheetViews
198 106
        $objWriter->startElement('sheetViews');
199
200
        // Sheet selected?
201 106
        $sheetSelected = false;
202 106
        if ($this->getParentWriter()->getSpreadsheet()->getIndex($pSheet) == $this->getParentWriter()->getSpreadsheet()->getActiveSheetIndex()) {
203 106
            $sheetSelected = true;
204
        }
205
206
        // sheetView
207 106
        $objWriter->startElement('sheetView');
208 106
        $objWriter->writeAttribute('tabSelected', $sheetSelected ? '1' : '0');
209 106
        $objWriter->writeAttribute('workbookViewId', '0');
210
211
        // Zoom scales
212 106
        if ($pSheet->getSheetView()->getZoomScale() != 100) {
213
            $objWriter->writeAttribute('zoomScale', $pSheet->getSheetView()->getZoomScale());
214
        }
215 106
        if ($pSheet->getSheetView()->getZoomScaleNormal() != 100) {
216
            $objWriter->writeAttribute('zoomScaleNormal', $pSheet->getSheetView()->getZoomScaleNormal());
217
        }
218
219
        // Show zeros (Excel also writes this attribute only if set to false)
220 106
        if ($pSheet->getSheetView()->getShowZeros() === false) {
221
            $objWriter->writeAttribute('showZeros', 0);
222
        }
223
224
        // View Layout Type
225 106
        if ($pSheet->getSheetView()->getView() !== SheetView::SHEETVIEW_NORMAL) {
226 1
            $objWriter->writeAttribute('view', $pSheet->getSheetView()->getView());
227
        }
228
229
        // Gridlines
230 106
        if ($pSheet->getShowGridlines()) {
231 106
            $objWriter->writeAttribute('showGridLines', 'true');
232
        } else {
233
            $objWriter->writeAttribute('showGridLines', 'false');
234
        }
235
236
        // Row and column headers
237 106
        if ($pSheet->getShowRowColHeaders()) {
238 106
            $objWriter->writeAttribute('showRowColHeaders', '1');
239
        } else {
240
            $objWriter->writeAttribute('showRowColHeaders', '0');
241
        }
242
243
        // Right-to-left
244 106
        if ($pSheet->getRightToLeft()) {
245
            $objWriter->writeAttribute('rightToLeft', 'true');
246
        }
247
248 106
        $activeCell = $pSheet->getActiveCell();
249 106
        $sqref = $pSheet->getSelectedCells();
250
251
        // Pane
252 106
        $pane = '';
253 106
        if ($pSheet->getFreezePane()) {
254 6
            [$xSplit, $ySplit] = Coordinate::coordinateFromString($pSheet->getFreezePane());
255 6
            $xSplit = Coordinate::columnIndexFromString($xSplit);
256 6
            --$xSplit;
257 6
            --$ySplit;
258
259 6
            $topLeftCell = $pSheet->getTopLeftCell();
260
261
            // pane
262 6
            $pane = 'topRight';
263 6
            $objWriter->startElement('pane');
264 6
            if ($xSplit > 0) {
265 1
                $objWriter->writeAttribute('xSplit', $xSplit);
266
            }
267 6
            if ($ySplit > 0) {
268 6
                $objWriter->writeAttribute('ySplit', $ySplit);
269 6
                $pane = ($xSplit > 0) ? 'bottomRight' : 'bottomLeft';
270
            }
271 6
            $objWriter->writeAttribute('topLeftCell', $topLeftCell);
272 6
            $objWriter->writeAttribute('activePane', $pane);
273 6
            $objWriter->writeAttribute('state', 'frozen');
274 6
            $objWriter->endElement();
275
276 6
            if (($xSplit > 0) && ($ySplit > 0)) {
277
                //    Write additional selections if more than two panes (ie both an X and a Y split)
278 1
                $objWriter->startElement('selection');
279 1
                $objWriter->writeAttribute('pane', 'topRight');
280 1
                $objWriter->endElement();
281 1
                $objWriter->startElement('selection');
282 1
                $objWriter->writeAttribute('pane', 'bottomLeft');
283 1
                $objWriter->endElement();
284
            }
285
        }
286
287
        // Selection
288
        // Only need to write selection element if we have a split pane
289
        // We cheat a little by over-riding the active cell selection, setting it to the split cell
290 106
        $objWriter->startElement('selection');
291 106
        if ($pane != '') {
292 6
            $objWriter->writeAttribute('pane', $pane);
293
        }
294 106
        $objWriter->writeAttribute('activeCell', $activeCell);
295 106
        $objWriter->writeAttribute('sqref', $sqref);
296 106
        $objWriter->endElement();
297
298 106
        $objWriter->endElement();
299
300 106
        $objWriter->endElement();
301 106
    }
302
303
    /**
304
     * Write SheetFormatPr.
305
     *
306
     * @param XMLWriter $objWriter XML Writer
307
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
308
     */
309 106
    private function writeSheetFormatPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
310
    {
311
        // sheetFormatPr
312 106
        $objWriter->startElement('sheetFormatPr');
313
314
        // Default row height
315 106
        if ($pSheet->getDefaultRowDimension()->getRowHeight() >= 0) {
316 3
            $objWriter->writeAttribute('customHeight', 'true');
317 3
            $objWriter->writeAttribute('defaultRowHeight', StringHelper::formatNumber($pSheet->getDefaultRowDimension()->getRowHeight()));
318
        } else {
319 103
            $objWriter->writeAttribute('defaultRowHeight', '14.4');
320
        }
321
322
        // Set Zero Height row
323 106
        if ((string) $pSheet->getDefaultRowDimension()->getZeroHeight() === '1' ||
324 106
            strtolower((string) $pSheet->getDefaultRowDimension()->getZeroHeight()) == 'true') {
325
            $objWriter->writeAttribute('zeroHeight', '1');
326
        }
327
328
        // Default column width
329 106
        if ($pSheet->getDefaultColumnDimension()->getWidth() >= 0) {
330 2
            $objWriter->writeAttribute('defaultColWidth', StringHelper::formatNumber($pSheet->getDefaultColumnDimension()->getWidth()));
331
        }
332
333
        // Outline level - row
334 106
        $outlineLevelRow = 0;
335 106
        foreach ($pSheet->getRowDimensions() as $dimension) {
336 13
            if ($dimension->getOutlineLevel() > $outlineLevelRow) {
337
                $outlineLevelRow = $dimension->getOutlineLevel();
338
            }
339
        }
340 106
        $objWriter->writeAttribute('outlineLevelRow', (int) $outlineLevelRow);
341
342
        // Outline level - column
343 106
        $outlineLevelCol = 0;
344 106
        foreach ($pSheet->getColumnDimensions() as $dimension) {
345 24
            if ($dimension->getOutlineLevel() > $outlineLevelCol) {
346 1
                $outlineLevelCol = $dimension->getOutlineLevel();
347
            }
348
        }
349 106
        $objWriter->writeAttribute('outlineLevelCol', (int) $outlineLevelCol);
350
351 106
        $objWriter->endElement();
352 106
    }
353
354
    /**
355
     * Write Cols.
356
     *
357
     * @param XMLWriter $objWriter XML Writer
358
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
359
     */
360 106
    private function writeCols(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
361
    {
362
        // cols
363 106
        if (count($pSheet->getColumnDimensions()) > 0) {
364 24
            $objWriter->startElement('cols');
365
366 24
            $pSheet->calculateColumnWidths();
367
368
            // Loop through column dimensions
369 24
            foreach ($pSheet->getColumnDimensions() as $colDimension) {
370
                // col
371 24
                $objWriter->startElement('col');
372 24
                $objWriter->writeAttribute('min', Coordinate::columnIndexFromString($colDimension->getColumnIndex()));
373 24
                $objWriter->writeAttribute('max', Coordinate::columnIndexFromString($colDimension->getColumnIndex()));
374
375 24
                if ($colDimension->getWidth() < 0) {
376
                    // No width set, apply default of 10
377 2
                    $objWriter->writeAttribute('width', '9.10');
378
                } else {
379
                    // Width set
380 24
                    $objWriter->writeAttribute('width', StringHelper::formatNumber($colDimension->getWidth()));
381
                }
382
383
                // Column visibility
384 24
                if ($colDimension->getVisible() === false) {
385 3
                    $objWriter->writeAttribute('hidden', 'true');
386
                }
387
388
                // Auto size?
389 24
                if ($colDimension->getAutoSize()) {
390 8
                    $objWriter->writeAttribute('bestFit', 'true');
391
                }
392
393
                // Custom width?
394 24
                if ($colDimension->getWidth() != $pSheet->getDefaultColumnDimension()->getWidth()) {
395 24
                    $objWriter->writeAttribute('customWidth', 'true');
396
                }
397
398
                // Collapsed
399 24
                if ($colDimension->getCollapsed() === true) {
400 1
                    $objWriter->writeAttribute('collapsed', 'true');
401
                }
402
403
                // Outline level
404 24
                if ($colDimension->getOutlineLevel() > 0) {
405 1
                    $objWriter->writeAttribute('outlineLevel', $colDimension->getOutlineLevel());
406
                }
407
408
                // Style
409 24
                $objWriter->writeAttribute('style', $colDimension->getXfIndex());
410
411 24
                $objWriter->endElement();
412
            }
413
414 24
            $objWriter->endElement();
415
        }
416 106
    }
417
418
    /**
419
     * Write SheetProtection.
420
     *
421
     * @param XMLWriter $objWriter XML Writer
422
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
423
     */
424 106
    private function writeSheetProtection(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
425
    {
426
        // sheetProtection
427 106
        $objWriter->startElement('sheetProtection');
428
429 106
        if ($pSheet->getProtection()->getPassword() !== '') {
430 2
            $objWriter->writeAttribute('password', $pSheet->getProtection()->getPassword());
431
        }
432
433 106
        $objWriter->writeAttribute('sheet', ($pSheet->getProtection()->getSheet() ? 'true' : 'false'));
434 106
        $objWriter->writeAttribute('objects', ($pSheet->getProtection()->getObjects() ? 'true' : 'false'));
435 106
        $objWriter->writeAttribute('scenarios', ($pSheet->getProtection()->getScenarios() ? 'true' : 'false'));
436 106
        $objWriter->writeAttribute('formatCells', ($pSheet->getProtection()->getFormatCells() ? 'true' : 'false'));
437 106
        $objWriter->writeAttribute('formatColumns', ($pSheet->getProtection()->getFormatColumns() ? 'true' : 'false'));
438 106
        $objWriter->writeAttribute('formatRows', ($pSheet->getProtection()->getFormatRows() ? 'true' : 'false'));
439 106
        $objWriter->writeAttribute('insertColumns', ($pSheet->getProtection()->getInsertColumns() ? 'true' : 'false'));
440 106
        $objWriter->writeAttribute('insertRows', ($pSheet->getProtection()->getInsertRows() ? 'true' : 'false'));
441 106
        $objWriter->writeAttribute('insertHyperlinks', ($pSheet->getProtection()->getInsertHyperlinks() ? 'true' : 'false'));
442 106
        $objWriter->writeAttribute('deleteColumns', ($pSheet->getProtection()->getDeleteColumns() ? 'true' : 'false'));
443 106
        $objWriter->writeAttribute('deleteRows', ($pSheet->getProtection()->getDeleteRows() ? 'true' : 'false'));
444 106
        $objWriter->writeAttribute('selectLockedCells', ($pSheet->getProtection()->getSelectLockedCells() ? 'true' : 'false'));
445 106
        $objWriter->writeAttribute('sort', ($pSheet->getProtection()->getSort() ? 'true' : 'false'));
446 106
        $objWriter->writeAttribute('autoFilter', ($pSheet->getProtection()->getAutoFilter() ? 'true' : 'false'));
447 106
        $objWriter->writeAttribute('pivotTables', ($pSheet->getProtection()->getPivotTables() ? 'true' : 'false'));
448 106
        $objWriter->writeAttribute('selectUnlockedCells', ($pSheet->getProtection()->getSelectUnlockedCells() ? 'true' : 'false'));
449 106
        $objWriter->endElement();
450 106
    }
451
452
    private static function writeAttributeIf(XMLWriter $objWriter, $condition, string $attr, string $val): void
453
    {
454
        if ($condition) {
455
            $objWriter->writeAttribute($attr, $val);
456
        }
457
    }
458 106
459
    private static function writeElementIf(XMLWriter $objWriter, $condition, string $attr, string $val): void
460
    {
461 106
        if ($condition) {
462
            $objWriter->writeElement($attr, $val);
463
        }
464 106
    }
465 5
466
    private static function writeOtherCondElements(XMLWriter $objWriter, Conditional $conditional, string $cellCoordinate): void
467
    {
468
        if ($conditional->getConditionType() == Conditional::CONDITION_CELLIS
469
            || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT
470 5
            || $conditional->getConditionType() == Conditional::CONDITION_EXPRESSION) {
471
            foreach ($conditional->getConditions() as $formula) {
472 5
                // Formula
473 5
                $objWriter->writeElement('formula', Xlfn::addXlfn($formula));
474
            }
475
        } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSBLANKS) {
476 5
            // formula copied from ms xlsx xml source file
477 5
            $objWriter->writeElement('formula', 'LEN(TRIM(' . $cellCoordinate . '))=0');
478 5
        } elseif ($conditional->getConditionType() == Conditional::CONDITION_NOTCONTAINSBLANKS) {
479 5
            // formula copied from ms xlsx xml source file
480
            $objWriter->writeElement('formula', 'LEN(TRIM(' . $cellCoordinate . '))>0');
481 5
        }
482 5
    }
483 4
484
    private static function writeTextCondElements(XMLWriter $objWriter, Conditional $conditional, string $cellCoordinate): void
485
    {
486 5
        $txt = $conditional->getText();
487 5
        if ($txt !== null) {
0 ignored issues
show
introduced by
The condition $txt !== null is always true.
Loading history...
488
            $objWriter->writeAttribute('text', $txt);
489
            if ($conditional->getOperatorType() == Conditional::OPERATOR_CONTAINSTEXT) {
490
                $objWriter->writeElement('formula', 'NOT(ISERROR(SEARCH("' . $txt . '",' . $cellCoordinate . ')))');
491 5
            } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_BEGINSWITH) {
492 1
                $objWriter->writeElement('formula', 'LEFT(' . $cellCoordinate . ',' . strlen($txt) . ')="' . $txt . '"');
493
            } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_ENDSWITH) {
494
                $objWriter->writeElement('formula', 'RIGHT(' . $cellCoordinate . ',' . strlen($txt) . ')="' . $txt . '"');
495 5
            } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_NOTCONTAINS) {
496 5
                $objWriter->writeElement('formula', 'ISERROR(SEARCH("' . $txt . '",' . $cellCoordinate . '))');
497 5
            }
498
        }
499 5
    }
500 5
501 5
    /**
502
     * Write ConditionalFormatting.
503 5
     *
504 5
     * @param XMLWriter $objWriter XML Writer
505 5
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
506
     */
507 5
    private function writeConditionalFormatting(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
508 5
    {
509 5
        // Conditional id
510
        $id = 1;
511 5
512 5
        // Loop through styles in the current worksheet
513 5
        foreach ($pSheet->getConditionalStylesCollection() as $cellCoordinate => $conditionalStyles) {
514 4
            foreach ($conditionalStyles as $conditional) {
515
                // WHY was this again?
516 4
                // if ($this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode()) == '') {
517
                //    continue;
518 2
                // }
519
                if ($conditional->getConditionType() != Conditional::CONDITION_NONE) {
520 2
                    // conditionalFormatting
521 1
                    $objWriter->startElement('conditionalFormatting');
522
                    $objWriter->writeAttribute('sqref', $cellCoordinate);
523 1
524
                    // cfRule
525
                    $objWriter->startElement('cfRule');
526 5
                    $objWriter->writeAttribute('type', $conditional->getConditionType());
527
                    $objWriter->writeAttribute('dxfId', $this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode()));
528 5
                    $objWriter->writeAttribute('priority', $id++);
529
530
                    self::writeAttributeif(
531
                        $objWriter,
532 106
                        ($conditional->getConditionType() == Conditional::CONDITION_CELLIS || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT)
533
                        && $conditional->getOperatorType() != Conditional::OPERATOR_NONE,
534
                        'operator',
535
                        $conditional->getOperatorType()
536
                    );
537
538
                    self::writeAttributeIf($objWriter, $conditional->getStopIfTrue(), 'stopIfTrue', '1');
539
540 106
                    if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT) {
541
                        self::writeTextCondElements($objWriter, $conditional, $cellCoordinate);
542
                    } else {
543 106
                        self::writeOtherCondElements($objWriter, $conditional, $cellCoordinate);
544
                    }
545
546 106
                    $objWriter->endElement();
547 2
548 2
                    $objWriter->endElement();
549 2
                }
550
            }
551 2
        }
552 2
    }
553
554 2
    /**
555 2
     * Write DataValidations.
556
     *
557
     * @param XMLWriter $objWriter XML Writer
558 2
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
559 2
     */
560
    private function writeDataValidations(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
561
    {
562 2
        // Datavalidation collection
563 2
        $dataValidationCollection = $pSheet->getDataValidationCollection();
564
565
        // Write data validations?
566 2
        if (!empty($dataValidationCollection)) {
567 2
            $dataValidationCollection = Coordinate::mergeRangesInCollection($dataValidationCollection);
568 2
            $objWriter->startElement('dataValidations');
569 2
            $objWriter->writeAttribute('count', count($dataValidationCollection));
570
571 2
            foreach ($dataValidationCollection as $coordinate => $dv) {
572 2
                $objWriter->startElement('dataValidation');
573
574 2
                if ($dv->getType() != '') {
575 2
                    $objWriter->writeAttribute('type', $dv->getType());
576
                }
577 2
578 2
                if ($dv->getErrorStyle() != '') {
579
                    $objWriter->writeAttribute('errorStyle', $dv->getErrorStyle());
580 2
                }
581 2
582
                if ($dv->getOperator() != '') {
583
                    $objWriter->writeAttribute('operator', $dv->getOperator());
584 2
                }
585
586 2
                $objWriter->writeAttribute('allowBlank', ($dv->getAllowBlank() ? '1' : '0'));
587 2
                $objWriter->writeAttribute('showDropDown', (!$dv->getShowDropDown() ? '1' : '0'));
588
                $objWriter->writeAttribute('showInputMessage', ($dv->getShowInputMessage() ? '1' : '0'));
589 2
                $objWriter->writeAttribute('showErrorMessage', ($dv->getShowErrorMessage() ? '1' : '0'));
590 1
591
                if ($dv->getErrorTitle() !== '') {
592
                    $objWriter->writeAttribute('errorTitle', $dv->getErrorTitle());
593 2
                }
594
                if ($dv->getError() !== '') {
595
                    $objWriter->writeAttribute('error', $dv->getError());
596 2
                }
597
                if ($dv->getPromptTitle() !== '') {
598 106
                    $objWriter->writeAttribute('promptTitle', $dv->getPromptTitle());
599
                }
600
                if ($dv->getPrompt() !== '') {
601
                    $objWriter->writeAttribute('prompt', $dv->getPrompt());
602
                }
603
604
                $objWriter->writeAttribute('sqref', $coordinate);
605
606 106
                if ($dv->getFormula1() !== '') {
607
                    $objWriter->writeElement('formula1', $dv->getFormula1());
608
                }
609 106
                if ($dv->getFormula2() !== '') {
610
                    $objWriter->writeElement('formula2', $dv->getFormula2());
611
                }
612 106
613
                $objWriter->endElement();
614
            }
615 106
616 10
            $objWriter->endElement();
617
        }
618 10
    }
619 10
620
    /**
621 10
     * Write Hyperlinks.
622 10
     *
623 10
     * @param XMLWriter $objWriter XML Writer
624 10
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
625
     */
626 7
    private function writeHyperlinks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
627
    {
628
        // Hyperlink collection
629 10
        $hyperlinkCollection = $pSheet->getHyperlinkCollection();
630 6
631 6
        // Relation ID
632
        $relationId = 1;
633
634 10
        // Write hyperlinks?
635
        if (!empty($hyperlinkCollection)) {
636
            $objWriter->startElement('hyperlinks');
637 10
638
            foreach ($hyperlinkCollection as $coordinate => $hyperlink) {
639 106
                $objWriter->startElement('hyperlink');
640
641
                $objWriter->writeAttribute('ref', $coordinate);
642
                if (!$hyperlink->isInternal()) {
643
                    $objWriter->writeAttribute('r:id', 'rId_hyperlink_' . $relationId);
644
                    ++$relationId;
645
                } else {
646
                    $objWriter->writeAttribute('location', str_replace('sheet://', '', $hyperlink->getUrl()));
647 106
                }
648
649 106
                if ($hyperlink->getTooltip() !== '') {
650
                    $objWriter->writeAttribute('tooltip', $hyperlink->getTooltip());
651 6
                    $objWriter->writeAttribute('display', $hyperlink->getTooltip());
652
                }
653
654 6
                $objWriter->endElement();
655
            }
656 6
657 6
            $objWriter->endElement();
658 6
        }
659 6
    }
660 6
661
    /**
662 6
     * Write ProtectedRanges.
663
     *
664
     * @param XMLWriter $objWriter XML Writer
665 6
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
666
     */
667 106
    private function writeProtectedRanges(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
668
    {
669
        if (count($pSheet->getProtectedCells()) > 0) {
670
            // protectedRanges
671
            $objWriter->startElement('protectedRanges');
672
673
            // Loop protectedRanges
674
            foreach ($pSheet->getProtectedCells() as $protectedCell => $passwordHash) {
675 106
                // protectedRange
676
                $objWriter->startElement('protectedRange');
677 106
                $objWriter->writeAttribute('name', 'p' . md5($protectedCell));
678
                $objWriter->writeAttribute('sqref', $protectedCell);
679 13
                if (!empty($passwordHash)) {
680
                    $objWriter->writeAttribute('password', $passwordHash);
0 ignored issues
show
Bug introduced by
$passwordHash of type array is incompatible with the type string expected by parameter $value of XMLWriter::writeAttribute(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

680
                    $objWriter->writeAttribute('password', /** @scrutinizer ignore-type */ $passwordHash);
Loading history...
681
                }
682 13
                $objWriter->endElement();
683
            }
684 13
685 13
            $objWriter->endElement();
686 13
        }
687
    }
688
689 13
    /**
690
     * Write MergeCells.
691 106
     *
692
     * @param XMLWriter $objWriter XML Writer
693
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
694
     */
695
    private function writeMergeCells(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
696
    {
697
        if (count($pSheet->getMergeCells()) > 0) {
698
            // mergeCells
699 106
            $objWriter->startElement('mergeCells');
700
701
            // Loop mergeCells
702 106
            foreach ($pSheet->getMergeCells() as $mergeCell) {
703
                // mergeCell
704 106
                $objWriter->startElement('mergeCell');
705 106
                $objWriter->writeAttribute('ref', $mergeCell);
0 ignored issues
show
Bug introduced by
$mergeCell of type array is incompatible with the type string expected by parameter $value of XMLWriter::writeAttribute(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

705
                $objWriter->writeAttribute('ref', /** @scrutinizer ignore-type */ $mergeCell);
Loading history...
706
                $objWriter->endElement();
707 106
            }
708
709
            $objWriter->endElement();
710
        }
711 106
    }
712
713
    /**
714
     * Write PrintOptions.
715 106
     *
716 106
     * @param XMLWriter $objWriter XML Writer
717
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
718
     */
719
    private function writePrintOptions(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
720
    {
721
        // printOptions
722
        $objWriter->startElement('printOptions');
723
724 106
        $objWriter->writeAttribute('gridLines', ($pSheet->getPrintGridlines() ? 'true' : 'false'));
725
        $objWriter->writeAttribute('gridLinesSet', 'true');
726
727 106
        if ($pSheet->getPageSetup()->getHorizontalCentered()) {
728 106
            $objWriter->writeAttribute('horizontalCentered', 'true');
729 106
        }
730 106
731 106
        if ($pSheet->getPageSetup()->getVerticalCentered()) {
732 106
            $objWriter->writeAttribute('verticalCentered', 'true');
733 106
        }
734 106
735 106
        $objWriter->endElement();
736
    }
737
738
    /**
739
     * Write PageMargins.
740
     *
741
     * @param XMLWriter $objWriter XML Writer
742
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
743 106
     */
744
    private function writePageMargins(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
745 106
    {
746 106
        // pageMargins
747
        $objWriter->startElement('pageMargins');
748 3
        $objWriter->writeAttribute('left', StringHelper::formatNumber($pSheet->getPageMargins()->getLeft()));
749
        $objWriter->writeAttribute('right', StringHelper::formatNumber($pSheet->getPageMargins()->getRight()));
750
        $objWriter->writeAttribute('top', StringHelper::formatNumber($pSheet->getPageMargins()->getTop()));
751 3
        $objWriter->writeAttribute('bottom', StringHelper::formatNumber($pSheet->getPageMargins()->getBottom()));
752 3
        $objWriter->writeAttribute('header', StringHelper::formatNumber($pSheet->getPageMargins()->getHeader()));
753
        $objWriter->writeAttribute('footer', StringHelper::formatNumber($pSheet->getPageMargins()->getFooter()));
754 3
        $objWriter->endElement();
755 3
    }
756
757 3
    /**
758
     * Write AutoFilter.
759 3
     *
760 3
     * @param XMLWriter $objWriter XML Writer
761 2
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
762 2
     */
763 2
    private function writeAutoFilter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
764 2
    {
765 2
        $autoFilterRange = $pSheet->getAutoFilter()->getRange();
766
        if (!empty($autoFilterRange)) {
767 2
            // autoFilter
768 2
            $objWriter->startElement('autoFilter');
769 1
770
            // Strip any worksheet reference from the filter coordinates
771
            $range = Coordinate::splitRange($autoFilterRange);
772 2
            $range = $range[0];
773 2
            //    Strip any worksheet ref
774 2
            [$ws, $range[0]] = PhpspreadsheetWorksheet::extractSheetTitle($range[0], true);
775 2
            $range = implode(':', $range);
776
777 1
            $objWriter->writeAttribute('ref', str_replace('$', '', $range));
778 2
779
            $columns = $pSheet->getAutoFilter()->getColumns();
780 1
            if (count($columns) > 0) {
781 1
                foreach ($columns as $columnID => $column) {
782 1
                    $rules = $column->getRules();
783 1
                    if (count($rules) > 0) {
784
                        $objWriter->startElement('filterColumn');
785 1
                        $objWriter->writeAttribute('colId', $pSheet->getAutoFilter()->getColumnOffset($columnID));
786 1
787 1
                        $objWriter->startElement($column->getFilterType());
788
                        if ($column->getJoin() == Column::AUTOFILTER_COLUMN_JOIN_AND) {
789 2
                            $objWriter->writeAttribute('and', 1);
790
                        }
791
792
                        foreach ($rules as $rule) {
793
                            if (($column->getFilterType() === Column::AUTOFILTER_FILTERTYPE_FILTER) &&
794
                                ($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_EQUAL) &&
795
                                ($rule->getValue() === '')) {
796 2
                                //    Filter rule for Blanks
797
                                $objWriter->writeAttribute('blank', 1);
798 2
                            } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER) {
799 1
                                //    Dynamic Filter Rule
800
                                $objWriter->writeAttribute('type', $rule->getGrouping());
801 2
                                $val = $column->getAttribute('val');
802
                                if ($val !== null) {
803 1
                                    $objWriter->writeAttribute('val', $val);
804 1
                                }
805 1
                                $maxVal = $column->getAttribute('maxVal');
806
                                if ($maxVal !== null) {
807
                                    $objWriter->writeAttribute('maxVal', $maxVal);
808 1
                                }
809
                            } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_TOPTENFILTER) {
810 2
                                //    Top 10 Filter Rule
811
                                $objWriter->writeAttribute('val', $rule->getValue());
812
                                $objWriter->writeAttribute('percent', (($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT) ? '1' : '0'));
813 2
                                $objWriter->writeAttribute('top', (($rule->getGrouping() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_TOP) ? '1' : '0'));
814
                            } else {
815
                                //    Filter, DateGroupItem or CustomFilter
816
                                $objWriter->startElement($rule->getRuleType());
817 2
818
                                if ($rule->getOperator() !== Rule::AUTOFILTER_COLUMN_RULE_EQUAL) {
819 2
                                    $objWriter->writeAttribute('operator', $rule->getOperator());
820
                                }
821
                                if ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DATEGROUP) {
822
                                    // Date Group filters
823 3
                                    foreach ($rule->getValue() as $key => $value) {
0 ignored issues
show
Bug introduced by
The expression $rule->getValue() of type string is not traversable.
Loading history...
824
                                        if ($value > '') {
825 106
                                            $objWriter->writeAttribute($key, $value);
826
                                        }
827
                                    }
828
                                    $objWriter->writeAttribute('dateTimeGrouping', $rule->getGrouping());
829
                                } else {
830
                                    $objWriter->writeAttribute('val', $rule->getValue());
831
                                }
832
833 106
                                $objWriter->endElement();
834
                            }
835
                        }
836 106
837 106
                        $objWriter->endElement();
838 106
839
                        $objWriter->endElement();
840 106
                    }
841 106
                }
842
            }
843 106
            $objWriter->endElement();
844 106
        }
845
    }
846
847
    /**
848 106
     * Write PageSetup.
849 106
     *
850
     * @param XMLWriter $objWriter XML Writer
851
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
852
     */
853 106
    private function writePageSetup(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
854
    {
855
        // pageSetup
856
        $objWriter->startElement('pageSetup');
857
        $objWriter->writeAttribute('paperSize', $pSheet->getPageSetup()->getPaperSize());
858 106
        $objWriter->writeAttribute('orientation', $pSheet->getPageSetup()->getOrientation());
859 106
860 4
        if ($pSheet->getPageSetup()->getScale() !== null) {
861
            $objWriter->writeAttribute('scale', $pSheet->getPageSetup()->getScale());
862
        }
863 106
        if ($pSheet->getPageSetup()->getFitToHeight() !== null) {
864 106
            $objWriter->writeAttribute('fitToHeight', $pSheet->getPageSetup()->getFitToHeight());
865
        } else {
866
            $objWriter->writeAttribute('fitToHeight', '0');
867
        }
868
        if ($pSheet->getPageSetup()->getFitToWidth() !== null) {
869
            $objWriter->writeAttribute('fitToWidth', $pSheet->getPageSetup()->getFitToWidth());
870
        } else {
871
            $objWriter->writeAttribute('fitToWidth', '0');
872 106
        }
873
        if ($pSheet->getPageSetup()->getFirstPageNumber() !== null) {
0 ignored issues
show
introduced by
The condition $pSheet->getPageSetup()-...stPageNumber() !== null is always true.
Loading history...
874
            $objWriter->writeAttribute('firstPageNumber', $pSheet->getPageSetup()->getFirstPageNumber());
875 106
            $objWriter->writeAttribute('useFirstPageNumber', '1');
876 106
        }
877 106
878 106
        $getUnparsedLoadedData = $pSheet->getParent()->getUnparsedLoadedData();
879 106
        if (isset($getUnparsedLoadedData['sheets'][$pSheet->getCodeName()]['pageSetupRelId'])) {
880
            $objWriter->writeAttribute('r:id', $getUnparsedLoadedData['sheets'][$pSheet->getCodeName()]['pageSetupRelId']);
881 106
        }
882 106
883 106
        $objWriter->endElement();
884 106
    }
885 106
886 106
    /**
887 106
     * Write Header / Footer.
888 106
     *
889
     * @param XMLWriter $objWriter XML Writer
890
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
891
     */
892
    private function writeHeaderFooter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
893
    {
894
        // headerFooter
895
        $objWriter->startElement('headerFooter');
896 106
        $objWriter->writeAttribute('differentOddEven', ($pSheet->getHeaderFooter()->getDifferentOddEven() ? 'true' : 'false'));
897
        $objWriter->writeAttribute('differentFirst', ($pSheet->getHeaderFooter()->getDifferentFirst() ? 'true' : 'false'));
898
        $objWriter->writeAttribute('scaleWithDoc', ($pSheet->getHeaderFooter()->getScaleWithDocument() ? 'true' : 'false'));
899 106
        $objWriter->writeAttribute('alignWithMargins', ($pSheet->getHeaderFooter()->getAlignWithMargins() ? 'true' : 'false'));
900 106
901 106
        $objWriter->writeElement('oddHeader', $pSheet->getHeaderFooter()->getOddHeader());
902 1
        $objWriter->writeElement('oddFooter', $pSheet->getHeaderFooter()->getOddFooter());
903 1
        $objWriter->writeElement('evenHeader', $pSheet->getHeaderFooter()->getEvenHeader());
904
        $objWriter->writeElement('evenFooter', $pSheet->getHeaderFooter()->getEvenFooter());
905
        $objWriter->writeElement('firstHeader', $pSheet->getHeaderFooter()->getFirstHeader());
906
        $objWriter->writeElement('firstFooter', $pSheet->getHeaderFooter()->getFirstFooter());
907
        $objWriter->endElement();
908
    }
909
910 106
    /**
911 1
     * Write Breaks.
912 1
     *
913 1
     * @param XMLWriter $objWriter XML Writer
914
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
915 1
     */
916 1
    private function writeBreaks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
917
    {
918 1
        // Get row and column breaks
919 1
        $aRowBreaks = [];
920 1
        $aColumnBreaks = [];
921 1
        foreach ($pSheet->getBreaks() as $cell => $breakType) {
922
            if ($breakType == PhpspreadsheetWorksheet::BREAK_ROW) {
923
                $aRowBreaks[] = $cell;
924 1
            } elseif ($breakType == PhpspreadsheetWorksheet::BREAK_COLUMN) {
925
                $aColumnBreaks[] = $cell;
926
            }
927
        }
928 106
929
        // rowBreaks
930
        if (!empty($aRowBreaks)) {
931
            $objWriter->startElement('rowBreaks');
932
            $objWriter->writeAttribute('count', count($aRowBreaks));
933
            $objWriter->writeAttribute('manualBreakCount', count($aRowBreaks));
934
935
            foreach ($aRowBreaks as $cell) {
936
                $coords = Coordinate::coordinateFromString($cell);
937
938
                $objWriter->startElement('brk');
939
                $objWriter->writeAttribute('id', $coords[1]);
940
                $objWriter->writeAttribute('man', '1');
941
                $objWriter->endElement();
942
            }
943
944 106
            $objWriter->endElement();
945
        }
946
947
        // Second, write column breaks
948
        if (!empty($aColumnBreaks)) {
949
            $objWriter->startElement('colBreaks');
950
            $objWriter->writeAttribute('count', count($aColumnBreaks));
951
            $objWriter->writeAttribute('manualBreakCount', count($aColumnBreaks));
952
953 106
            foreach ($aColumnBreaks as $cell) {
954
                $coords = Coordinate::coordinateFromString($cell);
955
956 106
                $objWriter->startElement('brk');
957
                $objWriter->writeAttribute('id', Coordinate::columnIndexFromString($coords[0]) - 1);
958
                $objWriter->writeAttribute('man', '1');
959 106
                $objWriter->endElement();
960
            }
961
962 106
            $objWriter->endElement();
963
        }
964
    }
965 106
966
    /**
967
     * Write SheetData.
968 106
     *
969 106
     * @param XMLWriter $objWriter XML Writer
970 100
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
971 100
     * @param string[] $pStringTable String table
972
     */
973
    private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, array $pStringTable)
974 106
    {
975 106
        // Flipped stringtable, for faster index searching
976
        $aFlippedStringTable = $this->getParentWriter()->getWriterPart('stringtable')->flipStringTable($pStringTable);
0 ignored issues
show
Bug introduced by
The method flipStringTable() does not exist on PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart. It seems like you code against a sub-type of PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart such as PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

976
        $aFlippedStringTable = $this->getParentWriter()->getWriterPart('stringtable')->/** @scrutinizer ignore-call */ flipStringTable($pStringTable);
Loading history...
977 106
978
        // sheetData
979
        $objWriter->startElement('sheetData');
980 106
981
        // Get column count
982 106
        $colCount = Coordinate::columnIndexFromString($pSheet->getHighestColumn());
983
984 100
        // Highest row number
985 100
        $highestRow = $pSheet->getHighestRow();
986 100
987
        // Loop through cells
988
        $cellsByRow = [];
989 100
        foreach ($pSheet->getCoordinates() as $coordinate) {
990 6
            $cellAddress = Coordinate::coordinateFromString($coordinate);
991 6
            $cellsByRow[$cellAddress[1]][] = $coordinate;
992
        }
993
994
        $currentRow = 0;
995 100
        while ($currentRow++ < $highestRow) {
996 2
            // Get row dimension
997
            $rowDimension = $pSheet->getRowDimension($currentRow);
998
999
            // Write current row?
1000 100
            $writeCurrentRow = isset($cellsByRow[$currentRow]) || $rowDimension->getRowHeight() >= 0 || $rowDimension->getVisible() == false || $rowDimension->getCollapsed() == true || $rowDimension->getOutlineLevel() > 0 || $rowDimension->getXfIndex() !== null;
0 ignored issues
show
introduced by
The condition $rowDimension->getXfIndex() !== null is always true.
Loading history...
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
1001
1002
            if ($writeCurrentRow) {
1003
                // Start a new row
1004
                $objWriter->startElement('row');
1005 100
                $objWriter->writeAttribute('r', $currentRow);
1006
                $objWriter->writeAttribute('spans', '1:' . $colCount);
1007
1008
                // Row dimensions
1009
                if ($rowDimension->getRowHeight() >= 0) {
1010 100
                    $objWriter->writeAttribute('customHeight', '1');
1011
                    $objWriter->writeAttribute('ht', StringHelper::formatNumber($rowDimension->getRowHeight()));
1012
                }
1013
1014
                // Row visibility
1015
                if (!$rowDimension->getVisible() === true) {
1016 100
                    $objWriter->writeAttribute('hidden', 'true');
1017 100
                }
1018
1019 100
                // Collapsed
1020
                if ($rowDimension->getCollapsed() === true) {
1021
                    $objWriter->writeAttribute('collapsed', 'true');
1022
                }
1023
1024 100
                // Outline level
1025
                if ($rowDimension->getOutlineLevel() > 0) {
1026
                    $objWriter->writeAttribute('outlineLevel', $rowDimension->getOutlineLevel());
1027
                }
1028 106
1029 106
                // Style
1030
                if ($rowDimension->getXfIndex() !== null) {
1031
                    $objWriter->writeAttribute('s', $rowDimension->getXfIndex());
1032
                    $objWriter->writeAttribute('customFormat', '1');
1033
                }
1034
1035
                // Write cells
1036
                if (isset($cellsByRow[$currentRow])) {
1037
                    foreach ($cellsByRow[$currentRow] as $cellAddress) {
1038
                        // Write cell
1039 100
                        $this->writeCell($objWriter, $pSheet, $cellAddress, $aFlippedStringTable);
1040
                    }
1041
                }
1042 100
1043 100
                // End row
1044 100
                $objWriter->endElement();
1045
            }
1046
        }
1047 100
1048 33
        $objWriter->endElement();
1049
    }
1050
1051
    /**
1052 100
     * @param XMLWriter $objWriter
1053 100
     * @param string $mappedType
1054
     * @param RichText|string $cellValue
1055 100
     */
1056
    private function writeCellInlineStr(XMLWriter $objWriter, string $mappedType, $cellValue): void
1057
    {
1058 100
        $objWriter->writeAttribute('t', $mappedType);
1059 100
        if (!$cellValue instanceof RichText) {
1060 99
            $objWriter->writeElement('t', StringHelper::controlCharacterPHP2OOXML(htmlspecialchars($cellValue)));
1061 82
        } elseif ($cellValue instanceof RichText) {
0 ignored issues
show
introduced by
$cellValue is always a sub-type of PhpOffice\PhpSpreadsheet\RichText\RichText.
Loading history...
1062 67
            $objWriter->startElement('is');
1063
            $this->getParentWriter()->getWriterPart('stringtable')->writeRichText($objWriter, $cellValue);
0 ignored issues
show
Bug introduced by
The method writeRichText() does not exist on PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart. It seems like you code against a sub-type of PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart such as PhpOffice\PhpSpreadsheet\Writer\Xlsx\StringTable. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

1063
            $this->getParentWriter()->getWriterPart('stringtable')->/** @scrutinizer ignore-call */ writeRichText($objWriter, $cellValue);
Loading history...
1064 67
            $objWriter->endElement();
1065 79
        }
1066 22
    }
1067 22
1068 22
    /**
1069 14
     * @param XMLWriter $objWriter
1070 19
     * @param string $mappedType
1071 5
     * @param RichText|string $cellValue
1072
     * @param string[] $pFlippedStringTable
1073
     */
1074 22
    private function writeCellString(XMLWriter $objWriter, string $mappedType, $cellValue, array $pFlippedStringTable): void
1075 75
    {
1076
        $objWriter->writeAttribute('t', $mappedType);
1077
        if (!$cellValue instanceof RichText) {
1078
            self::writeElementIf($objWriter, isset($pFlippedStringTable[$cellValue]), 'v', $pFlippedStringTable[$cellValue]);
1079
        } else {
1080 100
            $objWriter->writeElement('v', $pFlippedStringTable[$cellValue->getHashCode()]);
1081 100
        }
1082 8
    }
1083
1084 8
    /**
1085 8
     * @param XMLWriter $objWriter
1086 8
     * @param float|int $cellValue
1087 8
     */
1088
    private function writeCellNumeric(XMLWriter $objWriter, $cellValue): void
1089
    {
1090 8
        //force a decimal to be written if the type is float
1091 99
        if (is_float($cellValue)) {
1092 65
            // force point as decimal separator in case current locale uses comma
1093 65
            $cellValue = str_replace(',', '.', (string) $cellValue);
1094 65
            if (strpos($cellValue, '.') === false) {
1095
                $cellValue = $cellValue . '.0';
1096 2
            }
1097 2
        }
1098
        $objWriter->writeElement('v', $cellValue);
1099
    }
1100 65
1101 82
    private function writeCellBoolean(XMLWriter $objWriter, string $mappedType, bool $cellValue): void
1102 22
    {
1103 22
        $objWriter->writeAttribute('t', $mappedType);
1104
        $objWriter->writeElement('v', $cellValue ? '1' : '0');
1105
    }
1106
1107
    private function writeCellError(XMLWriter $objWriter, string $mappedType, string $cellValue, string $formulaerr = '#NULL!'): void
1108
    {
1109
        $objWriter->writeAttribute('t', $mappedType);
1110
        $cellIsFormula = substr($cellValue, 0, 1) === '=';
1111
        self::writeElementIf($objWriter, $cellIsFormula, 'f', Xlfn::addXlfnStripEquals($cellValue));
1112 22
        $objWriter->writeElement('v', $cellIsFormula ? $formulaerr : $cellValue);
1113
    }
1114 22
1115 22
    private function writeCellFormula(XMLWriter $objWriter, string $cellValue, Cell $pCell): void
1116 22
    {
1117 22
        $calculatedValue = $this->getParentWriter()->getPreCalculateFormulas() ? $pCell->getCalculatedValue() : $cellValue;
1118
        if (is_string($calculatedValue)) {
1119 22
            if (substr($calculatedValue, 0, 1) === '#') {
1120
                $this->writeCellError($objWriter, 'e', $cellValue, $calculatedValue);
1121
1122
                return;
1123
            }
1124
            $objWriter->writeAttribute('t', 'str');
1125
        } elseif (is_bool($calculatedValue)) {
1126 22
            $objWriter->writeAttribute('t', 'b');
1127 78
        }
1128
        // array values are not yet supported
1129 67
        //$attributes = $pCell->getFormulaAttributes();
1130
        //if (($attributes['t'] ?? null) === 'array') {
1131 29
        //    $objWriter->startElement('f');
1132 29
        //    $objWriter->writeAttribute('t', 'array');
1133 17
        //    $objWriter->writeAttribute('ref', $pCellAddress);
1134
        //    $objWriter->writeAttribute('aca', '1');
1135
        //    $objWriter->writeAttribute('ca', '1');
1136 67
        //    $objWriter->text(substr($cellValue, 1));
1137
        //    $objWriter->endElement();
1138 67
        //} else {
1139 29
        //    $objWriter->writeElement('f', Xlfn::addXlfnStripEquals($cellValue));
1140 9
        //}
1141
        $objWriter->writeElement('f', Xlfn::addXlfnStripEquals($cellValue));
1142 9
        self::writeElementIf(
1143 24
            $objWriter,
1144
            $this->getParentWriter()->getOffice2003Compatibility() === false,
1145
            'v',
1146
            ($this->getParentWriter()->getPreCalculateFormulas() && !is_array($calculatedValue) && substr($calculatedValue, 0, 1) !== '#')
1147
            ? StringHelper::formatNumber($calculatedValue) : '0'
1148
        );
1149
    }
1150
1151
    /**
1152
     * Write Cell.
1153
     *
1154
     * @param XMLWriter $objWriter XML Writer
1155 100
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
1156 100
     * @param string $pCellAddress Cell Address
1157
     * @param string[] $pFlippedStringTable String table (flipped), for faster index searching
1158
     */
1159
    private function writeCell(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, string $pCellAddress, array $pFlippedStringTable)
1160
    {
1161
        // Cell
1162
        $pCell = $pSheet->getCell($pCellAddress);
1163
        $objWriter->startElement('c');
1164
        $objWriter->writeAttribute('r', $pCellAddress);
1165 106
1166
        // Sheet styles
1167 106
        $xfi = $pCell->getXfIndex();
1168 106
        self::writeAttributeIf($objWriter, $xfi, 's', $xfi);
1169 106
1170 106
        // If cell value is supplied, write cell value
1171 81
        $cellValue = $pCell->getValue();
1172
        if (is_object($cellValue) || $cellValue !== '') {
1173
            // Map type
1174
            $mappedType = $pCell->getDataType();
1175 27
1176
            // Write data depending on its type
1177 27
            switch (strtolower($mappedType)) {
1178 27
                case 'inlinestr':    // Inline string
1179 4
                    $this->writeCellInlineStr($objWriter, $mappedType, $cellValue);
1180
1181 4
                    break;
1182
                case 's':            // String
1183
                    $this->writeCellString($objWriter, $mappedType, $cellValue, $pFlippedStringTable);
1184 27
1185 27
                    break;
1186 27
                case 'f':            // Formula
1187
                    $this->writeCellFormula($objWriter, $cellValue, $pCell);
1 ignored issue
show
Bug introduced by
It seems like $pCell can also be of type null; however, parameter $pCell of PhpOffice\PhpSpreadsheet...eet::writeCellFormula() does only seem to accept PhpOffice\PhpSpreadsheet\Cell\Cell, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1187
                    $this->writeCellFormula($objWriter, $cellValue, /** @scrutinizer ignore-type */ $pCell);
Loading history...
1188
1189
                    break;
1190
                case 'n':            // Numeric
1191
                    $this->writeCellNumeric($objWriter, $cellValue);
1192
1193
                    break;
1194 106
                case 'b':            // Boolean
1195
                    $this->writeCellBoolean($objWriter, $mappedType, $cellValue);
1196
1197 106
                    break;
1198 10
                case 'e':            // Error
1199 10
                    $this->writeCellError($objWriter, $mappedType, $cellValue);
1200 10
            }
1201
        }
1202 106
1203
        $objWriter->endElement();
1204
    }
1205
1206
    /**
1207
     * Write Drawings.
1208
     *
1209
     * @param XMLWriter $objWriter XML Writer
1210 106
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
1211
     * @param bool $includeCharts Flag indicating if we should include drawing details for charts
1212
     */
1213 106
    private function writeDrawings(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, $includeCharts = false)
1214 1
    {
1215 1
        $unparsedLoadedData = $pSheet->getParent()->getUnparsedLoadedData();
1216 1
        $hasUnparsedDrawing = isset($unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds']);
1217
        $chartCount = ($includeCharts) ? $pSheet->getChartCollection()->count() : 0;
1218 106
        if ($chartCount == 0 && $pSheet->getDrawingCollection()->count() == 0 && !$hasUnparsedDrawing) {
1219
            return;
1220 106
        }
1221
1222 106
        // If sheet contains drawings, add the relationships
1223 106
        $objWriter->startElement('drawing');
1224
1225
        $rId = 'rId1';
1226 1
        if (isset($unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds'])) {
1227 1
            $drawingOriginalIds = $unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds'];
1228
            // take first. In future can be overriten
1229 1
            $rId = reset($drawingOriginalIds);
1230
        }
1231
1232
        $objWriter->writeAttribute('r:id', $rId);
1233
        $objWriter->endElement();
1234
    }
1235
1236
    /**
1237
     * Write LegacyDrawing.
1238
     *
1239
     * @param XMLWriter $objWriter XML Writer
1240
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
1241
     */
1242
    private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
1243
    {
1244
        // If sheet contains comments, add the relationships
1245
        if (count($pSheet->getComments()) > 0) {
1246
            $objWriter->startElement('legacyDrawing');
1247
            $objWriter->writeAttribute('r:id', 'rId_comments_vml1');
1248
            $objWriter->endElement();
1249
        }
1250
    }
1251
1252
    /**
1253
     * Write LegacyDrawingHF.
1254
     *
1255
     * @param XMLWriter $objWriter XML Writer
1256
     * @param PhpspreadsheetWorksheet $pSheet Worksheet
1257
     */
1258
    private function writeLegacyDrawingHF(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
1259
    {
1260
        // If sheet contains images, add the relationships
1261
        if (count($pSheet->getHeaderFooter()->getImages()) > 0) {
1262
            $objWriter->startElement('legacyDrawingHF');
1263
            $objWriter->writeAttribute('r:id', 'rId_headerfooter_vml1');
1264
            $objWriter->endElement();
1265
        }
1266
    }
1267
1268
    private function writeAlternateContent(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet)
1269
    {
1270
        if (empty($pSheet->getParent()->getUnparsedLoadedData()['sheets'][$pSheet->getCodeName()]['AlternateContents'])) {
1271
            return;
1272
        }
1273
1274
        foreach ($pSheet->getParent()->getUnparsedLoadedData()['sheets'][$pSheet->getCodeName()]['AlternateContents'] as $alternateContent) {
1275
            $objWriter->writeRaw($alternateContent);
1276
        }
1277
    }
1278
}
1279