Documentation

Xls extends BaseWriter

in package

• Application

Table of Contents

Properties

$fileHandle  : resource

$includeCharts  : bool

Write charts that are defined in the workbook? Identifies whether the Writer should write definitions for any charts that exist in the PhpSpreadsheet object.

$preCalculateFormulas  : bool

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.

$colors  : array<string|int, mixed>

Color cache. Mapping between RGB value and color index.

$diskCachingDirectory  : string

Disk caching directory.

$documentSummaryInformation  : string

Extended OLE object document summary information.

$IDCLs  : array<string|int, mixed>

Identifier clusters for drawings. Used in MSODRAWINGGROUP record.

$parser  : Parser

Formula parser.

$shouldCloseFile  : bool

$spreadsheet  : Spreadsheet

PhpSpreadsheet object.

$strTable  : array<string|int, mixed>

Array of unique shared strings in workbook.

$strTotal  : int

Total number of shared strings in workbook.

$strUnique  : int

Number of unique shared strings in workbook.

$summaryInformation  : string

Basic OLE object summary information.

$two  : int

$useDiskCaching  : bool

Use disk caching where possible?

$writerWorkbook  : Workbook

$writerWorksheets  : array<string|int, Worksheet>

Methods

__construct()  : mixed

Create a new Xls Writer.

getDiskCachingDirectory()  : string

Get disk caching directory.

getIncludeCharts()  : bool

Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object.

getPreCalculateFormulas()  : bool

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.

getUseDiskCaching()  : bool

Get use disk caching where possible?

openFileHandle()  : void

Open file handle.

save()  : void

Save Spreadsheet to file.

setIncludeCharts()  : $this

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

setPreCalculateFormulas()  : $this

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.

setUseDiskCaching()  : $this

Set use disk caching where possible?

maybeCloseFileHandle()  : void

Close file handle only if we opened it ourselves.

processFlags()  : void

buildWorkbookEscher()  : void

Build the Escher object corresponding to the MSODRAWINGGROUP record.

buildWorksheetEschers()  : void

Build the Worksheet Escher objects.

checkForDrawings()  : bool

processBaseDrawing()  : void

processDrawing()  : void

processMemoryDrawing()  : void

writeDocumentSummaryInformation()  : string

Build the OLE Part for DocumentSummary Information.

writeSummaryInformation()  : string

Build the OLE Part for Summary Information.

writeSummaryProp()  : void

writeSummaryPropOle()  : void