Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Html:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\Html:

Public Member Functions
	__construct (Spreadsheet $spreadsheet)
	Create a new HTML. More...

	save ($pFilename)
	Save Spreadsheet to file. More...

	generateHtmlAll ()
	Save Spreadsheet as html to variable. More...

	setEditHtmlCallback (?callable $callback)
	Set a callback to edit the entire HTML. More...

	getSheetIndex ()
	Get sheet index. More...

	setSheetIndex ($pValue)
	Set sheet index. More...

	getGenerateSheetNavigationBlock ()
	Get sheet index. More...

	setGenerateSheetNavigationBlock ($pValue)
	Set sheet index. More...

	writeAllSheets ()
	Write all sheets (resets sheetIndex to NULL). More...

	generateHTMLHeader ($pIncludeStyles=false)
	Generate HTML header. More...

	generateSheetData ()
	Generate sheet data. More...

	generateNavigation ()
	Generate sheet tabs. More...

	generateStyles ($generateSurroundingHTML=true)
	Generate CSS styles. More...

	buildCSS ($generateSurroundingHTML=true)
	Build CSS styles. More...

	generateHTMLFooter ()
	Generate HTML footer. More...

	getImagesRoot ()
	Get images root. More...

	setImagesRoot ($pValue)
	Set images root. More...

	getEmbedImages ()
	Get embed images. More...

	setEmbedImages ($pValue)
	Set embed images. More...

	getUseInlineCss ()
	Get use inline CSS? More...

	setUseInlineCss ($pValue)
	Set use inline CSS? More...

	getUseEmbeddedCSS ()
	Get use embedded CSS? More...

	setUseEmbeddedCSS ($pValue)
	Set use embedded CSS? More...

	formatColor ($pValue, $pFormat)
	Add color to formatted string as inline style. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	getIncludeCharts ()
	Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. More...

	setIncludeCharts ($pValue)
	Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object. More...

	getPreCalculateFormulas ()
	Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. More...

	setPreCalculateFormulas ($pValue)
	Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save. More...

	getUseDiskCaching ()
	Get use disk caching where possible? More...

	setUseDiskCaching ($pValue, $pDirectory=null)
	Set use disk caching where possible? More...

	getDiskCachingDirectory ()
	Get disk caching directory. More...

	openFileHandle ($filename)
	Open file handle. More...

Static Public Member Functions
static	winFileToUrl ($filename)
	Convert Windows file name to file protocol URL. More...

Data Fields
const	VALIGN_ARR

const	HALIGN_ARR

const	BORDER_ARR

Protected Attributes
	$spreadsheet

	$isPdf = false

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	$includeCharts = false

	$preCalculateFormulas = true

	$fileHandle

Private Member Functions
	mapVAlign ($vAlign)
	Map VAlign. More...

	mapHAlign ($hAlign)
	Map HAlign. More...

	mapBorderStyle ($borderStyle)
	Map border style. More...

	generateSheetPrep ()

	generateSheetStarts ($sheet, $rowMin)

	generateSheetTags ($row, $theadStart, $theadEnd, $tbodyStart)

	extendRowsForCharts (Worksheet $pSheet, int $row)
	Extend Row if chart is placed after nominal end of row. More...

	extendRowsForChartsAndImages (Worksheet $pSheet, int $row)

	writeImageInCell (Worksheet $pSheet, $coordinates)
	Generate image tag in cell. More...

	writeChartInCell (Worksheet $pSheet, $coordinates)
	Generate chart tag in cell. More...

	buildCssRowHeights (Worksheet $sheet, array &$css, int $sheetIndex)

	buildCssPerSheet (Worksheet $sheet, array &$css)

	createCSSStyle (Style $pStyle)
	Create CSS style. More...

	createCSSStyleAlignment (Alignment $pStyle)
	Create CSS style (). More...

	createCSSStyleFont (Font $pStyle)
	Create CSS style (). More...

	createCSSStyleBorders (Borders $pStyle)
	Create CSS style (Borders). More...

	createCSSStyleBorder (Border $pStyle)
	Create CSS style (Border). More...

	createCSSStyleFill (Fill $pStyle)
	Create CSS style (Fill). More...

	generateTableTagInline ($pSheet, $id)

	generateTableTag ($pSheet, $id, &$html, $sheetIndex)

	generateTableHeader ($pSheet, $showid=true)
	Generate table header. More...

	generateTableFooter ()
	Generate table footer. More...

	generateRowStart (Worksheet $pSheet, $sheetIndex, $pRow)
	Generate row start. More...

	generateRowCellCss ($pSheet, $cellAddress, $pRow, $colNum)

	generateRowCellDataValueRich ($cell, &$cellData)

	generateRowCellDataValue ($pSheet, $cell, &$cellData)

	generateRowCellData ($pSheet, $cell, &$cssClass, $cellType)

	generateRowIncludeCharts ($pSheet, $coordinate)

	generateRowSpans ($html, $rowSpan, $colSpan)

	generateRowWriteCell (&$html, $pSheet, $coordinate, $cellType, $cellData, $colSpan, $rowSpan, $cssClass, $colNum, $sheetIndex, $pRow)

	generateRow (Worksheet $pSheet, array $pValues, $pRow, $cellType)
	Generate row. More...

	assembleCSS (array $pValue=[])
	Takes array where of CSS properties / values and converts to CSS string. More...

	calculateSpans ()
	Calculate information about HTML colspan and rowspan which is not always the same as Excel's. More...

	calculateSpansOmitRows ($sheet, $sheetIndex, $candidateSpannedRow)

	writeComment (Worksheet $pSheet, $coordinate)
	Write a comment in the same format as LibreOffice. More...

	generatePageDeclarations ($generateSurroundingHTML)

Static Private Member Functions
static	generateMeta ($val, $desc)

static	getChartCaption ($cap)
	Extend Row if chart is placed after nominal end of row. More...

Private Attributes
	$sheetIndex = 0

	$imagesRoot = ''

	$embedImages = false

	$useInlineCss = false

	$useEmbeddedCSS = true

	$cssStyles

	$columnWidths

	$defaultFont

	$spansAreCalculated = false

	$isSpannedCell = []

	$isBaseCell = []

	$isSpannedRow = []

	$generateSheetNavigationBlock = true

	$editHtmlCallback

Additional Inherited Members
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves. More...

Detailed Description

