Documentation

Xlsx extends BaseWriter

in package

• Application

Table of Contents

Constants

DEFAULT_FORCE_FULL_CALC  = false

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.

$bordersHashTable  : HashTable<string|int, Borders>

Private unique Borders HashTable.

$diskCachingDirectory  : string

Disk caching directory.

$drawingHashTable  : HashTable<string|int, BaseDrawing>

Private unique \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\BaseDrawing HashTable.

$explicitStyle0  : bool

$fillHashTable  : HashTable<string|int, Fill>

Private unique Fill HashTable.

$fontHashTable  : HashTable<string|int, Font>

Private unique \PhpOffice\PhpSpreadsheet\Style\Font HashTable.

$forceFullCalc  : bool|null

$numFmtHashTable  : HashTable<string|int, NumberFormat>

Private unique NumberFormat HashTable.

$office2003compatibility  : bool

Office2003 compatibility.

$pathNames  : array<string|int, mixed>

$shouldCloseFile  : bool

$spreadSheet  : Spreadsheet

Private Spreadsheet.

$stringTable  : array<string|int, string>

Private string table.

$styleHashTable  : HashTable<string|int, Style>

Private unique Style HashTable.

$stylesConditionalHashTable  : HashTable<string|int, Conditional>

Private unique Conditional HashTable.

$useCSEArrays  : bool

$useDiskCaching  : bool

Use disk caching where possible?

$useDynamicArray  : bool

$writerPartChart  : Chart

$writerPartComments  : Comments

$writerPartContentTypes  : ContentTypes

$writerPartDocProps  : DocProps

$writerPartDrawing  : Drawing

$writerPartRels  : Rels

$writerPartRelsRibbon  : RelsRibbon

$writerPartRelsVBA  : RelsVBA

$writerPartStringTable  : StringTable

$writerPartStyle  : Style

$writerPartTable  : Table

$writerPartTheme  : Theme

$writerPartWorkbook  : Workbook

$writerPartWorksheet  : Worksheet

$zip  : ZipStream

Private handle for zip stream.

Methods

__construct()  : mixed

Create a new Xlsx Writer.

getBordersHashTable()  : HashTable<string|int, Borders>

Get Borders HashTable.

getDiskCachingDirectory()  : string

Get disk caching directory.

getDrawingHashTable()  : HashTable<string|int, BaseDrawing>

Get \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\BaseDrawing HashTable.

getExplicitStyle0()  : bool

getFillHashTable()  : HashTable<string|int, Fill>

Get Fill HashTable.

getFontHashTable()  : HashTable<string|int, Font>

Get \PhpOffice\PhpSpreadsheet\Style\Font HashTable.

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.

getNumFmtHashTable()  : HashTable<string|int, NumberFormat>

Get NumberFormat HashTable.

getOffice2003Compatibility()  : bool

Get Office2003 compatibility.

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.

getSpreadsheet()  : Spreadsheet

Get Spreadsheet object.

getStringTable()  : array<string|int, string>

Get string table.

getStyleHashTable()  : HashTable<string|int, Style>

Get Style HashTable.

getStylesConditionalHashTable()  : HashTable<string|int, Conditional>

Get Conditional HashTable.

getUseDiskCaching()  : bool

Get use disk caching where possible?

getWriterPartChart()  : Chart

getWriterPartComments()  : Comments

getWriterPartContentTypes()  : ContentTypes

getWriterPartDocProps()  : DocProps

getWriterPartDrawing()  : Drawing

getWriterPartRels()  : Rels

getWriterPartRelsRibbon()  : RelsRibbon

getWriterPartRelsVBA()  : RelsVBA

getWriterPartStringTable()  : StringTable

getWriterPartStyle()  : Style

getWriterPartTable()  : Table

getWriterPartTheme()  : Theme

getWriterPartWorkbook()  : Workbook

getWriterPartWorksheet()  : Worksheet

openFileHandle()  : void

Open file handle.

save()  : void

Save PhpSpreadsheet to file.

setExplicitStyle0()  : self

This may be useful if non-default Alignment is part of default style and you think you might want to open the spreadsheet with LibreOffice or Gnumeric.

setForceFullCalc()  : self

If this is set when a spreadsheet is opened, values may not be automatically re-calculated, and a button will be available to force re-calculation.

setIncludeCharts()  : $this

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

setOffice2003Compatibility()  : $this

Set Office2003 compatibility.

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.

setSpreadsheet()  : $this

Set Spreadsheet object.

setUseCSEArrays()  : void

setUseDiskCaching()  : $this

Set use disk caching where possible?

useDynamicArrays()  : bool

maybeCloseFileHandle()  : void

Close file handle only if we opened it ourselves.

processFlags()  : void

addZipFile()  : void

addZipFiles()  : void

determineUseDynamicArrays()  : void

processDrawing()  : string|null|false

Loading…