Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
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 class Worksheet extends WriterPart 17 { 18 /** 19 * Write worksheet to XML format. 20 * 21 * @param string[] $pStringTable 22 * @param bool $includeCharts Flag indicating if we should write charts 23 * 24 * @return string XML Output 25 */ 26 public function writeWorksheet(PhpspreadsheetWorksheet $pSheet, $pStringTable = null, $includeCharts = false) 27 { 28 // Create XML writer 29 $objWriter = null; 30 if ($this->getParentWriter()->getUseDiskCaching()) { 31 $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory()); 32 } else { 33 $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY); 34 } 35 36 // XML header 37 $objWriter->startDocument('1.0', 'UTF-8', 'yes'); 38 39 // Worksheet 40 $objWriter->startElement('worksheet'); 41 $objWriter->writeAttribute('xml:space', 'preserve'); 42 $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main'); 43 $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); 44 45 $objWriter->writeAttribute('xmlns:xdr', 'http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing'); 46 $objWriter->writeAttribute('xmlns:x14', 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/main'); 47 $objWriter->writeAttribute('xmlns:mc', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); 48 $objWriter->writeAttribute('mc:Ignorable', 'x14ac'); 49 $objWriter->writeAttribute('xmlns:x14ac', 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac'); 50 51 // sheetPr 52 $this->writeSheetPr($objWriter, $pSheet); 53 54 // Dimension 55 $this->writeDimension($objWriter, $pSheet); 56 57 // sheetViews 58 $this->writeSheetViews($objWriter, $pSheet); 59 60 // sheetFormatPr 61 $this->writeSheetFormatPr($objWriter, $pSheet); 62 63 // cols 64 $this->writeCols($objWriter, $pSheet); 65 66 // sheetData 67 $this->writeSheetData($objWriter, $pSheet, $pStringTable); 68 69 // sheetProtection 70 $this->writeSheetProtection($objWriter, $pSheet); 71 72 // protectedRanges 73 $this->writeProtectedRanges($objWriter, $pSheet); 74 75 // autoFilter 76 $this->writeAutoFilter($objWriter, $pSheet); 77 78 // mergeCells 79 $this->writeMergeCells($objWriter, $pSheet); 80 81 // conditionalFormatting 82 $this->writeConditionalFormatting($objWriter, $pSheet); 83 84 // dataValidations 85 $this->writeDataValidations($objWriter, $pSheet); 86 87 // hyperlinks 88 $this->writeHyperlinks($objWriter, $pSheet); 89 90 // Print options 91 $this->writePrintOptions($objWriter, $pSheet); 92 93 // Page margins 94 $this->writePageMargins($objWriter, $pSheet); 95 96 // Page setup 97 $this->writePageSetup($objWriter, $pSheet); 98 99 // Header / footer 100 $this->writeHeaderFooter($objWriter, $pSheet); 101 102 // Breaks 103 $this->writeBreaks($objWriter, $pSheet); 104 105 // Drawings and/or Charts 106 $this->writeDrawings($objWriter, $pSheet, $includeCharts); 107 108 // LegacyDrawing 109 $this->writeLegacyDrawing($objWriter, $pSheet); 110 111 // LegacyDrawingHF 112 $this->writeLegacyDrawingHF($objWriter, $pSheet); 113 114 // AlternateContent 115 $this->writeAlternateContent($objWriter, $pSheet); 116 117 $objWriter->endElement(); 118 119 // Return 120 return $objWriter->getData(); 121 } 122 123 /** 124 * Write SheetPr. 125 * 126 * @param XMLWriter $objWriter XML Writer 127 * @param PhpspreadsheetWorksheet $pSheet Worksheet 128 */ 129 private function writeSheetPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 130 { 131 // sheetPr 132 $objWriter->startElement('sheetPr'); 133 if ($pSheet->getParent()->hasMacros()) { 134 //if the workbook have macros, we need to have codeName for the sheet 135 if (!$pSheet->hasCodeName()) { 136 $pSheet->setCodeName($pSheet->getTitle()); 137 } 138 $objWriter->writeAttribute('codeName', $pSheet->getCodeName()); 139 } 140 $autoFilterRange = $pSheet->getAutoFilter()->getRange(); 141 if (!empty($autoFilterRange)) { 142 $objWriter->writeAttribute('filterMode', 1); 143 $pSheet->getAutoFilter()->showHideRows(); 144 } 145 146 // tabColor 147 if ($pSheet->isTabColorSet()) { 148 $objWriter->startElement('tabColor'); 149 $objWriter->writeAttribute('rgb', $pSheet->getTabColor()->getARGB()); 150 $objWriter->endElement(); 151 } 152 153 // outlinePr 154 $objWriter->startElement('outlinePr'); 155 $objWriter->writeAttribute('summaryBelow', ($pSheet->getShowSummaryBelow() ? '1' : '0')); 156 $objWriter->writeAttribute('summaryRight', ($pSheet->getShowSummaryRight() ? '1' : '0')); 157 $objWriter->endElement(); 158 159 // pageSetUpPr 160 if ($pSheet->getPageSetup()->getFitToPage()) { 161 $objWriter->startElement('pageSetUpPr'); 162 $objWriter->writeAttribute('fitToPage', '1'); 163 $objWriter->endElement(); 164 } 165 166 $objWriter->endElement(); 167 } 168 169 /** 170 * Write Dimension. 171 * 172 * @param XMLWriter $objWriter XML Writer 173 * @param PhpspreadsheetWorksheet $pSheet Worksheet 174 */ 175 private function writeDimension(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 176 { 177 // dimension 178 $objWriter->startElement('dimension'); 179 $objWriter->writeAttribute('ref', $pSheet->calculateWorksheetDimension()); 180 $objWriter->endElement(); 181 } 182 183 /** 184 * Write SheetViews. 185 * 186 * @param XMLWriter $objWriter XML Writer 187 * @param PhpspreadsheetWorksheet $pSheet Worksheet 188 */ 189 private function writeSheetViews(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 190 { 191 // sheetViews 192 $objWriter->startElement('sheetViews'); 193 194 // Sheet selected? 195 $sheetSelected = false; 196 if ($this->getParentWriter()->getSpreadsheet()->getIndex($pSheet) == $this->getParentWriter()->getSpreadsheet()->getActiveSheetIndex()) { 197 $sheetSelected = true; 198 } 199 200 // sheetView 201 $objWriter->startElement('sheetView'); 202 $objWriter->writeAttribute('tabSelected', $sheetSelected ? '1' : '0'); 203 $objWriter->writeAttribute('workbookViewId', '0'); 204 205 // Zoom scales 206 if ($pSheet->getSheetView()->getZoomScale() != 100) { 207 $objWriter->writeAttribute('zoomScale', $pSheet->getSheetView()->getZoomScale()); 208 } 209 if ($pSheet->getSheetView()->getZoomScaleNormal() != 100) { 210 $objWriter->writeAttribute('zoomScaleNormal', $pSheet->getSheetView()->getZoomScaleNormal()); 211 } 212 213 // Show zeros (Excel also writes this attribute only if set to false) 214 if ($pSheet->getSheetView()->getShowZeros() === false) { 215 $objWriter->writeAttribute('showZeros', 0); 216 } 217 218 // View Layout Type 219 if ($pSheet->getSheetView()->getView() !== SheetView::SHEETVIEW_NORMAL) { 220 $objWriter->writeAttribute('view', $pSheet->getSheetView()->getView()); 221 } 222 223 // Gridlines 224 if ($pSheet->getShowGridlines()) { 225 $objWriter->writeAttribute('showGridLines', 'true'); 226 } else { 227 $objWriter->writeAttribute('showGridLines', 'false'); 228 } 229 230 // Row and column headers 231 if ($pSheet->getShowRowColHeaders()) { 232 $objWriter->writeAttribute('showRowColHeaders', '1'); 233 } else { 234 $objWriter->writeAttribute('showRowColHeaders', '0'); 235 } 236 237 // Right-to-left 238 if ($pSheet->getRightToLeft()) { 239 $objWriter->writeAttribute('rightToLeft', 'true'); 240 } 241 242 $activeCell = $pSheet->getActiveCell(); 243 $sqref = $pSheet->getSelectedCells(); 244 245 // Pane 246 $pane = ''; 247 if ($pSheet->getFreezePane()) { 248 [$xSplit, $ySplit] = Coordinate::coordinateFromString($pSheet->getFreezePane()); 249 $xSplit = Coordinate::columnIndexFromString($xSplit); 250 --$xSplit; 251 --$ySplit; 252 253 $topLeftCell = $pSheet->getTopLeftCell(); 254 255 // pane 256 $pane = 'topRight'; 257 $objWriter->startElement('pane'); 258 if ($xSplit > 0) { 259 $objWriter->writeAttribute('xSplit', $xSplit); 260 } 261 if ($ySplit > 0) { 262 $objWriter->writeAttribute('ySplit', $ySplit); 263 $pane = ($xSplit > 0) ? 'bottomRight' : 'bottomLeft'; 264 } 265 $objWriter->writeAttribute('topLeftCell', $topLeftCell); 266 $objWriter->writeAttribute('activePane', $pane); 267 $objWriter->writeAttribute('state', 'frozen'); 268 $objWriter->endElement(); 269 270 if (($xSplit > 0) && ($ySplit > 0)) { 271 // Write additional selections if more than two panes (ie both an X and a Y split) 272 $objWriter->startElement('selection'); 273 $objWriter->writeAttribute('pane', 'topRight'); 274 $objWriter->endElement(); 275 $objWriter->startElement('selection'); 276 $objWriter->writeAttribute('pane', 'bottomLeft'); 277 $objWriter->endElement(); 278 } 279 } 280 281 // Selection 282 // Only need to write selection element if we have a split pane 283 // We cheat a little by over-riding the active cell selection, setting it to the split cell 284 $objWriter->startElement('selection'); 285 if ($pane != '') { 286 $objWriter->writeAttribute('pane', $pane); 287 } 288 $objWriter->writeAttribute('activeCell', $activeCell); 289 $objWriter->writeAttribute('sqref', $sqref); 290 $objWriter->endElement(); 291 292 $objWriter->endElement(); 293 294 $objWriter->endElement(); 295 } 296 297 /** 298 * Write SheetFormatPr. 299 * 300 * @param XMLWriter $objWriter XML Writer 301 * @param PhpspreadsheetWorksheet $pSheet Worksheet 302 */ 303 private function writeSheetFormatPr(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 304 { 305 // sheetFormatPr 306 $objWriter->startElement('sheetFormatPr'); 307 308 // Default row height 309 if ($pSheet->getDefaultRowDimension()->getRowHeight() >= 0) { 310 $objWriter->writeAttribute('customHeight', 'true'); 311 $objWriter->writeAttribute('defaultRowHeight', StringHelper::formatNumber($pSheet->getDefaultRowDimension()->getRowHeight())); 312 } else { 313 $objWriter->writeAttribute('defaultRowHeight', '14.4'); 314 } 315 316 // Set Zero Height row 317 if ( 318 (string) $pSheet->getDefaultRowDimension()->getZeroHeight() === '1' || 319 strtolower((string) $pSheet->getDefaultRowDimension()->getZeroHeight()) == 'true' 320 ) { 321 $objWriter->writeAttribute('zeroHeight', '1'); 322 } 323 324 // Default column width 325 if ($pSheet->getDefaultColumnDimension()->getWidth() >= 0) { 326 $objWriter->writeAttribute('defaultColWidth', StringHelper::formatNumber($pSheet->getDefaultColumnDimension()->getWidth())); 327 } 328 329 // Outline level - row 330 $outlineLevelRow = 0; 331 foreach ($pSheet->getRowDimensions() as $dimension) { 332 if ($dimension->getOutlineLevel() > $outlineLevelRow) { 333 $outlineLevelRow = $dimension->getOutlineLevel(); 334 } 335 } 336 $objWriter->writeAttribute('outlineLevelRow', (int) $outlineLevelRow); 337 338 // Outline level - column 339 $outlineLevelCol = 0; 340 foreach ($pSheet->getColumnDimensions() as $dimension) { 341 if ($dimension->getOutlineLevel() > $outlineLevelCol) { 342 $outlineLevelCol = $dimension->getOutlineLevel(); 343 } 344 } 345 $objWriter->writeAttribute('outlineLevelCol', (int) $outlineLevelCol); 346 347 $objWriter->endElement(); 348 } 349 350 /** 351 * Write Cols. 352 * 353 * @param XMLWriter $objWriter XML Writer 354 * @param PhpspreadsheetWorksheet $pSheet Worksheet 355 */ 356 private function writeCols(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 357 { 358 // cols 359 if (count($pSheet->getColumnDimensions()) > 0) { 360 $objWriter->startElement('cols'); 361 362 $pSheet->calculateColumnWidths(); 363 364 // Loop through column dimensions 365 foreach ($pSheet->getColumnDimensions() as $colDimension) { 366 // col 367 $objWriter->startElement('col'); 368 $objWriter->writeAttribute('min', Coordinate::columnIndexFromString($colDimension->getColumnIndex())); 369 $objWriter->writeAttribute('max', Coordinate::columnIndexFromString($colDimension->getColumnIndex())); 370 371 if ($colDimension->getWidth() < 0) { 372 // No width set, apply default of 10 373 $objWriter->writeAttribute('width', '9.10'); 374 } else { 375 // Width set 376 $objWriter->writeAttribute('width', StringHelper::formatNumber($colDimension->getWidth())); 377 } 378 379 // Column visibility 380 if ($colDimension->getVisible() === false) { 381 $objWriter->writeAttribute('hidden', 'true'); 382 } 383 384 // Auto size? 385 if ($colDimension->getAutoSize()) { 386 $objWriter->writeAttribute('bestFit', 'true'); 387 } 388 389 // Custom width? 390 if ($colDimension->getWidth() != $pSheet->getDefaultColumnDimension()->getWidth()) { 391 $objWriter->writeAttribute('customWidth', 'true'); 392 } 393 394 // Collapsed 395 if ($colDimension->getCollapsed() === true) { 396 $objWriter->writeAttribute('collapsed', 'true'); 397 } 398 399 // Outline level 400 if ($colDimension->getOutlineLevel() > 0) { 401 $objWriter->writeAttribute('outlineLevel', $colDimension->getOutlineLevel()); 402 } 403 404 // Style 405 $objWriter->writeAttribute('style', $colDimension->getXfIndex()); 406 407 $objWriter->endElement(); 408 } 409 410 $objWriter->endElement(); 411 } 412 } 413 414 /** 415 * Write SheetProtection. 416 * 417 * @param XMLWriter $objWriter XML Writer 418 * @param PhpspreadsheetWorksheet $pSheet Worksheet 419 */ 420 private function writeSheetProtection(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 421 { 422 // sheetProtection 423 $objWriter->startElement('sheetProtection'); 424 425 $protection = $pSheet->getProtection(); 426 427 if ($protection->getAlgorithm()) { 428 $objWriter->writeAttribute('algorithmName', $protection->getAlgorithm()); 429 $objWriter->writeAttribute('hashValue', $protection->getPassword()); 430 $objWriter->writeAttribute('saltValue', $protection->getSalt()); 431 $objWriter->writeAttribute('spinCount', $protection->getSpinCount()); 432 } elseif ($protection->getPassword() !== '') { 433 $objWriter->writeAttribute('password', $protection->getPassword()); 434 } 435 436 $objWriter->writeAttribute('sheet', ($protection->getSheet() ? 'true' : 'false')); 437 $objWriter->writeAttribute('objects', ($protection->getObjects() ? 'true' : 'false')); 438 $objWriter->writeAttribute('scenarios', ($protection->getScenarios() ? 'true' : 'false')); 439 $objWriter->writeAttribute('formatCells', ($protection->getFormatCells() ? 'true' : 'false')); 440 $objWriter->writeAttribute('formatColumns', ($protection->getFormatColumns() ? 'true' : 'false')); 441 $objWriter->writeAttribute('formatRows', ($protection->getFormatRows() ? 'true' : 'false')); 442 $objWriter->writeAttribute('insertColumns', ($protection->getInsertColumns() ? 'true' : 'false')); 443 $objWriter->writeAttribute('insertRows', ($protection->getInsertRows() ? 'true' : 'false')); 444 $objWriter->writeAttribute('insertHyperlinks', ($protection->getInsertHyperlinks() ? 'true' : 'false')); 445 $objWriter->writeAttribute('deleteColumns', ($protection->getDeleteColumns() ? 'true' : 'false')); 446 $objWriter->writeAttribute('deleteRows', ($protection->getDeleteRows() ? 'true' : 'false')); 447 $objWriter->writeAttribute('selectLockedCells', ($protection->getSelectLockedCells() ? 'true' : 'false')); 448 $objWriter->writeAttribute('sort', ($protection->getSort() ? 'true' : 'false')); 449 $objWriter->writeAttribute('autoFilter', ($protection->getAutoFilter() ? 'true' : 'false')); 450 $objWriter->writeAttribute('pivotTables', ($protection->getPivotTables() ? 'true' : 'false')); 451 $objWriter->writeAttribute('selectUnlockedCells', ($protection->getSelectUnlockedCells() ? 'true' : 'false')); 452 $objWriter->endElement(); 453 } 454 455 private static function writeAttributeIf(XMLWriter $objWriter, $condition, string $attr, string $val): void 456 { 457 if ($condition) { 458 $objWriter->writeAttribute($attr, $val); 459 } 460 } 461 462 private static function writeElementIf(XMLWriter $objWriter, $condition, string $attr, string $val): void 463 { 464 if ($condition) { 465 $objWriter->writeElement($attr, $val); 466 } 467 } 468 469 private static function writeOtherCondElements(XMLWriter $objWriter, Conditional $conditional, string $cellCoordinate): void 470 { 471 if ( 472 $conditional->getConditionType() == Conditional::CONDITION_CELLIS 473 || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT 474 || $conditional->getConditionType() == Conditional::CONDITION_EXPRESSION 475 ) { 476 foreach ($conditional->getConditions() as $formula) { 477 // Formula 478 $objWriter->writeElement('formula', Xlfn::addXlfn($formula)); 479 } 480 } elseif ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSBLANKS) { 481 // formula copied from ms xlsx xml source file 482 $objWriter->writeElement('formula', 'LEN(TRIM(' . $cellCoordinate . '))=0'); 483 } elseif ($conditional->getConditionType() == Conditional::CONDITION_NOTCONTAINSBLANKS) { 484 // formula copied from ms xlsx xml source file 485 $objWriter->writeElement('formula', 'LEN(TRIM(' . $cellCoordinate . '))>0'); 486 } 487 } 488 489 private static function writeTextCondElements(XMLWriter $objWriter, Conditional $conditional, string $cellCoordinate): void 490 { 491 $txt = $conditional->getText(); 492 if ($txt !== null) { 493 $objWriter->writeAttribute('text', $txt); 494 if ($conditional->getOperatorType() == Conditional::OPERATOR_CONTAINSTEXT) { 495 $objWriter->writeElement('formula', 'NOT(ISERROR(SEARCH("' . $txt . '",' . $cellCoordinate . ')))'); 496 } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_BEGINSWITH) { 497 $objWriter->writeElement('formula', 'LEFT(' . $cellCoordinate . ',' . strlen($txt) . ')="' . $txt . '"'); 498 } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_ENDSWITH) { 499 $objWriter->writeElement('formula', 'RIGHT(' . $cellCoordinate . ',' . strlen($txt) . ')="' . $txt . '"'); 500 } elseif ($conditional->getOperatorType() == Conditional::OPERATOR_NOTCONTAINS) { 501 $objWriter->writeElement('formula', 'ISERROR(SEARCH("' . $txt . '",' . $cellCoordinate . '))'); 502 } 503 } 504 } 505 506 /** 507 * Write ConditionalFormatting. 508 * 509 * @param XMLWriter $objWriter XML Writer 510 * @param PhpspreadsheetWorksheet $pSheet Worksheet 511 */ 512 private function writeConditionalFormatting(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 513 { 514 // Conditional id 515 $id = 1; 516 517 // Loop through styles in the current worksheet 518 foreach ($pSheet->getConditionalStylesCollection() as $cellCoordinate => $conditionalStyles) { 519 foreach ($conditionalStyles as $conditional) { 520 // WHY was this again? 521 // if ($this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode()) == '') { 522 // continue; 523 // } 524 if ($conditional->getConditionType() != Conditional::CONDITION_NONE) { 525 // conditionalFormatting 526 $objWriter->startElement('conditionalFormatting'); 527 $objWriter->writeAttribute('sqref', $cellCoordinate); 528 529 // cfRule 530 $objWriter->startElement('cfRule'); 531 $objWriter->writeAttribute('type', $conditional->getConditionType()); 532 $objWriter->writeAttribute('dxfId', $this->getParentWriter()->getStylesConditionalHashTable()->getIndexForHashCode($conditional->getHashCode())); 533 $objWriter->writeAttribute('priority', $id++); 534 535 self::writeAttributeif( 536 $objWriter, 537 ($conditional->getConditionType() == Conditional::CONDITION_CELLIS || $conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT) 538 && $conditional->getOperatorType() != Conditional::OPERATOR_NONE, 539 'operator', 540 $conditional->getOperatorType() 541 ); 542 543 self::writeAttributeIf($objWriter, $conditional->getStopIfTrue(), 'stopIfTrue', '1'); 544 545 if ($conditional->getConditionType() == Conditional::CONDITION_CONTAINSTEXT) { 546 self::writeTextCondElements($objWriter, $conditional, $cellCoordinate); 547 } else { 548 self::writeOtherCondElements($objWriter, $conditional, $cellCoordinate); 549 } 550 551 $objWriter->endElement(); 552 553 $objWriter->endElement(); 554 } 555 } 556 } 557 } 558 559 /** 560 * Write DataValidations. 561 * 562 * @param XMLWriter $objWriter XML Writer 563 * @param PhpspreadsheetWorksheet $pSheet Worksheet 564 */ 565 private function writeDataValidations(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 566 { 567 // Datavalidation collection 568 $dataValidationCollection = $pSheet->getDataValidationCollection(); 569 570 // Write data validations? 571 if (!empty($dataValidationCollection)) { 572 $dataValidationCollection = Coordinate::mergeRangesInCollection($dataValidationCollection); 573 $objWriter->startElement('dataValidations'); 574 $objWriter->writeAttribute('count', count($dataValidationCollection)); 575 576 foreach ($dataValidationCollection as $coordinate => $dv) { 577 $objWriter->startElement('dataValidation'); 578 579 if ($dv->getType() != '') { 580 $objWriter->writeAttribute('type', $dv->getType()); 581 } 582 583 if ($dv->getErrorStyle() != '') { 584 $objWriter->writeAttribute('errorStyle', $dv->getErrorStyle()); 585 } 586 587 if ($dv->getOperator() != '') { 588 $objWriter->writeAttribute('operator', $dv->getOperator()); 589 } 590 591 $objWriter->writeAttribute('allowBlank', ($dv->getAllowBlank() ? '1' : '0')); 592 $objWriter->writeAttribute('showDropDown', (!$dv->getShowDropDown() ? '1' : '0')); 593 $objWriter->writeAttribute('showInputMessage', ($dv->getShowInputMessage() ? '1' : '0')); 594 $objWriter->writeAttribute('showErrorMessage', ($dv->getShowErrorMessage() ? '1' : '0')); 595 596 if ($dv->getErrorTitle() !== '') { 597 $objWriter->writeAttribute('errorTitle', $dv->getErrorTitle()); 598 } 599 if ($dv->getError() !== '') { 600 $objWriter->writeAttribute('error', $dv->getError()); 601 } 602 if ($dv->getPromptTitle() !== '') { 603 $objWriter->writeAttribute('promptTitle', $dv->getPromptTitle()); 604 } 605 if ($dv->getPrompt() !== '') { 606 $objWriter->writeAttribute('prompt', $dv->getPrompt()); 607 } 608 609 $objWriter->writeAttribute('sqref', $coordinate); 610 611 if ($dv->getFormula1() !== '') { 612 $objWriter->writeElement('formula1', $dv->getFormula1()); 613 } 614 if ($dv->getFormula2() !== '') { 615 $objWriter->writeElement('formula2', $dv->getFormula2()); 616 } 617 618 $objWriter->endElement(); 619 } 620 621 $objWriter->endElement(); 622 } 623 } 624 625 /** 626 * Write Hyperlinks. 627 * 628 * @param XMLWriter $objWriter XML Writer 629 * @param PhpspreadsheetWorksheet $pSheet Worksheet 630 */ 631 private function writeHyperlinks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 632 { 633 // Hyperlink collection 634 $hyperlinkCollection = $pSheet->getHyperlinkCollection(); 635 636 // Relation ID 637 $relationId = 1; 638 639 // Write hyperlinks? 640 if (!empty($hyperlinkCollection)) { 641 $objWriter->startElement('hyperlinks'); 642 643 foreach ($hyperlinkCollection as $coordinate => $hyperlink) { 644 $objWriter->startElement('hyperlink'); 645 646 $objWriter->writeAttribute('ref', $coordinate); 647 if (!$hyperlink->isInternal()) { 648 $objWriter->writeAttribute('r:id', 'rId_hyperlink_' . $relationId); 649 ++$relationId; 650 } else { 651 $objWriter->writeAttribute('location', str_replace('sheet://', '', $hyperlink->getUrl())); 652 } 653 654 if ($hyperlink->getTooltip() !== '') { 655 $objWriter->writeAttribute('tooltip', $hyperlink->getTooltip()); 656 $objWriter->writeAttribute('display', $hyperlink->getTooltip()); 657 } 658 659 $objWriter->endElement(); 660 } 661 662 $objWriter->endElement(); 663 } 664 } 665 666 /** 667 * Write ProtectedRanges. 668 * 669 * @param XMLWriter $objWriter XML Writer 670 * @param PhpspreadsheetWorksheet $pSheet Worksheet 671 */ 672 private function writeProtectedRanges(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 673 { 674 if (count($pSheet->getProtectedCells()) > 0) { 675 // protectedRanges 676 $objWriter->startElement('protectedRanges'); 677 678 // Loop protectedRanges 679 foreach ($pSheet->getProtectedCells() as $protectedCell => $passwordHash) { 680 // protectedRange 681 $objWriter->startElement('protectedRange'); 682 $objWriter->writeAttribute('name', 'p' . md5($protectedCell)); 683 $objWriter->writeAttribute('sqref', $protectedCell); 684 if (!empty($passwordHash)) { 685 $objWriter->writeAttribute('password', $passwordHash); 686 } 687 $objWriter->endElement(); 688 } 689 690 $objWriter->endElement(); 691 } 692 } 693 694 /** 695 * Write MergeCells. 696 * 697 * @param XMLWriter $objWriter XML Writer 698 * @param PhpspreadsheetWorksheet $pSheet Worksheet 699 */ 700 private function writeMergeCells(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 701 { 702 if (count($pSheet->getMergeCells()) > 0) { 703 // mergeCells 704 $objWriter->startElement('mergeCells'); 705 706 // Loop mergeCells 707 foreach ($pSheet->getMergeCells() as $mergeCell) { 708 // mergeCell 709 $objWriter->startElement('mergeCell'); 710 $objWriter->writeAttribute('ref', $mergeCell); 711 $objWriter->endElement(); 712 } 713 714 $objWriter->endElement(); 715 } 716 } 717 718 /** 719 * Write PrintOptions. 720 * 721 * @param XMLWriter $objWriter XML Writer 722 * @param PhpspreadsheetWorksheet $pSheet Worksheet 723 */ 724 private function writePrintOptions(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 725 { 726 // printOptions 727 $objWriter->startElement('printOptions'); 728 729 $objWriter->writeAttribute('gridLines', ($pSheet->getPrintGridlines() ? 'true' : 'false')); 730 $objWriter->writeAttribute('gridLinesSet', 'true'); 731 732 if ($pSheet->getPageSetup()->getHorizontalCentered()) { 733 $objWriter->writeAttribute('horizontalCentered', 'true'); 734 } 735 736 if ($pSheet->getPageSetup()->getVerticalCentered()) { 737 $objWriter->writeAttribute('verticalCentered', 'true'); 738 } 739 740 $objWriter->endElement(); 741 } 742 743 /** 744 * Write PageMargins. 745 * 746 * @param XMLWriter $objWriter XML Writer 747 * @param PhpspreadsheetWorksheet $pSheet Worksheet 748 */ 749 private function writePageMargins(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 750 { 751 // pageMargins 752 $objWriter->startElement('pageMargins'); 753 $objWriter->writeAttribute('left', StringHelper::formatNumber($pSheet->getPageMargins()->getLeft())); 754 $objWriter->writeAttribute('right', StringHelper::formatNumber($pSheet->getPageMargins()->getRight())); 755 $objWriter->writeAttribute('top', StringHelper::formatNumber($pSheet->getPageMargins()->getTop())); 756 $objWriter->writeAttribute('bottom', StringHelper::formatNumber($pSheet->getPageMargins()->getBottom())); 757 $objWriter->writeAttribute('header', StringHelper::formatNumber($pSheet->getPageMargins()->getHeader())); 758 $objWriter->writeAttribute('footer', StringHelper::formatNumber($pSheet->getPageMargins()->getFooter())); 759 $objWriter->endElement(); 760 } 761 762 /** 763 * Write AutoFilter. 764 * 765 * @param XMLWriter $objWriter XML Writer 766 * @param PhpspreadsheetWorksheet $pSheet Worksheet 767 */ 768 private function writeAutoFilter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 769 { 770 $autoFilterRange = $pSheet->getAutoFilter()->getRange(); 771 if (!empty($autoFilterRange)) { 772 // autoFilter 773 $objWriter->startElement('autoFilter'); 774 775 // Strip any worksheet reference from the filter coordinates 776 $range = Coordinate::splitRange($autoFilterRange); 777 $range = $range[0]; 778 // Strip any worksheet ref 779 [$ws, $range[0]] = PhpspreadsheetWorksheet::extractSheetTitle($range[0], true); 780 $range = implode(':', $range); 781 782 $objWriter->writeAttribute('ref', str_replace('$', '', $range)); 783 784 $columns = $pSheet->getAutoFilter()->getColumns(); 785 if (count($columns) > 0) { 786 foreach ($columns as $columnID => $column) { 787 $rules = $column->getRules(); 788 if (count($rules) > 0) { 789 $objWriter->startElement('filterColumn'); 790 $objWriter->writeAttribute('colId', $pSheet->getAutoFilter()->getColumnOffset($columnID)); 791 792 $objWriter->startElement($column->getFilterType()); 793 if ($column->getJoin() == Column::AUTOFILTER_COLUMN_JOIN_AND) { 794 $objWriter->writeAttribute('and', 1); 795 } 796 797 foreach ($rules as $rule) { 798 if ( 799 ($column->getFilterType() === Column::AUTOFILTER_FILTERTYPE_FILTER) && 800 ($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_EQUAL) && 801 ($rule->getValue() === '') 802 ) { 803 // Filter rule for Blanks 804 $objWriter->writeAttribute('blank', 1); 805 } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DYNAMICFILTER) { 806 // Dynamic Filter Rule 807 $objWriter->writeAttribute('type', $rule->getGrouping()); 808 $val = $column->getAttribute('val'); 809 if ($val !== null) { 810 $objWriter->writeAttribute('val', $val); 811 } 812 $maxVal = $column->getAttribute('maxVal'); 813 if ($maxVal !== null) { 814 $objWriter->writeAttribute('maxVal', $maxVal); 815 } 816 } elseif ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_TOPTENFILTER) { 817 // Top 10 Filter Rule 818 $objWriter->writeAttribute('val', $rule->getValue()); 819 $objWriter->writeAttribute('percent', (($rule->getOperator() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_PERCENT) ? '1' : '0')); 820 $objWriter->writeAttribute('top', (($rule->getGrouping() === Rule::AUTOFILTER_COLUMN_RULE_TOPTEN_TOP) ? '1' : '0')); 821 } else { 822 // Filter, DateGroupItem or CustomFilter 823 $objWriter->startElement($rule->getRuleType()); 824 825 if ($rule->getOperator() !== Rule::AUTOFILTER_COLUMN_RULE_EQUAL) { 826 $objWriter->writeAttribute('operator', $rule->getOperator()); 827 } 828 if ($rule->getRuleType() === Rule::AUTOFILTER_RULETYPE_DATEGROUP) { 829 // Date Group filters 830 foreach ($rule->getValue() as $key => $value) { 831 if ($value > '') { 832 $objWriter->writeAttribute($key, $value); 833 } 834 } 835 $objWriter->writeAttribute('dateTimeGrouping', $rule->getGrouping()); 836 } else { 837 $objWriter->writeAttribute('val', $rule->getValue()); 838 } 839 840 $objWriter->endElement(); 841 } 842 } 843 844 $objWriter->endElement(); 845 846 $objWriter->endElement(); 847 } 848 } 849 } 850 $objWriter->endElement(); 851 } 852 } 853 854 /** 855 * Write PageSetup. 856 * 857 * @param XMLWriter $objWriter XML Writer 858 * @param PhpspreadsheetWorksheet $pSheet Worksheet 859 */ 860 private function writePageSetup(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 861 { 862 // pageSetup 863 $objWriter->startElement('pageSetup'); 864 $objWriter->writeAttribute('paperSize', $pSheet->getPageSetup()->getPaperSize()); 865 $objWriter->writeAttribute('orientation', $pSheet->getPageSetup()->getOrientation()); 866 867 if ($pSheet->getPageSetup()->getScale() !== null) { 868 $objWriter->writeAttribute('scale', $pSheet->getPageSetup()->getScale()); 869 } 870 if ($pSheet->getPageSetup()->getFitToHeight() !== null) { 871 $objWriter->writeAttribute('fitToHeight', $pSheet->getPageSetup()->getFitToHeight()); 872 } else { 873 $objWriter->writeAttribute('fitToHeight', '0'); 874 } 875 if ($pSheet->getPageSetup()->getFitToWidth() !== null) { 876 $objWriter->writeAttribute('fitToWidth', $pSheet->getPageSetup()->getFitToWidth()); 877 } else { 878 $objWriter->writeAttribute('fitToWidth', '0'); 879 } 880 if ($pSheet->getPageSetup()->getFirstPageNumber() !== null) { 881 $objWriter->writeAttribute('firstPageNumber', $pSheet->getPageSetup()->getFirstPageNumber()); 882 $objWriter->writeAttribute('useFirstPageNumber', '1'); 883 } 884 $objWriter->writeAttribute('pageOrder', $pSheet->getPageSetup()->getPageOrder()); 885 886 $getUnparsedLoadedData = $pSheet->getParent()->getUnparsedLoadedData(); 887 if (isset($getUnparsedLoadedData['sheets'][$pSheet->getCodeName()]['pageSetupRelId'])) { 888 $objWriter->writeAttribute('r:id', $getUnparsedLoadedData['sheets'][$pSheet->getCodeName()]['pageSetupRelId']); 889 } 890 891 $objWriter->endElement(); 892 } 893 894 /** 895 * Write Header / Footer. 896 * 897 * @param XMLWriter $objWriter XML Writer 898 * @param PhpspreadsheetWorksheet $pSheet Worksheet 899 */ 900 private function writeHeaderFooter(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 901 { 902 // headerFooter 903 $objWriter->startElement('headerFooter'); 904 $objWriter->writeAttribute('differentOddEven', ($pSheet->getHeaderFooter()->getDifferentOddEven() ? 'true' : 'false')); 905 $objWriter->writeAttribute('differentFirst', ($pSheet->getHeaderFooter()->getDifferentFirst() ? 'true' : 'false')); 906 $objWriter->writeAttribute('scaleWithDoc', ($pSheet->getHeaderFooter()->getScaleWithDocument() ? 'true' : 'false')); 907 $objWriter->writeAttribute('alignWithMargins', ($pSheet->getHeaderFooter()->getAlignWithMargins() ? 'true' : 'false')); 908 909 $objWriter->writeElement('oddHeader', $pSheet->getHeaderFooter()->getOddHeader()); 910 $objWriter->writeElement('oddFooter', $pSheet->getHeaderFooter()->getOddFooter()); 911 $objWriter->writeElement('evenHeader', $pSheet->getHeaderFooter()->getEvenHeader()); 912 $objWriter->writeElement('evenFooter', $pSheet->getHeaderFooter()->getEvenFooter()); 913 $objWriter->writeElement('firstHeader', $pSheet->getHeaderFooter()->getFirstHeader()); 914 $objWriter->writeElement('firstFooter', $pSheet->getHeaderFooter()->getFirstFooter()); 915 $objWriter->endElement(); 916 } 917 918 /** 919 * Write Breaks. 920 * 921 * @param XMLWriter $objWriter XML Writer 922 * @param PhpspreadsheetWorksheet $pSheet Worksheet 923 */ 924 private function writeBreaks(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 925 { 926 // Get row and column breaks 927 $aRowBreaks = []; 928 $aColumnBreaks = []; 929 foreach ($pSheet->getBreaks() as $cell => $breakType) { 930 if ($breakType == PhpspreadsheetWorksheet::BREAK_ROW) { 931 $aRowBreaks[] = $cell; 932 } elseif ($breakType == PhpspreadsheetWorksheet::BREAK_COLUMN) { 933 $aColumnBreaks[] = $cell; 934 } 935 } 936 937 // rowBreaks 938 if (!empty($aRowBreaks)) { 939 $objWriter->startElement('rowBreaks'); 940 $objWriter->writeAttribute('count', count($aRowBreaks)); 941 $objWriter->writeAttribute('manualBreakCount', count($aRowBreaks)); 942 943 foreach ($aRowBreaks as $cell) { 944 $coords = Coordinate::coordinateFromString($cell); 945 946 $objWriter->startElement('brk'); 947 $objWriter->writeAttribute('id', $coords[1]); 948 $objWriter->writeAttribute('man', '1'); 949 $objWriter->endElement(); 950 } 951 952 $objWriter->endElement(); 953 } 954 955 // Second, write column breaks 956 if (!empty($aColumnBreaks)) { 957 $objWriter->startElement('colBreaks'); 958 $objWriter->writeAttribute('count', count($aColumnBreaks)); 959 $objWriter->writeAttribute('manualBreakCount', count($aColumnBreaks)); 960 961 foreach ($aColumnBreaks as $cell) { 962 $coords = Coordinate::coordinateFromString($cell); 963 964 $objWriter->startElement('brk'); 965 $objWriter->writeAttribute('id', Coordinate::columnIndexFromString($coords[0]) - 1); 966 $objWriter->writeAttribute('man', '1'); 967 $objWriter->endElement(); 968 } 969 970 $objWriter->endElement(); 971 } 972 } 973 974 /** 975 * Write SheetData. 976 * 977 * @param XMLWriter $objWriter XML Writer 978 * @param PhpspreadsheetWorksheet $pSheet Worksheet 979 * @param string[] $pStringTable String table 980 */ 981 private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, array $pStringTable): void 982 { 983 // Flipped stringtable, for faster index searching 984 $aFlippedStringTable = $this->getParentWriter()->getWriterPart('stringtable')->flipStringTable($pStringTable); 985 986 // sheetData 987 $objWriter->startElement('sheetData'); 988 989 // Get column count 990 $colCount = Coordinate::columnIndexFromString($pSheet->getHighestColumn()); 991 992 // Highest row number 993 $highestRow = $pSheet->getHighestRow(); 994 995 // Loop through cells 996 $cellsByRow = []; 997 foreach ($pSheet->getCoordinates() as $coordinate) { 998 $cellAddress = Coordinate::coordinateFromString($coordinate); 999 $cellsByRow[$cellAddress[1]][] = $coordinate; 1000 } 1001 1002 $currentRow = 0; 1003 while ($currentRow++ < $highestRow) { 1004 // Get row dimension 1005 $rowDimension = $pSheet->getRowDimension($currentRow); 1006 1007 // Write current row? 1008 $writeCurrentRow = isset($cellsByRow[$currentRow]) || $rowDimension->getRowHeight() >= 0 || $rowDimension->getVisible() == false || $rowDimension->getCollapsed() == true || $rowDimension->getOutlineLevel() > 0 || $rowDimension->getXfIndex() !== null; 1009 1010 if ($writeCurrentRow) { 1011 // Start a new row 1012 $objWriter->startElement('row'); 1013 $objWriter->writeAttribute('r', $currentRow); 1014 $objWriter->writeAttribute('spans', '1:' . $colCount); 1015 1016 // Row dimensions 1017 if ($rowDimension->getRowHeight() >= 0) { 1018 $objWriter->writeAttribute('customHeight', '1'); 1019 $objWriter->writeAttribute('ht', StringHelper::formatNumber($rowDimension->getRowHeight())); 1020 } 1021 1022 // Row visibility 1023 if (!$rowDimension->getVisible() === true) { 1024 $objWriter->writeAttribute('hidden', 'true'); 1025 } 1026 1027 // Collapsed 1028 if ($rowDimension->getCollapsed() === true) { 1029 $objWriter->writeAttribute('collapsed', 'true'); 1030 } 1031 1032 // Outline level 1033 if ($rowDimension->getOutlineLevel() > 0) { 1034 $objWriter->writeAttribute('outlineLevel', $rowDimension->getOutlineLevel()); 1035 } 1036 1037 // Style 1038 if ($rowDimension->getXfIndex() !== null) { 1039 $objWriter->writeAttribute('s', $rowDimension->getXfIndex()); 1040 $objWriter->writeAttribute('customFormat', '1'); 1041 } 1042 1043 // Write cells 1044 if (isset($cellsByRow[$currentRow])) { 1045 foreach ($cellsByRow[$currentRow] as $cellAddress) { 1046 // Write cell 1047 $this->writeCell($objWriter, $pSheet, $cellAddress, $aFlippedStringTable); 1048 } 1049 } 1050 1051 // End row 1052 $objWriter->endElement(); 1053 } 1054 } 1055 1056 $objWriter->endElement(); 1057 } 1058 1059 /** 1060 * @param RichText|string $cellValue 1061 */ 1062 private function writeCellInlineStr(XMLWriter $objWriter, string $mappedType, $cellValue): void 1063 { 1064 $objWriter->writeAttribute('t', $mappedType); 1065 if (!$cellValue instanceof RichText) { 1066 $objWriter->writeElement('t', StringHelper::controlCharacterPHP2OOXML(htmlspecialchars($cellValue))); 1067 } elseif ($cellValue instanceof RichText) { 1068 $objWriter->startElement('is'); 1069 $this->getParentWriter()->getWriterPart('stringtable')->writeRichText($objWriter, $cellValue); 1070 $objWriter->endElement(); 1071 } 1072 } 1073 1074 /** 1075 * @param RichText|string $cellValue 1076 * @param string[] $pFlippedStringTable 1077 */ 1078 private function writeCellString(XMLWriter $objWriter, string $mappedType, $cellValue, array $pFlippedStringTable): void 1079 { 1080 $objWriter->writeAttribute('t', $mappedType); 1081 if (!$cellValue instanceof RichText) { 1082 self::writeElementIf($objWriter, isset($pFlippedStringTable[$cellValue]), 'v', $pFlippedStringTable[$cellValue] ?? ''); 1083 } else { 1084 $objWriter->writeElement('v', $pFlippedStringTable[$cellValue->getHashCode()]); 1085 } 1086 } 1087 1088 /** 1089 * @param float|int $cellValue 1090 */ 1091 private function writeCellNumeric(XMLWriter $objWriter, $cellValue): void 1092 { 1093 //force a decimal to be written if the type is float 1094 if (is_float($cellValue)) { 1095 // force point as decimal separator in case current locale uses comma 1096 $cellValue = str_replace(',', '.', (string) $cellValue); 1097 if (strpos($cellValue, '.') === false) { 1098 $cellValue = $cellValue . '.0'; 1099 } 1100 } 1101 $objWriter->writeElement('v', $cellValue); 1102 } 1103 1104 private function writeCellBoolean(XMLWriter $objWriter, string $mappedType, bool $cellValue): void 1105 { 1106 $objWriter->writeAttribute('t', $mappedType); 1107 $objWriter->writeElement('v', $cellValue ? '1' : '0'); 1108 } 1109 1110 private function writeCellError(XMLWriter $objWriter, string $mappedType, string $cellValue, string $formulaerr = '#NULL!'): void 1111 { 1112 $objWriter->writeAttribute('t', $mappedType); 1113 $cellIsFormula = substr($cellValue, 0, 1) === '='; 1114 self::writeElementIf($objWriter, $cellIsFormula, 'f', Xlfn::addXlfnStripEquals($cellValue)); 1115 $objWriter->writeElement('v', $cellIsFormula ? $formulaerr : $cellValue); 1116 } 1117 1118 private function writeCellFormula(XMLWriter $objWriter, string $cellValue, Cell $pCell): void 1119 { 1120 $calculatedValue = $this->getParentWriter()->getPreCalculateFormulas() ? $pCell->getCalculatedValue() : $cellValue; 1121 if (is_string($calculatedValue)) { 1122 if (\PhpOffice\PhpSpreadsheet\Calculation\Functions::isError($calculatedValue)) { 1123 $this->writeCellError($objWriter, 'e', $cellValue, $calculatedValue); 1124 1125 return; 1126 } 1127 $objWriter->writeAttribute('t', 'str'); 1128 } elseif (is_bool($calculatedValue)) { 1129 $objWriter->writeAttribute('t', 'b'); 1130 } 1131 // array values are not yet supported 1132 //$attributes = $pCell->getFormulaAttributes(); 1133 //if (($attributes['t'] ?? null) === 'array') { 1134 // $objWriter->startElement('f'); 1135 // $objWriter->writeAttribute('t', 'array'); 1136 // $objWriter->writeAttribute('ref', $pCellAddress); 1137 // $objWriter->writeAttribute('aca', '1'); 1138 // $objWriter->writeAttribute('ca', '1'); 1139 // $objWriter->text(substr($cellValue, 1)); 1140 // $objWriter->endElement(); 1141 //} else { 1142 // $objWriter->writeElement('f', Xlfn::addXlfnStripEquals($cellValue)); 1143 //} 1144 $objWriter->writeElement('f', Xlfn::addXlfnStripEquals($cellValue)); 1145 self::writeElementIf( 1146 $objWriter, 1147 $this->getParentWriter()->getOffice2003Compatibility() === false, 1148 'v', 1149 ($this->getParentWriter()->getPreCalculateFormulas() && !is_array($calculatedValue) && substr($calculatedValue, 0, 1) !== '#') 1150 ? StringHelper::formatNumber($calculatedValue) : '0' 1151 ); 1152 } 1153 1154 /** 1155 * Write Cell. 1156 * 1157 * @param XMLWriter $objWriter XML Writer 1158 * @param PhpspreadsheetWorksheet $pSheet Worksheet 1159 * @param string $pCellAddress Cell Address 1160 * @param string[] $pFlippedStringTable String table (flipped), for faster index searching 1161 */ 1162 private function writeCell(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, string $pCellAddress, array $pFlippedStringTable): void 1163 { 1164 // Cell 1165 $pCell = $pSheet->getCell($pCellAddress); 1166 $objWriter->startElement('c'); 1167 $objWriter->writeAttribute('r', $pCellAddress); 1168 1169 // Sheet styles 1170 $xfi = $pCell->getXfIndex(); 1171 self::writeAttributeIf($objWriter, $xfi, 's', $xfi); 1172 1173 // If cell value is supplied, write cell value 1174 $cellValue = $pCell->getValue(); 1175 if (is_object($cellValue) || $cellValue !== '') { 1176 // Map type 1177 $mappedType = $pCell->getDataType(); 1178 1179 // Write data depending on its type 1180 switch (strtolower($mappedType)) { 1181 case 'inlinestr': // Inline string 1182 $this->writeCellInlineStr($objWriter, $mappedType, $cellValue); 1183 1184 break; 1185 case 's': // String 1186 $this->writeCellString($objWriter, $mappedType, $cellValue, $pFlippedStringTable); 1187 1188 break; 1189 case 'f': // Formula 1190 $this->writeCellFormula($objWriter, $cellValue, $pCell); 1191 1192 break; 1193 case 'n': // Numeric 1194 $this->writeCellNumeric($objWriter, $cellValue); 1195 1196 break; 1197 case 'b': // Boolean 1198 $this->writeCellBoolean($objWriter, $mappedType, $cellValue); 1199 1200 break; 1201 case 'e': // Error 1202 $this->writeCellError($objWriter, $mappedType, $cellValue); 1203 } 1204 } 1205 1206 $objWriter->endElement(); 1207 } 1208 1209 /** 1210 * Write Drawings. 1211 * 1212 * @param XMLWriter $objWriter XML Writer 1213 * @param PhpspreadsheetWorksheet $pSheet Worksheet 1214 * @param bool $includeCharts Flag indicating if we should include drawing details for charts 1215 */ 1216 private function writeDrawings(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet, $includeCharts = false): void 1217 { 1218 $unparsedLoadedData = $pSheet->getParent()->getUnparsedLoadedData(); 1219 $hasUnparsedDrawing = isset($unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds']); 1220 $chartCount = ($includeCharts) ? $pSheet->getChartCollection()->count() : 0; 1221 if ($chartCount == 0 && $pSheet->getDrawingCollection()->count() == 0 && !$hasUnparsedDrawing) { 1222 return; 1223 } 1224 1225 // If sheet contains drawings, add the relationships 1226 $objWriter->startElement('drawing'); 1227 1228 $rId = 'rId1'; 1229 if (isset($unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds'])) { 1230 $drawingOriginalIds = $unparsedLoadedData['sheets'][$pSheet->getCodeName()]['drawingOriginalIds']; 1231 // take first. In future can be overriten 1232 // (! synchronize with \PhpOffice\PhpSpreadsheet\Writer\Xlsx\Rels::writeWorksheetRelationships) 1233 $rId = reset($drawingOriginalIds); 1234 } 1235 1236 $objWriter->writeAttribute('r:id', $rId); 1237 $objWriter->endElement(); 1238 } 1239 1240 /** 1241 * Write LegacyDrawing. 1242 * 1243 * @param XMLWriter $objWriter XML Writer 1244 * @param PhpspreadsheetWorksheet $pSheet Worksheet 1245 */ 1246 private function writeLegacyDrawing(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 1247 { 1248 // If sheet contains comments, add the relationships 1249 if (count($pSheet->getComments()) > 0) { 1250 $objWriter->startElement('legacyDrawing'); 1251 $objWriter->writeAttribute('r:id', 'rId_comments_vml1'); 1252 $objWriter->endElement(); 1253 } 1254 } 1255 1256 /** 1257 * Write LegacyDrawingHF. 1258 * 1259 * @param XMLWriter $objWriter XML Writer 1260 * @param PhpspreadsheetWorksheet $pSheet Worksheet 1261 */ 1262 private function writeLegacyDrawingHF(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 1263 { 1264 // If sheet contains images, add the relationships 1265 if (count($pSheet->getHeaderFooter()->getImages()) > 0) { 1266 $objWriter->startElement('legacyDrawingHF'); 1267 $objWriter->writeAttribute('r:id', 'rId_headerfooter_vml1'); 1268 $objWriter->endElement(); 1269 } 1270 } 1271 1272 private function writeAlternateContent(XMLWriter $objWriter, PhpspreadsheetWorksheet $pSheet): void 1273 { 1274 if (empty($pSheet->getParent()->getUnparsedLoadedData()['sheets'][$pSheet->getCodeName()]['AlternateContents'])) { 1275 return; 1276 } 1277 1278 foreach ($pSheet->getParent()->getUnparsedLoadedData()['sheets'][$pSheet->getCodeName()]['AlternateContents'] as $alternateContent) { 1279 $objWriter->writeRaw($alternateContent); 1280 } 1281 } 1282 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