Definition at line 28 of file Html.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Writer\Html::__construct ( Spreadsheet $spreadsheet )

Create a new HTML.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 145 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$spreadsheet.

     {
         $this->spreadsheet = $spreadsheet;
         $this->defaultFont = $this->spreadsheet->getDefaultStyle()->getFont();
     }

Member Function Documentation

◆ assembleCSS()

PhpOffice\PhpSpreadsheet\Writer\Html::assembleCSS ( array $pValue = [] )

private

Takes array where of CSS properties / values and converts to CSS string.

Returns: string

Definition at line 1536 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValueRich(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowStart(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell(), PhpOffice\PhpSpreadsheet\Writer\Html\generateStyles(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableHeader(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateTableTagInline().

     {
         $pairs = [];
         foreach ($pValue as $property => $value) {
             $pairs[] = $property . ':' . $value;
         }
         $string = implode('; ', $pairs);
 
         return $string;
     }

Here is the caller graph for this function:

◆ buildCSS()

PhpOffice\PhpSpreadsheet\Writer\Html::buildCSS ( $generateSurroundingHTML = true )

Build CSS styles.

Parameters

bool $generateSurroundingHTML Generate surrounding HTML style? (html { })

Returns: array

Definition at line 905 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$cssStyles, $index, $style, PhpOffice\PhpSpreadsheet\Writer\Html\buildCssPerSheet(), PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans(), and PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateStyles().

     {
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCssPerSheet()

PhpOffice\PhpSpreadsheet\Writer\Html::buildCssPerSheet	(	Worksheet	$sheet,
		array &	$css
	)

private

Definition at line 847 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS().

                                                                     : 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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildCssRowHeights()

PhpOffice\PhpSpreadsheet\Writer\Html::buildCssRowHeights	(	Worksheet	$sheet,
		array &	$css,
		int	$sheetIndex
	)

private

Definition at line 827 of file Html.php.

References $row, and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getRowDimensions().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCssPerSheet().

                                                                                        : 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';
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateSpans()

PhpOffice\PhpSpreadsheet\Writer\Html::calculateSpans ( )

private

Calculate information about HTML colspan and rowspan which is not always the same as Excel's.

Definition at line 1685 of file Html.php.

References $c, $lc, $lr, $r, PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex, PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpansOmitRows(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\indexesFromString(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\splitRange().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetPrep().

                                      : 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::indexesFromString($first);
                 $fc = $fc - 1;
 
                 [$lc, $lr] = Coordinate::indexesFromString($last);
                 $lc = $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateSpansOmitRows()

PhpOffice\PhpSpreadsheet\Writer\Html::calculateSpansOmitRows	(	$sheet,
		$sheetIndex,
		$candidateSpannedRow
	)

private

Definition at line 1748 of file Html.php.

References $c, PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex, and PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans().

                                                                                       : 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;
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyle()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyle ( Style $pStyle )

private

Create CSS style.

Returns: array

Definition at line 999 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFill(), PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont(), PhpOffice\PhpSpreadsheet\Style\Style\getAlignment(), PhpOffice\PhpSpreadsheet\Style\Style\getBorders(), PhpOffice\PhpSpreadsheet\Style\Style\getFill(), and PhpOffice\PhpSpreadsheet\Style\Style\getFont().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS().

     {
         // Create CSS
         return array_merge(
             $this->createCSSStyleAlignment($pStyle->getAlignment()),
             $this->createCSSStyleBorders($pStyle->getBorders()),
             $this->createCSSStyleFont($pStyle->getFont()),
             $this->createCSSStyleFill($pStyle->getFill())
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyleAlignment()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyleAlignment ( Alignment $pStyle )

private

Create CSS style ().

Parameters

Alignment $pStyle

Returns: array

Definition at line 1017 of file Html.php.

References PhpOffice\PhpSpreadsheet\Style\Alignment\getHorizontal(), PhpOffice\PhpSpreadsheet\Style\Alignment\getIndent(), PhpOffice\PhpSpreadsheet\Style\Alignment\getVertical(), PhpOffice\PhpSpreadsheet\Writer\Html\mapHAlign(), and PhpOffice\PhpSpreadsheet\Writer\Html\mapVAlign().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle().

     {
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyleBorder()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyleBorder ( Border $pStyle )

private

Create CSS style (Border).

Parameters

Border $pStyle Border

Returns: string

Definition at line 1095 of file Html.php.

References PhpOffice\PhpSpreadsheet\Style\Border\getBorderStyle(), PhpOffice\PhpSpreadsheet\Style\Border\getColor(), and PhpOffice\PhpSpreadsheet\Writer\Html\mapBorderStyle().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorders().

     {
         //    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');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyleBorders()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyleBorders ( Borders $pStyle )

private

Create CSS style (Borders).

Parameters

Borders $pStyle Borders

Returns: array

Definition at line 1074 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorder(), PhpOffice\PhpSpreadsheet\Style\Borders\getBottom(), PhpOffice\PhpSpreadsheet\Style\Borders\getLeft(), PhpOffice\PhpSpreadsheet\Style\Borders\getRight(), and PhpOffice\PhpSpreadsheet\Style\Borders\getTop().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle().

     {
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyleFill()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyleFill ( Fill $pStyle )

private

Create CSS style (Fill).

Parameters

Fill $pStyle Fill

Returns: array

Definition at line 1110 of file Html.php.

References PhpOffice\PhpSpreadsheet\Style\Fill\FILL_NONE, PhpOffice\PhpSpreadsheet\Style\Fill\getFillType(), and PhpOffice\PhpSpreadsheet\Style\Fill\getStartColor().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle().

     {
         // Construct HTML
         $css = [];
 
         // Create CSS
         $value = $pStyle->getFillType() == Fill::FILL_NONE ?
             'white' : '#' . $pStyle->getStartColor()->getRGB();
         $css['background-color'] = $value;
 
         return $css;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCSSStyleFont()

PhpOffice\PhpSpreadsheet\Writer\Html::createCSSStyleFont ( Font $pStyle )

private

Create CSS style ().

Returns: array

Definition at line 1040 of file Html.php.

References PhpOffice\PhpSpreadsheet\Style\Font\getBold(), PhpOffice\PhpSpreadsheet\Style\Font\getColor(), PhpOffice\PhpSpreadsheet\Style\Font\getItalic(), PhpOffice\PhpSpreadsheet\Style\Font\getName(), PhpOffice\PhpSpreadsheet\Style\Font\getSize(), PhpOffice\PhpSpreadsheet\Style\Font\getStrikethrough(), PhpOffice\PhpSpreadsheet\Style\Font\getUnderline(), and PhpOffice\PhpSpreadsheet\Style\Font\UNDERLINE_NONE.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyle(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValueRich().

     {
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extendRowsForCharts()

PhpOffice\PhpSpreadsheet\Writer\Html::extendRowsForCharts	(	Worksheet	$pSheet,
		int	$row
	)

private

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.

Parameters

Worksheet	$pSheet
int	$row	Row to check for charts

Returns: array

Definition at line 556 of file Html.php.

References $row, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getChartCollection().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForChartsAndImages().

     {
         $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];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extendRowsForChartsAndImages()

PhpOffice\PhpSpreadsheet\Writer\Html::extendRowsForChartsAndImages	(	Worksheet	$pSheet,
		int	$row
	)

private

Definition at line 581 of file Html.php.

References $html, $row, PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForCharts(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getDrawingCollection(), PHP_EOL, PhpOffice\PhpSpreadsheet\Writer\Html\writeChartInCell(), and PhpOffice\PhpSpreadsheet\Writer\Html\writeImageInCell().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

                                                                               : 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 .= '<tr>';
             for ($col = 'A'; $col != $colMax; ++$col) {
                 $htmlx = $this->writeImageInCell($pSheet, $col . $row);
                 $htmlx .= $this->includeCharts ? $this->writeChartInCell($pSheet, $col . $row) : '';
                 if ($htmlx) {
                     $html .= "<td class='style0' style='position: relative;'>$htmlx</td>";
                 } else {
                     $html .= "<td class='style0'></td>";
                 }
             }
             ++$row;
             $html .= '</tr>' . PHP_EOL;
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatColor()

PhpOffice\PhpSpreadsheet\Writer\Html::formatColor	(	$pValue,
		$pFormat
	)

Add color to formatted string as inline style.

Parameters

string	$pValue	Plain formatted value without color
string	$pFormat	Format code

Returns: string

Definition at line 1659 of file Html.php.

     {
         // 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 = '<span style="color:' . $color . '">' . $value . '</span>';
         }
 
         return $value;
     }

◆ generateHtmlAll()

PhpOffice\PhpSpreadsheet\Writer\Html::generateHtmlAll ( )

Save Spreadsheet as html to variable.

Returns: string

Definition at line 173 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$editHtmlCallback, $html, PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\generateHTMLFooter(), PhpOffice\PhpSpreadsheet\Writer\Html\generateHTMLHeader(), PhpOffice\PhpSpreadsheet\Writer\Html\generateNavigation(), PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\getArrayReturnType(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\getInstance(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\RETURN_ARRAY_AS_VALUE, and PhpOffice\PhpSpreadsheet\Calculation\Calculation\setArrayReturnType().

     {
         // 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;
     }

Here is the call graph for this function:

◆ generateHTMLFooter()

PhpOffice\PhpSpreadsheet\Writer\Html::generateHTMLFooter ( )

Generate HTML footer.

Definition at line 1126 of file Html.php.

References $html, and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll().

     {
         // Construct HTML
         $html = '';
         $html .= '  </body>' . PHP_EOL;
         $html .= '</html>' . PHP_EOL;
 
         return $html;
     }

Here is the caller graph for this function:

◆ generateHTMLHeader()

PhpOffice\PhpSpreadsheet\Writer\Html::generateHTMLHeader ( $pIncludeStyles = false )

Generate HTML header.

Parameters

bool $pIncludeStyles Include styles?

Returns: string

Definition at line 361 of file Html.php.

References $html, PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), PhpOffice\PhpSpreadsheet\Writer\Html\generateStyles(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll().

     {
         // Construct HTML
         $properties = $this->spreadsheet->getProperties();
         $html = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . PHP_EOL;
         $html .= '<html xmlns="http://www.w3.org/1999/xhtml">' . PHP_EOL;
         $html .= '  <head>' . PHP_EOL;
         $html .= '      <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . PHP_EOL;
         $html .= '      <meta name="generator" content="PhpSpreadsheet, https://github.com/PHPOffice/PhpSpreadsheet" />' . PHP_EOL;
         $html .= '      <title>' . htmlspecialchars($properties->getTitle()) . '</title>' . 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 .= '  </head>' . PHP_EOL;
         $html .= '' . PHP_EOL;
         $html .= '  <body>' . PHP_EOL;
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateMeta()

static PhpOffice\PhpSpreadsheet\Writer\Html::generateMeta	(	$val,
		$desc
	)

staticprivate

Definition at line 349 of file Html.php.

References PHP_EOL.

     {
         return $val ? ('      <meta name="' . $desc . '" content="' . htmlspecialchars($val) . '" />' . PHP_EOL) : '';
     }

◆ generateNavigation()

PhpOffice\PhpSpreadsheet\Writer\Html::generateNavigation ( )

Generate sheet tabs.

Returns: string

Definition at line 510 of file Html.php.

References $html, and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll().

     {
         // 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 .= '<ul class="navigation">' . PHP_EOL;
 
             foreach ($sheets as $sheet) {
                 $html .= '  <li class="sheet' . $sheetId . '"><a href="#sheet' . $sheetId . '">' . $sheet->getTitle() . '</a></li>' . PHP_EOL;
                 ++$sheetId;
             }
 
             $html .= '</ul>' . PHP_EOL;
         }
 
         return $html;
     }

Here is the caller graph for this function:

◆ generatePageDeclarations()

PhpOffice\PhpSpreadsheet\Writer\Html::generatePageDeclarations ( $generateSurroundingHTML )

private

Definition at line 1812 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans(), EOF, PhpOffice\PhpSpreadsheet\Shared\StringHelper\formatNumber(), PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\ORIENTATION_LANDSCAPE, PhpOffice\PhpSpreadsheet\Worksheet\PageSetup\ORIENTATION_PORTRAIT, and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHTMLHeader(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateStyles().

     {
         // 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 ? ('<style type="text/css">' . PHP_EOL) : '';
 
         // Loop all sheets
         $sheetId = 0;
         foreach ($sheets as $pSheet) {
             $htmlPage .= "@page page$sheetId { ";
             $left = StringHelper::formatNumber($pSheet->getPageMargins()->getLeft()) . 'in; ';
             $htmlPage .= 'margin-left: ' . $left;
             $right = StringHelper::FormatNumber($pSheet->getPageMargins()->getRight()) . 'in; ';
             $htmlPage .= 'margin-right: ' . $right;
             $top = StringHelper::FormatNumber($pSheet->getPageMargins()->getTop()) . 'in; ';
             $htmlPage .= 'margin-top: ' . $top;
             $bottom = StringHelper::FormatNumber($pSheet->getPageMargins()->getBottom()) . 'in; ';
             $htmlPage .= 'margin-bottom: ' . $bottom;
             $orientation = $pSheet->getPageSetup()->getOrientation();
             if ($orientation === \PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_LANDSCAPE) {
                 $htmlPage .= 'size: landscape; ';
             } elseif ($orientation === \PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_PORTRAIT) {
                 $htmlPage .= 'size: portrait; ';
             }
             $htmlPage .= "}\n";
             ++$sheetId;
         }
         $htmlPage .= <<<EOF
 .navigation {page-break-after: always;}
 .scrpgbrk, div + div {page-break-before: always;}
 @media screen {
   .gridlines td {border: 1px solid black;}
   .gridlines th {border: 1px solid black;}
   body>div {margin-top: 5px;}
   body>div:first-child {margin-top: 0;}
   .scrpgbrk {margin-top: 1px;}
 }
 @media print {
   .gridlinesp td {border: 1px solid black;}
   .gridlinesp th {border: 1px solid black;}
   .navigation {display: none;}
 }
 
 EOF;
         $htmlPage .= $generateSurroundingHTML ? ('</style>' . PHP_EOL) : '';
 
         return $htmlPage;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRow()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRow	(	Worksheet	$pSheet,
		array	$pValues,
			$pRow,
			$cellType
	)

private

Generate row.

Parameters

Worksheet	$pSheet
array	$pValues	Array containing cells in a row
int	$pRow	Row number (0-based)
string	$cellType	eg: 'td'

Returns: string

Definition at line 1473 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         // 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 = '<a href="' . htmlspecialchars($pSheet->getHyperlink($coordinate)->getUrl()) . '" title="' . htmlspecialchars($pSheet->getHyperlink($coordinate)->getTooltip()) . '">' . $cellData . '</a>';
             }
 
             // 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 .= '          </tr>' . PHP_EOL;
 
         // Return
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowCellCss()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowCellCss	(	$pSheet,
		$cellAddress,
		$pRow,
		$colNum
	)

private

Definition at line 1256 of file Html.php.

References PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRow().

     {
         $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];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowCellData()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowCellData	(		$pSheet,
			$cell,
		&	$cssClass,
			$cellType
	)

private

Definition at line 1337 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValue(), and PhpOffice\PhpSpreadsheet\Style\Alignment\HORIZONTAL_GENERAL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRow().

     {
         $cellData = '&nbsp;';
         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 &nbsp;
             // Example: "  Hello\n to the world" is converted to "&nbsp;&nbsp;Hello\n&nbsp;to the world"
             $cellData = preg_replace('/(?m)(?:^|\\G) /', '&nbsp;', $cellData);
 
             // convert newline "\n" to '<br>'
             $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowCellDataValue()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowCellDataValue	(		$pSheet,
			$cell,
		&	$cellData
	)

private

Definition at line 1315 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValueRich(), and PhpOffice\PhpSpreadsheet\Style\NumberFormat\toFormattedString().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellData().

                                                                          : 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 = '<sup>' . $cellData . '</sup>';
             } elseif ($pSheet->getParent()->getCellXfByIndex($cell->getXfIndex())->getFont()->getSubscript()) {
                 $cellData = '<sub>' . $cellData . '</sub>';
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowCellDataValueRich()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowCellDataValueRich	(		$cell,
		&	$cellData
	)

private

Definition at line 1282 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), and PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleFont().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowCellDataValue().

                                                                     : void
     {
         // Loop through rich text elements
         $elements = $cell->getValue()->getRichTextElements();
         foreach ($elements as $element) {
             // Rich text start?
             if ($element instanceof Run) {
                 $cellData .= '<span style="' . $this->assembleCSS($this->createCSSStyleFont($element->getFont())) . '">';
 
                 $cellEnd = '';
                 if ($element->getFont()->getSuperscript()) {
                     $cellData .= '<sup>';
                     $cellEnd = '</sup>';
                 } elseif ($element->getFont()->getSubscript()) {
                     $cellData .= '<sub>';
                     $cellEnd = '</sub>';
                 }
 
                 // Convert UTF8 data to PCDATA
                 $cellText = $element->getText();
                 $cellData .= htmlspecialchars($cellText);
 
                 $cellData .= $cellEnd;
 
                 $cellData .= '</span>';
             } else {
                 // Convert UTF8 data to PCDATA
                 $cellText = $element->getText();
                 $cellData .= htmlspecialchars($cellText);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowIncludeCharts	(	$pSheet,
		$coordinate
	)

private

Definition at line 1390 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\writeChartInCell().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell().

     {
         return $this->includeCharts ? $this->writeChartInCell($pSheet, $coordinate) : '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowSpans()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowSpans	(	$html,
		$rowSpan,
		$colSpan
	)

private

Definition at line 1395 of file Html.php.

References $html.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell().

     {
         $html .= ($colSpan > 1) ? (' colspan="' . $colSpan . '"') : '';
         $html .= ($rowSpan > 1) ? (' rowspan="' . $rowSpan . '"') : '';
 
         return $html;
     }

Here is the caller graph for this function:

◆ generateRowStart()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowStart	(	Worksheet	$pSheet,
			$sheetIndex,
			$pRow
	)

private

Generate row start.

Parameters

Worksheet	$pSheet
int	$sheetIndex	Sheet index (0-based)
int	$pRow	row number

Returns: string

Definition at line 1223 of file Html.php.

References $html, PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex, $style, PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableFooter(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableHeader(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getBreaks(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRow().

     {
         $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: </table>
                 $html .= $this->generateTableFooter();
                 if ($this->isPdf && $this->useInlineCss) {
                     $html .= '<div style="page-break-before:always" />';
                 }
 
                 // open table again: <table> + <col> etc.
                 $html .= $this->generateTableHeader($pSheet, false);
                 $html .= '<tbody>' . PHP_EOL;
             }
         }
 
         // Write row start
         if (!$this->useInlineCss) {
             $html .= '          <tr class="row' . $pRow . '">' . PHP_EOL;
         } else {
             $style = isset($this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow])
                 ? $this->assembleCSS($this->cssStyles['table.sheet' . $sheetIndex . ' tr.row' . $pRow]) : '';
 
             $html .= '          <tr style="' . $style . '">' . PHP_EOL;
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateRowWriteCell()

PhpOffice\PhpSpreadsheet\Writer\Html::generateRowWriteCell	(	&	$html,
			$pSheet,
			$coordinate,
			$cellType,
			$cellData,
			$colSpan,
			$rowSpan,
			$cssClass,
			$colNum,
			$sheetIndex,
			$pRow
	)

private

Definition at line 1403 of file Html.php.

References $html, $i, PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex, PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowIncludeCharts(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowSpans(), PHP_EOL, PhpOffice\PhpSpreadsheet\Writer\Html\writeComment(), and PhpOffice\PhpSpreadsheet\Writer\Html\writeImageInCell().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRow().

                                                                                                                                                          : 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 <td> element because TCPDF
             // does not recognize e.g. <col style="width:42pt">
             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 <td> element because TCPDF
             // does not recognize e.g. <tr style="height:50pt">
             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 .= '</' . $cellType . '>' . PHP_EOL;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateSheetData()

PhpOffice\PhpSpreadsheet\Writer\Html::generateSheetData ( )

Generate sheet data.

Returns: string

Definition at line 441 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll().

     {
         $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::indexesFromString($min);
             [$maxCol, $maxRow] = Coordinate::indexesFromString($max);
 
             [$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 .= '<div style="page-break-before:always" ></div>';
                 }
             }
 
             // Next sheet
             ++$sheetId;
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateSheetPrep()

PhpOffice\PhpSpreadsheet\Writer\Html::generateSheetPrep ( )

private

Definition at line 389 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         // 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateSheetStarts()

PhpOffice\PhpSpreadsheet\Writer\Html::generateSheetStarts	(	$sheet,
		$rowMin
	)

private

Definition at line 404 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         // calculate start of <tbody>, <thead>
         $tbodyStart = $rowMin;
         $theadStart = $theadEnd = 0; // default: no <thead>    no </thead>
         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];
     }

Here is the caller graph for this function:

◆ generateSheetTags()

PhpOffice\PhpSpreadsheet\Writer\Html::generateSheetTags	(	$row,
		$theadStart,
		$theadEnd,
		$tbodyStart
	)

private

Definition at line 423 of file Html.php.

References $row, and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         // <thead> ?
         $startTag = ($row == $theadStart) ? ('        <thead>' . PHP_EOL) : '';
         if (!$startTag) {
             $startTag = ($row == $tbodyStart) ? ('        <tbody>' . PHP_EOL) : '';
         }
         $endTag = ($row == $theadEnd) ? ('        </thead>' . PHP_EOL) : '';
         $cellType = ($row >= $tbodyStart) ? 'td' : 'th';
 
         return [$cellType, $startTag, $endTag];
     }

Here is the caller graph for this function:

◆ generateStyles()

PhpOffice\PhpSpreadsheet\Writer\Html::generateStyles ( $generateSurroundingHTML = true )

Generate CSS styles.

Parameters

bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>)

Returns: string

Definition at line 796 of file Html.php.

References $html, PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS(), PhpOffice\PhpSpreadsheet\Writer\Html\generatePageDeclarations(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHTMLHeader().

     {
         // Build CSS
         $css = $this->buildCSS($generateSurroundingHTML);
 
         // Construct HTML
         $html = '';
 
         // Start styles
         if ($generateSurroundingHTML) {
             $html .= '    <style type="text/css">' . PHP_EOL;
             $html .= (array_key_exists('html', $css)) ? ('      html { ' . $this->assembleCSS($css['html']) . ' }' . PHP_EOL) : '';
         }
 
         // Write all other styles
         foreach ($css as $styleName => $styleDefinition) {
             if ($styleName != 'html') {
                 $html .= '      ' . $styleName . ' { ' . $this->assembleCSS($styleDefinition) . ' }' . PHP_EOL;
             }
         }
         $html .= $this->generatePageDeclarations(false);
 
         // End styles
         if ($generateSurroundingHTML) {
             $html .= '    </style>' . PHP_EOL;
         }
 
         // Return
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateTableFooter()

PhpOffice\PhpSpreadsheet\Writer\Html::generateTableFooter ( )

private

Generate table footer.

Definition at line 1209 of file Html.php.

References PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowStart(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         return '    </tbody></table>' . PHP_EOL . '</div>' . PHP_EOL;
     }

Here is the caller graph for this function:

◆ generateTableHeader()

PhpOffice\PhpSpreadsheet\Writer\Html::generateTableHeader	(	$pSheet,
		$showid = `true`
	)

private

Generate table header.

Parameters

Worksheet	$pSheet	The worksheet for the table we are writing
bool	$showid	whether or not to add id to table tag

Returns: string

Definition at line 1175 of file Html.php.

References $html, $i, $id, PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex, $style, PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\columnIndexFromString(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableTag(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowStart(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateSheetData().

     {
         $sheetIndex = $pSheet->getParent()->getIndex($pSheet);
 
         // Construct HTML
         $html = '';
         $id = $showid ? "id='sheet$sheetIndex'" : '';
         if ($showid) {
             $html .= "<div style='page: page$sheetIndex'>\n";
         } else {
             $html .= "<div style='page: page$sheetIndex' class='scrpgbrk'>\n";
         }
 
         $this->generateTableTag($pSheet, $id, $html, $sheetIndex);
 
         // Write <col> elements
         $highestColumnIndex = Coordinate::columnIndexFromString($pSheet->getHighestColumn()) - 1;
         $i = -1;
         while ($i++ < $highestColumnIndex) {
             if (!$this->useInlineCss) {
                 $html .= '        <col class="col' . $i . '" />' . PHP_EOL;
             } else {
                 $style = isset($this->cssStyles['table.sheet' . $sheetIndex . ' col.col' . $i]) ?
                     $this->assembleCSS($this->cssStyles['table.sheet' . $sheetIndex . ' col.col' . $i]) : '';
                 $html .= '        <col style="' . $style . '" />' . PHP_EOL;
             }
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateTableTag()

PhpOffice\PhpSpreadsheet\Writer\Html::generateTableTag	(		$pSheet,
			$id,
		&	$html,
			$sheetIndex
	)

private

Definition at line 1156 of file Html.php.

References $html, $id, PhpOffice\PhpSpreadsheet\Writer\Html\generateTableTagInline(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateTableHeader().

                                                                         : void
     {
         if (!$this->useInlineCss) {
             $gridlines = $pSheet->getShowGridlines() ? ' gridlines' : '';
             $gridlinesp = $pSheet->getPrintGridlines() ? ' gridlinesp' : '';
             $html .= "    <table border='0' cellpadding='0' cellspacing='0' $id class='sheet$sheetIndex$gridlines$gridlinesp'>" . PHP_EOL;
         } else {
             $html .= $this->generateTableTagInline($pSheet, $id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateTableTagInline()

PhpOffice\PhpSpreadsheet\Writer\Html::generateTableTagInline	(	$pSheet,
		$id
	)

private

Definition at line 1136 of file Html.php.

References $html, $style, PhpOffice\PhpSpreadsheet\Writer\Html\assembleCSS(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateTableTag().

     {
         $style = isset($this->cssStyles['table']) ?
             $this->assembleCSS($this->cssStyles['table']) : '';
 
         $prntgrid = $pSheet->getPrintGridlines();
         $viewgrid = $this->isPdf ? $prntgrid : $pSheet->getShowGridlines();
         if ($viewgrid && $prntgrid) {
             $html = "    <table border='1' cellpadding='1' $id cellspacing='1' style='$style' class='gridlines gridlinesp'>" . PHP_EOL;
         } elseif ($viewgrid) {
             $html = "    <table border='0' cellpadding='0' $id cellspacing='0' style='$style' class='gridlines'>" . PHP_EOL;
         } elseif ($prntgrid) {
             $html = "    <table border='0' cellpadding='0' $id cellspacing='0' style='$style' class='gridlinesp'>" . PHP_EOL;
         } else {
             $html = "    <table border='0' cellpadding='1' $id cellspacing='0' style='$style'>" . PHP_EOL;
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChartCaption()

static PhpOffice\PhpSpreadsheet\Writer\Html::getChartCaption ( $cap )

staticprivate

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.

Parameters

mixed $cap

Returns: string

Definition at line 784 of file Html.php.

     {
         return is_array($cap) ? implode(' ', $cap) : $cap;
     }

◆ getEmbedImages()

PhpOffice\PhpSpreadsheet\Writer\Html::getEmbedImages ( )

Get embed images.

Returns: bool

Definition at line 1576 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$embedImages.

     {
         return $this->embedImages;
     }

◆ getGenerateSheetNavigationBlock()

PhpOffice\PhpSpreadsheet\Writer\Html::getGenerateSheetNavigationBlock ( )

Get sheet index.

Returns: bool

Definition at line 318 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$generateSheetNavigationBlock.

     {
         return $this->generateSheetNavigationBlock;
     }

◆ getImagesRoot()

PhpOffice\PhpSpreadsheet\Writer\Html::getImagesRoot ( )

Get images root.

Returns: string

Definition at line 1552 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$imagesRoot.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\writeImageInCell().

     {
         return $this->imagesRoot;
     }

Here is the caller graph for this function:

◆ getSheetIndex()

PhpOffice\PhpSpreadsheet\Writer\Html::getSheetIndex ( )

Get sheet index.

Returns: int

Definition at line 294 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$sheetIndex.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf\save(), PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf\save(), and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\save().

     {
         return $this->sheetIndex;
     }

Here is the caller graph for this function:

◆ getUseEmbeddedCSS()

PhpOffice\PhpSpreadsheet\Writer\Html::getUseEmbeddedCSS ( )

Get use embedded CSS?

Returns: bool

Deprecated:: no longer used

Definition at line 1628 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$useEmbeddedCSS.

     {
         return $this->useEmbeddedCSS;
     }

◆ getUseInlineCss()

PhpOffice\PhpSpreadsheet\Writer\Html::getUseInlineCss ( )

Get use inline CSS?

Returns: bool

Definition at line 1600 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\Html\$useInlineCss.

     {
         return $this->useInlineCss;
     }

◆ mapBorderStyle()

PhpOffice\PhpSpreadsheet\Writer\Html::mapBorderStyle ( $borderStyle )

private

Map border style.

Parameters

int $borderStyle Sheet index

Returns: string

Definition at line 284 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleBorder().

     {
         return array_key_exists($borderStyle, self::BORDER_ARR) ? self::BORDER_ARR[$borderStyle] : '1px solid';
     }

Here is the caller graph for this function:

◆ mapHAlign()

PhpOffice\PhpSpreadsheet\Writer\Html::mapHAlign ( $hAlign )

private

Map HAlign.

Parameters

string $hAlign Horizontal alignment

Returns: string

Definition at line 257 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment().

     {
         return array_key_exists($hAlign, self::HALIGN_ARR) ? self::HALIGN_ARR[$hAlign] : '';
     }

Here is the caller graph for this function:

◆ mapVAlign()

PhpOffice\PhpSpreadsheet\Writer\Html::mapVAlign ( $vAlign )

private

Map VAlign.

Parameters

string $vAlign Vertical alignment

Returns: string

Definition at line 237 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\createCSSStyleAlignment().

     {
         return array_key_exists($vAlign, self::VALIGN_ARR) ? self::VALIGN_ARR[$vAlign] : 'baseline';
     }

Here is the caller graph for this function:

◆ save()

PhpOffice\PhpSpreadsheet\Writer\Html::save ( $pFilename )

Save Spreadsheet to file.

Parameters

resource | string $pFilename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 156 of file Html.php.

References PhpOffice\PhpSpreadsheet\Writer\BaseWriter\maybeCloseFileHandle(), and PhpOffice\PhpSpreadsheet\Writer\BaseWriter\openFileHandle().

                                     : void
     {
         // Open file
         $this->openFileHandle($pFilename);
 
         // Write html
         fwrite($this->fileHandle, $this->generateHTMLAll());
 
         // Close file
         $this->maybeCloseFileHandle();
     }

Here is the call graph for this function:

◆ setEditHtmlCallback()

PhpOffice\PhpSpreadsheet\Writer\Html::setEditHtmlCallback ( ?callable $callback )

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.

Definition at line 218 of file Html.php.

                                                             : void
     {
         $this->editHtmlCallback = $callback;
     }

◆ setEmbedImages()

PhpOffice\PhpSpreadsheet\Writer\Html::setEmbedImages ( $pValue )

Set embed images.

Parameters

bool $pValue

Returns: $this

Definition at line 1588 of file Html.php.

     {
         $this->embedImages = $pValue;
 
         return $this;
     }

◆ setGenerateSheetNavigationBlock()

PhpOffice\PhpSpreadsheet\Writer\Html::setGenerateSheetNavigationBlock ( $pValue )

Set sheet index.

Parameters

bool $pValue Flag indicating whether the sheet navigation block should be generated or not

Returns: $this

Definition at line 330 of file Html.php.

     {
         $this->generateSheetNavigationBlock = (bool) $pValue;
 
         return $this;
     }

◆ setImagesRoot()

PhpOffice\PhpSpreadsheet\Writer\Html::setImagesRoot ( $pValue )

Set images root.

Parameters

string $pValue

Returns: $this

Definition at line 1564 of file Html.php.

     {
         $this->imagesRoot = $pValue;
 
         return $this;
     }

◆ setSheetIndex()

PhpOffice\PhpSpreadsheet\Writer\Html::setSheetIndex ( $pValue )

Set sheet index.

Parameters

int $pValue Sheet index

Returns: $this

Definition at line 306 of file Html.php.

     {
         $this->sheetIndex = $pValue;
 
         return $this;
     }

◆ setUseEmbeddedCSS()

PhpOffice\PhpSpreadsheet\Writer\Html::setUseEmbeddedCSS ( $pValue )

Set use embedded CSS?

Parameters

bool $pValue

Returns: $this

Deprecated:: no longer used

Definition at line 1644 of file Html.php.

     {
         $this->useEmbeddedCSS = $pValue;
 
         return $this;
     }

◆ setUseInlineCss()

PhpOffice\PhpSpreadsheet\Writer\Html::setUseInlineCss ( $pValue )

Set use inline CSS?

Parameters

bool $pValue

Returns: $this

Definition at line 1612 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf\__construct().

     {
         $this->useInlineCss = $pValue;
 
         return $this;
     }

Here is the caller graph for this function:

◆ winFileToUrl()

static PhpOffice\PhpSpreadsheet\Writer\Html::winFileToUrl ( $filename )

static

Convert Windows file name to file protocol URL.

Parameters

string $filename file name on local system

Returns: string

Definition at line 630 of file Html.php.

References $filename.

     {
         // Windows filename
         if (substr($filename, 1, 2) === ':\\') {
             $filename = 'file:///' . str_replace('\\', '/', $filename);
         }
 
         return $filename;
     }

◆ writeAllSheets()

PhpOffice\PhpSpreadsheet\Writer\Html::writeAllSheets ( )

Write all sheets (resets sheetIndex to NULL).

Returns: $this

Definition at line 342 of file Html.php.

     {
         $this->sheetIndex = null;
 
         return $this;
     }

◆ writeChartInCell()

PhpOffice\PhpSpreadsheet\Writer\Html::writeChartInCell	(	Worksheet	$pSheet,
			$coordinates
	)

private

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.

Parameters

Worksheet	$pSheet
string	$coordinates	Cell coordinates

Returns: string

Definition at line 729 of file Html.php.

References $html, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getChartCollection(), PHP_EOL, and PhpOffice\PhpSpreadsheet\Shared\File\sysGetTempDir().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForChartsAndImages(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateRowIncludeCharts().

     {
         // 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 .= '<img style="position: absolute; z-index: 1; left: ' . $chartCoordinates['xOffset'] . 'px; top: ' . $chartCoordinates['yOffset'] . 'px; width: ' . $imageDetails[0] . 'px; height: ' . $imageDetails[1] . 'px;" src="' . $imageData . '" alt="' . $filedesc . '" />' . PHP_EOL;
 
                         unlink($chartFileName);
                     }
                 }
             }
         }
 
         // Return
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeComment()

PhpOffice\PhpSpreadsheet\Writer\Html::writeComment	(	Worksheet	$pSheet,
			$coordinate
	)

private

Write a comment in the same format as LibreOffice.

See also: https://github.com/LibreOffice/core/blob/9fc9bf3240f8c62ad7859947ab8a033ac1fe93fa/sc/source/filter/html/htmlexp.cxx#L1073-L1092

Parameters

string $coordinate

Returns: string

Definition at line 1789 of file Html.php.

References $result, $sanitizer, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getComment(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getComments(), HTMLPurifier(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell().

     {
         $result = '';
         if (!$this->isPdf && isset($pSheet->getComments()[$coordinate])) {
             $sanitizer = new HTMLPurifier();
             $sanitizedString = $sanitizer->purify($pSheet->getComment($coordinate)->getText()->getPlainText());
             if ($sanitizedString !== '') {
                 $result .= '<a class="comment-indicator"></a>';
                 $result .= '<div class="comment">' . nl2br($sanitizedString) . '</div>';
                 $result .= PHP_EOL;
             }
         }
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeImageInCell()

PhpOffice\PhpSpreadsheet\Writer\Html::writeImageInCell	(	Worksheet	$pSheet,
			$coordinates
	)

private

Generate image tag in cell.

Parameters

Worksheet	$pSheet
string	$coordinates	Cell coordinates

Returns: string

Definition at line 648 of file Html.php.

References $filename, $html, PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getDrawingCollection(), PhpOffice\PhpSpreadsheet\Writer\Html\getImagesRoot(), and PHP_EOL.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\extendRowsForChartsAndImages(), and PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell().

     {
         // 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 .= '<img style="position: absolute; z-index: 1; left: ' .
                     $drawing->getOffsetX() . 'px; top: ' . $drawing->getOffsetY() . 'px; width: ' .
                     $drawing->getWidth() . 'px; height: ' . $drawing->getHeight() . 'px;" src="' .
                     $imageData . '" alt="' . $filedesc . '" />';
             } elseif ($drawing instanceof MemoryDrawing) {
                 $imageResource = $drawing->getImageResource();
                 if ($imageResource) {
                     ob_start(); //  Let's start output buffering.
                     imagepng($imageResource); //  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 .= '<img alt="' . $filedesc . '" src="' . $dataUri . '" style="max-width:100%;width:' . $drawing->getWidth() . 'px;" />';
                 }
             }
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $columnWidths

PhpOffice\PhpSpreadsheet\Writer\Html::$columnWidths

private

Definition at line 84 of file Html.php.

◆ $cssStyles

PhpOffice\PhpSpreadsheet\Writer\Html::$cssStyles

private

Definition at line 77 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCSS().

◆ $defaultFont

PhpOffice\PhpSpreadsheet\Writer\Html::$defaultFont

private

Definition at line 91 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCssPerSheet().

◆ $editHtmlCallback

PhpOffice\PhpSpreadsheet\Writer\Html::$editHtmlCallback

private

Definition at line 140 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\generateHtmlAll().

◆ $embedImages

PhpOffice\PhpSpreadsheet\Writer\Html::$embedImages = false

private

Definition at line 56 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\getEmbedImages().

◆ $generateSheetNavigationBlock

PhpOffice\PhpSpreadsheet\Writer\Html::$generateSheetNavigationBlock = true

private

Definition at line 133 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\getGenerateSheetNavigationBlock().

◆ $imagesRoot

PhpOffice\PhpSpreadsheet\Writer\Html::$imagesRoot = ''

private

Definition at line 49 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\getImagesRoot().

◆ $isBaseCell

PhpOffice\PhpSpreadsheet\Writer\Html::$isBaseCell = []

private

Definition at line 112 of file Html.php.

◆ $isPdf

PhpOffice\PhpSpreadsheet\Writer\Html::$isPdf = false

protected

Definition at line 126 of file Html.php.

◆ $isSpannedCell

PhpOffice\PhpSpreadsheet\Writer\Html::$isSpannedCell = []

private

Definition at line 105 of file Html.php.

◆ $isSpannedRow

PhpOffice\PhpSpreadsheet\Writer\Html::$isSpannedRow = []

private

Definition at line 119 of file Html.php.

◆ $sheetIndex

PhpOffice\PhpSpreadsheet\Writer\Html::$sheetIndex = 0

private

Definition at line 42 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\buildCssPerSheet(), PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpans(), PhpOffice\PhpSpreadsheet\Writer\Html\calculateSpansOmitRows(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRow(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowStart(), PhpOffice\PhpSpreadsheet\Writer\Html\generateRowWriteCell(), PhpOffice\PhpSpreadsheet\Writer\Html\generateTableHeader(), and PhpOffice\PhpSpreadsheet\Writer\Html\getSheetIndex().

◆ $spansAreCalculated

PhpOffice\PhpSpreadsheet\Writer\Html::$spansAreCalculated = false

private

Definition at line 98 of file Html.php.

◆ $spreadsheet

PhpOffice\PhpSpreadsheet\Writer\Html::$spreadsheet

protected

Definition at line 35 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\__construct().

◆ $useEmbeddedCSS

PhpOffice\PhpSpreadsheet\Writer\Html::$useEmbeddedCSS = true

private

Definition at line 70 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\getUseEmbeddedCSS().

◆ $useInlineCss

PhpOffice\PhpSpreadsheet\Writer\Html::$useInlineCss = false

private

Definition at line 63 of file Html.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Html\getUseInlineCss().

◆ BORDER_ARR

const PhpOffice\PhpSpreadsheet\Writer\Html::BORDER_ARR

Initial value:

= [

Border::BORDER_NONE => 'none'

Definition at line 262 of file Html.php.

◆ HALIGN_ARR

const PhpOffice\PhpSpreadsheet\Writer\Html::HALIGN_ARR

Initial value:

= [

Alignment::HORIZONTAL_LEFT => 'left'

Definition at line 242 of file Html.php.

◆ VALIGN_ARR

const PhpOffice\PhpSpreadsheet\Writer\Html::VALIGN_ARR

Initial value:

= [

Alignment::VERTICAL_BOTTOM => 'bottom'

Definition at line 223 of file Html.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/Html.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assembleCSS()

◆ buildCSS()

◆ buildCssPerSheet()

◆ buildCssRowHeights()

◆ calculateSpans()

◆ calculateSpansOmitRows()

◆ createCSSStyle()

◆ createCSSStyleAlignment()

◆ createCSSStyleBorder()

◆ createCSSStyleBorders()

◆ createCSSStyleFill()

◆ createCSSStyleFont()

◆ extendRowsForCharts()

◆ extendRowsForChartsAndImages()

◆ formatColor()

◆ generateHtmlAll()

◆ generateHTMLFooter()

◆ generateHTMLHeader()

◆ generateMeta()

◆ generateNavigation()

◆ generatePageDeclarations()

◆ generateRow()

◆ generateRowCellCss()

◆ generateRowCellData()

◆ generateRowCellDataValue()

◆ generateRowCellDataValueRich()

◆ generateRowIncludeCharts()

◆ generateRowSpans()

◆ generateRowStart()

◆ generateRowWriteCell()

◆ generateSheetData()

◆ generateSheetPrep()

◆ generateSheetStarts()

◆ generateSheetTags()

◆ generateStyles()

◆ generateTableFooter()

◆ generateTableHeader()

◆ generateTableTag()

◆ generateTableTagInline()

◆ getChartCaption()

◆ getEmbedImages()

◆ getGenerateSheetNavigationBlock()

◆ getImagesRoot()

◆ getSheetIndex()

◆ getUseEmbeddedCSS()

◆ getUseInlineCss()

◆ mapBorderStyle()

◆ mapHAlign()

◆ mapVAlign()

◆ save()

◆ setEditHtmlCallback()

◆ setEmbedImages()

◆ setGenerateSheetNavigationBlock()

◆ setImagesRoot()

◆ setSheetIndex()

◆ setUseEmbeddedCSS()

◆ setUseInlineCss()

◆ winFileToUrl()

◆ writeAllSheets()

◆ writeChartInCell()

◆ writeComment()

◆ writeImageInCell()

Field Documentation

◆ $columnWidths

◆ $cssStyles

◆ $defaultFont

◆ $editHtmlCallback

◆ $embedImages