Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Html:

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

	buildCSS ($generateSurroundingHTML=true)
	Build CSS styles.

	formatColor ($value, $format)
	Add color to formatted string as inline style.

	generateHtmlAll ()
	Save Spreadsheet as html to variable.

	generateHTMLFooter ()
	Generate HTML footer.

	generateHTMLHeader ($includeStyles=false)
	Generate HTML header.

	generateNavigation ()
	Generate sheet tabs.

	generateSheetData ()
	Generate sheet data.

	generateStyles ($generateSurroundingHTML=true)
	Generate CSS styles.

	getDiskCachingDirectory ()
	Get disk caching directory.

	getEmbedImages ()
	Get embed images.

	getGenerateSheetNavigationBlock ()
	Get sheet index.

	getImagesRoot ()
	Get images root.

	getIncludeCharts ()
	Write charts in workbook?

	getOrientation ()

	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.

	getSheetIndex ()
	Get sheet index.

	getUseDiskCaching ()
	Get use disk caching where possible?

	getUseEmbeddedCSS ()
	Get use embedded CSS?

	getUseInlineCss ()
	Get use inline CSS?

	openFileHandle ($filename)
	Open file handle.

	save ($filename, int $flags=0)
	Save Spreadsheet to file.

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

	setEmbedImages ($embedImages)
	Set embed images.

	setGenerateSheetNavigationBlock ($generateSheetNavigationBlock)
	Set sheet index.

	setImagesRoot ($imagesRoot)
	Set images root.

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

	setPreCalculateFormulas ($precalculateFormulas)
	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.

	setSheetIndex ($sheetIndex)
	Set sheet index.

	setUseDiskCaching ($useDiskCache, $cacheDirectory=null)
	Set use disk caching where possible?

	setUseEmbeddedCSS ($useEmbeddedCSS)
	Set use embedded CSS?

	setUseInlineCss ($useInlineCss)
	Set use inline CSS?

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

Static Public Member Functions
static	winFileToUrl ($filename, bool $mpdf=false)
	Convert Windows file name to file protocol URL.

Public Attributes
const	BODY_LINE = ' <body>' . PHP_EOL

const	BORDER_ARR

const	DISABLE_PRECALCULATE_FORMULAE = 2

const	SAVE_WITH_CHARTS = 1

Protected Member Functions
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves.

	processFlags (int $flags)

Protected Attributes
bool	$embedImages = false
	embed images, or link to images.

resource	$fileHandle

bool	$includeCharts = false

bool	$isMPdf = false
	Is the current writer creating mPDF?

bool	$isPdf = false
	Is the current writer creating PDF?

bool	$preCalculateFormulas = true
	Pre-calculate formulas Forces PhpSpreadsheet to 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.

Spreadsheet	$spreadsheet

Constructor & Destructor Documentation

◆ __construct()

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

Create a new HTML.

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Reimplemented in PhpOffice\PhpSpreadsheet\Writer\Pdf, and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf.

Member Function Documentation

◆ buildCSS()

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

Build CSS styles.

Parameters

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

Return values

array

◆ formatColor()

PhpOffice\PhpSpreadsheet\Writer\Html::formatColor	(		$value,
			$format )

Add color to formatted string as inline style.

Parameters

string	$value	Plain formatted value without color
string	$format	Format code

Return values

string

◆ generateHtmlAll()

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

Save Spreadsheet as html to variable.

Return values

string

◆ generateHTMLHeader()

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

Generate HTML header.

Parameters

bool $includeStyles Include styles?

Return values

string

◆ generateNavigation()

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

Generate sheet tabs.

Return values

string

◆ generateSheetData()

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

Generate sheet data.

Return values

string

◆ generateStyles()

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

Generate CSS styles.

Parameters

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

Return values

string

◆ getDiskCachingDirectory()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getDiskCachingDirectory ( )

inherited

Get disk caching directory.

Return values

string

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getEmbedImages()

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

Get embed images.

Return values

bool

◆ getGenerateSheetNavigationBlock()

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

Get sheet index.

Return values

bool

◆ getImagesRoot()

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

Get images root.

Return values

string

◆ getIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getIncludeCharts ( )

inherited

Write charts in workbook?

If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.

Return values

bool

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getOrientation()

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

