spreadsheet = $spreadsheet; $this->defaultFont = $this->spreadsheet->getDefaultStyle()->getFont(); } /** * Save Spreadsheet to file. * * @param resource|string $pFilename */ public function save($pFilename): void { // Open file $this->openFileHandle($pFilename); // Write html fwrite($this->fileHandle, $this->generateHTMLAll()); // Close file $this->maybeCloseFileHandle(); } /** * Save Spreadsheet as html to variable. * * @return string */ public function generateHtmlAll() { // garbage collect $this->spreadsheet->garbageCollect(); $saveDebugLog = Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog(); Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false); $saveArrayReturnType = Calculation::getArrayReturnType(); Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_VALUE); // Build CSS $this->buildCSS(!$this->useInlineCss); $html = ''; // Write headers $html .= $this->generateHTMLHeader(!$this->useInlineCss); // Write navigation (tabs) if ((!$this->isPdf) && ($this->generateSheetNavigationBlock)) { $html .= $this->generateNavigation(); } // Write data $html .= $this->generateSheetData(); // Write footer $html .= $this->generateHTMLFooter(); $callback = $this->editHtmlCallback; if ($callback) { $html = $callback($html); } Calculation::setArrayReturnType($saveArrayReturnType); Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog); return $html; } /** * Set a callback to edit the entire HTML. * * The callback must accept the HTML as string as first parameter, * and it must return the edited HTML as string. */ public function setEditHtmlCallback(?callable $callback): void { $this->editHtmlCallback = $callback; } const VALIGN_ARR = [ Alignment::VERTICAL_BOTTOM => 'bottom', Alignment::VERTICAL_TOP => 'top', Alignment::VERTICAL_CENTER => 'middle', Alignment::VERTICAL_JUSTIFY => 'middle', ]; /** * Map VAlign. * * @param string $vAlign Vertical alignment * * @return string */ private function mapVAlign($vAlign) { return array_key_exists($vAlign, self::VALIGN_ARR) ? self::VALIGN_ARR[$vAlign] : 'baseline'; } const HALIGN_ARR = [ Alignment::HORIZONTAL_LEFT => 'left', Alignment::HORIZONTAL_RIGHT => 'right', Alignment::HORIZONTAL_CENTER => 'center', Alignment::HORIZONTAL_CENTER_CONTINUOUS => 'center', Alignment::HORIZONTAL_JUSTIFY => 'justify', ]; /** * Map HAlign. * * @param string $hAlign Horizontal alignment * * @return string */ private function mapHAlign($hAlign) { return array_key_exists($hAlign, self::HALIGN_ARR) ? self::HALIGN_ARR[$hAlign] : ''; } const BORDER_ARR = [ Border::BORDER_NONE => 'none', Border::BORDER_DASHDOT => '1px dashed', Border::BORDER_DASHDOTDOT => '1px dotted', Border::BORDER_DASHED => '1px dashed', Border::BORDER_DOTTED => '1px dotted', Border::BORDER_DOUBLE => '3px double', Border::BORDER_HAIR => '1px solid', Border::BORDER_MEDIUM => '2px solid', Border::BORDER_MEDIUMDASHDOT => '2px dashed', Border::BORDER_MEDIUMDASHDOTDOT => '2px dotted', Border::BORDER_SLANTDASHDOT => '2px dashed', Border::BORDER_THICK => '3px solid', ]; /** * Map border style. * * @param int $borderStyle Sheet index * * @return string */ private function mapBorderStyle($borderStyle) { return array_key_exists($borderStyle, self::BORDER_ARR) ? self::BORDER_ARR[$borderStyle] : '1px solid'; } /** * Get sheet index. * * @return int */ public function getSheetIndex() { return $this->sheetIndex; } /** * Set sheet index. * * @param int $pValue Sheet index * * @return $this */ public function setSheetIndex($pValue) { $this->sheetIndex = $pValue; return $this; } /** * Get sheet index. * * @return bool */ public function getGenerateSheetNavigationBlock() { return $this->generateSheetNavigationBlock; } /** * Set sheet index. * * @param bool $pValue Flag indicating whether the sheet navigation block should be generated or not * * @return $this */ public function setGenerateSheetNavigationBlock($pValue) { $this->generateSheetNavigationBlock = (bool) $pValue; return $this; } /** * Write all sheets (resets sheetIndex to NULL). * * @return $this */ public function writeAllSheets() { $this->sheetIndex = null; return $this; } private static function generateMeta($val, $desc) { return $val ? (' ' . PHP_EOL) : ''; } /** * Generate HTML header. * * @param bool $pIncludeStyles Include styles? * * @return string */ public function generateHTMLHeader($pIncludeStyles = false) { // Construct HTML $properties = $this->spreadsheet->getProperties(); $html = '' . PHP_EOL; $html .= '' . PHP_EOL; $html .= ' ' . PHP_EOL; $html .= ' ' . PHP_EOL; $html .= ' ' . PHP_EOL; $html .= ' ' . htmlspecialchars($properties->getTitle()) . '' . PHP_EOL; $html .= self::generateMeta($properties->getCreator(), 'author'); $html .= self::generateMeta($properties->getTitle(), 'title'); $html .= self::generateMeta($properties->getDescription(), 'description'); $html .= self::generateMeta($properties->getSubject(), 'subject'); $html .= self::generateMeta($properties->getKeywords(), 'keywords'); $html .= self::generateMeta($properties->getCategory(), 'category'); $html .= self::generateMeta($properties->getCompany(), 'company'); $html .= self::generateMeta($properties->getManager(), 'manager'); $html .= $pIncludeStyles ? $this->generateStyles(true) : $this->generatePageDeclarations(true); $html .= ' ' . PHP_EOL; $html .= '' . PHP_EOL; $html .= ' ' . PHP_EOL; return $html; } private function generateSheetPrep() { // Ensure that Spans have been calculated? $this->calculateSpans(); // Fetch sheets if ($this->sheetIndex === null) { $sheets = $this->spreadsheet->getAllSheets(); } else { $sheets = [$this->spreadsheet->getSheet($this->sheetIndex)]; } return $sheets; } private function generateSheetStarts($sheet, $rowMin) { // calculate start of , $tbodyStart = $rowMin; $theadStart = $theadEnd = 0; // default: no no if ($sheet->getPageSetup()->isRowsToRepeatAtTopSet()) { $rowsToRepeatAtTop = $sheet->getPageSetup()->getRowsToRepeatAtTop(); // we can only support repeating rows that start at top row if ($rowsToRepeatAtTop[0] == 1) { $theadStart = $rowsToRepeatAtTop[0]; $theadEnd = $rowsToRepeatAtTop[1]; $tbodyStart = $rowsToRepeatAtTop[1] + 1; } } return [$theadStart, $theadEnd, $tbodyStart]; } private function generateSheetTags($row, $theadStart, $theadEnd, $tbodyStart) { // ? $startTag = ($row == $theadStart) ? (' ' . PHP_EOL) : ''; if (!$startTag) { $startTag = ($row == $tbodyStart) ? (' ' . PHP_EOL) : ''; } $endTag = ($row == $theadEnd) ? (' ' . PHP_EOL) : ''; $cellType = ($row >= $tbodyStart) ? 'td' : 'th'; return [$cellType, $startTag, $endTag]; } /** * Generate sheet data. * * @return string */ public function generateSheetData() { $sheets = $this->generateSheetPrep(); // Construct HTML $html = ''; // Loop all sheets $sheetId = 0; foreach ($sheets as $sheet) { // Write table header $html .= $this->generateTableHeader($sheet); // Get worksheet dimension [$min, $max] = explode(':', $sheet->calculateWorksheetDataDimension()); [$minCol, $minRow] = Coordinate::coordinateFromString($min); $minCol = Coordinate::columnIndexFromString($minCol); [$maxCol, $maxRow] = Coordinate::coordinateFromString($max); $maxCol = Coordinate::columnIndexFromString($maxCol); [$theadStart, $theadEnd, $tbodyStart] = $this->generateSheetStarts($sheet, $minRow); // Loop through cells $row = $minRow - 1; while ($row++ < $maxRow) { [$cellType, $startTag, $endTag] = $this->generateSheetTags($row, $theadStart, $theadEnd, $tbodyStart); $html .= $startTag; // Write row if there are HTML table cells in it if (!isset($this->isSpannedRow[$sheet->getParent()->getIndex($sheet)][$row])) { // Start a new rowData $rowData = []; // Loop through columns $column = $minCol; while ($column <= $maxCol) { // Cell exists? if ($sheet->cellExistsByColumnAndRow($column, $row)) { $rowData[$column] = Coordinate::stringFromColumnIndex($column) . $row; } else { $rowData[$column] = ''; } ++$column; } $html .= $this->generateRow($sheet, $rowData, $row - 1, $cellType); } $html .= $endTag; } $html .= $this->extendRowsForChartsAndImages($sheet, $row); // Write table footer $html .= $this->generateTableFooter(); // Writing PDF? if ($this->isPdf && $this->useInlineCss) { if ($this->sheetIndex === null && $sheetId + 1 < $this->spreadsheet->getSheetCount()) { $html .= '
'; } } // Next sheet ++$sheetId; } return $html; } /** * Generate sheet tabs. * * @return string */ public function generateNavigation() { // Fetch sheets $sheets = []; if ($this->sheetIndex === null) { $sheets = $this->spreadsheet->getAllSheets(); } else { $sheets[] = $this->spreadsheet->getSheet($this->sheetIndex); } // Construct HTML $html = ''; // Only if there are more than 1 sheets if (count($sheets) > 1) { // Loop all sheets $sheetId = 0; $html .= '' . PHP_EOL; } return $html; } /** * Extend Row if chart is placed after nominal end of row. * This code should be exercised by sample: * Chart/32_Chart_read_write_PDF.php. * However, that test is suppressed due to out-of-date * Jpgraph code issuing warnings. So, don't measure * code coverage for this function till that is fixed. * * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet * @param int $row Row to check for charts * * @return array * * @codeCoverageIgnore */ private function extendRowsForCharts(Worksheet $pSheet, int $row) { $rowMax = $row; $colMax = 'A'; $anyfound = false; if ($this->includeCharts) { foreach ($pSheet->getChartCollection() as $chart) { if ($chart instanceof Chart) { $anyfound = true; $chartCoordinates = $chart->getTopLeftPosition(); $chartTL = Coordinate::coordinateFromString($chartCoordinates['cell']); $chartCol = Coordinate::columnIndexFromString($chartTL[0]); if ($chartTL[1] > $rowMax) { $rowMax = $chartTL[1]; if ($chartCol > Coordinate::columnIndexFromString($colMax)) { $colMax = $chartTL[0]; } } } } } return [$rowMax, $colMax, $anyfound]; } private function extendRowsForChartsAndImages(Worksheet $pSheet, int $row): string { [$rowMax, $colMax, $anyfound] = $this->extendRowsForCharts($pSheet, $row); foreach ($pSheet->getDrawingCollection() as $drawing) { $anyfound = true; $imageTL = Coordinate::coordinateFromString($drawing->getCoordinates()); $imageCol = Coordinate::columnIndexFromString($imageTL[0]); if ($imageTL[1] > $rowMax) { $rowMax = $imageTL[1]; if ($imageCol > Coordinate::columnIndexFromString($colMax)) { $colMax = $imageTL[0]; } } } // Don't extend rows if not needed if ($row === $rowMax || !$anyfound) { return ''; } $html = ''; ++$colMax; ++$row; while ($row <= $rowMax) { $html .= ''; for ($col = 'A'; $col != $colMax; ++$col) { $htmlx = $this->writeImageInCell($pSheet, $col . $row); $htmlx .= $this->includeCharts ? $this->writeChartInCell($pSheet, $col . $row) : ''; if ($htmlx) { $html .= "$htmlx"; } else { $html .= ""; } } ++$row; $html .= '' . PHP_EOL; } return $html; } /** * Convert Windows file name to file protocol URL. * * @param string $filename file name on local system * * @return string */ public static function winFileToUrl($filename) { // Windows filename if (substr($filename, 1, 2) === ':\\') { $filename = 'file:///' . str_replace('\\', '/', $filename); } return $filename; } /** * Generate image tag in cell. * * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet * @param string $coordinates Cell coordinates * * @return string */ private function writeImageInCell(Worksheet $pSheet, $coordinates) { // Construct HTML $html = ''; // Write images foreach ($pSheet->getDrawingCollection() as $drawing) { if ($drawing->getCoordinates() != $coordinates) { continue; } $filedesc = $drawing->getDescription(); $filedesc = $filedesc ? htmlspecialchars($filedesc, ENT_QUOTES) : 'Embedded image'; if ($drawing instanceof Drawing) { $filename = $drawing->getPath(); // Strip off eventual '.' $filename = preg_replace('/^[.]/', '', $filename); // Prepend images root $filename = $this->getImagesRoot() . $filename; // Strip off eventual '.' if followed by non-/ $filename = preg_replace('@^[.]([^/])@', '$1', $filename); // Convert UTF8 data to PCDATA $filename = htmlspecialchars($filename); $html .= PHP_EOL; $imageData = self::winFileToUrl($filename); if ($this->embedImages && !$this->isPdf) { $picture = @file_get_contents($filename); if ($picture !== false) { $imageDetails = getimagesize($filename); // base64 encode the binary data $base64 = base64_encode($picture); $imageData = 'data:' . $imageDetails['mime'] . ';base64,' . $base64; } } $html .= '' . $filedesc . ''; } elseif ($drawing instanceof MemoryDrawing) { ob_start(); // Let's start output buffering. imagepng($drawing->getImageResource()); // This will normally output the image, but because of ob_start(), it won't. $contents = ob_get_contents(); // Instead, output above is saved to $contents ob_end_clean(); // End the output buffer. $dataUri = 'data:image/jpeg;base64,' . base64_encode($contents); // Because of the nature of tables, width is more important than height. // max-width: 100% ensures that image doesnt overflow containing cell // width: X sets width of supplied image. // As a result, images bigger than cell will be contained and images smaller will not get stretched $html .= '' . $filedesc . ''; } } return $html; } /** * Generate chart tag in cell. * This code should be exercised by sample: * Chart/32_Chart_read_write_PDF.php. * However, that test is suppressed due to out-of-date * Jpgraph code issuing warnings. So, don't measure * code coverage for this function till that is fixed. * * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet * @param string $coordinates Cell coordinates * * @return string * * @codeCoverageIgnore */ private function writeChartInCell(Worksheet $pSheet, $coordinates) { // Construct HTML $html = ''; // Write charts foreach ($pSheet->getChartCollection() as $chart) { if ($chart instanceof Chart) { $chartCoordinates = $chart->getTopLeftPosition(); if ($chartCoordinates['cell'] == $coordinates) { $chartFileName = File::sysGetTempDir() . '/' . uniqid('', true) . '.png'; if (!$chart->render($chartFileName)) { return; } $html .= PHP_EOL; $imageDetails = getimagesize($chartFileName); $filedesc = $chart->getTitle(); $filedesc = $filedesc ? self::getChartCaption($filedesc->getCaption()) : ''; $filedesc = $filedesc ? htmlspecialchars($filedesc, ENT_QUOTES) : 'Embedded chart'; if ($fp = fopen($chartFileName, 'rb', 0)) { $picture = fread($fp, filesize($chartFileName)); fclose($fp); // base64 encode the binary data $base64 = base64_encode($picture); $imageData = 'data:' . $imageDetails['mime'] . ';base64,' . $base64; $html .= '' . $filedesc . '' . PHP_EOL; unlink($chartFileName); } } } } // Return return $html; } /** * Extend Row if chart is placed after nominal end of row. * This code should be exercised by sample: * Chart/32_Chart_read_write_PDF.php. * However, that test is suppressed due to out-of-date * Jpgraph code issuing warnings. So, don't measure * code coverage for this function till that is fixed. * Caption is described in documentation as fixed, * but in 32_Chart it is somehow an array of RichText. * * @param mixed $cap * * @return string * * @codeCoverageIgnore */ private static function getChartCaption($cap) { return is_array($cap) ? implode(' ', $cap) : $cap; } /** * Generate CSS styles. * * @param bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>) * * @return string */ public function generateStyles($generateSurroundingHTML = true) { // Build CSS $css = $this->buildCSS($generateSurroundingHTML); // Construct HTML $html = ''; // Start styles if ($generateSurroundingHTML) { $html .= ' ' . PHP_EOL; } // Return return $html; } private function buildCssRowHeights(Worksheet $sheet, array &$css, int $sheetIndex): void { // Calculate row heights foreach ($sheet->getRowDimensions() as $rowDimension) { $row = $rowDimension->getRowIndex() - 1; // table.sheetN tr.rowYYYYYY { } $css['table.sheet' . $sheetIndex . ' tr.row' . $row] = []; if ($rowDimension->getRowHeight() != -1) { $pt_height = $rowDimension->getRowHeight(); $css['table.sheet' . $sheetIndex . ' tr.row' . $row]['height'] = $pt_height . 'pt'; } if ($rowDimension->getVisible() === false) { $css['table.sheet' . $sheetIndex . ' tr.row' . $row]['display'] = 'none'; $css['table.sheet' . $sheetIndex . ' tr.row' . $row]['visibility'] = 'hidden'; } } } private function buildCssPerSheet(Worksheet $sheet, array &$css): void { // Calculate hash code $sheetIndex = $sheet->getParent()->getIndex($sheet); // Build styles // Calculate column widths $sheet->calculateColumnWidths(); // col elements, initialize $highestColumnIndex = Coordinate::columnIndexFromString($sheet->getHighestColumn()) - 1; $column = -1; while ($column++ < $highestColumnIndex) { $this->columnWidths[$sheetIndex][$column] = 42; // approximation $css['table.sheet' . $sheetIndex . ' col.col' . $column]['width'] = '42pt'; } // col elements, loop through columnDimensions and set width foreach ($sheet->getColumnDimensions() as $columnDimension) { $column = Coordinate::columnIndexFromString($columnDimension->getColumnIndex()) - 1; $width = SharedDrawing::cellDimensionToPixels($columnDimension->getWidth(), $this->defaultFont); $width = SharedDrawing::pixelsToPoints($width); if ($columnDimension->getVisible() === false) { $css['table.sheet' . $sheetIndex . ' .column' . $column]['display'] = 'none'; } if ($width >= 0) { $this->columnWidths[$sheetIndex][$column] = $width; $css['table.sheet' . $sheetIndex . ' col.col' . $column]['width'] = $width . 'pt'; } } // Default row height $rowDimension = $sheet->getDefaultRowDimension(); // table.sheetN tr { } $css['table.sheet' . $sheetIndex . ' tr'] = []; if ($rowDimension->getRowHeight() == -1) { $pt_height = SharedFont::getDefaultRowHeightByFont($this->spreadsheet->getDefaultStyle()->getFont()); } else { $pt_height = $rowDimension->getRowHeight(); } $css['table.sheet' . $sheetIndex . ' tr']['height'] = $pt_height . 'pt'; if ($rowDimension->getVisible() === false) { $css['table.sheet' . $sheetIndex . ' tr']['display'] = 'none'; $css['table.sheet' . $sheetIndex . ' tr']['visibility'] = 'hidden'; } $this->buildCssRowHeights($sheet, $css, $sheetIndex); } /** * Build CSS styles. * * @param bool $generateSurroundingHTML Generate surrounding HTML style? (html { }) * * @return array */ public function buildCSS($generateSurroundingHTML = true) { // Cached? if ($this->cssStyles !== null) { return $this->cssStyles; } // Ensure that spans have been calculated $this->calculateSpans(); // Construct CSS $css = []; // Start styles if ($generateSurroundingHTML) { // html { } $css['html']['font-family'] = 'Calibri, Arial, Helvetica, sans-serif'; $css['html']['font-size'] = '11pt'; $css['html']['background-color'] = 'white'; } // CSS for comments as found in LibreOffice $css['a.comment-indicator:hover + div.comment'] = [ 'background' => '#ffd', 'position' => 'absolute', 'display' => 'block', 'border' => '1px solid black', 'padding' => '0.5em', ]; $css['a.comment-indicator'] = [ 'background' => 'red', 'display' => 'inline-block', 'border' => '1px solid black', 'width' => '0.5em', 'height' => '0.5em', ]; $css['div.comment']['display'] = 'none'; // table { } $css['table']['border-collapse'] = 'collapse'; // .b {} $css['.b']['text-align'] = 'center'; // BOOL // .e {} $css['.e']['text-align'] = 'center'; // ERROR // .f {} $css['.f']['text-align'] = 'right'; // FORMULA // .inlineStr {} $css['.inlineStr']['text-align'] = 'left'; // INLINE // .n {} $css['.n']['text-align'] = 'right'; // NUMERIC // .s {} $css['.s']['text-align'] = 'left'; // STRING // Calculate cell style hashes foreach ($this->spreadsheet->getCellXfCollection() as $index => $style) { $css['td.style' . $index] = $this->createCSSStyle($style); $css['th.style' . $index] = $this->createCSSStyle($style); } // Fetch sheets $sheets = []; if ($this->sheetIndex === null) { $sheets = $this->spreadsheet->getAllSheets(); } else { $sheets[] = $this->spreadsheet->getSheet($this->sheetIndex); } // Build styles per sheet foreach ($sheets as $sheet) { $this->buildCssPerSheet($sheet, $css); } // Cache if ($this->cssStyles === null) { $this->cssStyles = $css; } // Return return $css; } /** * Create CSS style. * * @return array */ private function createCSSStyle(Style $pStyle) { // Create CSS return array_merge( $this->createCSSStyleAlignment($pStyle->getAlignment()), $this->createCSSStyleBorders($pStyle->getBorders()), $this->createCSSStyleFont($pStyle->getFont()), $this->createCSSStyleFill($pStyle->getFill()) ); } /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Alignment). * * @param Alignment $pStyle \PhpOffice\PhpSpreadsheet\Style\Alignment * * @return array */ private function createCSSStyleAlignment(Alignment $pStyle) { // Construct CSS $css = []; // Create CSS $css['vertical-align'] = $this->mapVAlign($pStyle->getVertical()); $textAlign = $this->mapHAlign($pStyle->getHorizontal()); if ($textAlign) { $css['text-align'] = $textAlign; if (in_array($textAlign, ['left', 'right'])) { $css['padding-' . $textAlign] = (string) ((int) $pStyle->getIndent() * 9) . 'px'; } } return $css; } /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Font). * * @return array */ private function createCSSStyleFont(Font $pStyle) { // Construct CSS $css = []; // Create CSS if ($pStyle->getBold()) { $css['font-weight'] = 'bold'; } if ($pStyle->getUnderline() != Font::UNDERLINE_NONE && $pStyle->getStrikethrough()) { $css['text-decoration'] = 'underline line-through'; } elseif ($pStyle->getUnderline() != Font::UNDERLINE_NONE) { $css['text-decoration'] = 'underline'; } elseif ($pStyle->getStrikethrough()) { $css['text-decoration'] = 'line-through'; } if ($pStyle->getItalic()) { $css['font-style'] = 'italic'; } $css['color'] = '#' . $pStyle->getColor()->getRGB(); $css['font-family'] = '\'' . $pStyle->getName() . '\''; $css['font-size'] = $pStyle->getSize() . 'pt'; return $css; } /** * Create CSS style (Borders). * * @param Borders $pStyle Borders * * @return array */ private function createCSSStyleBorders(Borders $pStyle) { // Construct CSS $css = []; // Create CSS $css['border-bottom'] = $this->createCSSStyleBorder($pStyle->getBottom()); $css['border-top'] = $this->createCSSStyleBorder($pStyle->getTop()); $css['border-left'] = $this->createCSSStyleBorder($pStyle->getLeft()); $css['border-right'] = $this->createCSSStyleBorder($pStyle->getRight()); return $css; } /** * Create CSS style (Border). * * @param Border $pStyle Border * * @return string */ private function createCSSStyleBorder(Border $pStyle) { // Create CSS - add !important to non-none border styles for merged cells $borderStyle = $this->mapBorderStyle($pStyle->getBorderStyle()); return $borderStyle . ' #' . $pStyle->getColor()->getRGB() . (($borderStyle == 'none') ? '' : ' !important'); } /** * Create CSS style (Fill). * * @param Fill $pStyle Fill * * @return array */ private function createCSSStyleFill(Fill $pStyle) { // Construct HTML $css = []; // Create CSS $value = $pStyle->getFillType() == Fill::FILL_NONE ? 'white' : '#' . $pStyle->getStartColor()->getRGB(); $css['background-color'] = $value; return $css; } /** * Generate HTML footer. */ public function generateHTMLFooter() { // Construct HTML $html = ''; $html .= ' ' . PHP_EOL; $html .= '' . PHP_EOL; return $html; } private function generateTableTagInline($pSheet, $id) { $style = isset($this->cssStyles['table']) ? $this->assembleCSS($this->cssStyles['table']) : ''; $prntgrid = $pSheet->getPrintGridlines(); $viewgrid = $this->isPdf ? $prntgrid : $pSheet->getShowGridlines(); if ($viewgrid && $prntgrid) { $html = " " . PHP_EOL; } elseif ($viewgrid) { $html = "
" . PHP_EOL; } elseif ($prntgrid) { $html = "
" . PHP_EOL; } else { $html = "
" . PHP_EOL; } return $html; } private function generateTableTag($pSheet, $id, &$html, $sheetIndex): void { if (!$this->useInlineCss) { $gridlines = $pSheet->getShowGridlines() ? ' gridlines' : ''; $gridlinesp = $pSheet->getPrintGridlines() ? ' gridlinesp' : ''; $html .= "
" . PHP_EOL; } else { $html .= $this->generateTableTagInline($pSheet, $id); } } /** * Generate table header. * * @param Worksheet $pSheet The worksheet for the table we are writing * @param bool $showid whether or not to add id to table tag * * @return string */ private function generateTableHeader($pSheet, $showid = true) { $sheetIndex = $pSheet->getParent()->getIndex($pSheet); // Construct HTML $html = ''; $id = $showid ? "id='sheet$sheetIndex'" : ''; if ($showid) { $html .= "
\n"; } else { $html .= "
\n"; } $this->generateTableTag($pSheet, $id, $html, $sheetIndex); // Write
elements $highestColumnIndex = Coordinate::columnIndexFromString($pSheet->getHighestColumn()) - 1; $i = -1; while ($i++ < $highestColumnIndex) { if (!$this->useInlineCss) { $html .= ' ' . PHP_EOL; } else { $style = isset($this->cssStyles['table.sheet' . $sheetIndex . ' col.col' . $i]) ? $this->assembleCSS($this->cssStyles['table.sheet' . $sheetIndex . ' col.col' . $i]) : ''; $html .= ' ' . PHP_EOL; } } return $html; } /** * Generate table footer. */ private function generateTableFooter() { return '
' . PHP_EOL . '' . PHP_EOL; } /** * Generate row start. * * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet * @param int $sheetIndex Sheet index (0-based) * @param int $pRow row number * * @return string */ private function generateRowStart(Worksheet $pSheet, $sheetIndex, $pRow) { $html = ''; if (count($pSheet->getBreaks()) > 0) { $breaks = $pSheet->getBreaks(); // check if a break is needed before this row if (isset($breaks['A' . $pRow])) { // close table: $html .= $this->generateTableFooter(); if ($this->isPdf && $this->useInlineCss) { $html .= '
'; } // open table again: + etc. $html .= $this->generateTableHeader($pSheet, false); $html .= '' . PHP_EOL; } } // Write row start if (!$this->useInlineCss) { $html .= ' ' . PHP_EOL; } else { $style = isset($this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow]) ? $this->assembleCSS($this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow]) : ''; $html .= ' ' . PHP_EOL; } return $html; } private function generateRowCellCss($pSheet, $cellAddress, $pRow, $colNum) { $cell = ($cellAddress > '') ? $pSheet->getCell($cellAddress) : ''; $coordinate = Coordinate::stringFromColumnIndex($colNum + 1) . ($pRow + 1); if (!$this->useInlineCss) { $cssClass = 'column' . $colNum; } else { $cssClass = []; // The statements below do nothing. // Commenting out the code rather than deleting it // in case someone can figure out what their intent was. //if ($cellType == 'th') { // if (isset($this->cssStyles['table.sheet' . $sheetIndex . ' th.column' . $colNum])) { // $this->cssStyles['table.sheet' . $sheetIndex . ' th.column' . $colNum]; // } //} else { // if (isset($this->cssStyles['table.sheet' . $sheetIndex . ' td.column' . $colNum])) { // $this->cssStyles['table.sheet' . $sheetIndex . ' td.column' . $colNum]; // } //} // End of mystery statements. } return [$cell, $cssClass, $coordinate]; } private function generateRowCellDataValueRich($cell, &$cellData): void { // Loop through rich text elements $elements = $cell->getValue()->getRichTextElements(); foreach ($elements as $element) { // Rich text start? if ($element instanceof Run) { $cellData .= ''; $cellEnd = ''; if ($element->getFont()->getSuperscript()) { $cellData .= ''; $cellEnd = ''; } elseif ($element->getFont()->getSubscript()) { $cellData .= ''; $cellEnd = ''; } // Convert UTF8 data to PCDATA $cellText = $element->getText(); $cellData .= htmlspecialchars($cellText); $cellData .= $cellEnd; $cellData .= ''; } else { // Convert UTF8 data to PCDATA $cellText = $element->getText(); $cellData .= htmlspecialchars($cellText); } } } private function generateRowCellDataValue($pSheet, $cell, &$cellData): void { if ($cell->getValue() instanceof RichText) { $this->generateRowCellDataValueRich($cell, $cellData); } else { $origData = $this->preCalculateFormulas ? $cell->getCalculatedValue() : $cell->getValue(); $cellData = NumberFormat::toFormattedString( $origData, $pSheet->getParent()->getCellXfByIndex($cell->getXfIndex())->getNumberFormat()->getFormatCode(), [$this, 'formatColor'] ); if ($cellData === $origData) { $cellData = htmlspecialchars($cellData); } if ($pSheet->getParent()->getCellXfByIndex($cell->getXfIndex())->getFont()->getSuperscript()) { $cellData = '' . $cellData . ''; } elseif ($pSheet->getParent()->getCellXfByIndex($cell->getXfIndex())->getFont()->getSubscript()) { $cellData = '' . $cellData . ''; } } } private function generateRowCellData($pSheet, $cell, &$cssClass, $cellType) { $cellData = ' '; if ($cell instanceof Cell) { $cellData = ''; // Don't know what this does, and no test cases. //if ($cell->getParent() === null) { // $cell->attach($pSheet); //} // Value $this->generateRowCellDataValue($pSheet, $cell, $cellData); // Converts the cell content so that spaces occuring at beginning of each new line are replaced by   // Example: " Hello\n to the world" is converted to "  Hello\n to the world" $cellData = preg_replace('/(?m)(?:^|\\G) /', ' ', $cellData); // convert newline "\n" to '
' $cellData = nl2br($cellData); // Extend CSS class? if (!$this->useInlineCss) { $cssClass .= ' style' . $cell->getXfIndex(); $cssClass .= ' ' . $cell->getDataType(); } else { if ($cellType == 'th') { if (isset($this->cssStyles['th.style' . $cell->getXfIndex()])) { $cssClass = array_merge($cssClass, $this->cssStyles['th.style' . $cell->getXfIndex()]); } } else { if (isset($this->cssStyles['td.style' . $cell->getXfIndex()])) { $cssClass = array_merge($cssClass, $this->cssStyles['td.style' . $cell->getXfIndex()]); } } // General horizontal alignment: Actual horizontal alignment depends on dataType $sharedStyle = $pSheet->getParent()->getCellXfByIndex($cell->getXfIndex()); if ( $sharedStyle->getAlignment()->getHorizontal() == Alignment::HORIZONTAL_GENERAL && isset($this->cssStyles['.' . $cell->getDataType()]['text-align']) ) { $cssClass['text-align'] = $this->cssStyles['.' . $cell->getDataType()]['text-align']; } } } else { // Use default borders for empty cell if (is_string($cssClass)) { $cssClass .= ' style0'; } } return $cellData; } private function generateRowIncludeCharts($pSheet, $coordinate) { return $this->includeCharts ? $this->writeChartInCell($pSheet, $coordinate) : ''; } private function generateRowSpans($html, $rowSpan, $colSpan) { $html .= ($colSpan > 1) ? (' colspan="' . $colSpan . '"') : ''; $html .= ($rowSpan > 1) ? (' rowspan="' . $rowSpan . '"') : ''; return $html; } private function generateRowWriteCell(&$html, $pSheet, $coordinate, $cellType, $cellData, $colSpan, $rowSpan, $cssClass, $colNum, $sheetIndex, $pRow): void { // Image? $htmlx = $this->writeImageInCell($pSheet, $coordinate); // Chart? $htmlx .= $this->generateRowIncludeCharts($pSheet, $coordinate); // Column start $html .= ' <' . $cellType; if (!$this->useInlineCss && !$this->isPdf) { $html .= ' class="' . $cssClass . '"'; if ($htmlx) { $html .= " style='position: relative;'"; } } else { //** Necessary redundant code for the sake of \PhpOffice\PhpSpreadsheet\Writer\Pdf ** // We must explicitly write the width of the if ($this->useInlineCss) { $xcssClass = $cssClass; } else { $html .= ' class="' . $cssClass . '"'; $xcssClass = []; } $width = 0; $i = $colNum - 1; $e = $colNum + $colSpan - 1; while ($i++ < $e) { if (isset($this->columnWidths[$sheetIndex][$i])) { $width += $this->columnWidths[$sheetIndex][$i]; } } $xcssClass['width'] = $width . 'pt'; // We must also explicitly write the height of the if (isset($this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow]['height'])) { $height = $this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow]['height']; $xcssClass['height'] = $height; } //** end of redundant code ** if ($htmlx) { $xcssClass['position'] = 'relative'; } $html .= ' style="' . $this->assembleCSS($xcssClass) . '"'; } $html = $this->generateRowSpans($html, $rowSpan, $colSpan); $html .= '>'; $html .= $htmlx; $html .= $this->writeComment($pSheet, $coordinate); // Cell data $html .= $cellData; // Column end $html .= '' . PHP_EOL; } /** * Generate row. * * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet * @param array $pValues Array containing cells in a row * @param int $pRow Row number (0-based) * @param string $cellType eg: 'td' * * @return string */ private function generateRow(Worksheet $pSheet, array $pValues, $pRow, $cellType) { // Sheet index $sheetIndex = $pSheet->getParent()->getIndex($pSheet); $html = $this->generateRowStart($pSheet, $sheetIndex, $pRow); // Write cells $colNum = 0; foreach ($pValues as $cellAddress) { [$cell, $cssClass, $coordinate] = $this->generateRowCellCss($pSheet, $cellAddress, $pRow, $colNum); $colSpan = 1; $rowSpan = 1; // Cell Data $cellData = $this->generateRowCellData($pSheet, $cell, $cssClass, $cellType); // Hyperlink? if ($pSheet->hyperlinkExists($coordinate) && !$pSheet->getHyperlink($coordinate)->isInternal()) { $cellData = '' . $cellData . ''; } // Should the cell be written or is it swallowed by a rowspan or colspan? $writeCell = !(isset($this->isSpannedCell[$pSheet->getParent()->getIndex($pSheet)][$pRow + 1][$colNum]) && $this->isSpannedCell[$pSheet->getParent()->getIndex($pSheet)][$pRow + 1][$colNum]); // Colspan and Rowspan $colspan = 1; $rowspan = 1; if (isset($this->isBaseCell[$pSheet->getParent()->getIndex($pSheet)][$pRow + 1][$colNum])) { $spans = $this->isBaseCell[$pSheet->getParent()->getIndex($pSheet)][$pRow + 1][$colNum]; $rowSpan = $spans['rowspan']; $colSpan = $spans['colspan']; // Also apply style from last cell in merge to fix borders - // relies on !important for non-none border declarations in createCSSStyleBorder $endCellCoord = Coordinate::stringFromColumnIndex($colNum + $colSpan) . ($pRow + $rowSpan); if (!$this->useInlineCss) { $cssClass .= ' style' . $pSheet->getCell($endCellCoord)->getXfIndex(); } } // Write if ($writeCell) { $this->generateRowWriteCell($html, $pSheet, $coordinate, $cellType, $cellData, $colSpan, $rowSpan, $cssClass, $colNum, $sheetIndex, $pRow); } // Next column ++$colNum; } // Write row end $html .= ' ' . PHP_EOL; // Return return $html; } /** * Takes array where of CSS properties / values and converts to CSS string. * * @return string */ private function assembleCSS(array $pValue = []) { $pairs = []; foreach ($pValue as $property => $value) { $pairs[] = $property . ':' . $value; } $string = implode('; ', $pairs); return $string; } /** * Get images root. * * @return string */ public function getImagesRoot() { return $this->imagesRoot; } /** * Set images root. * * @param string $pValue * * @return $this */ public function setImagesRoot($pValue) { $this->imagesRoot = $pValue; return $this; } /** * Get embed images. * * @return bool */ public function getEmbedImages() { return $this->embedImages; } /** * Set embed images. * * @param bool $pValue * * @return $this */ public function setEmbedImages($pValue) { $this->embedImages = $pValue; return $this; } /** * Get use inline CSS? * * @return bool */ public function getUseInlineCss() { return $this->useInlineCss; } /** * Set use inline CSS? * * @param bool $pValue * * @return $this */ public function setUseInlineCss($pValue) { $this->useInlineCss = $pValue; return $this; } /** * Get use embedded CSS? * * @return bool * * @codeCoverageIgnore * * @deprecated no longer used */ public function getUseEmbeddedCSS() { return $this->useEmbeddedCSS; } /** * Set use embedded CSS? * * @param bool $pValue * * @return $this * * @codeCoverageIgnore * * @deprecated no longer used */ public function setUseEmbeddedCSS($pValue) { $this->useEmbeddedCSS = $pValue; return $this; } /** * Add color to formatted string as inline style. * * @param string $pValue Plain formatted value without color * @param string $pFormat Format code * * @return string */ public function formatColor($pValue, $pFormat) { // Color information, e.g. [Red] is always at the beginning $color = null; // initialize $matches = []; $color_regex = '/^\\[[a-zA-Z]+\\]/'; if (preg_match($color_regex, $pFormat, $matches)) { $color = str_replace(['[', ']'], '', $matches[0]); $color = strtolower($color); } // convert to PCDATA $value = htmlspecialchars($pValue); // color span tag if ($color !== null) { $value = '' . $value . ''; } return $value; } /** * Calculate information about HTML colspan and rowspan which is not always the same as Excel's. */ private function calculateSpans(): void { if ($this->spansAreCalculated) { return; } // Identify all cells that should be omitted in HTML due to cell merge. // In HTML only the upper-left cell should be written and it should have // appropriate rowspan / colspan attribute $sheetIndexes = $this->sheetIndex !== null ? [$this->sheetIndex] : range(0, $this->spreadsheet->getSheetCount() - 1); foreach ($sheetIndexes as $sheetIndex) { $sheet = $this->spreadsheet->getSheet($sheetIndex); $candidateSpannedRow = []; // loop through all Excel merged cells foreach ($sheet->getMergeCells() as $cells) { [$cells] = Coordinate::splitRange($cells); $first = $cells[0]; $last = $cells[1]; [$fc, $fr] = Coordinate::coordinateFromString($first); $fc = Coordinate::columnIndexFromString($fc) - 1; [$lc, $lr] = Coordinate::coordinateFromString($last); $lc = Coordinate::columnIndexFromString($lc) - 1; // loop through the individual cells in the individual merge $r = $fr - 1; while ($r++ < $lr) { // also, flag this row as a HTML row that is candidate to be omitted $candidateSpannedRow[$r] = $r; $c = $fc - 1; while ($c++ < $lc) { if (!($c == $fc && $r == $fr)) { // not the upper-left cell (should not be written in HTML) $this->isSpannedCell[$sheetIndex][$r][$c] = [ 'baseCell' => [$fr, $fc], ]; } else { // upper-left is the base cell that should hold the colspan/rowspan attribute $this->isBaseCell[$sheetIndex][$r][$c] = [ 'xlrowspan' => $lr - $fr + 1, // Excel rowspan 'rowspan' => $lr - $fr + 1, // HTML rowspan, value may change 'xlcolspan' => $lc - $fc + 1, // Excel colspan 'colspan' => $lc - $fc + 1, // HTML colspan, value may change ]; } } } } $this->calculateSpansOmitRows($sheet, $sheetIndex, $candidateSpannedRow); // TODO: Same for columns } // We have calculated the spans $this->spansAreCalculated = true; } private function calculateSpansOmitRows($sheet, $sheetIndex, $candidateSpannedRow): void { // Identify which rows should be omitted in HTML. These are the rows where all the cells // participate in a merge and the where base cells are somewhere above. $countColumns = Coordinate::columnIndexFromString($sheet->getHighestColumn()); foreach ($candidateSpannedRow as $rowIndex) { if (isset($this->isSpannedCell[$sheetIndex][$rowIndex])) { if (count($this->isSpannedCell[$sheetIndex][$rowIndex]) == $countColumns) { $this->isSpannedRow[$sheetIndex][$rowIndex] = $rowIndex; } } } // For each of the omitted rows we found above, the affected rowspans should be subtracted by 1 if (isset($this->isSpannedRow[$sheetIndex])) { foreach ($this->isSpannedRow[$sheetIndex] as $rowIndex) { $adjustedBaseCells = []; $c = -1; $e = $countColumns - 1; while ($c++ < $e) { $baseCell = $this->isSpannedCell[$sheetIndex][$rowIndex][$c]['baseCell']; if (!in_array($baseCell, $adjustedBaseCells)) { // subtract rowspan by 1 --$this->isBaseCell[$sheetIndex][$baseCell[0]][$baseCell[1]]['rowspan']; $adjustedBaseCells[] = $baseCell; } } } } } /** * Write a comment in the same format as LibreOffice. * * @see https://github.com/LibreOffice/core/blob/9fc9bf3240f8c62ad7859947ab8a033ac1fe93fa/sc/source/filter/html/htmlexp.cxx#L1073-L1092 * * @param string $coordinate * * @return string */ private function writeComment(Worksheet $pSheet, $coordinate) { $result = ''; if (!$this->isPdf && isset($pSheet->getComments()[$coordinate])) { $result .= ''; $result .= '
' . nl2br($pSheet->getComment($coordinate)->getText()->getPlainText()) . '
'; $result .= PHP_EOL; } return $result; } /** * Generate @page declarations. * * @param bool $generateSurroundingHTML * * @return string */ private function generatePageDeclarations($generateSurroundingHTML) { // Ensure that Spans have been calculated? $this->calculateSpans(); // Fetch sheets $sheets = []; if ($this->sheetIndex === null) { $sheets = $this->spreadsheet->getAllSheets(); } else { $sheets[] = $this->spreadsheet->getSheet($this->sheetIndex); } // Construct HTML $htmlPage = $generateSurroundingHTML ? ('' . PHP_EOL) : ''; return $htmlPage; } }
element because TCPDF // does not recognize e.g.
element because TCPDF // does not recognize e.g.