Documentation

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

$delimiter  : string

Delimiter.

$diskCachingDirectory  : string

Disk caching directory.

$enclosure  : string

Enclosure.

$enclosureRequired  : bool

$excelCompatibility  : bool

Whether to write a fully Excel compatible CSV file.

$includeSeparatorLine  : bool

Whether to write a Separator line as the first line of the file sep=x.

$lineEnding  : string

Line ending.

$outputEncoding  : string

Output encoding.

$sheetIndex  : int

Sheet index to write.

$shouldCloseFile  : bool

$spreadsheet  : Spreadsheet

PhpSpreadsheet object.

$useBOM  : bool

Whether to write a UTF8 BOM.

$useDiskCaching  : bool

Use disk caching where possible?

Methods

__construct()  : mixed

Create a new CSV.

getDelimiter()  : string

getDiskCachingDirectory()  : string

Get disk caching directory.

getEnclosure()  : string

getEnclosureRequired()  : bool

getExcelCompatibility()  : bool

Get whether the file should be saved with full Excel Compatibility.

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.

getIncludeSeparatorLine()  : bool

Get whether a separator line should be included.

getLineEnding()  : string

getOutputEncoding()  : string

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.

getSheetIndex()  : int

getUseBOM()  : bool

Get whether BOM should be used.

getUseDiskCaching()  : bool

Get use disk caching where possible?

openFileHandle()  : void

Open file handle.

save()  : void

Save PhpSpreadsheet to file.

setDelimiter()  : self

setEnclosure()  : self

setEnclosureRequired()  : self

setExcelCompatibility()  : self

Set whether the file should be saved with full Excel Compatibility.

setIncludeCharts()  : $this

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

setIncludeSeparatorLine()  : self

Set whether a separator line should be included as the first line of the file.

setLineEnding()  : self

setOutputEncoding()  : self

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.

setSheetIndex()  : self

setUseBOM()  : self

Set whether BOM should be used, typically when non-ASCII characters are used.

setUseDiskCaching()  : $this

Set use disk caching where possible?

maybeCloseFileHandle()  : void

Close file handle only if we opened it ourselves.

processFlags()  : void

elementToString()  : string

Convert boolean to TRUE/FALSE; otherwise return element cast to string.

writeLine()  : void

Write line to CSV file.