Reimplemented in PhpOffice\PhpSpreadsheet\Writer\Pdf.

◆ getPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getPreCalculateFormulas ( )

inherited

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.

This is faster for saving in PhpSpreadsheet, but slower when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself.

Return values

bool

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getUseDiskCaching()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::getUseDiskCaching ( )

inherited

Get use disk caching where possible?

Return values

bool

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ getUseEmbeddedCSS()

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

Get use embedded CSS?

Return values

bool

@codeCoverageIgnore

Deprecated: no longer used

◆ getUseInlineCss()

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

Get use inline CSS?

Return values

bool

◆ openFileHandle()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::openFileHandle ( $filename )

inherited

Open file handle.

Parameters

resource | string $filename

◆ save()

PhpOffice\PhpSpreadsheet\Writer\Html::save	(		$filename,
		int	$flags = 0 )

Save Spreadsheet to file.

Parameters

resource | string $filename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Reimplemented in PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf, PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf, and PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf.

◆ 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.

◆ setEmbedImages()

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

Set embed images.

Parameters

bool $embedImages

Return values

$this

◆ setGenerateSheetNavigationBlock()

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

Set sheet index.

Parameters

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

Return values

$this

◆ setImagesRoot()

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

Set images root.

Parameters

string $imagesRoot

Return values

$this

◆ setIncludeCharts()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setIncludeCharts ( $includeCharts )

inherited

Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object.

Set to false (the default) to ignore charts.

Parameters

bool $includeCharts

Return values

IWriter

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setPreCalculateFormulas()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setPreCalculateFormulas ( $precalculateFormulas )

inherited

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.

Parameters

bool $precalculateFormulas Pre-Calculate Formulas?

Return values

IWriter

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setSheetIndex()

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

Set sheet index.

Parameters

int $sheetIndex Sheet index

Return values

$this

◆ setUseDiskCaching()

PhpOffice\PhpSpreadsheet\Writer\BaseWriter::setUseDiskCaching	(		$useDiskCache,
			$cacheDirectory = null )

inherited

Set use disk caching where possible?

Parameters

bool	$useDiskCache
string	$cacheDirectory	Disk caching directory

Return values

IWriter

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

◆ setUseEmbeddedCSS()

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

Set use embedded CSS?

Parameters

bool $useEmbeddedCSS

Return values

$this

@codeCoverageIgnore

Deprecated: no longer used

◆ setUseInlineCss()

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

Set use inline CSS?

Parameters

bool $useInlineCss

Return values

$this

◆ winFileToUrl()

static PhpOffice\PhpSpreadsheet\Writer\Html::winFileToUrl	(		$filename,
		bool	$mpdf = false )

static

Convert Windows file name to file protocol URL.

Parameters

string $filename file name on local system

Return values

string

◆ writeAllSheets()

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

Write all sheets (resets sheetIndex to NULL).

Return values

$this

Member Data Documentation

◆ BORDER_ARR

const PhpOffice\PhpSpreadsheet\Writer\Html::BORDER_ARR

Initial value:

= [
        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',
    ]

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

lib/phpspreadsheet/phpspreadsheet/src/PhpSpreadsheet/Writer/Html.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildCSS()

◆ formatColor()

◆ generateHtmlAll()

◆ generateHTMLHeader()

◆ generateNavigation()

◆ generateSheetData()

◆ generateStyles()

◆ getDiskCachingDirectory()

◆ getEmbedImages()

◆ getGenerateSheetNavigationBlock()

◆ getImagesRoot()

◆ getIncludeCharts()

◆ getOrientation()

◆ getPreCalculateFormulas()

◆ getUseDiskCaching()

◆ getUseEmbeddedCSS()

◆ getUseInlineCss()

◆ openFileHandle()

◆ save()

◆ setEditHtmlCallback()

◆ setEmbedImages()

◆ setGenerateSheetNavigationBlock()

◆ setImagesRoot()

◆ setIncludeCharts()

◆ setPreCalculateFormulas()

◆ setSheetIndex()

◆ setUseDiskCaching()

◆ setUseEmbeddedCSS()

◆ setUseInlineCss()

◆ winFileToUrl()

◆ writeAllSheets()

Member Data Documentation

◆ BORDER_ARR