Properties

$includeCharts

$includeCharts : boolean

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

Type

boolean

$preCalculateFormulas

$preCalculateFormulas : boolean

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.

Type

boolean

$fileHandle

$fileHandle : resource

Type

resource

$useDiskCaching

$useDiskCaching : boolean

Use disk caching where possible?

Type

boolean

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory.

Type

string

$shouldCloseFile

$shouldCloseFile : boolean

Type

boolean

$office2003compatibility

$office2003compatibility : boolean

Office2003 compatibility.

Type

boolean

$spreadSheet

$spreadSheet : \PhpOffice\PhpSpreadsheet\Spreadsheet

Private Spreadsheet.

Type

\PhpOffice\PhpSpreadsheet\Spreadsheet

$stringTable

$stringTable : array<mixed,string>

Private string table.

Type

array<mixed,string>

$stylesConditionalHashTable

$stylesConditionalHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Conditional HashTable.

Type

\PhpOffice\PhpSpreadsheet\HashTable

$styleHashTable

$styleHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Style HashTable.

Type

\PhpOffice\PhpSpreadsheet\HashTable

$fillHashTable

$fillHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Fill HashTable.

Type

\PhpOffice\PhpSpreadsheet\HashTable

$fontHashTable

$fontHashTable : \PhpOffice\PhpSpreadsheet\HashTable

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

Type

\PhpOffice\PhpSpreadsheet\HashTable

$bordersHashTable

$bordersHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Borders HashTable.

Type

\PhpOffice\PhpSpreadsheet\HashTable

$numFmtHashTable

$numFmtHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique NumberFormat HashTable.

Type

\PhpOffice\PhpSpreadsheet\HashTable

$drawingHashTable

$drawingHashTable : \PhpOffice\PhpSpreadsheet\HashTable

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

Type

\PhpOffice\PhpSpreadsheet\HashTable

Methods

getIncludeCharts()

getIncludeCharts() : boolean

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.

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

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

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getPreCalculateFormulas()

getPreCalculateFormulas() : boolean

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.

Returns

boolean

setPreCalculateFormulas()

setPreCalculateFormulas(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

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

boolean $pValue

Pre-Calculate Formulas?

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getUseDiskCaching()

getUseDiskCaching() : boolean

Get use disk caching where possible?

Returns

boolean

setUseDiskCaching()

setUseDiskCaching(boolean  $pValue, string  $pDirectory = null) : \PhpOffice\PhpSpreadsheet\Writer\IWriter

Set use disk caching where possible?

Parameters

boolean $pValue
string $pDirectory

Disk caching directory

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory.

Returns

string

openFileHandle()

openFileHandle(resource|string  $filename) 

Open file handle.

Parameters

resource|string $filename

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) 

Create a new Xlsx Writer.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

save()

save(resource|string  $pFilename) 

Save PhpSpreadsheet to file.

Parameters

resource|string $pFilename

getSpreadsheet()

getSpreadsheet() : \PhpOffice\PhpSpreadsheet\Spreadsheet

Get Spreadsheet object.

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet

setSpreadsheet()

setSpreadsheet(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : $this

Set Spreadsheet object.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

PhpSpreadsheet object

Returns

$this

getStringTable()

getStringTable() : array<mixed,string>

Get string table.

Returns

array<mixed,string>

getStyleHashTable()

getStyleHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get Style HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getStylesConditionalHashTable()

getStylesConditionalHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get Conditional HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getFillHashTable()

getFillHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get Fill HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getFontHashTable()

getFontHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get \PhpOffice\PhpSpreadsheet\Style\Font HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getBordersHashTable()

getBordersHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get Borders HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getNumFmtHashTable()

getNumFmtHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

Get NumberFormat HashTable.

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getDrawingHashTable()

getDrawingHashTable() : \PhpOffice\PhpSpreadsheet\HashTable

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

Returns

\PhpOffice\PhpSpreadsheet\HashTable

getOffice2003Compatibility()

getOffice2003Compatibility() : boolean

Get Office2003 compatibility.

Returns

boolean

setOffice2003Compatibility()

setOffice2003Compatibility(boolean  $pValue) : $this

Set Office2003 compatibility.

Parameters

boolean $pValue

Office2003 compatibility?

Returns

$this

maybeCloseFileHandle()

maybeCloseFileHandle() 

Close file handle only if we opened it ourselves.