Properties

$includeCharts

$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;.

Type

bool

$preCalculateFormulas

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

Type

bool

$fileHandle

$fileHandle : resource

Type

resource

$useDiskCaching

$useDiskCaching : bool

Use disk caching where possible?

Type

bool

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory.

Type

string

$shouldCloseFile

$shouldCloseFile : bool

Type

bool

$office2003compatibility

$office2003compatibility : bool

Office2003 compatibility.

Type

bool

$writerParts

$writerParts : \PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart[]

Private writer parts.

Type

WriterPart[]

$spreadSheet

$spreadSheet : \PhpOffice\PhpSpreadsheet\Spreadsheet

Private Spreadsheet.

Type

Spreadsheet

$stringTable

$stringTable : string[]

Private string table.

Type

string[]

$stylesConditionalHashTable

$stylesConditionalHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Conditional HashTable.

Type

HashTable

$styleHashTable

$styleHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Style HashTable.

Type

HashTable

$fillHashTable

$fillHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Fill HashTable.

Type

HashTable

$fontHashTable

$fontHashTable : \PhpOffice\PhpSpreadsheet\HashTable

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

Type

HashTable

$bordersHashTable

$bordersHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique Borders HashTable.

Type

HashTable

$numFmtHashTable

$numFmtHashTable : \PhpOffice\PhpSpreadsheet\HashTable

Private unique NumberFormat HashTable.

Type

HashTable

$drawingHashTable

$drawingHashTable : \PhpOffice\PhpSpreadsheet\HashTable

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

Type

HashTable

$zip

$zip : \ZipStream\ZipStream

Private handle for zip stream.

Type

ZipStream

$pathNames

$pathNames

Methods

getIncludeCharts()

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.

If false (the default) it will ignore any charts defined in the PhpSpreadsheet object.

Returns

bool —

setIncludeCharts()

setIncludeCharts(mixed  $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

mixed $pValue

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter —

getPreCalculateFormulas()

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.

Returns

bool —

setPreCalculateFormulas()

setPreCalculateFormulas(mixed  $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

mixed $pValue

Pre-Calculate Formulas?

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter —

getUseDiskCaching()

getUseDiskCaching() : bool

Get use disk caching where possible?

Returns

bool —

setUseDiskCaching()

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

Set use disk caching where possible?

Parameters

mixed $pValue
mixed $pDirectory

Disk caching directory

Returns

\PhpOffice\PhpSpreadsheet\Writer\IWriter —

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory.

Returns

string —

openFileHandle()

openFileHandle(resource|string  $filename) : void

Open file handle.

Parameters

resource|string $filename

__construct()

__construct(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : mixed

Create a new Xlsx Writer.

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Returns

mixed —

getWriterPart()

getWriterPart(string  $pPartName) : \PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart

Get writer part.

Parameters

string $pPartName

Writer part name

Returns

\PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart —

save()

save(resource|string  $pFilename) : void

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() : string[]

Get string table.

Returns

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() : bool

Get Office2003 compatibility.

Returns

bool —

setOffice2003Compatibility()

setOffice2003Compatibility(bool  $pValue) : $this

Set Office2003 compatibility.

Parameters

bool $pValue

Office2003 compatibility?

Returns

$this —

maybeCloseFileHandle()

maybeCloseFileHandle() : void

Close file handle only if we opened it ourselves.

addZipFile()

addZipFile(string  $path, string  $content) : void

Parameters

string $path
string $content