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

$spreadsheet

$spreadsheet : \PhpOffice\PhpSpreadsheet\Spreadsheet

PhpSpreadsheet object.

Type

Spreadsheet

$delimiter

$delimiter : string

Delimiter.

Type

string

$enclosure

$enclosure : string

Enclosure.

Type

string

$lineEnding

$lineEnding : string

Line ending.

Type

string

$sheetIndex

$sheetIndex : int

Sheet index to write.

Type

int

$useBOM

$useBOM : bool

Whether to write a BOM (for UTF8).

Type

bool

$includeSeparatorLine

$includeSeparatorLine : bool

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

Type

bool

$excelCompatibility

$excelCompatibility : bool

Whether to write a fully Excel compatible CSV file.

Type

bool

$enclosureRequired

$enclosureRequired

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

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Spreadsheet object

Returns

mixed —

save()

save(resource|string  $pFilename) : void

Save PhpSpreadsheet to file.

Parameters

resource|string $pFilename

getDelimiter()

getDelimiter() : string

Get delimiter.

Returns

string —

setDelimiter()

setDelimiter(string  $pValue) : $this

Set delimiter.

Parameters

string $pValue

Delimiter, defaults to ','

Returns

$this —

getEnclosure()

getEnclosure() : string

Get enclosure.

Returns

string —

setEnclosure()

setEnclosure(string  $pValue = '"') : $this

Set enclosure.

Parameters

string $pValue

Enclosure, defaults to "

Returns

$this —

getLineEnding()

getLineEnding() : string

Get line ending.

Returns

string —

setLineEnding()

setLineEnding(string  $pValue) : $this

Set line ending.

Parameters

string $pValue

Line ending, defaults to OS line ending (PHP_EOL)

Returns

$this —

getUseBOM()

getUseBOM() : bool

Get whether BOM should be used.

Returns

bool —

setUseBOM()

setUseBOM(bool  $pValue) : $this

Set whether BOM should be used.

Parameters

bool $pValue

Use UTF-8 byte-order mark? Defaults to false

Returns

$this —

getIncludeSeparatorLine()

getIncludeSeparatorLine() : bool

Get whether a separator line should be included.

Returns

bool —

setIncludeSeparatorLine()

setIncludeSeparatorLine(bool  $pValue) : $this

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

Parameters

bool $pValue

Use separator line? Defaults to false

Returns

$this —

getExcelCompatibility()

getExcelCompatibility() : bool

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

Returns

bool —

setExcelCompatibility()

setExcelCompatibility(bool  $pValue) : $this

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

Parameters

bool $pValue

Set the file to be written as a fully Excel compatible csv file Note that this overrides other settings such as useBOM, enclosure and delimiter

Returns

$this —

getSheetIndex()

getSheetIndex() : int

Get sheet index.

Returns

int —

setSheetIndex()

setSheetIndex(int  $pValue) : $this

Set sheet index.

Parameters

int $pValue

Sheet index

Returns

$this —

setEnclosureRequired()

setEnclosureRequired(bool  $value) : self

Parameters

bool $value

Returns

self —

getEnclosureRequired()

getEnclosureRequired() : bool

Returns

bool —

maybeCloseFileHandle()

maybeCloseFileHandle() : void

Close file handle only if we opened it ourselves.

writeLine()

writeLine(resource  $pFileHandle, array  $pValues) : void

Write line to CSV file.

Parameters

resource $pFileHandle

PHP filehandle

array $pValues

Array containing values in a row